VitamHttpHeader (Vitam API Reference (1.0.0))

java.lang.Object
- java.lang.Enum<VitamHttpHeader>
- - fr.gouv.vitam.common.server.application.VitamHttpHeader

All Implemented Interfaces:

Serializable, Comparable<VitamHttpHeader>
```
public enum VitamHttpHeader
extends Enum<VitamHttpHeader>
```
Enum use to represent possible HTTP header for Vitam application. Also define a regular expression to check if values from HTTP headers are right

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATION_ID` The X_APPLICATION_ID header, used in requests to specify external Application Session Id
`CONTEXT_ID` The CONTEXT_ID header, used in POST and PUT requests to ask for a particular workflow execution context stepBuStep or not
`METHOD_OVERRIDE` The X-Http-Method-Override header, used in requests to handle unsupported Http methods with body
`OFFERS_IDS` The X_OFFER_IDS header, used in HEAD requests to give list of offer id
`QUALIFIER` The X-Qualifier header, used to get an object
`STRATEGY_ID` The X_STRATEGY_ID header, used in HEAD requests to ask for a particular strategy
`TENANT_ID` The X_TENANT_ID header, used in requests to specify the used tenant
`VERSION` The X-Version header, used to get an object
`X_CONTENT_LENGTH` The X-Content-Length used to have object size (for storage)
`X_DIGEST` The X_DIGEST used to have digest value (for storage)
`X_DIGEST_ALGORITHM` The X_DIGEST_ALGORITHM used to have digest algrithm (for storage)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VitamHttpHeader`	`get(String headerName)` Get VitamHttpHeader from name
`String`	`getName()` Get the header name
`String`	`getRegExp()` Get the regular expression to validate header values
`static VitamHttpHeader`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static VitamHttpHeader[]`	`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
  - STRATEGY_ID
```
public static final VitamHttpHeader STRATEGY_ID
```
    The X_STRATEGY_ID header, used in HEAD requests to ask for a particular strategy
  - OFFERS_IDS
```
public static final VitamHttpHeader OFFERS_IDS
```
    The X_OFFER_IDS header, used in HEAD requests to give list of offer id
  - TENANT_ID
```
public static final VitamHttpHeader TENANT_ID
```
    The X_TENANT_ID header, used in requests to specify the used tenant
  - APPLICATION_ID
```
public static final VitamHttpHeader APPLICATION_ID
```
    The X_APPLICATION_ID header, used in requests to specify external Application Session Id
  - METHOD_OVERRIDE
```
public static final VitamHttpHeader METHOD_OVERRIDE
```
    The X-Http-Method-Override header, used in requests to handle unsupported Http methods with body
  - QUALIFIER
```
public static final VitamHttpHeader QUALIFIER
```
    The X-Qualifier header, used to get an object
  - VERSION
```
public static final VitamHttpHeader VERSION
```
    The X-Version header, used to get an object
  - X_CONTENT_LENGTH
```
public static final VitamHttpHeader X_CONTENT_LENGTH
```
    The X-Content-Length used to have object size (for storage)
  - X_DIGEST
```
public static final VitamHttpHeader X_DIGEST
```
    The X_DIGEST used to have digest value (for storage)
  - X_DIGEST_ALGORITHM
```
public static final VitamHttpHeader X_DIGEST_ALGORITHM
```
    The X_DIGEST_ALGORITHM used to have digest algrithm (for storage)
  - CONTEXT_ID
```
public static final VitamHttpHeader CONTEXT_ID
```
    The CONTEXT_ID header, used in POST and PUT requests to ask for a particular workflow execution context stepBuStep or not
- Method Detail
  - values
```
public static VitamHttpHeader[] 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 (VitamHttpHeader c : VitamHttpHeader.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static VitamHttpHeader 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
  - 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 VitamHttpHeader get(String headerName)
```
    Get VitamHttpHeader from name
    
    Parameters:
    
    headerName - the wanted header name
    
    Returns:
    
    the header if exists, null otherwise

Enum VitamHttpHeader

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STRATEGY_ID

OFFERS_IDS

TENANT_ID

APPLICATION_ID

METHOD_OVERRIDE

QUALIFIER

VERSION

X_CONTENT_LENGTH

X_DIGEST

X_DIGEST_ALGORITHM

CONTEXT_ID

Method Detail

values

valueOf

getName

getRegExp

get