Package fr.gouv.vitam.ihmdemo.common.api

Enum Class IhmWebAppHeader

java.lang.Object

java.lang.Enum<IhmWebAppHeader>

fr.gouv.vitam.ihmdemo.common.api.IhmWebAppHeader

All Implemented Interfaces:

Serializable, Comparable<IhmWebAppHeader>, Constable

public enum IhmWebAppHeader
extends Enum<IhmWebAppHeader>

Enum use to represent possible HTTP header for Vitam application. Also define a regular expression to check if values from HTTP headers are right

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE	The COOKIE header, used to get an object
LIMIT	The X_LIMIT header, used to get an object
OFFSET	The X_OFFSET header, used to get an object
REQUEST_ID	The X_REQUEST_ID header, used to get an object
TOTAL	The X_TOTAL header, used to get an object

Method Summary

Modifier and Type	Method	Description
static IhmWebAppHeader	get(String headerName)	Get VitamHttpHeader from name
String	getName()	Get the header name
String	getRegExp()	Get the regular expression to validate header values
static IhmWebAppHeader	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IhmWebAppHeader[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIMIT

public static final IhmWebAppHeader LIMIT

The X_LIMIT header, used to get an object

OFFSET

public static final IhmWebAppHeader OFFSET

The X_OFFSET header, used to get an object

TOTAL

public static final IhmWebAppHeader TOTAL

The X_TOTAL header, used to get an object

REQUEST_ID

public static final IhmWebAppHeader REQUEST_ID

The X_REQUEST_ID header, used to get an object

COOKIE

public static final IhmWebAppHeader COOKIE

The COOKIE header, used to get an object

Method Details

values

public static IhmWebAppHeader[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static IhmWebAppHeader valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Get the header name

Returns:

the header name

getRegExp

public String getRegExp()

Get the regular expression to validate header values

Returns:

the regular expression

get

public static IhmWebAppHeader get(String headerName)

Get VitamHttpHeader from name

Parameters:

headerName - the wanted header name

Returns:

the header if exists, null otherwise