|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.data.Message
org.restlet.data.Request
public class Request
Generic request sent by client connectors. It is then received by server connectors and processed by Restlets. This request can also be processed by a chain of Restlets, on both client and server sides. Requests are uniform across all types of connectors, protocols and components.
Response
,
Uniform
Constructor Summary | |
---|---|
Request()
Constructor. |
|
Request(Method method,
Reference resourceRef)
Constructor. |
|
Request(Method method,
Reference resourceRef,
Representation entity)
Constructor. |
|
Request(Method method,
java.lang.String resourceUri)
Constructor. |
|
Request(Method method,
java.lang.String resourceUri,
Representation entity)
Constructor. |
Method Summary | |
---|---|
ChallengeResponse |
getChallengeResponse()
Returns the authentication response sent by a client to an origin server. |
ClientInfo |
getClientInfo()
Returns the client-specific information. |
Conditions |
getConditions()
Returns the modifiable conditions applying to this request. |
Series<Cookie> |
getCookies()
Returns the modifiable series of cookies provided by the client. |
static Request |
getCurrent()
Returns the request associated to the current thread. |
Reference |
getHostRef()
Returns the host reference. |
Method |
getMethod()
Returns the method. |
Reference |
getOriginalRef()
Returns the original reference as requested by the client. |
Protocol |
getProtocol()
Returns the protocol by first returning the resourceRef.schemeProtocol property if it is set, or the baseRef.schemeProtocol property otherwise. |
java.util.List<Range> |
getRanges()
Returns the ranges to return from the target resource's representation. |
Reference |
getReferrerRef()
Returns the referrer reference if available. |
Reference |
getResourceRef()
Returns the reference of the target resource. |
Reference |
getRootRef()
Returns the application root reference. |
boolean |
isConfidential()
Implemented based on the Protocol.isConfidential() method for the
request's protocol returned by getProtocol() ; |
boolean |
isEntityAvailable()
Indicates if a content is available and can be sent. |
void |
setChallengeResponse(ChallengeResponse challengeResponse)
Sets the authentication response sent by a client to an origin server. |
void |
setClientInfo(ClientInfo clientInfo)
Sets the client-specific information. |
void |
setConditions(Conditions conditions)
Sets the conditions applying to this request. |
void |
setCookies(Series<Cookie> cookies)
Sets the cookies provided by the client. |
void |
setHostRef(Reference hostRef)
Sets the host reference. |
void |
setHostRef(java.lang.String hostUri)
Sets the host reference using an URI string. |
void |
setMethod(Method method)
Sets the method called. |
void |
setOriginalRef(Reference originalRef)
Sets the original reference requested by the client. |
void |
setRanges(java.util.List<Range> ranges)
Sets the ranges to return from the target resource's representation. |
void |
setReferrerRef(Reference referrerRef)
Sets the referrer reference if available. |
void |
setReferrerRef(java.lang.String referrerUri)
Sets the referrer reference if available using an URI string. |
void |
setResourceRef(Reference resourceRef)
Sets the target resource reference. |
void |
setResourceRef(java.lang.String resourceUri)
Sets the target resource reference using an URI string. |
void |
setRootRef(Reference rootRef)
Sets the application root reference. |
Methods inherited from class org.restlet.data.Message |
---|
getAttributes, getEntity, getEntityAsDom, getEntityAsForm, getEntityAsObject, getEntityAsSax, release, setAttributes, setEntity, setEntity, setEntity |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Request()
public Request(Method method, Reference resourceRef)
method
- The call's method.resourceRef
- The resource reference.public Request(Method method, Reference resourceRef, Representation entity)
method
- The call's method.resourceRef
- The resource reference.entity
- The entity.public Request(Method method, java.lang.String resourceUri)
method
- The call's method.resourceUri
- The resource URI.public Request(Method method, java.lang.String resourceUri, Representation entity)
method
- The call's method.resourceUri
- The resource URI.entity
- The entity.Method Detail |
---|
public static Request getCurrent()
Response.getCurrent()
method.
Warning: this method should only be used under duress. You should by
default prefer obtaining the current context using methods such as
Handler.getRequest()
.
public ChallengeResponse getChallengeResponse()
public ClientInfo getClientInfo()
public Conditions getConditions()
public Series<Cookie> getCookies()
public Reference getHostRef()
public Method getMethod()
public Reference getOriginalRef()
getResourceRef()
method for details.
getResourceRef()
public Protocol getProtocol()
public java.util.List<Range> getRanges()
public Reference getReferrerRef()
public Reference getResourceRef()
getOriginalRef()
method instead. Also,
note that beside the update of its base property, the resource reference
can be modified during the request processing.
For example, the TunnelService
associated to an application can
extract some special extensions or query parameters and replace them by
semantically equivalent properties on the request object. Therefore, the
resource reference can become different from the original reference.
Finally, when sending out requests via a dispatcher such as
Context.getClientDispatcher()
or
Context.getServerDispatcher()
, if the reference contains URI
template variables, those variables are automatically resolved using the
request's attributes.
getOriginalRef()
public Reference getRootRef()
public boolean isConfidential()
Protocol.isConfidential()
method for the
request's protocol returned by getProtocol()
;
isConfidential
in class Message
public boolean isEntityAvailable()
isEntityAvailable
in class Message
public void setChallengeResponse(ChallengeResponse challengeResponse)
challengeResponse
- The authentication response sent by a client to an origin
server.public void setClientInfo(ClientInfo clientInfo)
clientInfo
- The client-specific information.public void setConditions(Conditions conditions)
conditions
- The conditions applying to this request.public void setCookies(Series<Cookie> cookies)
cookies
- The cookies provided by the client.public void setHostRef(Reference hostRef)
hostRef
- The host reference.public void setHostRef(java.lang.String hostUri)
hostUri
- The host URI.public void setMethod(Method method)
method
- The method called.public void setOriginalRef(Reference originalRef)
originalRef
- The original reference.getOriginalRef()
public void setRanges(java.util.List<Range> ranges)
ranges
- The ranges.public void setReferrerRef(Reference referrerRef)
referrerRef
- The referrer reference.public void setReferrerRef(java.lang.String referrerUri)
referrerUri
- The referrer URI.public void setResourceRef(Reference resourceRef)
resourceRef
- The resource reference.getResourceRef()
public void setResourceRef(java.lang.String resourceUri)
resourceUri
- The resource URI.setResourceRef(Reference)
public void setRootRef(Reference rootRef)
rootRef
- The application root reference.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |