| java.lang.Object
 org.restlet.data.Message
org.restlet.data.Request
All known Subclasses: org.restlet.util.WrapperRequest, com.noelios.restlet.http.HttpRequest,
| Request | | public class Request extends Message (Code) | | 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.
See Also: org.restlet.data.Response
See Also: org.restlet.Uniform
author:
Jerome Louvel (contact@noelios.com) |
| Request | | public Request()(Code) | | Constructor.
|
| Request | | public Request(Method method, Reference resourceRef)(Code) | | Constructor.
Parameters:
method - The call's method.
Parameters:
resourceRef - The resource reference. |
| Request | | public Request(Method method, Reference resourceRef, Representation entity)(Code) | | Constructor.
Parameters:
method - The call's method.
Parameters:
resourceRef - The resource reference.
Parameters:
entity - The entity. |
| Request | | public Request(Method method, String resourceUri)(Code) | | Constructor.
Parameters:
method - The call's method.
Parameters:
resourceUri - The resource URI. |
| Request | | public Request(Method method, String resourceUri, Representation entity)(Code) | | Constructor.
Parameters:
method - The call's method.
Parameters:
resourceUri - The resource URI.
Parameters:
entity - The entity. |
| getChallengeResponse | | public ChallengeResponse getChallengeResponse()(Code) | | Returns the authentication response sent by a client to an origin server.
The authentication response sent by a client to an origin server. |
| getClientInfo | | public ClientInfo getClientInfo()(Code) | | Returns the client-specific information.
The client-specific information. |
| getConditions | | public Conditions getConditions()(Code) | | Returns the conditions applying to this call.
The conditions applying to this call. |
| getCookies | | public Series<Cookie> getCookies()(Code) | | Returns the cookies provided by the client.
The cookies provided by the client. |
| getHostRef | | public Reference getHostRef()(Code) | | Returns the host reference. This may be different from the resourceRef's
host, for example for URNs and other URIs that don't contain host
information.
The host reference. |
| getMethod | | public Method getMethod()(Code) | | Returns the method.
The method. |
| getProtocol | | public Protocol getProtocol()(Code) | | Returns the protocol by first returning the baseRef.schemeProtocol
property if it is set, or the resourceRef.schemeProtocol property
otherwise.
The protocol or null if not available. |
| getReferrerRef | | public Reference getReferrerRef()(Code) | | Returns the referrer reference if available.
The referrer reference. |
| getResourceRef | | public Reference getResourceRef()(Code) | | Returns the reference of the target resource.
The reference of the target resource. |
| getRootRef | | public Reference getRootRef()(Code) | | Returns the application root reference.
The application root reference. |
| isConfidential | | public boolean isConfidential()(Code) | | Indicates if the call came over a confidential channel such as an
SSL-secured connection.
True if the call came over a confidential channel. |
| isEntityAvailable | | public boolean isEntityAvailable()(Code) | | Indicates if a content is available and can be sent. Several conditions
must be met: the method must allow the sending of content, the content
must exists and have some available data.
True if a content is available and can be sent. |
| setChallengeResponse | | public void setChallengeResponse(ChallengeResponse response)(Code) | | Sets the authentication response sent by a client to an origin server.
Parameters:
response - The authentication response sent by a client to an originserver. |
| setConfidential | | public void setConfidential(boolean confidential)(Code) | | Indicates if the call came over a confidential channel such as an
SSL-secured connection.
Parameters:
confidential - True if the call came over a confidential channel. |
| setHostRef | | public void setHostRef(Reference hostRef)(Code) | | Sets the host reference.
Parameters:
hostRef - The host reference. |
| setHostRef | | public void setHostRef(String hostUri)(Code) | | Sets the host reference using an URI string.
Parameters:
hostUri - The host URI. |
| setMethod | | public void setMethod(Method method)(Code) | | Sets the method called.
Parameters:
method - The method called. |
| setReferrerRef | | public void setReferrerRef(Reference referrerRef)(Code) | | Sets the referrer reference if available.
Parameters:
referrerRef - The referrer reference. |
| setReferrerRef | | public void setReferrerRef(String referrerUri)(Code) | | Sets the referrer reference if available using an URI string.
Parameters:
referrerUri - The referrer URI. |
| setResourceRef | | public void setResourceRef(Reference resourceRef)(Code) | | Sets the target resource reference. If the reference is relative, it will
be resolved as an absolute reference. Also, the context's base reference
will be reset. Finally, the reference will be normalized to ensure a
consistent handling of the call.
Parameters:
resourceRef - The resource reference. |
| setResourceRef | | public void setResourceRef(String resourceUri)(Code) | | Sets the target resource reference using an URI string. Note that the URI
can be either absolute or relative to the context's base reference.
Parameters:
resourceUri - The resource URI. |
| setRootRef | | public void setRootRef(Reference rootRef)(Code) | | Sets the application root reference.
Parameters:
rootRef - The application root reference. |
|
|