org.opentox.toxotis.client
Enum HttpStatusCodes

java.lang.Object
  extended by java.lang.Enum<HttpStatusCodes>
      extended by org.opentox.toxotis.client.HttpStatusCodes
All Implemented Interfaces:
Serializable, Comparable<HttpStatusCodes>

public enum HttpStatusCodes
extends Enum<HttpStatusCodes>

Standard HTTP status codes.

Author:
chung

Enum Constant Summary
Accepted
          The request has been accepted for processing, but the processing has not been completed.
BadGateway
          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.
BadRequest
          The request could not be understood by the server due to malformed syntax.
Created
          The request has been fulfilled and resulted in a new resource being created.
Forbidden
          The server understood the request, but is refusing to fulfill it.
Found
          The requested resource resides temporarily under a different URI.
InternalServerError
          The server encountered an unexpected condition which prevented it from fulfilling the request.
MethodNotAllowed
          The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
MovedPermanently
          The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.
NoContent
          The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta-information.
NotAcceptable
           
NotFound
          The server has not found anything matching the Request-URI.
NotImplemented
           
NotModified
          If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code.
SeeOther
          The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.
ServiceUnavailable
          The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
Success
          The request has succeeded.
TemporaryRedirect
          The requested resource resides temporarily under a different URI.
Unauthorized
          The request requires user authentication.
 
Method Summary
 String getDocumentation()
          Get some short documentation about the status code.
 int getStatus()
          Return the status code as an integer.
static HttpStatusCodes valueOf(String name)
          Returns the enum constant of this type with the specified name.
static HttpStatusCodes[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Success

public static final HttpStatusCodes Success
The request has succeeded.

The information returned with the response is dependent on the method used in the request, for example: GET an entity corresponding to the requested resource is sent in the response; HEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body; POST an entity describing or containing the result of the action; TRACE an entity containing the request message as received by the end server.


Created

public static final HttpStatusCodes Created
The request has been fulfilled and resulted in a new resource being created.

The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead.


Accepted

public static final HttpStatusCodes Accepted
The request has been accepted for processing, but the processing has not been completed.

The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this.

The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled.


NoContent

public static final HttpStatusCodes NoContent
The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta-information.

The response MAY include new or updated meta-information in the form of entity-headers, which if present SHOULD be associated with the requested variant.

If the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated meta-information SHOULD be applied to the document currently in the user agent's active view.

The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields.


MovedPermanently

public static final HttpStatusCodes MovedPermanently
The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.

Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise.

The new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

 Note: When automatically redirecting a POST request after
 receiving a 301 status code, some existing HTTP/1.0 user agents
 will erroneously change it into a GET request.


Found

public static final HttpStatusCodes Found
The requested resource resides temporarily under a different URI.

Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

If the 302 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.

Note: RFC 1945 and RFC 2068 specify that the client is not allowed to change the method on the redirected request. However, most existing user agent implementations treat 302 as if it were a 303 response, performing a GET on the Location field-value regardless of the original request method. The status codes 303 and 307 have been added for servers that wish to make unambiguously clear which kind of reaction is expected of the client.


SeeOther

public static final HttpStatusCodes SeeOther
The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.

This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable.

The different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).

Note: Many pre-HTTP/1.1 user agents do not understand the 303 status. When interoperability with such clients is a concern, the 302 status code may be used instead, since most user agents react to a 302 response as described here for 303.


NotModified

public static final HttpStatusCodes NotModified
If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.


TemporaryRedirect

public static final HttpStatusCodes TemporaryRedirect
The requested resource resides temporarily under a different URI.

Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.

The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain the information necessary for a user to repeat the original request on the new URI.

If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.


BadRequest

public static final HttpStatusCodes BadRequest
The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.


Unauthorized

public static final HttpStatusCodes Unauthorized
The request requires user authentication.

The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information.


Forbidden

public static final HttpStatusCodes Forbidden
The server understood the request, but is refusing to fulfill it.

Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead.


NotFound

public static final HttpStatusCodes NotFound
The server has not found anything matching the Request-URI.

No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.


MethodNotAllowed

public static final HttpStatusCodes MethodNotAllowed
The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

The response MUST include an Allow header containing a list of valid methods for the requested resource.


NotAcceptable

public static final HttpStatusCodes NotAcceptable

InternalServerError

public static final HttpStatusCodes InternalServerError
The server encountered an unexpected condition which prevented it from fulfilling the request.


NotImplemented

public static final HttpStatusCodes NotImplemented

BadGateway

public static final HttpStatusCodes BadGateway
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.


ServiceUnavailable

public static final HttpStatusCodes ServiceUnavailable
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.

Note: The existence of the 503 status code does not imply that a server must use it when becoming overloaded. Some servers may wish to simply refuse the connection.

Method Detail

values

public static HttpStatusCodes[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (HttpStatusCodes c : HttpStatusCodes.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpStatusCodes valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getDocumentation

public String getDocumentation()
Get some short documentation about the status code. The documentation is copied from the RFC-2616 specification.

Returns:
Documentation as String.

getStatus

public int getStatus()
Return the status code as an integer.

Returns:
Status code.


Copyright © 2011-2012 OpenTox. All Rights Reserved.