com.pingidentity.pa.sdk.http

Class HttpStatus

java.lang.Object

com.pingidentity.pa.sdk.http.HttpStatus

public final class HttpStatus
extends Object

An immutable HTTP response status code and its corresponding message (reason phrase).

See: RFC-2616, Status Code and Reason Phrase

Field Summary

Fields

Modifier and Type	Field and Description
static HttpStatus	ACCEPTED
static HttpStatus	ALLOWED
static HttpStatus	BAD_GATEWAY
static HttpStatus	BAD_REQUEST
static HttpStatus	CONFLICT
static HttpStatus	CONTINUE
static HttpStatus	CREATED
static HttpStatus	EXPECTATION_FAILED
static HttpStatus	FORBIDDEN
static HttpStatus	FOUND
static HttpStatus	GATEWAY_TIMEOUT
static HttpStatus	GONE
static HttpStatus	HTTP_VERSION_NOT_SUPPORTED
static HttpStatus	INTERNAL_SERVER_ERROR
static HttpStatus	LENGTH_REQUIRED
static HttpStatus	METHOD_NOT_ALLOWED
static HttpStatus	MOVED_PERMANENTLY
static HttpStatus	MULTIPLE_CHOICES
static HttpStatus	NETWORK_AUTHENTICATION_REQUIRED
static HttpStatus	NO_CONTENT
static HttpStatus	NON_AUTHORITATIVE_INFORMATION
static HttpStatus	NOT_ACCEPTABLE
static HttpStatus	NOT_FOUND
static HttpStatus	NOT_IMPLEMENTED
static HttpStatus	NOT_MODIFIED
static HttpStatus	OK
static HttpStatus	PARTIAL_CONTENT
static HttpStatus	PAYMENT_REQUIRED
static HttpStatus	PERMANENT_REDIRECT
static HttpStatus	PRECONDITION_FAILED
static HttpStatus	PRECONDITION_REQUIRED
static HttpStatus	PROXY_AUTHENTICATION_REQUIRED
static HttpStatus	REQUEST_BODY_REQUIRED
static HttpStatus	REQUEST_ENTITY_TOO_LARGE
static HttpStatus	REQUEST_HEADER_FIELDS_TOO_LARGE
static HttpStatus	REQUEST_TIMEOUT
static HttpStatus	REQUEST_URI_TOO_LONG
static HttpStatus	REQUESTED_RANGE_NOT_SATISFIABLE
static HttpStatus	RESET_CONTENT
static HttpStatus	SEE_OTHER
static HttpStatus	SERVICE_UNAVAILABLE
static HttpStatus	SWITCHING_PROTOCOLS
static HttpStatus	TEMPORARY_REDIRECT
static HttpStatus	TOO_MANY_REQUESTS
static HttpStatus	UNAUTHORIZED
static HttpStatus	UNPROCESSABLE_ENTITY
static HttpStatus	UNSUPPORTED_MEDIA_TYPE
static HttpStatus	USE_PROXY

Constructor Summary

Constructors

Constructor and Description
HttpStatus(int code, String message) Constructs a new HttpStatus without any localization support.
HttpStatus(int code, String message, LocalizedMessage localizedMessage) Constructs a new HttpStatus.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determines if this status equals another [object].
static HttpStatus	forCode(int statusCode) Retrieves the HttpStatus constant for a supplied status code.
int	getCode() Retrieves the Status-Code, which is a 3-digit integer result code of the attempt to understand and satisfy the request.
LocalizedMessage	getLocalizedMessage() Retrieves the localized status message, which may be more suitable for presenting to an end-user in a response.
String	getMessage() Retrieves the standard Reason-Phrase, which is intended to give a short textual description of the Status-Code to a human user.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTINUE

public static final HttpStatus CONTINUE

SWITCHING_PROTOCOLS

public static final HttpStatus SWITCHING_PROTOCOLS

OK

public static final HttpStatus OK

CREATED

public static final HttpStatus CREATED

ACCEPTED

public static final HttpStatus ACCEPTED

NON_AUTHORITATIVE_INFORMATION

public static final HttpStatus NON_AUTHORITATIVE_INFORMATION

NO_CONTENT

public static final HttpStatus NO_CONTENT

RESET_CONTENT

public static final HttpStatus RESET_CONTENT

PARTIAL_CONTENT

public static final HttpStatus PARTIAL_CONTENT

MULTIPLE_CHOICES

public static final HttpStatus MULTIPLE_CHOICES

MOVED_PERMANENTLY

public static final HttpStatus MOVED_PERMANENTLY

FOUND

public static final HttpStatus FOUND

SEE_OTHER

public static final HttpStatus SEE_OTHER

NOT_MODIFIED

public static final HttpStatus NOT_MODIFIED

USE_PROXY

public static final HttpStatus USE_PROXY

TEMPORARY_REDIRECT

public static final HttpStatus TEMPORARY_REDIRECT

PERMANENT_REDIRECT

public static final HttpStatus PERMANENT_REDIRECT

BAD_REQUEST

public static final HttpStatus BAD_REQUEST

UNAUTHORIZED

public static final HttpStatus UNAUTHORIZED

PAYMENT_REQUIRED

public static final HttpStatus PAYMENT_REQUIRED

FORBIDDEN

public static final HttpStatus FORBIDDEN

NOT_FOUND

public static final HttpStatus NOT_FOUND

METHOD_NOT_ALLOWED

public static final HttpStatus METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

public static final HttpStatus NOT_ACCEPTABLE

PROXY_AUTHENTICATION_REQUIRED

public static final HttpStatus PROXY_AUTHENTICATION_REQUIRED

REQUEST_TIMEOUT

public static final HttpStatus REQUEST_TIMEOUT

CONFLICT

public static final HttpStatus CONFLICT

GONE

public static final HttpStatus GONE

LENGTH_REQUIRED

public static final HttpStatus LENGTH_REQUIRED

PRECONDITION_FAILED

public static final HttpStatus PRECONDITION_FAILED

REQUEST_ENTITY_TOO_LARGE

public static final HttpStatus REQUEST_ENTITY_TOO_LARGE

REQUEST_URI_TOO_LONG

public static final HttpStatus REQUEST_URI_TOO_LONG

UNSUPPORTED_MEDIA_TYPE

public static final HttpStatus UNSUPPORTED_MEDIA_TYPE

REQUESTED_RANGE_NOT_SATISFIABLE

public static final HttpStatus REQUESTED_RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

public static final HttpStatus EXPECTATION_FAILED

UNPROCESSABLE_ENTITY

public static final HttpStatus UNPROCESSABLE_ENTITY

PRECONDITION_REQUIRED

public static final HttpStatus PRECONDITION_REQUIRED

TOO_MANY_REQUESTS

public static final HttpStatus TOO_MANY_REQUESTS

REQUEST_HEADER_FIELDS_TOO_LARGE

public static final HttpStatus REQUEST_HEADER_FIELDS_TOO_LARGE

INTERNAL_SERVER_ERROR

public static final HttpStatus INTERNAL_SERVER_ERROR

NOT_IMPLEMENTED

public static final HttpStatus NOT_IMPLEMENTED

BAD_GATEWAY

public static final HttpStatus BAD_GATEWAY

SERVICE_UNAVAILABLE

public static final HttpStatus SERVICE_UNAVAILABLE

GATEWAY_TIMEOUT

public static final HttpStatus GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

public static final HttpStatus HTTP_VERSION_NOT_SUPPORTED

NETWORK_AUTHENTICATION_REQUIRED

public static final HttpStatus NETWORK_AUTHENTICATION_REQUIRED

ALLOWED

public static final HttpStatus ALLOWED

REQUEST_BODY_REQUIRED

public static final HttpStatus REQUEST_BODY_REQUIRED

Constructor Detail

HttpStatus

public HttpStatus(int code,
                  String message,
                  LocalizedMessage localizedMessage)

Constructs a new HttpStatus.

Parameters:

code - the response status code

message - the standard, non-localized status message (Reason-Phrase)

localizedMessage - the localized status message

HttpStatus

public HttpStatus(int code,
                  String message)

Constructs a new HttpStatus without any localization support.

Parameters:

code - the response status code

message - the standard, non-localized status message (Reason-Phrase)

Method Detail

getCode

public int getCode()

Retrieves the Status-Code, which is a 3-digit integer result code of the attempt to understand and satisfy the request.

Returns:

the response status code

getMessage

public String getMessage()

Retrieves the standard Reason-Phrase, which is intended to give a short textual description of the Status-Code to a human user.

The getLocalizedMessage() method can be used to retrieve a value that may be customized for a specific Locale.

Returns:

the standard, non-localized status message (Reason-Phrase)

getLocalizedMessage

public LocalizedMessage getLocalizedMessage()

Retrieves the localized status message, which may be more suitable for presenting to an end-user in a response.

Returns:

the localized status message

equals

public boolean equals(Object o)

Determines if this status equals another [object]. Two instances of HttpStatus are considered equal if they have the same status code, regardless of messages.

Overrides:

equals in class Object

Parameters:

o - the object with which to compare

Returns:

true if the specified object is an instance of HttpStatus and has the same status code (as returned by getCode())

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of this status, in the form "[Status-Code] [Reason-Phrase]" (e.g. "404 Not Found")

forCode

public static HttpStatus forCode(int statusCode)

Retrieves the HttpStatus constant for a supplied status code.

For example, given the status code 404, this method will return NOT_FOUND.

Parameters:

statusCode - the status code for which to find a matching constant

Returns:

the matching status, or null if there is not a pre-defined status for the supplied code