Package com.sun.identity.console.base

Class AMPrimaryMastHeadViewBean

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.console.base.AMViewBeanBase

com.sun.identity.console.base.AMPrimaryMastHeadViewBean

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, com.sun.web.ui.view.tabs.CCNodeEventHandlerInterface

Direct Known Subclasses:

AbstractEventHandlerAddViewBean, AbstractEventHandlerEditViewBean, AbstractEventHandlerSelectViewBean, AgentAddViewBean, AgentConfigInheritViewBean, AgentDumpViewBean, AgentExportPolicyViewBean, AgentGroupAddViewBean, AgentProfileViewBean, AgentsViewBean, AuthConfigViewBean, CompleteCreateHostedIDPViewBean, ConfigureGoogleAppsViewBean, ConfigureGoogleAppsWarningViewBean, ConfigureOAuth2ViewBean, ConfigureSalesForceAppsFinishWarningViewBean, ConfigureSalesForceAppsViewBean, ConfigureSalesForceAppsWarningViewBean, ConfigureSocialAuthNViewBean, CreateCOTViewBean, CreateFedletViewBean, CreateFedletWarningViewBean, CreateHostedIDPViewBean, CreateHostedSPViewBean, CreateRemoteIDPViewBean, CreateRemoteSPViewBean, CreateSAML2MetaDataViewBean, CreateSoapSTSDeploymentViewBean, DynamicRequestViewBean, EntityOpViewBeanBase, EntityPropertiesBase, EntityResourceOfferingViewBean, FederationViewBean, FSAuthDomainsOpViewBeanBase, FSSAMLSelectTrustedPartnerTypeViewBean, FSSAMLServiceViewBean, FSSAMLSiteIDViewBeanBase, FSSAMLTargetURLsViewBeanBase, FSSAMLTrustedPartnersViewBeanBase, G11NCharsetAliasViewBeanBase, G11NSupportedCharsetsViewBeanBase, HomeViewBean, IDRepoOpViewBeanBase, IDRepoSelectTypeViewBean, ImportEntityViewBean, NewAuthConfigViewBean, NewAuthInstanceViewBean, PolicySelectTypeViewBean, ProfileViewBeanBase, RedirectToRealmHomeViewBean, ReorderAuthChainsViewBean, RestSTSEditViewBean, RMRealmOpViewBeanBase, RMRealmViewBeanBase, SCConfigViewBean, SCPolicyResourceComparatorViewBeanBase, SCPropertiesBase, SCSAML2SOAPBindingRequestHandlerListViewBeanBase, SCSOAPBindingRequestHandlerListViewBeanBase, SelectTypeViewBeanBase, ServerAddViewBean, ServerCloneViewBean, ServerConfigInheritViewBean, ServerConfigXMLAddServerViewBean, ServerConfigXMLViewBean, ServerEditAdvancedViewBean, ServerEditViewBeanBase, ServerSiteViewBean, ServicesCannotAssignServiceViewBean, ServicesNoAttributeViewBean, ServicesSelectViewBean, ServicesSelectViewBean, ServiceViewBeanBase, SessionPropertyOpViewBeanBase, SiteAddViewBean, SiteEditViewBean, SMDiscoveryBootstrapRefOffViewBeanBase, SMDiscoveryDescriptionViewBeanBase, SMDiscoveryProviderResourceIdMapperViewBeanBase, SMViewBeanBase, SoapSTSEditViewBean, STSExportPolicyViewBean, SubSchemaTypeSelectViewBean, ValidateSAML2SetupViewBean, WebServiceUserCredAddViewBean, WebServiceUserCredEditViewBean, WSAuthNServicesHandlersViewBeanBase, WSPPServiceDSAttributeMapListViewBeanBase, WSPPServiceSupportedContainerViewBeanBase

public abstract class AMPrimaryMastHeadViewBean
extends AMViewBeanBase
implements com.sun.web.ui.view.tabs.CCNodeEventHandlerInterface

This is the base class for all view beans that have primary masthead in Console.

Field Summary

Fields

Modifier and Type	Field	Description
static String	HDR_COMMON
static String	MH_COMMON
static String	PG_SESSION_PAGE_TRAIL_ID
protected static String	PG_SESSION_TAB_ID
protected static Set	retainPageSessionsBtwTabs
static String	TAB_COMMON
protected com.sun.web.ui.model.CCTabsModel	tabModel

Fields inherited from class com.sun.identity.console.base.AMViewBeanBase

BTN_GHOST, debug, initialized, PG_SESSION_ATTR, PG_SESSION_ATTR_ID, PG_SESSION_SSO_ID, SZ_CACHE

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.View

QUALIFIED_VIEW_NAME_SEPARATOR

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.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	Description
AMPrimaryMastHeadViewBean(String name)	Creates an instance of base view bean object.

Method Summary

Modifier and Type	Method	Description
protected void	addPageTrail(String displayName, String viewBeanClassName)
protected PageTrail.Marker	backTrail()
void	beginDisplay(com.iplanet.jato.view.event.DisplayEvent event)
protected void	beginDisplay(com.iplanet.jato.view.event.DisplayEvent event, boolean setSelectedTabNode)
protected com.iplanet.jato.view.View	createChild(String name)	Creates user interface components used by this view bean.
protected void	createTabModel()	code to handle tab related functionality
void	forwardTo(com.iplanet.jato.RequestContext rc)
protected String	getBreadCrumbDisplayName()
protected int	getDefaultTabId(String realmName, jakarta.servlet.http.HttpServletRequest req)
protected AMViewBeanBase	getTabNodeAssociatedViewBean(String tabSetName, int nodeID)	Returns view bean for a tab.
protected String	getTrackingTabIDName()
void	handleBreadCrumbHrefRequest(com.iplanet.jato.view.event.RequestInvocationEvent event)
protected boolean	handleRealmNameInTabSwitch(com.iplanet.jato.RequestContext rc)
protected void	initPageTrail()
protected boolean	isRootRealm(String realm, String startDN)
void	lockPageTrail()
void	nodeClicked(com.iplanet.jato.view.event.RequestInvocationEvent event, int nodeID)	Handles tab selected event.
void	passPgSessionMapEx(com.iplanet.jato.view.ViewBean other)	Pass session attribute map to other view bean.
protected void	registerChildren()	Registers user interface components used by this view bean.
protected void	setPageTrail(String displayName, String viewBeanClassName)
void	setRequestContext(com.iplanet.jato.RequestContext rc)
protected void	setSelectedTabNode(String realmName)
protected boolean	startPageTrail()
void	unlockPageTrail()
void	unlockPageTrailForSwapping()

Methods inherited from class com.sun.identity.console.base.AMViewBeanBase

addBlankTextField, appendPgSession, beginChildDisplay, bypassForwardTo, charToHex, createOptionList, createOptionList, createOptionList, createOptionList, createOptionList, deserializePageAttributes, disableButton, getBackButtonLabel, getBlankTextFields, getCallingView, getCharset, getCharset, getContentType, getCurrentLocation, getCurrentLocationDN, getCurrentRealm, getCurrentRealmEncoded, getList, getModel, getModelInternal, getPageSessionAttributes, getPageSessionAttributeString, getPath, getRequestURL, getServiceNameForAccessControl, getUserLocale, getValues, handleGRequest, hexToString, hideTableSelectionIcons, initialize, isInlineAlertMessageSet, mapRequestParameter, passPgSessionMap, passPgSessionMap, performDelegationTasks, redirectToStartURL, resetButtonState, resetView, setCurrentLocation, setInlineAlertMessage, setInlineAlertMessage, setPageSessionAttributes, setRequestContentInitialize, stringToHex

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

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

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, beginComponentDisplay, beginDisplay, childExists, createChildReserved, endChildDisplay, endChildDisplay, endComponentDisplay, endDisplay, endDisplay, ensureChild, getChild, getChildNames, getChildNames, getChildType, getCommandChildNames, getDefaultModel, getDisplayField, getDisplayFieldBooleanValue, getDisplayFieldDoubleValue, getDisplayFieldIntValue, getDisplayFieldStringValue, getDisplayFieldValue, getNumChildren, getQualifiedCommandChildNames, 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.ContainerView

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

Methods inherited from interface com.iplanet.jato.RequestHandler

acceptRequest, getRequestContext, handleRequest

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

getName, getParent, getQualifiedName, setName, setParent

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

getModel, getSession, getViewBean

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

getWebActionModels, handleWebAction, isAutoRetrieveEnabled, setAutoRetrieveEnabled

Field Detail

PG_SESSION_PAGE_TRAIL_ID

public static final String PG_SESSION_PAGE_TRAIL_ID

See Also:

Constant Field Values

PG_SESSION_TAB_ID

protected static final String PG_SESSION_TAB_ID

See Also:

Constant Field Values

retainPageSessionsBtwTabs

protected static Set retainPageSessionsBtwTabs

MH_COMMON

public static final String MH_COMMON

See Also:

Constant Field Values

HDR_COMMON

public static final String HDR_COMMON

See Also:

Constant Field Values

TAB_COMMON

public static final String TAB_COMMON

See Also:

Constant Field Values

tabModel

protected com.sun.web.ui.model.CCTabsModel tabModel

Constructor Detail

AMPrimaryMastHeadViewBean

public AMPrimaryMastHeadViewBean(String name)

Creates an instance of base view bean object.

Parameters:

name - Name of page.

Method Detail

setRequestContext

public void setRequestContext(com.iplanet.jato.RequestContext rc)

Specified by:

setRequestContext in interface com.iplanet.jato.RequestParticipant

Overrides:

setRequestContext in class AMViewBeanBase

forwardTo

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

Specified by:

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

Overrides:

forwardTo in class AMViewBeanBase

handleRealmNameInTabSwitch

protected boolean handleRealmNameInTabSwitch(com.iplanet.jato.RequestContext rc)

registerChildren

protected void registerChildren()

Registers user interface components used by this view bean.

Overrides:

registerChildren in class AMViewBeanBase

createChild

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

Creates user interface components used by this view bean.

Overrides:

createChild in class AMViewBeanBase

Parameters:

name - of component

Returns:

child component

beginDisplay

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

Specified by:

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

Overrides:

beginDisplay in class AMViewBeanBase

Throws:

com.iplanet.jato.model.ModelControlException

beginDisplay

protected void beginDisplay(com.iplanet.jato.view.event.DisplayEvent event,
                            boolean setSelectedTabNode)
                     throws com.iplanet.jato.model.ModelControlException

Throws:

com.iplanet.jato.model.ModelControlException

setSelectedTabNode

protected void setSelectedTabNode(String realmName)

getDefaultTabId

protected int getDefaultTabId(String realmName,
                              jakarta.servlet.http.HttpServletRequest req)

createTabModel

protected void createTabModel()

code to handle tab related functionality

nodeClicked

public void nodeClicked(com.iplanet.jato.view.event.RequestInvocationEvent event,
                        int nodeID)

Handles tab selected event.

Specified by:

nodeClicked in interface com.sun.web.ui.view.tabs.CCNodeEventHandlerInterface

Parameters:

event - Request Invocation Event.

nodeID - Selected Node ID.

passPgSessionMapEx

public void passPgSessionMapEx(com.iplanet.jato.view.ViewBean other)

Pass session attribute map to other view bean.

Parameters:

other - view bean

getTabNodeAssociatedViewBean

protected AMViewBeanBase getTabNodeAssociatedViewBean(String tabSetName,
                                                      int nodeID)
                                               throws AMConsoleException

Returns view bean for a tab.

Parameters:

tabSetName - Name of tab set.

nodeID - Node ID.

Returns:

view bean for a tab.

Throws:

AMConsoleException - if view bean cannot be found.

getTrackingTabIDName

protected String getTrackingTabIDName()

isRootRealm

protected boolean isRootRealm(String realm,
                              String startDN)

initPageTrail

protected void initPageTrail()
                      throws AMConsoleException

Throws:

AMConsoleException

setPageTrail

protected void setPageTrail(String displayName,
                            String viewBeanClassName)

addPageTrail

protected void addPageTrail(String displayName,
                            String viewBeanClassName)

backTrail

protected PageTrail.Marker backTrail()

getBreadCrumbDisplayName

protected String getBreadCrumbDisplayName()

startPageTrail

protected boolean startPageTrail()

unlockPageTrail

public void unlockPageTrail()

unlockPageTrailForSwapping

public void unlockPageTrailForSwapping()

lockPageTrail

public void lockPageTrail()

handleBreadCrumbHrefRequest

public void handleBreadCrumbHrefRequest(com.iplanet.jato.view.event.RequestInvocationEvent event)