com.webmethods.portal.framework

Interface IDispatchManager

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface IDispatchManager
extends IComponentProvider

The IDispatchManager dispatches requests through the variety of dispatch handlers that it manages

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_VALUE_ATTR_KEY an attribute that holds an com.webmethods.portal.service.cache.impl.AliasValue for the alias dispatch handler
static String	DEFAULT_METHOD 'get' is the default HttpServlet
static String	POST_METHOD 'get' is the default HttpServlet

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method and Description
void	forward(HttpServletRequest request, HttpServletResponse response, int responseCode) Forward to another dipsatch handler
String	getNormalizedRequestURI(HttpServletRequest request) get normalized request uri.
String	getNormalizedRequestURI(HttpServletRequest request, boolean urlDecode) get normalized request uri.
String	getRequestedMethod(HttpServletRequest request, boolean lookupCommand) Check for a 'method=' parameter.
void	handleDispatch(HttpServletRequest request, HttpServletResponse response) The main entry point for managing dispatched requests
void	handleError(HttpServletRequest request, HttpServletResponse response, IExceptionBean exceptionBean) An error has occurred, this is a directive to generically handle generating an appropriate response
void	handleMethod(HttpServletRequest request, HttpServletResponse response, String methodName) This is a directive to invoke a specific dispatch handler based upon its method name
void	pres(HttpServletRequest request, HttpServletResponse response) Forward the request to the IPresentationManager
void	redirect(HttpServletRequest request, HttpServletResponse response) Redirect the client to a new URL
void	stream(HttpServletRequest request, HttpServletResponse response) Stream data back to the client

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

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

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, shutdown

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

acquireURI, acquireURI

Field Detail

ALIAS_VALUE_ATTR_KEY

static final String ALIAS_VALUE_ATTR_KEY

an attribute that holds an com.webmethods.portal.service.cache.impl.AliasValue for the alias dispatch handler

See Also:

Constant Field Values

DEFAULT_METHOD

static final String DEFAULT_METHOD

'get' is the default HttpServlet

See Also:

Constant Field Values

POST_METHOD

static final String POST_METHOD

'get' is the default HttpServlet

See Also:

Constant Field Values

Method Detail

getRequestedMethod

String getRequestedMethod(HttpServletRequest request,
                          boolean lookupCommand)
                   throws PortalException

Check for a 'method=' parameter. If not found, check for a 'command=' parameter. If found, depending on the lookupCommand param, return either the name of the command or 'command'. Otherwise return the default http method (GET or POST, etc...)

Parameters:

request -

lookupCommand - If this is true and a command is found the name of the command will be returned. If this is false and a command is found, the 'command' will be returned. If no command is found and no method is found, the the default http method will be found.

Returns:

the requested method

Throws:

PortalException

getNormalizedRequestURI

String getNormalizedRequestURI(HttpServletRequest request)

get normalized request uri. For example, the real uri would be '/server/nis/topic.root' the normalized uri would be '/topic.root'

Parameters:

request -

getNormalizedRequestURI

String getNormalizedRequestURI(HttpServletRequest request,
                               boolean urlDecode)

get normalized request uri. For example, the real uri would be '/server/nis/topic.root' the normalized uri would be '/topic.root'

Parameters:

request -

urlDecode - whether or not to decode

See Also:

Encoder.decode(java.lang.String)

handleDispatch

void handleDispatch(HttpServletRequest request,
                    HttpServletResponse response)
             throws PortalException

The main entry point for managing dispatched requests

Parameters:

request -

response -

Throws:

PortalException

handleMethod

void handleMethod(HttpServletRequest request,
                  HttpServletResponse response,
                  String methodName)
           throws PortalException

This is a directive to invoke a specific dispatch handler based upon its method name

Parameters:

request -

response -

methodName -

Throws:

PortalException

See Also:

handleDispatch(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

handleError

void handleError(HttpServletRequest request,
                 HttpServletResponse response,
                 IExceptionBean exceptionBean)
          throws PortalException

An error has occurred, this is a directive to generically handle generating an appropriate response

Parameters:

request -

response -

exceptionBean - is the current exception bean.

Throws:

PortalException

See Also:

ExceptionBean

forward

void forward(HttpServletRequest request,
             HttpServletResponse response,
             int responseCode)
      throws PortalException

Forward to another dipsatch handler

Parameters:

request -

response -

responseCode -

Throws:

PortalException

redirect

void redirect(HttpServletRequest request,
              HttpServletResponse response)
       throws PortalException

Redirect the client to a new URL

Parameters:

request -

response -

Throws:

PortalException

stream

void stream(HttpServletRequest request,
            HttpServletResponse response)
     throws PortalException

Stream data back to the client

Parameters:

request -

response -

Throws:

PortalException

pres

void pres(HttpServletRequest request,
          HttpServletResponse response)
   throws PortalException

Forward the request to the IPresentationManager

Parameters:

request -

response -

Throws:

PortalException