| Package | Description |
|---|---|
| org.restlet.client |
Core classes of the API.
|
| org.restlet.client.data |
Information exchanged by components.
|
| org.restlet.client.resource |
Client and server resource classes.
|
| org.restlet.client.util |
Various utility classes.
|
| Modifier and Type | Method and Description |
|---|---|
Status |
Response.getStatus()
Returns the status.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Response.setStatus(Status status)
Sets the status.
|
void |
Response.setStatus(Status status,
java.lang.String description)
Sets the status.
|
void |
Response.setStatus(Status status,
java.lang.Throwable throwable)
Sets the status.
|
void |
Response.setStatus(Status status,
java.lang.Throwable throwable,
java.lang.String message)
Sets the status.
|
| Modifier and Type | Field and Description |
|---|---|
static Status |
Status.CLIENT_ERROR_BAD_REQUEST
The request could not be understood by the server due to malformed
syntax.
|
static Status |
Status.CLIENT_ERROR_CONFLICT
The request could not be completed due to a conflict with the current
state of the resource (as experienced in a version control system).
|
static Status |
Status.CLIENT_ERROR_EXPECTATION_FAILED
The user agent expects some behavior of the server (given in an Expect
request-header field), but this expectation could not be met by this
server.
|
static Status |
Status.CLIENT_ERROR_FAILED_DEPENDENCY
This status code means that the method could not be performed on the
resource because the requested action depended on another action and that
action failed.
|
static Status |
Status.CLIENT_ERROR_FORBIDDEN
The server understood the request, but is refusing to fulfill it as it
could be explained in the entity.
|
static Status |
Status.CLIENT_ERROR_GONE
The requested resource is no longer available at the server and no
forwarding address is known.
|
static Status |
Status.CLIENT_ERROR_LENGTH_REQUIRED
The server refuses to accept the request without a defined
Content-Length.
|
static Status |
Status.CLIENT_ERROR_LOCKED
The source or destination resource of a method is locked (or temporarily
involved in another process).
|
static Status |
Status.CLIENT_ERROR_METHOD_NOT_ALLOWED
The method specified in the Request-Line is not allowed for the resource
identified by the Request-URI.
|
static Status |
Status.CLIENT_ERROR_NOT_ACCEPTABLE
The resource identified by the request is only capable of generating
response entities whose content characteristics do not match the user's
requirements (in Accept* headers).
|
static Status |
Status.CLIENT_ERROR_NOT_FOUND
The server has not found anything matching the Request-URI or the server
does not wish to reveal exactly why the request has been refused, or no
other response is applicable.
|
static Status |
Status.CLIENT_ERROR_PAYMENT_REQUIRED
This code is reserved for future use.
|
static Status |
Status.CLIENT_ERROR_PRECONDITION_FAILED
Sent by the server when the user agent asks the server to carry out a
request under certain conditions that are not met.
|
static Status |
Status.CLIENT_ERROR_PROXY_AUTHENTIFICATION_REQUIRED
This code is similar to 401 (Unauthorized), but indicates that the client
must first authenticate itself with the proxy.
|
static Status |
Status.CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE
The server is refusing to process a request because the request entity is
larger than the server is willing or able to process.
|
static Status |
Status.CLIENT_ERROR_REQUEST_TIMEOUT
Sent by the server when an HTTP client opens a connection, but has never
sent a request (or never sent the blank line that signals the end of the
request).
|
static Status |
Status.CLIENT_ERROR_REQUEST_URI_TOO_LONG
The server is refusing to service the request because the Request-URI is
longer than the server is willing to interpret.
|
static Status |
Status.CLIENT_ERROR_REQUESTED_RANGE_NOT_SATISFIABLE
The request includes a Range request-header field and the selected
resource is too small for any of the byte-ranges to apply.
|
static Status |
Status.CLIENT_ERROR_TOO_MANY_REQUESTS
The server refuses to accept the request because the user has sent too
many requests in a given amount of time.
|
static Status |
Status.CLIENT_ERROR_UNAUTHORIZED
The request requires user authentication.
|
static Status |
Status.CLIENT_ERROR_UNPROCESSABLE_ENTITY
This status code means the server understands the content type of the
request entity (syntactically correct) but was unable to process the
contained instructions.
|
static Status |
Status.CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE
The server is refusing to service the request because the entity of the
request is in a format not supported by the requested resource for the
requested method.
|
static Status |
Status.CONNECTOR_ERROR_COMMUNICATION
The client connector faced an error during the communication with the
remote server (interruption, timeout, etc.).
|
static Status |
Status.CONNECTOR_ERROR_CONNECTION
The client connector could not connect to the remote server.
|
static Status |
Status.CONNECTOR_ERROR_INTERNAL
The client connector faced an internal error during the process of a
request to its server or the process of a response to its client.
|
static Status |
Status.INFO_CONTINUE
This interim response (the client has to wait for the final response) is
used to inform the client that the initial part of the request has been
received and has not yet been rejected or completed by the server.
|
static Status |
Status.INFO_DISCONNECTED_OPERATION
Warning status code, typically returned by a cache, indicating that it is
intentionally disconnected from the rest of the network for a period of
time.
|
static Status |
Status.INFO_HEURISTIC_EXPIRATION
Warning status code, typically returned by a cache, indicating that it
heuristically chose a freshness lifetime greater than 24 hours and the
response's age is greater than 24 hours.
|
static Status |
Status.INFO_MISC_WARNING
Warning status code, optionally including arbitrary information to be
presented to a human user, typically returned by a cache.
|
static Status |
Status.INFO_PROCESSING
This interim response is used to inform the client that the server has
accepted the complete request, but has not yet completed it since the
server has a reasonable expectation that the request will take
significant time to complete.
|
static Status |
Status.INFO_REVALIDATION_FAILED
Warning status code, typically returned by a cache, indicating that the
response is stale because an attempt to revalidate the response failed,
due to an inability to reach the server.
|
static Status |
Status.INFO_STALE_RESPONSE
Warning status code, typically returned by a cache, indicating that the
response is stale.
|
static Status |
Status.INFO_SWITCHING_PROTOCOL
The server understands and is willing to comply with the client's
request, via the Upgrade message header field, for a change in the
application protocol being used on this connection.
|
static Status |
Status.REDIRECTION_FOUND
The requested resource resides temporarily under a different URI which
should not be used for future requests by the client (use status codes
303 or 307 instead since this status has been manifestly misused).
|
static Status |
Status.REDIRECTION_MULTIPLE_CHOICES
The server lets the user agent choosing one of the multiple
representations of the requested resource, each representation having its
own specific location provided in the response entity.
|
static Status |
Status.REDIRECTION_NOT_MODIFIED
Status code sent by the server in response to a conditional GET request
in case the document has not been modified.
|
static Status |
Status.REDIRECTION_PERMANENT
The requested resource has been assigned a new permanent URI and any
future references to this resource SHOULD use one of the returned URIs.
|
static Status |
Status.REDIRECTION_SEE_OTHER
The response to the request can be found under a different URI and SHOULD
be retrieved using a GET method on that resource.
|
static Status |
Status.REDIRECTION_TEMPORARY
The requested resource resides temporarily under a different URI which
should not be used for future requests by the client.
|
static Status |
Status.REDIRECTION_USE_PROXY
The requested resource MUST be accessed through the proxy given by the
Location field.
|
static Status |
Status.SERVER_ERROR_BAD_GATEWAY
The server, while acting as a gateway or proxy, received an invalid
response from the upstream server it accessed in attempting to fulfill
the request.
|
static Status |
Status.SERVER_ERROR_GATEWAY_TIMEOUT
The server, while acting as a gateway or proxy, could not connect to the
upstream server.
|
static Status |
Status.SERVER_ERROR_INSUFFICIENT_STORAGE
This status code means the method could not be performed on the resource
because the server is unable to store the representation needed to
successfully complete the request.
|
static Status |
Status.SERVER_ERROR_INTERNAL
The server encountered an unexpected condition which prevented it from
fulfilling the request.
|
static Status |
Status.SERVER_ERROR_NOT_IMPLEMENTED
The server does not support the functionality required to fulfill the
request.
|
static Status |
Status.SERVER_ERROR_SERVICE_UNAVAILABLE
The server is currently unable to handle the request due to a temporary
overloading or maintenance of the server.
|
static Status |
Status.SERVER_ERROR_VERSION_NOT_SUPPORTED
The server does not support, or refuses to support, the HTTP protocol
version that was used in the request message.
|
static Status |
Status.SUCCESS_ACCEPTED
The request has been accepted for processing, but the processing has not
been completed.
|
static Status |
Status.SUCCESS_CREATED
The request has been fulfilled and resulted in a new resource being
created.
|
static Status |
Status.SUCCESS_MISC_PERSISTENT_WARNING
Warning status code, optionally including arbitrary information to be
presented to a human user, typically returned by a cache.
|
static Status |
Status.SUCCESS_MULTI_STATUS
This response is used to inform the client that the HTTP response entity
contains a set of status codes generated during the method invocation.
|
static Status |
Status.SUCCESS_NO_CONTENT
The server has fulfilled the request but does not need to return an
entity-body (for example after a DELETE), and might want to return
updated meta-information.
|
static Status |
Status.SUCCESS_NON_AUTHORITATIVE
The request has succeeded but the returned meta-information in the
entity-header does not come from the origin server, but is gathered from
a local or a third-party copy.
|
static Status |
Status.SUCCESS_OK
The request has succeeded.
|
static Status |
Status.SUCCESS_PARTIAL_CONTENT
The server has fulfilled the partial GET request for the resource
assuming the request has included a Range header field indicating the
desired range.
|
static Status |
Status.SUCCESS_RESET_CONTENT
The server has fulfilled the request and the user agent SHOULD reset the
document view which caused the request to be sent.
|
static Status |
Status.SUCCESS_TRANSFORMATION_APPLIED
Warning status code, typically returned by a cache or a proxy, indicating
that the response has been transformed.
|
| Modifier and Type | Method and Description |
|---|---|
Status |
Conditions.getRangeStatus(RepresentationInfo representationInfo)
Returns the range conditional status of an entity.
|
Status |
Conditions.getRangeStatus(Tag tag,
java.util.Date modificationDate)
Returns the range conditional status of an entity.
|
Status |
Warning.getStatus()
Returns the special status.
|
Status |
Conditions.getStatus(Method method,
boolean entityExists,
Tag tag,
java.util.Date modificationDate)
Returns the conditional status of a variant using a given method.
|
Status |
Conditions.getStatus(Method method,
RepresentationInfo representationInfo)
Returns the conditional status of a variant using a given method.
|
static Status |
Status.valueOf(int code)
Returns the status associated to a code.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Warning.setStatus(Status status)
Sets the special status.
|
| Constructor and Description |
|---|
Status(Status status,
java.lang.String description)
Constructor.
|
Status(Status status,
java.lang.String reasonPhrase,
java.lang.String description)
Constructor.
|
Status(Status status,
java.lang.Throwable throwable)
Constructor.
|
Status(Status status,
java.lang.Throwable throwable,
java.lang.String reasonPhrase)
Constructor.
|
Status(Status status,
java.lang.Throwable throwable,
java.lang.String reasonPhrase,
java.lang.String description)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
Status |
ResourceException.getStatus()
Returns the status associated to this exception.
|
Status |
Resource.getStatus()
Returns the status.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
Resource.doError(Status errorStatus)
Invoked when an error response status is received.
|
void |
ClientResource.doError(Status errorStatus)
By default, it throws a new resource exception.
|
void |
ClientResource.doError(Status errorStatus,
Request request,
Response response)
By default, it throws a new resource exception.
|
protected void |
Resource.doError(Status errorStatus,
java.lang.String errorMessage)
Invoked when an error response status is received.
|
| Constructor and Description |
|---|
ResourceException(Status status)
Constructor.
|
ResourceException(Status status,
Request request,
Response response)
Constructor.
|
ResourceException(Status status,
Resource resource)
Deprecated.
use constructor with status, request and response instead.
|
ResourceException(Status status,
java.lang.String description)
Constructor.
|
ResourceException(Status status,
java.lang.String description,
java.lang.Throwable cause)
Constructor.
|
ResourceException(Status status,
java.lang.Throwable cause)
Constructor.
|
ResourceException(Status status,
java.lang.Throwable cause,
Request request,
Response response)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
Status |
WrapperResponse.getStatus()
Returns the status.
|
| Modifier and Type | Method and Description |
|---|---|
void |
WrapperResponse.setStatus(Status status)
Sets the status.
|
void |
WrapperResponse.setStatus(Status status,
java.lang.String message)
Sets the status.
|
void |
WrapperResponse.setStatus(Status status,
java.lang.Throwable throwable) |
void |
WrapperResponse.setStatus(Status status,
java.lang.Throwable throwable,
java.lang.String message) |
Copyright © 2005-2024 Restlet.