|
||||||||||
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,
String resourceUri)
Constructor. |
|
Request(Method method,
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 conditions applying to this call. |
Series<Cookie> |
getCookies()
Returns the cookies provided by the client. |
Reference |
getHostRef()
Returns the host reference. |
Method |
getMethod()
Returns the method. |
Protocol |
getProtocol()
Returns the protocol by first returning the baseRef.schemeProtocol property if it is set, or the resourceRef.schemeProtocol property otherwise. |
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()
Indicates if the call came over a confidential channel such as an SSL-secured connection. |
boolean |
isEntityAvailable()
Indicates if a content is available and can be sent. |
void |
setChallengeResponse(ChallengeResponse response)
Sets the authentication response sent by a client to an origin server. |
void |
setConfidential(boolean confidential)
Indicates if the call came over a confidential channel such as an SSL-secured connection. |
void |
setHostRef(Reference hostRef)
Sets the host reference. |
void |
setHostRef(String hostUri)
Sets the host reference using an URI string. |
void |
setMethod(Method method)
Sets the method called. |
void |
setReferrerRef(Reference referrerRef)
Sets the referrer reference if available. |
void |
setReferrerRef(String referrerUri)
Sets the referrer reference if available using an URI string. |
void |
setResourceRef(Reference resourceRef)
Sets the target resource reference. |
void |
setResourceRef(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, 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, String resourceUri)
method
- The call's method.resourceUri
- The resource URI.public Request(Method method, String resourceUri, Representation entity)
method
- The call's method.resourceUri
- The resource URI.entity
- The entity.Method Detail |
---|
public ChallengeResponse getChallengeResponse()
public ClientInfo getClientInfo()
public Conditions getConditions()
public Series<Cookie> getCookies()
public Reference getHostRef()
public Method getMethod()
public Protocol getProtocol()
public Reference getReferrerRef()
public Reference getResourceRef()
public Reference getRootRef()
public boolean isConfidential()
public boolean isEntityAvailable()
isEntityAvailable
in class Message
public void setChallengeResponse(ChallengeResponse response)
response
- The authentication response sent by a client to an origin
server.public void setConfidential(boolean confidential)
confidential
- True if the call came over a confidential channel.public void setHostRef(Reference hostRef)
hostRef
- The host reference.public void setHostRef(String hostUri)
hostUri
- The host URI.public void setMethod(Method method)
method
- The method called.public void setReferrerRef(Reference referrerRef)
referrerRef
- The referrer reference.public void setReferrerRef(String referrerUri)
referrerUri
- The referrer URI.public void setResourceRef(Reference resourceRef)
resourceRef
- The resource reference.public void setResourceRef(String resourceUri)
resourceUri
- The resource URI.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 |