com.nitido.nimbox.http
Class SkinDispatcherForDynamic

java.lang.Object
  com.nitido.nimbox.http.SkinDispatcher
      com.nitido.nimbox.http.SkinDispatcherForDynamic

All Implemented Interfaces:

HttpNimletConstants

public class SkinDispatcherForDynamic
extends SkinDispatcher

The SkinDispatcher for Dynamic protocol (in other words, the regular JSP skins).

This dispatcher will accept skin names in the format of "<SkinCore>?<HttpGetParameters>". It will dispatch a JSP in the format of "dynamic/<SkinCore>?<HttpGetParameters>".

This dispatcher support the following additional configurations:

• "enableADService"
• "response.header.<ResponseHeaderName>" - a set of configuration that specifies the default HTTP response headers that will be generated when the dispatcher dispatch the JSP. These response headers will be set to the specified value only if the corresponding header has not be set. (i.e. it will not overwrite any existing header that is already set in the current response.)
• "response.excluded.skins" - a comma separated list of <SkinCore> strings that will be excluded from the default response header generation.
• "response.override.headers" - a comma separated list of <ResponseHeaderName> that will be always overrided by the default header value specified by the configurations "response.header.<ResponseHeaderName>".

Field Summary

protected NiMAdService

_adService

Fields inherited from interface com.nitido.nimbox.http.HttpNimletConstants

CONF_KEY_CONTAINER_ENTITY_ID, CONF_KEY_CONTAINER_ENTITY_PWD, CONF_KEY_CONTAINER_INIT_ALL_NIMLETS, CONF_KEY_ERROR_SKIN, CONF_KEY_PREFIX_NIMLET_MAP, CONF_KEY_PREFIX_NIMLET_SETTING, CONF_KEY_PREFIX_PARSER_MULTIPART, CONF_KEY_PREFIX_SKIN_SETTING, CONF_KEY_PREFIX_SKIN_TYPE, CONF_KEY_REG_ENCODING, CONTAINER_TYPE, DEF_SAVE_DIRECTORY, KEY_ENABLE_AD_SERVICE_FLAG, KEY_ERROR_EXCEPTION, KEY_ERROR_MESSAGE, KEY_ERROR_OLD_SKIN, KEY_NIM_ENTITY, KEY_RESPONSE_EXCLUDED_SKINS, KEY_RESPONSE_OVERRIDE_HEADERS, KEY_SKIN_AD_MAP, LEN_KEY_PREFIX_NIMLET_MAP, LEN_KEY_PREFIX_PARSER_MULTIPART, LEN_KEY_PREFIX_SKIN_TYPE, LEN_PREFIX_KEY_RESPONSE_HEADER, LEN_PROTOCOL_DYNAMIC, LEN_PROTOCOL_FORWARD, LEN_PROTOCOL_INCLUDE, LEN_PROTOCOL_NIMLET, LEN_PROTOCOL_REDIRECT, LEN_PROTOCOL_STATIC, LEN_PROTOCOL_VOID, MSG_NO_NIMLET, MULTIPART_PARSER, PARAM_KEY_NIMLET, PREFIX_KEY_RESPONSE_HEADER, PROTOCOL_DYNAMIC, PROTOCOL_FORWARD, PROTOCOL_INCLUDE, PROTOCOL_NIMLET, PROTOCOL_REDIRECT, PROTOCOL_SEPARATOR, PROTOCOL_STATIC, PROTOCOL_VOID, REGULAR_PARSER, REQ_HEADER_CONTENT_TYPE, SKIN_START_DYNAMIC, SKIN_START_FORWARD, SKIN_START_INCLUDE, SKIN_START_NIMLET, SKIN_START_REDIRECT, SKIN_START_STATIC, SKIN_START_VOID, TYPE_MULTIPART_FORM

Constructor Summary

SkinDispatcherForDynamic()
Default constructor.

Method Summary

void	dispatch(HttpNimletContainer container, HttpNimletOutput prevOut) This method is responsible for dispatching the information as specified by the parameters
void	init(java.util.HashMap map) Initializes the SkinDispatcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_adService

protected NiMAdService _adService

Constructor Detail

SkinDispatcherForDynamic

public SkinDispatcherForDynamic()

Default constructor. Note: although this class is only used within this package, we should still leave the constructor public so that we can use reflection to instantiate this in the future.

Method Detail

init

public void init(java.util.HashMap map)
          throws javax.servlet.ServletException

Initializes the SkinDispatcher. This skin dispatcher requires the following configuration parameters:

• com.nitido.nimbox.http.skinsetting.dynamic.enableADService=[true|false]

If KEY_ENABLE_AD_SERVICE_FLAG is set to true, the skin dispatcher will initialize the SimpleAdService, otherwise the AD service is not initialized.

Specified by:

init in class SkinDispatcher

Parameters:

map - HashMap with the dispatcher initialization parameters.

Throws:

javax.servlet.ServletException - if the SkinDispatcher cannot be initialized correctly. We throw ServletException because this is the standard Java Servlet exception to be thrown for initialization failure.

dispatch

public void dispatch(HttpNimletContainer container,
                     HttpNimletOutput prevOut)
              throws javax.servlet.ServletException,
                     java.io.IOException

Description copied from class: SkinDispatcher

This method is responsible for dispatching the information as specified by the parameters

Specified by:

dispatch in class SkinDispatcher

Parameters:

container - The HttpNimletContainer object

prevOut - The HttpNimletOutput object to be passed to the skin being dispatched.

Throws:

javax.servlet.ServletException - if the target resource throws this exception.

java.io.IOException - if an input or output error is detected when dispatching.