com.sun.identity.authentication.UI

Class LogoutViewBean

java.lang.Object

com.iplanet.jato.view.ViewBase

com.iplanet.jato.view.ContainerViewBase

com.iplanet.jato.view.RequestHandlingViewBase

com.iplanet.jato.view.ViewBeanBase

org.forgerock.openam.console.base.ConsoleViewBeanBase

com.sun.identity.authentication.UI.AuthViewBeanBase

com.sun.identity.authentication.UI.LogoutViewBean

All Implemented Interfaces:

com.iplanet.jato.RequestCompletionListener, com.iplanet.jato.RequestHandler, com.iplanet.jato.RequestParticipant, com.iplanet.jato.view.ContainerView, com.iplanet.jato.view.View, com.iplanet.jato.view.ViewBean, com.iplanet.jato.view.WebActionHandler, com.iplanet.jato.view.WebActions

public class LogoutViewBean
extends AuthViewBeanBase

This class is a default implementation of LogoutViewBean auth Logout UI.

Field Summary

Fields

Modifier and Type	Field and Description
String	gotoUrl Goto url
static String	HTML_TITLE_LOGOUT Default parameter name for logout html title
String	jsp_page JSP page
static String	PAGE_NAME Default page name
ResourceBundle	rb Resource bundle for Locale
String	ResultVal Logout result value
static String	TXT_GOTO_LOGIN_AFTER_LOGOUT Default parameter name for goto login text after logout
static String	TXT_LOGOUT Default parameter name for logout text
static String	URL_LOGIN Default parameter name for login url

Fields inherited from class com.sun.identity.authentication.UI.AuthViewBeanBase

fallbackLocale, PAGE_ENCODING, rbCache, SERVICE_URI, serviceUri, storeCookies

Fields inherited from class com.iplanet.jato.view.ViewBeanBase

DEFAULT_COMMAND_CHILD_NVP_NAME, DISPLAY_EVENT_COMPLETED_REQUEST_ATTRIBUTE_NAME, OPTION_USE_PAGE_SESSION_FOR_DEFAULT_COMMAND_CHILD

Fields inherited from class com.iplanet.jato.view.RequestHandlingViewBase

HANDLE_REQUEST_METHOD_PREFIX, HANDLE_REQUEST_METHOD_SUFFIX

Fields inherited from class com.iplanet.jato.view.ContainerViewBase

BEGIN_DISPLAY_EVENT_METHOD_PREFIX, BEGIN_DISPLAY_EVENT_METHOD_SUFFIX, END_DISPLAY_EVENT_METHOD_PREFIX, END_DISPLAY_EVENT_METHOD_SUFFIX, eventMethodRegistry, OPTION_ENABLE_QUALIFIELD_CHILD_NAME_LOOKUPS, OPTION_USE_LEGACY_DISPLAY_EVENT_SIGNATURES

Fields inherited from interface com.iplanet.jato.view.ViewBean

PAGE_SESSION_ATTRIBUTE_NVP_NAME, VIEW_BEAN_NAME_SUFFIX

Fields inherited from interface com.iplanet.jato.view.View

QUALIFIED_VIEW_NAME_SEPARATOR

Fields inherited from interface com.iplanet.jato.view.WebActionHandler

DELETE_CONTEXT, EXECUTE_CONTEXT, INSERT_CONTEXT, MODEL_TYPE_DELETE, MODEL_TYPE_EXECUTE, MODEL_TYPE_INSERT, MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, RETRIEVE_CONTEXT, UPDATE_CONTEXT

Fields inherited from interface com.iplanet.jato.view.WebActions

ACTION_CLEAR, ACTION_DELETE, ACTION_EXECUTE, ACTION_FIRST, ACTION_INSERT, ACTION_LAST, ACTION_NEXT, ACTION_PREV, ACTION_PREVIOUS, ACTION_REFRESH, ACTION_SELECT, ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
LogoutViewBean() Creates LoginViewBean object.

Method Summary

Modifier and Type	Method and Description
boolean	beginContentHrefLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event) Returns if it begins content href logout display
boolean	beginContentStaticTextLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event) Returns true to display static text content.
void	beginDisplay(com.iplanet.jato.view.event.DisplayEvent event) Called as notification that the JSP has begun its display processing.
boolean	beginHrefLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event) Returns if it begins href logout display
boolean	beginStaticTextLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event) Returns if it begins static text logout display
protected com.iplanet.jato.view.View	createChild(String name)
void	forwardTo(com.iplanet.jato.RequestContext requestContext) Forwards the request to this view bean, displaying the page.
String	getDisplayURL() Returns display url for auth auth Logout UI
String	getTileIndex() Returns tile Index.
void	handleHrefLogoutRequest(com.iplanet.jato.view.event.RequestInvocationEvent event) Handles href logout request
protected void	registerChildren() registers child views

Methods inherited from class com.sun.identity.authentication.UI.AuthViewBeanBase

getEncodedInputValue, getEncodedQueryParams, getRequestLocale, getValidatedInputURL, setPageEncoding

Methods inherited from class org.forgerock.openam.console.base.ConsoleViewBeanBase

deserializePageAttributes

Methods inherited from class com.iplanet.jato.view.ViewBeanBase

clearPageSessionAttributes, forward, forwardTo, getDefaultCommandDescriptor, getDefaultDisplayURL, getLogicalName, getModuleURL, getPageSessionAttribute, getPageSessionAttributes, getPageSessionAttributeString, getPageSessionAttributeString, getRequestInvocationName, getRequestInvocationName, handleDeserializePageAttributesException, include, include, include, invokeRequestHandler, invokeRequestHandlerInternal, mapRequestParameters, removePageSessionAttribute, securityCheck, setDefaultCommandDescriptor, setDefaultDisplayURL, setPageSessionAttribute, setPageSessionAttributes, setRequestContext

Methods inherited from class com.iplanet.jato.view.RequestHandlingViewBase

acceptRequest, afterAllModelsExecute, afterAllWebActionModelsExecute, afterHandleRequestCommandExecution, afterModelExecutes, afterWebActionModelExecutes, appMessage, beforeHandleRequestCommandExecution, beforeModelExecutes, beforeWebActionModelExecutes, createDefaultExecutionContext, executeAutoDeletingModel, executeAutoDeletingModels, executeAutoExecutingModel, executeAutoExecutingModels, executeAutoInsertingModel, executeAutoInsertingModels, executeAutoRetrievingModel, executeAutoRetrievingModels, executeAutoRetrievingModels, executeAutoUpdatingModel, executeAutoUpdatingModels, getAutoDeletingModels, getAutoExecutingModels, getAutoInsertingModels, getAutoRetrieveExecutionContext, getAutoRetrievingModels, getAutoUpdatingModels, getFirstActionExecutionContext, getLastActionExecutionContext, getModel, getNextActionExecutionContext, getPreviousActionExecutionContext, getRefreshActionExecutionContext, getRequestCompletionListenerChildNames, getRequestContext, getRequestParticipantChildNames, getSession, getViewBean, getWebActionModelOffset, getWebActionModels, getWebActionRowOffsetSessionKey, handleRequest, handleWebAction, isAutoRetrieveEnabled, onHandleRequestCommandExecutionError, onModelError, onNoModelDataAvailable, onWebActionExecutionError, requestComplete, setAutoDeletingModels, setAutoExecutingModels, setAutoInsertingModels, setAutoRetrieveEnabled, setAutoRetrieveExecutionContext, setAutoRetrievingModels, setAutoUpdatingModels, setWebActionModelOffset

Methods inherited from class com.iplanet.jato.view.ContainerViewBase

beginChildDisplay, beginChildDisplay, beginComponentDisplay, beginDisplay, childExists, createChildReserved, endChildDisplay, endChildDisplay, endComponentDisplay, endDisplay, endDisplay, ensureChild, getChild, getChildNames, getChildNames, getChildType, getCommandChildNames, getDefaultModel, getDisplayField, getDisplayFieldBooleanValue, getDisplayFieldDoubleValue, getDisplayFieldIntValue, getDisplayFieldStringValue, getDisplayFieldValue, getNumChildren, getQualifiedCommandChildNames, mapRequestParameter, onValidationException, registerChild, registerDisplayEventHandlers, removeAllChildren, removeChild, removeQualifiedNameIndices, resetChildren, setDefaultModel, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, setDisplayFieldValue, unregisterChild

Methods inherited from class com.iplanet.jato.view.ViewBase

getName, getParent, getParentViewBean, getQualifiedName, getQualifiedViewNameSeparator, getRootView, getRootView, getSimpleQualifiedName, isVisible, setName, setParent, setQualifiedViewNameSeparator, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.iplanet.jato.view.ViewBean

getModel, getSession, getViewBean

Methods inherited from interface com.iplanet.jato.view.ContainerView

beginChildDisplay, endChildDisplay, endDisplay, getChild, getChildNames, getChildType, getDefaultModel, getDisplayField, getDisplayFieldValue, getNumChildren, resetChildren, setDisplayFieldValue

Methods inherited from interface com.iplanet.jato.view.View

getName, getParent, getQualifiedName, setName, setParent

Methods inherited from interface com.iplanet.jato.RequestHandler

acceptRequest, getRequestContext, handleRequest

Methods inherited from interface com.iplanet.jato.view.WebActionHandler

getWebActionModels, handleWebAction, isAutoRetrieveEnabled, setAutoRetrieveEnabled

Field Detail

PAGE_NAME

public static final String PAGE_NAME

Default page name

See Also:

Constant Field Values

ResultVal

public String ResultVal

Logout result value

gotoUrl

public String gotoUrl

Goto url

jsp_page

public String jsp_page

JSP page

rb

public ResourceBundle rb

Resource bundle for Locale

URL_LOGIN

public static final String URL_LOGIN

Default parameter name for login url

See Also:

Constant Field Values

TXT_LOGOUT

public static final String TXT_LOGOUT

Default parameter name for logout text

See Also:

Constant Field Values

TXT_GOTO_LOGIN_AFTER_LOGOUT

public static final String TXT_GOTO_LOGIN_AFTER_LOGOUT

Default parameter name for goto login text after logout

See Also:

Constant Field Values

HTML_TITLE_LOGOUT

public static final String HTML_TITLE_LOGOUT

Default parameter name for logout html title

See Also:

Constant Field Values

Constructor Detail

LogoutViewBean

public LogoutViewBean()

Creates LoginViewBean object.

Method Detail

registerChildren

protected void registerChildren()

registers child views

Overrides:

registerChildren in class AuthViewBeanBase

forwardTo

public void forwardTo(com.iplanet.jato.RequestContext requestContext)

Forwards the request to this view bean, displaying the page. This method is the equivalent of RequestDispatcher.forward(), meaning that the same semantics apply to the use of this method. This method makes implicit use of the display URL returned by the getDisplayURL() method.

Specified by:

forwardTo in interface com.iplanet.jato.view.ViewBean

Overrides:

forwardTo in class com.iplanet.jato.view.ViewBeanBase

Parameters:

requestContext - servlet context for auth request

getDisplayURL

public String getDisplayURL()

Returns display url for auth auth Logout UI

Specified by:

getDisplayURL in interface com.iplanet.jato.view.ViewBean

Overrides:

getDisplayURL in class com.iplanet.jato.view.ViewBeanBase

Returns:

display url for auth auth Logout UI

createChild

protected com.iplanet.jato.view.View createChild(String name)

Overrides:

createChild in class AuthViewBeanBase

beginDisplay

public void beginDisplay(com.iplanet.jato.view.event.DisplayEvent event)
                  throws com.iplanet.jato.model.ModelControlException

Called as notification that the JSP has begun its display processing. In addition to performing the default behavior in the superclass's version, this method executes any auto-retrieving or auto- executing models associated with this view unless auto-retrieval is disabled.

Specified by:

beginDisplay in interface com.iplanet.jato.view.ContainerView

Overrides:

beginDisplay in class com.iplanet.jato.view.RequestHandlingViewBase

Parameters:

event - Display Event.

Throws:

com.iplanet.jato.model.ModelControlException - if manipulation of a model fails during display preparation or execution of auto-retrieving models.

handleHrefLogoutRequest

public void handleHrefLogoutRequest(com.iplanet.jato.view.event.RequestInvocationEvent event)
                             throws javax.servlet.ServletException,
                                    IOException

Handles href logout request

Parameters:

event - request invocation event

Throws:

javax.servlet.ServletException - if it fails to forward logout request

IOException - if it fails to forward logout request

beginHrefLogoutDisplay

public boolean beginHrefLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)

Returns if it begins href logout display

Parameters:

event - child display event

Returns:

true by default.

beginContentHrefLogoutDisplay

public boolean beginContentHrefLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)

Returns if it begins content href logout display

Parameters:

event - child display event

Returns:

true by default.

beginStaticTextLogoutDisplay

public boolean beginStaticTextLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)

Returns if it begins static text logout display

Parameters:

event - child display event

Returns:

true by default.

getTileIndex

public String getTileIndex()

Returns tile Index.

Specified by:

getTileIndex in class AuthViewBeanBase

Returns:

Tile index.

beginContentStaticTextLogoutDisplay

public boolean beginContentStaticTextLogoutDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)

Returns true to display static text content.

Parameters:

event - Child display event.

Returns:

true to display static text content.