T
- The ResourceRepresentation
class that request deals withpublic class RESTRequest<T extends Resource>
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private java.io.ByteArrayOutputStream |
mByteArrayResultStream
The server response
|
private long |
mExpirationTime |
private Bundle |
mExtraParams
Defines extra parameters for request
|
private java.lang.Class<? extends FailBehavior> |
mFailBehaviorClass |
private java.util.List<SerializableHeader> |
mHeaders
List of
SerializableHeader for this request |
private java.util.UUID |
mID
ID of the request.
|
private boolean |
mPending
Boolean to know if request is pending
|
private RequestListeners |
mRequestListeners
Instance of
RequestListeners |
private T |
mResource
Instance of
ResourceRepresentation attached to this request |
private java.lang.Class<T> |
mResourceClass
The Class object of
ResourceRepresentation attached to this request. |
private int |
mResultCode
Request result code
|
private java.lang.String |
mUrl
Url for this request
|
private HTTPVerb |
mVerb
The particular
HTTPVerb for this request |
private static long |
serialVersionUID |
Constructor and Description |
---|
RESTRequest(HTTPVerb verb,
java.util.UUID id,
java.lang.String url,
Bundle extraParams)
Constructor
|
RESTRequest(java.util.UUID id,
java.lang.Class<T> clazz)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addHeader(SerializableHeader h)
Add
SerializableHeader to RESTRequest |
void |
addHeader(java.lang.String name,
java.lang.String value)
Add
SerializableHeader from name and value |
long |
getExpirationTime() |
Bundle |
getExtraParams()
Getter for extra parameters
|
java.lang.Class<? extends FailBehavior> |
getFailBehaviorClass() |
java.util.List<SerializableHeader> |
getHeaders()
Getter for request's list of
SerializableHeader |
java.util.UUID |
getID()
Getter for the unique ID of the request
|
RequestListeners |
getRequestListeners()
Getter for
mRequestListeners |
T |
getResource()
Getter for
ResourceRepresentation |
java.lang.Class<T> |
getResourceClass()
Getter for Class object of
RESTRequest 's ResourceRepresentation |
int |
getResultCode()
Getter for
mResultCode |
java.io.InputStream |
getResultStream()
Getter for
mByteArrayResultStream . |
java.lang.String |
getUrl()
Getter for url
|
HTTPVerb |
getVerb()
Getter for
HTTPVerb |
boolean |
isPending()
Getter for
mPending |
void |
pauseListeners()
Pauses the listeners by setting their state to
ListenerState.UNSET |
boolean |
resumeListeners()
Resumes the listeners.
|
void |
setExpirationTime(long expirationTime) |
void |
setExtraParams(Bundle extraParams)
Setter for extra parameters
|
void |
setFailBehaviorClass(java.lang.Class<? extends FailBehavior> failBehaviorClass) |
void |
setPending(boolean pending)
Setter for
mPending |
<L> void |
setRequestListeners(Activity a,
java.lang.Class<L> clazz)
Setter for
mRequestListeners . |
void |
setResource(Resource mResourceRepresentation)
Setter for
ResourceRepresentation |
void |
setResultCode(int resultCode)
Set the request's result code
|
void |
setResultStream(java.io.InputStream mResultStream)
Setter for
mByteArrayResultStream |
void |
setUrl(java.lang.String url)
Setter for url
|
void |
setVerb(HTTPVerb mVerb)
Setter for
HTTPVerb |
java.lang.String |
toString() |
boolean |
triggerOnFailedRequestListeners()
Triggers
RequestListeners.OnFailedRequestListener if state is set to ListenerState.SET and updates state to ListenerState.TRIGGERED . |
boolean |
triggerOnFinishedRequestListeners()
Triggers
RequestListeners.OnFinishedRequestListener if state is set to ListenerState.SET and updates state to ListenerState.TRIGGERED . |
boolean |
triggerOnStartedRequestListeners()
Triggers
RequestListeners.OnStartedRequestListener if state is set to ListenerState.SET and updates state to ListenerState.TRIGGERED . |
boolean |
triggerOnSucceededRequestListeners()
Triggers
RequestListeners.OnFinishedRequestListener if state is set to ListenerState.SET and updates state to ListenerState.TRIGGERED . |
private static final long serialVersionUID
private java.util.UUID mID
getID()
private HTTPVerb mVerb
HTTPVerb
for this requestgetVerb()
,
setVerb(HTTPVerb)
private java.lang.String mUrl
getUrl()
,
setUrl(String)
private int mResultCode
getResultCode()
,
setResultCode(int)
private boolean mPending
isPending()
,
setPending(boolean)
private transient java.io.ByteArrayOutputStream mByteArrayResultStream
getResultStream()
,
setResultStream(InputStream)
private Bundle mExtraParams
private java.util.List<SerializableHeader> mHeaders
SerializableHeader
for this requestprivate T extends Resource mResource
ResourceRepresentation
attached to this requestRESTRequest#getResourceRepresentation()
,
RESTRequest#setResourceRepresentation(ResourceRepresentation)
private java.lang.Class<T extends Resource> mResourceClass
ResourceRepresentation
attached to this request. Useful when mResource
is nullgetResourceClass()
private transient RequestListeners mRequestListeners
RequestListeners
setRequestListeners(Activity, Class)
,
getRequestListeners()
private java.lang.Class<? extends FailBehavior> mFailBehaviorClass
private long mExpirationTime
public RESTRequest(java.util.UUID id, java.lang.Class<T> clazz)
id
- Unique ID of the requestclazz
- The Class object of the ResourceRepresentation
attached to this requestpublic RESTRequest(HTTPVerb verb, java.util.UUID id, java.lang.String url, Bundle extraParams)
verb
- id
- url
- extraParams
- public void pauseListeners()
ListenerState.UNSET
resumeListeners()
,
RequestListeners
public boolean resumeListeners()
ListenerState.UNSET
, state is updated to ListenerState.SET
. If the state is ListenerState.TRIGGER_ME
the listener is triggered and is state updated to ListenerState.TRIGGERED
pauseListeners()
,
RequestListeners
public java.util.UUID getID()
mID
public java.util.List<SerializableHeader> getHeaders()
SerializableHeader
SerializableHeader
of the requestmHeaders
,
addHeader(SerializableHeader)
,
addHeader(String, String)
,
SerializableHeader
public boolean triggerOnStartedRequestListeners()
RequestListeners.OnStartedRequestListener
if state is set to ListenerState.SET
and updates state to ListenerState.TRIGGERED
. If the listener is unset, state is updated to ListenerState.TRIGGER_ME
RequestListeners.mOnStartedRequestListeners
public boolean triggerOnSucceededRequestListeners()
RequestListeners.OnFinishedRequestListener
if state is set to ListenerState.SET
and updates state to ListenerState.TRIGGERED
. If the listener is unset, state is updated to ListenerState.TRIGGER_ME
RequestListeners.mOnSucceededRequestListeners
public boolean triggerOnFailedRequestListeners()
RequestListeners.OnFailedRequestListener
if state is set to ListenerState.SET
and updates state to ListenerState.TRIGGERED
. If the listener is unset, state is updated to ListenerState.TRIGGER_ME
RequestListeners.mOnFailedRequestListeners
public boolean triggerOnFinishedRequestListeners()
RequestListeners.OnFinishedRequestListener
if state is set to ListenerState.SET
and updates state to ListenerState.TRIGGERED
. If the listener is unset, state is updated to ListenerState.TRIGGER_ME
RequestListeners.mOnFinishedRequestListeners
public java.lang.String getUrl()
RESTRequest
's urlmUrl
,
setUrl(String)
public void setUrl(java.lang.String url)
url
- The RESTRequest
's urlmUrl
,
getUrl()
public int getResultCode()
mResultCode
mResultCode
,
setResultCode(int)
public void setResultCode(int resultCode)
resultCode
- The result code to setmResultCode
,
getResultCode()
public boolean isPending()
mPending
mPending
,
setPending(boolean)
public void setPending(boolean pending)
mPending
pending
- The pending statemPending
,
isPending()
public java.io.InputStream getResultStream()
mByteArrayResultStream
. Returns a new InputStream each timemByteArrayResultStream
,
setResultStream(InputStream)
public void setResultStream(java.io.InputStream mResultStream) throws java.io.IOException
mByteArrayResultStream
mResultStream
- The server's result streamjava.io.IOException
mByteArrayResultStream
,
getResultStream()
public HTTPVerb getVerb()
HTTPVerb
RESTRequest
's HTTPVerb
HTTPVerb
,
mVerb
,
setVerb(HTTPVerb)
public void setVerb(HTTPVerb mVerb)
HTTPVerb
mVerb
- The RESTRequest
's HTTPVerb
HTTPVerb
,
mVerb
,
getVerb()
public T getResource()
ResourceRepresentation
RESTRequest
's ResourceRepresentation
ResourceRepresentation
,
mResource
,
RESTRequest#setResourceRepresentation(ResourceRepresentation)
public java.lang.Class<T> getResourceClass()
RESTRequest
's ResourceRepresentation
RESTRequest
's ResourceRepresentation
ResourceRepresentation
,
mResourceClass
public void setResource(Resource mResourceRepresentation)
ResourceRepresentation
mResourceRepresentation
- Instance of ResourceRepresentation
ResourceRepresentation
,
mResource
,
RESTRequest#getResourceRepresentation()
public Bundle getExtraParams()
RESTRequest
's extra parametersmExtraParams
,
setExtraParams(Bundle)
public void setExtraParams(Bundle extraParams)
extraParams
- Extra parameters to store in RESTRequest
mExtraParams
public RequestListeners getRequestListeners()
mRequestListeners
mRequestListeners
mRequestListeners
,
RequestListeners
,
setRequestListeners(Activity, Class)
public <L> void setRequestListeners(Activity a, java.lang.Class<L> clazz)
mRequestListeners
. Dynamically instanciate new instance of the specified RequestListeners
class.a
- Context activity where the RequestListeners
inner class is definedclazz
- RESTRequest
Class object holding by this RequestListeners
classpublic void addHeader(SerializableHeader h)
SerializableHeader
to RESTRequest
h
- Instance of SerializableHeader
SerializableHeader
,
mHeaders
,
getHeaders()
,
addHeader(String, String)
public void addHeader(java.lang.String name, java.lang.String value)
SerializableHeader
from name and valuename
- Header's namevalue
- Header's valueSerializableHeader
,
mHeaders
,
getHeaders()
,
addHeader(SerializableHeader)
public void setExpirationTime(long expirationTime)
public long getExpirationTime()
public java.lang.Class<? extends FailBehavior> getFailBehaviorClass()
public void setFailBehaviorClass(java.lang.Class<? extends FailBehavior> failBehaviorClass)
public java.lang.String toString()
toString
in class java.lang.Object