CloudPlugs REST Library  1.0.0
for Java
Package com.cloudplugs.rest

Classes

class  Const
 Tool class containing internal default values and options. This class is for internal usage. More...
 
class  Opts
 An instance of this class contains all the options for connecting and making requests to the server, including the authentication credentials required for most HTTP requests. This class mainly offers getter and setter methods to manage all the options. More...
 
class  Request
 An instance of this class is a HTTP request to send or already sent to the server. More...
 
class  Response
 An instance of this class is a HTTP response received by the server or a generic error response. More...
 
class  RestBaseManager
 Base class for handling HTTP requests. This class is not intended for direct usage, the developer should use a subclass of this one.

An instance of this class will also emit events about the internal spooler behavoir, so that any attached com.cloudplugs.util.Listener to a RestBaseManager will be notified about what's happening in the execution flow.

See also RestManager. More...
 
interface  RestCallback
 An instance of this interface will asynchronously receive the results of a HTTP request execution enqueued using one of the methods in RestManager. More...
 
class  RestClient
 This is the main class for handling the connection to the CloudPlugs server on the Java platform.

An instance of RestClient manages the HTTP requests flow by creating a thread spooler for each server to connect. Such spooler will send enqueued HTTP requests one by one following the FIFO order. An instance of this class will also emit events about the internal spooler behavior, so that any attached com.cloudplugs.util.Listener to a RestClient will be notified about what's happening in the execution flow.

The primary usage of this class is to invoke the method getManager(Opts) for obtaining an instance of RestManager able to enqueue asynchronous HTTP requests (executed in an underlying thread spooler) using the preferred options Opts.

Android developers should avoid a direct use of this class, they should use com.cloudplugs.rest.android.RestClient (unavailable on Java platform), because it supports reliable background execution of HTTP requests through a dedicated Android service and CPU wake locks. By using a direct instance of this class, an Android app could lose the ability to send HTTP requests and to receive the responses when the app is not in foreground. More...
 
class  RestException
 An exception thrown by REST CloudPlugs API. More...
 
class  RestJob
 An instance of this class is an enqueued request execution obtained by RestBaseManager#getJobOf(int). More...
 
class  RestManager
 Class for handling remote requests with CloudPlugs server. More...
 
class  RestSpooler
 A thread spooler for asynchronous sending of HTTP requests. This class is for internal usage. More...