Package com.onenetwork.platform.integ.rest

Infrastructure for implementing REST-ful web services using JAXRS.

To implement a REST resource, extend BaseResource and add your JAX-RS annotations.

  • Class Summary 
    Class Description
    BaseResource
    Base class for a JAX-RS based RESTful web services.
    PlatformRestClient
    Simple REST client for calling Platform REST APIs.
    ResourceListenerFactory
    This class is used by a module to help make a REST Resource more extensible through the use of a listener pattern.
    ResourceResponse
    Resource response object which is specifically useful in the context of Platform UI components.
  • Exception Summary 
    Exception Description
    MissingRequiredParameterException
    Since JAX-RS cannot enforce requiredness for http parameters, this exception can used to represent a missing parameter to a REST resource method.
    ResourceException
    An exception which can be thrown from a resource and will result in a json message the client can consume with a user-friendly error message.
    UnsafeJsonpException  
  • Annotation Types Summary 
    Annotation Type Description
    ResourceListener
    Allows you to register a listener for a specific REST Resource.