Package org.sunbird.common.dto

Enum HeaderParam

java.lang.Object

java.lang.Enum<HeaderParam>

org.sunbird.common.dto.HeaderParam

All Implemented Interfaces:

Serializable, Comparable<HeaderParam>

public enum HeaderParam
extends Enum<HeaderParam>

The keys of the Execution Context Values.

Author:

Mahesh

Enum Constant Summary

Enum Constants

Enum Constant	Description
APP_ID
CHANNEL_ID
CONSUMER_ID
CURRENT_INVOCATION_PATH
DEVICE_ID
PROXY_USER_ID
PROXY_USER_NAME
REQUEST_ID
REQUEST_PATH
REQUEST_ST_ED_PATH
SCOPE_ID
SYSTEM_LOCALE
USER_DATA
USER_ID
USER_LOCALE
USER_NAME

Method Summary

Modifier and Type	Method	Description
String	getParamName()
static HeaderParam	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HeaderParam[]	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

REQUEST_ID

public static final HeaderParam REQUEST_ID

REQUEST_PATH

public static final HeaderParam REQUEST_PATH

REQUEST_ST_ED_PATH

public static final HeaderParam REQUEST_ST_ED_PATH

CURRENT_INVOCATION_PATH

public static final HeaderParam CURRENT_INVOCATION_PATH

USER_DATA

public static final HeaderParam USER_DATA

USER_LOCALE

public static final HeaderParam USER_LOCALE

SYSTEM_LOCALE

public static final HeaderParam SYSTEM_LOCALE

USER_ID

public static final HeaderParam USER_ID

PROXY_USER_ID

public static final HeaderParam PROXY_USER_ID

USER_NAME

public static final HeaderParam USER_NAME

PROXY_USER_NAME

public static final HeaderParam PROXY_USER_NAME

SCOPE_ID

public static final HeaderParam SCOPE_ID

CONSUMER_ID

public static final HeaderParam CONSUMER_ID

CHANNEL_ID

public static final HeaderParam CHANNEL_ID

APP_ID

public static final HeaderParam APP_ID

DEVICE_ID

public static final HeaderParam DEVICE_ID

Method Detail

values

public static HeaderParam[] 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 (HeaderParam c : HeaderParam.values())
    System.out.println(c);

Returns:

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

valueOf

public static HeaderParam 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

getParamName

public String getParamName()