com.opendxl.streaming.client

Enum HttpStatusCodes

java.lang.Object

java.lang.Enum<HttpStatusCodes>

com.opendxl.streaming.client.HttpStatusCodes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HttpStatusCodes>

public enum HttpStatusCodes
extends java.lang.Enum<HttpStatusCodes>

HttpStatusCodes defines the HTTP codes which the Databus Consumer Service can return.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST
CONFLICT
FORBIDDEN
INTERNAL_SERVER_ERROR
NO_CONTENT
NOT_FOUND
OK
UNAUTHORIZED

Method Summary

Modifier and Type	Method and Description
int	getCode() Get the integer value corresponding to the HTTP Status Code
static HttpStatusCodes	getHttpStatus(int statusCode) Get the HttpStatus object for a HTTP Status Code
static boolean	isSuccess(int statusCode) Checks whether a status code is successful one
static HttpStatusCodes	valueOf(java.lang.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final HttpStatusCodes OK

NO_CONTENT

public static final HttpStatusCodes NO_CONTENT

BAD_REQUEST

public static final HttpStatusCodes BAD_REQUEST

UNAUTHORIZED

public static final HttpStatusCodes UNAUTHORIZED

FORBIDDEN

public static final HttpStatusCodes FORBIDDEN

NOT_FOUND

public static final HttpStatusCodes NOT_FOUND

CONFLICT

public static final HttpStatusCodes CONFLICT

INTERNAL_SERVER_ERROR

public static final HttpStatusCodes INTERNAL_SERVER_ERROR

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isSuccess

public static boolean isSuccess(int statusCode)

Checks whether a status code is successful one

Parameters:

statusCode - an HTTP Response Status Code

Returns:

true if status code belongs to 2xx Success range false otherwise

getHttpStatus

public static HttpStatusCodes getHttpStatus(int statusCode)

Get the HttpStatus object for a HTTP Status Code

Parameters:

statusCode - an HTTP Response Status Code

Returns:

HttpStatusCodes object corresponding to the statusCode value

getCode

public int getCode()

Get the integer value corresponding to the HTTP Status Code

Returns:

HTTP code value