com.webmethods.portal.framework.dispatch

Interface IDispatchHandler

All Superinterfaces:

IComponent, IHandler, IInitializable, ISystemHandler

public interface IDispatchHandler
extends IHandler

The IComponent for the IDispatchManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_KEY There has to be one IDispatchHandler that is the 'alias' handler
static String	AUTHENTICATE_KEY There has to be one IDispatchHandler that is the 'authenticateuser' handler
static String	COMMAND_KEY There has to be one IDispatchHandler that is the 'command' handler
static int	DISP_RESPONSE_FORWARD Forward the request to another IDispatchHandler
static int	DISP_RESPONSE_FORWARD_DEFAULT_GET Forward the request to another IDispatchHandler
static int	DISP_RESPONSE_FORWARD_RAW Forward the request to another IDispatchHandler
static int	DISP_RESPONSE_NONE Dispatch handling is complete, don't do anything further.
static int	DISP_RESPONSE_PRES Delegate to the IPresentationManager
static int	DISP_RESPONSE_REDIRECT Redirect this request with an http Redirect using the PresentationData
static int	DISP_RESPONSE_STREAM Stream the PresentationData back to the user
static String	ERROR_KEY There has to be one IDispatchHandler that is the 'error' handler
static String	HANDLE_SYSADMIN Sysadmin user IDispatchHandler handler
static String	LOGIN_KEY There has to be one IDispatchHandler that is the 'displaylogin' handler
static String	LOGOUT_KEY There has to be one IDispatchHandler that is the 'logout' handler

Method Summary

Modifier and Type	Method and Description
int	handle(HttpServletRequest request, HttpServletResponse response) Handles the request.

Methods inherited from interface com.webmethods.portal.framework.IHandler

getConfigElem, getHandlerBean, getName, getPerfToken, initialize, postInitialize, shutdown

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init

Field Detail

LOGIN_KEY

static final String LOGIN_KEY

There has to be one IDispatchHandler that is the 'displaylogin' handler

See Also:

Constant Field Values

AUTHENTICATE_KEY

static final String AUTHENTICATE_KEY

There has to be one IDispatchHandler that is the 'authenticateuser' handler

See Also:

Constant Field Values

LOGOUT_KEY

static final String LOGOUT_KEY

There has to be one IDispatchHandler that is the 'logout' handler

See Also:

Constant Field Values

ERROR_KEY

static final String ERROR_KEY

There has to be one IDispatchHandler that is the 'error' handler

See Also:

Constant Field Values

ALIAS_KEY

static final String ALIAS_KEY

There has to be one IDispatchHandler that is the 'alias' handler

See Also:

Constant Field Values

COMMAND_KEY

static final String COMMAND_KEY

There has to be one IDispatchHandler that is the 'command' handler

See Also:

Constant Field Values

HANDLE_SYSADMIN

static final String HANDLE_SYSADMIN

Sysadmin user IDispatchHandler handler

See Also:

Constant Field Values

DISP_RESPONSE_NONE

static final int DISP_RESPONSE_NONE

Dispatch handling is complete, don't do anything further.

See Also:

Constant Field Values

DISP_RESPONSE_REDIRECT

static final int DISP_RESPONSE_REDIRECT

Redirect this request with an http Redirect using the PresentationData

See Also:

Constant Field Values

DISP_RESPONSE_FORWARD

static final int DISP_RESPONSE_FORWARD

Forward the request to another IDispatchHandler

See Also:

Constant Field Values

DISP_RESPONSE_FORWARD_RAW

static final int DISP_RESPONSE_FORWARD_RAW

Forward the request to another IDispatchHandler

See Also:

Constant Field Values

DISP_RESPONSE_FORWARD_DEFAULT_GET

static final int DISP_RESPONSE_FORWARD_DEFAULT_GET

Forward the request to another IDispatchHandler

See Also:

Constant Field Values

DISP_RESPONSE_STREAM

static final int DISP_RESPONSE_STREAM

Stream the PresentationData back to the user

See Also:

Constant Field Values

DISP_RESPONSE_PRES

static final int DISP_RESPONSE_PRES

Delegate to the IPresentationManager

See Also:

Constant Field Values

Method Detail

handle

int handle(HttpServletRequest request,
           HttpServletResponse response)
    throws FrameworkException

Handles the request. The response value tells the DispatchManager how to further handle the request. Prior to the DispatchManager delegating to the IDispatchHandler, a PresentationData is associated with the HttpServletRequest. The following response are valid:

• DISP_RESPONSE_NONE: The work is complete, don't do anything further
• DISP_RESPONSE_REDIRECT: Redirect this request with an http Redirect using the PresentationData
• DISP_RESPONSE_FORWARD: Forward the request to another IDispatchHandler
• DISP_RESPONSE_FORWARD_RAW: Forward the request to another IDispatchHandler without checking the type
• DISP_RESPONSE_FORWARD_DEFAULT_GET: Forward the request to the default get IDispatchHandler for the requested resource
• DISP_RESPONSE_STREAM: Stream the PresentationData back to the user
• DISP_RESPONSE_PRES: Delegate to the IPresentationManager

Parameters:

request - the current HttpServletRequest

response - the current HttpServletResponse

Throws:

FrameworkException