com.nitido.nimbox.http
Interface HttpNimletConstants

All Known Implementing Classes:

ADTrackingRedirectNimlet, EnhancedDispatcher, HttpNimletContainer, HttpNimletDriver, HttpNimletSessionListener, Skin, SkinDispatcher, SkinDispatcherForDynamic, SkinDispatcherForForward, SkinDispatcherForInclude, SkinDispatcherForNimlet, SkinDispatcherForRedirect, SkinDispatcherForStatic, SkinDispatcherForVoid

public interface HttpNimletConstants

This interface contains the set of constants used by the HttpNimletContainer, HttpNimletDriver, HttpSessionListener, and SkinDispatcher classes.

Field Summary

static java.lang.String	CONF_KEY_CONTAINER_ENTITY_ID The key used to store/retrieve, from the configuration service, the identifier of the entity for the container.
static java.lang.String	CONF_KEY_CONTAINER_ENTITY_PWD The key used to store/retrieve, from the configuration service, the password of the entity for the container.
static java.lang.String	CONF_KEY_CONTAINER_INIT_ALL_NIMLETS The key to indicate whether the container will instantiate and initializes ALL specified nimlets at the beginning.
static java.lang.String	CONF_KEY_ERROR_SKIN The key for getting the configuration for the error skin of the HttpNimletDriver.
static java.lang.String	CONF_KEY_PREFIX_NIMLET_MAP The key prefix used to store/retrieve the configuration for mapping a nimlet name to the actual class name
static java.lang.String	CONF_KEY_PREFIX_NIMLET_SETTING The key prefix used to store/retrieve a nimlet initialization settings.
static java.lang.String	CONF_KEY_PREFIX_PARSER_MULTIPART Used by the HttpNimletDriver to retrieve configuration to initialize the parser for interpreting multipart requests
static java.lang.String	CONF_KEY_PREFIX_SKIN_SETTING The key prefix used to store/retrive initialization parameters for the different skin dispatchers.
static java.lang.String	CONF_KEY_PREFIX_SKIN_TYPE The key prefix used to store/retrieve the protocol component of the skin URI.
static java.lang.String	CONF_KEY_REG_ENCODING The key for getting the configuration for the request encoding charset for the regular encoding.
static java.lang.String	CONTAINER_TYPE String representation of an HTTP NimletContainer type.
static java.lang.String	DEF_SAVE_DIRECTORY Used by the HttpNimletDriver as the default directory location to store files send through the HttpServletRequest.
static java.lang.String	KEY_ENABLE_AD_SERVICE_FLAG Key used to retrieve the flag to enable/disable the NiM Ad Service.
static java.lang.String	KEY_ERROR_EXCEPTION Key used to retrieve the skin name that causes the error generated by SkinDispatcherForNimlet.
static java.lang.String	KEY_ERROR_MESSAGE Key used to retrieve the error message generated by the SkinDispatcherForNmlet.
static java.lang.String	KEY_ERROR_OLD_SKIN Key used to retrieve the skin name that causes the error generated by SkinDispatcherForNimlet.
static java.lang.String	KEY_NIM_ENTITY Key used to store/retrieve the reference to the authenticated Entity inside the HTTPSession of a client.
static java.lang.String	KEY_RESPONSE_EXCLUDED_SKINS Key for the skins that will be excluded from generating the default HTTP response header.
static java.lang.String	KEY_RESPONSE_OVERRIDE_HEADERS Key for the HTTP response headers that will be always overrided by the skin dispatcher's default HTTP response headers.
static java.lang.String	KEY_SKIN_AD_MAP Key used to retrieve the AD Map from the request.getAttribute()
static int	LEN_KEY_PREFIX_NIMLET_MAP The length of the key prefix for the nimlet map
static int	LEN_KEY_PREFIX_PARSER_MULTIPART The length of the key prefix for the multipart requrest parser.
static int	LEN_KEY_PREFIX_SKIN_TYPE The length of the key prefix for the protocol component of the skin URI.
static int	LEN_PREFIX_KEY_RESPONSE_HEADER Length of the key prefix for the default HTTP response header.
static int	LEN_PROTOCOL_DYNAMIC The length of the Skin URI protocol component for dispatching dynamically generated skins.
static int	LEN_PROTOCOL_FORWARD The length of the Skin URI protocol component for forwarding the request to the given URL
static int	LEN_PROTOCOL_INCLUDE The length of the Skin URI protocol component for including to the request the given URL
static int	LEN_PROTOCOL_NIMLET The length of the Skin URI protocol component for dispatching Nimlets.
static int	LEN_PROTOCOL_REDIRECT The length of the Skin URI protocol component for redirecting the request to the given URL
static int	LEN_PROTOCOL_STATIC The length of the Skin URI protocol component for dispatching static skins.
static int	LEN_PROTOCOL_VOID The length of the VOID Skin URI protocol component
static java.lang.String	MSG_NO_NIMLET Error message to be displayed to the client when the nimlet name is not available on the HTTP request.
static java.lang.String	MULTIPART_PARSER Used internally by the HttpNimletDriver to set/get from its cache, the reference to the parser used to interpret multipart HttpServletRequest
static java.lang.String	PARAM_KEY_NIMLET The key used to store/retrieve the nimlet name, from the HTTP request, that should be called to execute the request.
static java.lang.String	PREFIX_KEY_RESPONSE_HEADER Key prefix for the default HTTP response header.
static java.lang.String	PROTOCOL_DYNAMIC The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a dynamically generated skin.
static java.lang.String	PROTOCOL_FORWARD The protocol component of the Skin URI that indicates that the request should be forwarded to the given URL.
static java.lang.String	PROTOCOL_INCLUDE The protocol component of the Skin URI that indicates that the following URL should be included to the request
static java.lang.String	PROTOCOL_NIMLET The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a Nimlet.
static java.lang.String	PROTOCOL_REDIRECT The protocol component of the Skin URI that indicates that the request should be redirected to the given URL.
static java.lang.String	PROTOCOL_SEPARATOR The protocol separator of the Skin URI
static java.lang.String	PROTOCOL_STATIC The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a static skin.
static java.lang.String	PROTOCOL_VOID The protocol component of the Skin URI that indicates the Driver to not dispatch.
static java.lang.String	REGULAR_PARSER Used internally by the HttpNimletDriver to set/get from its cache, the reference to the parser used to interpret regular HttpServletRequests
static java.lang.String	REQ_HEADER_CONTENT_TYPE HTTP request header indicating the request Content Type.
static int	SKIN_START_DYNAMIC The location within the Skin URI that indicates the index where the skin name starts
static int	SKIN_START_FORWARD The location within the Skin URI that indicates the index where the forwarding URL starts
static int	SKIN_START_INCLUDE The location within the Skin URI that indicates the index where the URL to be included starts
static int	SKIN_START_NIMLET The location within the Skin URI that indicates the index where the nimlet name starts
static int	SKIN_START_REDIRECT The location within the Skin URI that indicates the index where the redirection URL starts
static int	SKIN_START_STATIC The location within the Skin URI that indicates the index where the skin name starts
static int	SKIN_START_VOID The location within the Skin URI that indicates the index where the protocol string terminates
static java.lang.String	TYPE_MULTIPART_FORM HTTP request header indicating that the request is a multipart request.

Field Detail

REQ_HEADER_CONTENT_TYPE

static final java.lang.String REQ_HEADER_CONTENT_TYPE

HTTP request header indicating the request Content Type. The acatual value is "Content-Type".

See Also:

Constant Field Values

TYPE_MULTIPART_FORM

static final java.lang.String TYPE_MULTIPART_FORM

HTTP request header indicating that the request is a multipart request. The acatual value is "multipart/form-data".

See Also:

Constant Field Values

CONTAINER_TYPE

static final java.lang.String CONTAINER_TYPE

String representation of an HTTP NimletContainer type. The acatual value is "http".

See Also:

Constant Field Values

KEY_NIM_ENTITY

static final java.lang.String KEY_NIM_ENTITY

Key used to store/retrieve the reference to the authenticated Entity inside the HTTPSession of a client. The actual value is "nim.entity".

See Also:

Constant Field Values

KEY_ERROR_MESSAGE

static final java.lang.String KEY_ERROR_MESSAGE

Key used to retrieve the error message generated by the SkinDispatcherForNmlet. This key/value will be presented only when the Dispatcher encounter errors and need to dispatch the error skin.

See Also:

Constant Field Values

KEY_ERROR_EXCEPTION

static final java.lang.String KEY_ERROR_EXCEPTION

Key used to retrieve the skin name that causes the error generated by SkinDispatcherForNimlet. This key/value will be presented only when the Dispatcher encounter errors and need to dispatch the error skin.

See Also:

Constant Field Values

KEY_ERROR_OLD_SKIN

static final java.lang.String KEY_ERROR_OLD_SKIN

Key used to retrieve the skin name that causes the error generated by SkinDispatcherForNimlet. This key/value will be presented only when the Dispatcher encounter errors and need to dispatch the error skin.

See Also:

Constant Field Values

KEY_SKIN_AD_MAP

static final java.lang.String KEY_SKIN_AD_MAP

Key used to retrieve the AD Map from the request.getAttribute()

See Also:

Constant Field Values

PREFIX_KEY_RESPONSE_HEADER

static final java.lang.String PREFIX_KEY_RESPONSE_HEADER

Key prefix for the default HTTP response header.

See Also:

Constant Field Values

LEN_PREFIX_KEY_RESPONSE_HEADER

static final int LEN_PREFIX_KEY_RESPONSE_HEADER

Length of the key prefix for the default HTTP response header.

KEY_RESPONSE_EXCLUDED_SKINS

static final java.lang.String KEY_RESPONSE_EXCLUDED_SKINS

Key for the skins that will be excluded from generating the default HTTP response header.

See Also:

Constant Field Values

KEY_RESPONSE_OVERRIDE_HEADERS

static final java.lang.String KEY_RESPONSE_OVERRIDE_HEADERS

Key for the HTTP response headers that will be always overrided by the skin dispatcher's default HTTP response headers.

See Also:

Constant Field Values

MSG_NO_NIMLET

static final java.lang.String MSG_NO_NIMLET

Error message to be displayed to the client when the nimlet name is not available on the HTTP request.

See Also:

Constant Field Values

KEY_ENABLE_AD_SERVICE_FLAG

static final java.lang.String KEY_ENABLE_AD_SERVICE_FLAG

Key used to retrieve the flag to enable/disable the NiM Ad Service. If this flag is set to "true" the dynamic Skin dispatcher will contact the NiM AD Service to retrieve the AD Map for the skin being dispatched.

See Also:

Constant Field Values

CONF_KEY_CONTAINER_ENTITY_ID

static final java.lang.String CONF_KEY_CONTAINER_ENTITY_ID

The key used to store/retrieve, from the configuration service, the identifier of the entity for the container.

See Also:

Constant Field Values

CONF_KEY_CONTAINER_ENTITY_PWD

static final java.lang.String CONF_KEY_CONTAINER_ENTITY_PWD

The key used to store/retrieve, from the configuration service, the password of the entity for the container.

See Also:

Constant Field Values

CONF_KEY_CONTAINER_INIT_ALL_NIMLETS

static final java.lang.String CONF_KEY_CONTAINER_INIT_ALL_NIMLETS

The key to indicate whether the container will instantiate and initializes ALL specified nimlets at the beginning. The container will init. all nimlets only if the configuration value is "true".

See Also:

Constant Field Values

CONF_KEY_ERROR_SKIN

static final java.lang.String CONF_KEY_ERROR_SKIN

The key for getting the configuration for the error skin of the HttpNimletDriver. This error skin is used only if there are serious low level errors occur when parsing a request. For example, when the client submit a multi-part HTTP request, exceptions may generated if the submitted data is too big.

See Also:

Constant Field Values

CONF_KEY_REG_ENCODING

static final java.lang.String CONF_KEY_REG_ENCODING

The key for getting the configuration for the request encoding charset for the regular encoding. This is an optional configuration. If no encoding is provided, the system will just use whatever the web server is configured to use.

See Also:

Constant Field Values

CONF_KEY_PREFIX_NIMLET_MAP

static final java.lang.String CONF_KEY_PREFIX_NIMLET_MAP

The key prefix used to store/retrieve the configuration for mapping a nimlet name to the actual class name

See Also:

Constant Field Values

LEN_KEY_PREFIX_NIMLET_MAP

static final int LEN_KEY_PREFIX_NIMLET_MAP

The length of the key prefix for the nimlet map

CONF_KEY_PREFIX_NIMLET_SETTING

static final java.lang.String CONF_KEY_PREFIX_NIMLET_SETTING

The key prefix used to store/retrieve a nimlet initialization settings.

See Also:

Constant Field Values

CONF_KEY_PREFIX_SKIN_TYPE

static final java.lang.String CONF_KEY_PREFIX_SKIN_TYPE

The key prefix used to store/retrieve the protocol component of the skin URI.

See Also:

Constant Field Values

LEN_KEY_PREFIX_SKIN_TYPE

static final int LEN_KEY_PREFIX_SKIN_TYPE

The length of the key prefix for the protocol component of the skin URI.

CONF_KEY_PREFIX_SKIN_SETTING

static final java.lang.String CONF_KEY_PREFIX_SKIN_SETTING

The key prefix used to store/retrive initialization parameters for the different skin dispatchers.

See Also:

Constant Field Values

PARAM_KEY_NIMLET

static final java.lang.String PARAM_KEY_NIMLET

The key used to store/retrieve the nimlet name, from the HTTP request, that should be called to execute the request.

See Also:

Constant Field Values

PROTOCOL_NIMLET

static final java.lang.String PROTOCOL_NIMLET

The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a Nimlet.

See Also:

Constant Field Values

LEN_PROTOCOL_NIMLET

static final int LEN_PROTOCOL_NIMLET

The length of the Skin URI protocol component for dispatching Nimlets.

SKIN_START_NIMLET

static final int SKIN_START_NIMLET

The location within the Skin URI that indicates the index where the nimlet name starts

PROTOCOL_STATIC

static final java.lang.String PROTOCOL_STATIC

The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a static skin.

See Also:

Constant Field Values

LEN_PROTOCOL_STATIC

static final int LEN_PROTOCOL_STATIC

The length of the Skin URI protocol component for dispatching static skins.

SKIN_START_STATIC

static final int SKIN_START_STATIC

The location within the Skin URI that indicates the index where the skin name starts

PROTOCOL_DYNAMIC

static final java.lang.String PROTOCOL_DYNAMIC

The protocol component of the Skin URI that indicates that the following skin name to be dispatched is a dynamically generated skin.

See Also:

Constant Field Values

LEN_PROTOCOL_DYNAMIC

static final int LEN_PROTOCOL_DYNAMIC

The length of the Skin URI protocol component for dispatching dynamically generated skins.

SKIN_START_DYNAMIC

static final int SKIN_START_DYNAMIC

The location within the Skin URI that indicates the index where the skin name starts

PROTOCOL_REDIRECT

static final java.lang.String PROTOCOL_REDIRECT

The protocol component of the Skin URI that indicates that the request should be redirected to the given URL.

See Also:

Constant Field Values

LEN_PROTOCOL_REDIRECT

static final int LEN_PROTOCOL_REDIRECT

The length of the Skin URI protocol component for redirecting the request to the given URL

SKIN_START_REDIRECT

static final int SKIN_START_REDIRECT

The location within the Skin URI that indicates the index where the redirection URL starts

PROTOCOL_FORWARD

static final java.lang.String PROTOCOL_FORWARD

The protocol component of the Skin URI that indicates that the request should be forwarded to the given URL.

See Also:

Constant Field Values

LEN_PROTOCOL_FORWARD

static final int LEN_PROTOCOL_FORWARD

The length of the Skin URI protocol component for forwarding the request to the given URL

SKIN_START_FORWARD

static final int SKIN_START_FORWARD

The location within the Skin URI that indicates the index where the forwarding URL starts

PROTOCOL_INCLUDE

static final java.lang.String PROTOCOL_INCLUDE

The protocol component of the Skin URI that indicates that the following URL should be included to the request

See Also:

Constant Field Values

LEN_PROTOCOL_INCLUDE

static final int LEN_PROTOCOL_INCLUDE

The length of the Skin URI protocol component for including to the request the given URL

SKIN_START_INCLUDE

static final int SKIN_START_INCLUDE

The location within the Skin URI that indicates the index where the URL to be included starts

PROTOCOL_VOID

static final java.lang.String PROTOCOL_VOID

The protocol component of the Skin URI that indicates the Driver to not dispatch.

See Also:

Constant Field Values

LEN_PROTOCOL_VOID

static final int LEN_PROTOCOL_VOID

The length of the VOID Skin URI protocol component

SKIN_START_VOID

static final int SKIN_START_VOID

The location within the Skin URI that indicates the index where the protocol string terminates

PROTOCOL_SEPARATOR

static final java.lang.String PROTOCOL_SEPARATOR

The protocol separator of the Skin URI

See Also:

Constant Field Values

REGULAR_PARSER

static final java.lang.String REGULAR_PARSER

Used internally by the HttpNimletDriver to set/get from its cache, the reference to the parser used to interpret regular HttpServletRequests

See Also:

Constant Field Values

MULTIPART_PARSER

static final java.lang.String MULTIPART_PARSER

Used internally by the HttpNimletDriver to set/get from its cache, the reference to the parser used to interpret multipart HttpServletRequest

See Also:

Constant Field Values

DEF_SAVE_DIRECTORY

static final java.lang.String DEF_SAVE_DIRECTORY

Used by the HttpNimletDriver as the default directory location to store files send through the HttpServletRequest.

See Also:

Constant Field Values

CONF_KEY_PREFIX_PARSER_MULTIPART

static final java.lang.String CONF_KEY_PREFIX_PARSER_MULTIPART

Used by the HttpNimletDriver to retrieve configuration to initialize the parser for interpreting multipart requests

See Also:

Constant Field Values

LEN_KEY_PREFIX_PARSER_MULTIPART

static final int LEN_KEY_PREFIX_PARSER_MULTIPART

The length of the key prefix for the multipart requrest parser.