Package com.sun.identity.console.base

Class ConsoleServletBase

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.iplanet.jato.ApplicationServletBase

com.sun.identity.console.base.ConsoleServletBase

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

Direct Known Subclasses:

AgentConfigurationServlet, AMBaseServlet, AuditServlet, AuthServlet, DelegationServlet, FSServlet, IDMServlet, PMServlet, RMServlet, SCServlet, SMServlet, STSServlet, TaskServlet, UMServlet, WSServlet

public abstract class ConsoleServletBase
extends com.iplanet.jato.ApplicationServletBase

This is the base class for all the module servlets. The basic function of this class is to perform authentication check. If the user is not authenticated, then he is redirected to the login page. If the user is entering for the first time after login, then he is redirected to the AMAdminFrame. This servlet will do nothing if the user has a valid SSO Token. Every module servlet in console must extend from this servlet.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.iplanet.jato.ApplicationServletBase

APPLICATION_ERROR_MESSAGE_I18N, DEVELOPER_EVENT_OVERRIDE_HELP_MESSAGE_I18N, GENERATE_UNIQUE_URLS, HANDLING_SERVLET_ATTRIBUTE_NAME, MESSAGE_AREA_POSTFIX, MESSAGE_AREA_PREFIX, PARAM_DEBUG, PARAM_HANDLER_BEAN, REQUEST_CONTEXT_ATTRIBUTE_NAME, RESERVED_PARAMETER_NAME_PREFIX, SHOW_MESSAGE_BUFFER_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
ConsoleServletBase()

Method Summary

Modifier and Type	Method	Description
protected void	onBeforeRequest(com.iplanet.jato.RequestContext requestContext)	Forwards request to login view bean if user has not logged in.
protected void	onPageSessionDeserializationException(com.iplanet.jato.RequestContext requestContext, com.iplanet.jato.view.ViewBean viewBean, Exception e)
protected void	onRequestHandlerNotFound(com.iplanet.jato.RequestContext requestContext, String handlerName)	Forwards to invalid URL view bean, in case of an invalid target request handler (page).
protected void	onRequestHandlerNotSpecified(com.iplanet.jato.RequestContext requestContext)	Forwards to invalid URL view bean, in case of no handler specified
protected void	onSessionTimeout(com.iplanet.jato.RequestContext requestContext)	Ignores HTTP session time out.
protected void	onUncaughtException(com.iplanet.jato.RequestContext requestContext, Exception e)	Forwards to uncaught exception view bean, to respond to uncaught application error messages.

Methods inherited from class com.iplanet.jato.ApplicationServletBase

addResponseHeaders, createRequestContext, dispatchRequest, doGet, doPost, fireAfterRequestEvent, fireBeforeRequestEvent, fireInitializeHandlerEvent, fireNewSessionEvent, firePageSessionDeserializationException, fireRequestHandlerNotFoundEvent, fireRequestHandlerNotSpecifiedEvent, fireSessionEvents, fireSessionTimeoutEvent, fireUncaughtException, getAllowShortViewBeanNames, getDefaultHandlerName, getEchoLogToSystemOut, getEnabledLogLevels, getEnforceStrictSessionTimeout, getGenerateUniqueURLs, getLocalizedMessage, getLogMessagePrefix, getModuleURL, getModuleURL, getModuleURLParameterName, getPackageName, getPageName, getQualifiedViewNameSeparator, getServletName, getShowMissingModuleURLWarning, getUseOldBooleanFieldMapping, getUseTaglibTEI, getViewBeanInstance, init, initializeRequestContext, isNewSession, isSessionTimedOut, isShowMessageBuffer, notifyRequestCompletionListeners, onAfterRequest, onAfterRequest, onBeforeHeader, onBeforeRequest, onBeforeSessionUpdate, onInitializeHandler, onInitializeHandler, onInitializeHandler, onNewSession, onNewSession, onSessionTimeout, outputServletErrorMessage, parsePathInfo, prepareEventOverrideMessage, prepareServletErrorMessage, processRequest, setAllowShortViewBeanNames, setDefaultHandlerName, setEchoLogToSystemOut, setEnabledLogLevels, setEnforceStrictSessionTimeout, setGenerateUniqueURLs, setLogMessagePrefix, setModuleURL, setProperty, setQualifiedViewNameSeparator, setShowMessageBuffer, setShowMissingModuleURLWarning, setUseOldBooleanFieldMapping, setUseTaglibTEI

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleServletBase

public ConsoleServletBase()

Method Detail

onBeforeRequest

protected void onBeforeRequest(com.iplanet.jato.RequestContext requestContext)
                        throws jakarta.servlet.ServletException

Forwards request to login view bean if user has not logged in.

Overrides:

onBeforeRequest in class com.iplanet.jato.ApplicationServletBase

Parameters:

requestContext - request context.

Throws:

jakarta.servlet.ServletException - if redirection fails.

onSessionTimeout

protected void onSessionTimeout(com.iplanet.jato.RequestContext requestContext)
                         throws jakarta.servlet.ServletException

Ignores HTTP session time out. Console uses SSO Token Session.

Overrides:

onSessionTimeout in class com.iplanet.jato.ApplicationServletBase

Parameters:

requestContext - - The JATO request context.

Throws:

jakarta.servlet.ServletException

onRequestHandlerNotFound

protected void onRequestHandlerNotFound(com.iplanet.jato.RequestContext requestContext,
                                        String handlerName)
                                 throws jakarta.servlet.ServletException

Forwards to invalid URL view bean, in case of an invalid target request handler (page).

Overrides:

onRequestHandlerNotFound in class com.iplanet.jato.ApplicationServletBase

Parameters:

requestContext - - request context

handlerName - - name of handler

Throws:

jakarta.servlet.ServletException - if forwarding to the invalid URL view bean fails.

onRequestHandlerNotSpecified

protected void onRequestHandlerNotSpecified(com.iplanet.jato.RequestContext requestContext)
                                     throws jakarta.servlet.ServletException

Forwards to invalid URL view bean, in case of no handler specified

Overrides:

onRequestHandlerNotSpecified in class com.iplanet.jato.ApplicationServletBase

Parameters:

requestContext - - request context

Throws:

jakarta.servlet.ServletException - if forwarding to the invalid URL view bean fails.

onPageSessionDeserializationException

protected void onPageSessionDeserializationException(com.iplanet.jato.RequestContext requestContext,
                                                     com.iplanet.jato.view.ViewBean viewBean,
                                                     Exception e)
                                              throws jakarta.servlet.ServletException,
                                                     IOException

Overrides:

onPageSessionDeserializationException in class com.iplanet.jato.ApplicationServletBase

Throws:

jakarta.servlet.ServletException

IOException

onUncaughtException

protected void onUncaughtException(com.iplanet.jato.RequestContext requestContext,
                                   Exception e)
                            throws jakarta.servlet.ServletException,
                                   IOException

Forwards to uncaught exception view bean, to respond to uncaught application error messages.

Overrides:

onUncaughtException in class com.iplanet.jato.ApplicationServletBase

Parameters:

requestContext - - request context

e - Exception that was not handled by the application.

Throws:

jakarta.servlet.ServletException - if the error response cannot be processed.

IOException - if the redirect response cannot be sent.