com.nitido.nimbox.http
Class SkinDispatcher

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

All Implemented Interfaces:

HttpNimletConstants

Direct Known Subclasses:

EnhancedDispatcher, SkinDispatcherForDynamic, SkinDispatcherForForward, SkinDispatcherForInclude, SkinDispatcherForNimlet, SkinDispatcherForRedirect, SkinDispatcherForStatic, SkinDispatcherForVoid

public abstract class SkinDispatcher
extends java.lang.Object
implements HttpNimletConstants

The SkinDispatcher interface for HTTP.

Field Summary

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

SkinDispatcher()
Default constructor.

Method Summary

abstract void	dispatch(HttpNimletContainer container, HttpNimletOutput prevOut) This method is responsible for dispatching the information as specified by the parameters
abstract void	init(java.util.HashMap settings) This method is used to initialize the SkinDispatcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

SkinDispatcher

public SkinDispatcher()

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 abstract void init(java.util.HashMap settings)
                   throws javax.servlet.ServletException

This method is used to initialize the SkinDispatcher.

Parameters:

settings - 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 abstract void dispatch(HttpNimletContainer container,
                              HttpNimletOutput prevOut)
                       throws javax.servlet.ServletException,
                              java.io.IOException

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

Parameters:

container - The HttpNimletContainer object

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

Throws:

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

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