Package com.sun.identity.console.federation

Class EntityPropertiesBase

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

com.sun.identity.console.federation.EntityPropertiesBase

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:

IDFFViewBeanBase, SAMLv2Base, WSFedGeneralBase

public abstract class EntityPropertiesBase
extends AMPrimaryMastHeadViewBean

This is the base for all of the entity propery views. It will build the tab menu based on the configurations (roles) supported by the selected entity type. Extender must implement the following methods: protected abstract String getProfileName(); protected abstract void createPropertyModel(String name); The value returned from getProfileName() must be the beginning of the name of the class viewbean being invoked. For example, for a SAMLv2 protocol entity, getProfileName() will return "SAMLv2" which will then be converted to SAMLv2GeneralViewBean, SAMLv2General.jsp, etc...

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENTITY_LOCATION
static String	ENTITY_NAME
static String	ENTITY_REALM
String	entityName
static String	HOSTED
String	location
static String	PROPERTY_ATTRIBUTES
protected AMPropertySheetModel	psModel
protected com.sun.web.ui.model.CCPageTitleModel	ptModel
String	realm

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

HDR_COMMON, MH_COMMON, PG_SESSION_PAGE_TRAIL_ID, PG_SESSION_TAB_ID, retainPageSessionsBtwTabs, TAB_COMMON, tabModel

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

BTN_GHOST, debug, 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
EntityPropertiesBase(String name)

Method Summary

Modifier and Type	Method	Description
void	beginDisplay(com.iplanet.jato.view.event.DisplayEvent event)
protected com.iplanet.jato.view.View	createChild(String name)	Creates user interface components used by this view bean.
protected void	createPageTitleModel()
protected abstract void	createPropertyModel()
protected void	createTabModel()	code to handle tab related functionality
protected AMModel	getEntityModel()
protected abstract String	getProfileName()
void	handleButton1Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
void	handleButton2Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
void	handleButton3Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
protected void	initialize()
boolean	isHosted()
void	nodeClicked(com.iplanet.jato.view.event.RequestInvocationEvent event, int nodeID)	Event Handlers for the following events: tab selection, save button, reset button, back button.
protected void	registerChildren()	Registers user interface components used by this view bean.
void	retrieveCommonProperties()	This will pull the following properties from the page session: entity name name of the realm where the entity exists location (either hosted or remote)
protected void	setPageTitle(String title)

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

addPageTrail, backTrail, beginDisplay, forwardTo, getBreadCrumbDisplayName, getDefaultTabId, getTabNodeAssociatedViewBean, getTrackingTabIDName, handleBreadCrumbHrefRequest, handleRealmNameInTabSwitch, initPageTrail, isRootRealm, lockPageTrail, passPgSessionMapEx, setPageTrail, setRequestContext, setSelectedTabNode, startPageTrail, unlockPageTrail, 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, 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

entityName

public String entityName

realm

public String realm

location

public String location

ptModel

protected com.sun.web.ui.model.CCPageTitleModel ptModel

psModel

protected AMPropertySheetModel psModel

PROPERTY_ATTRIBUTES

public static final String PROPERTY_ATTRIBUTES

See Also:

Constant Field Values

ENTITY_NAME

public static final String ENTITY_NAME

See Also:

Constant Field Values

ENTITY_REALM

public static final String ENTITY_REALM

See Also:

Constant Field Values

ENTITY_LOCATION

public static final String ENTITY_LOCATION

See Also:

Constant Field Values

HOSTED

public static final String HOSTED

See Also:

Constant Field Values

Constructor Detail

EntityPropertiesBase

public EntityPropertiesBase(String name)

Method Detail

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 AMPrimaryMastHeadViewBean

Throws:

com.iplanet.jato.model.ModelControlException

registerChildren

protected void registerChildren()

Description copied from class: AMPrimaryMastHeadViewBean

Registers user interface components used by this view bean.

Overrides:

registerChildren in class AMPrimaryMastHeadViewBean

createChild

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

Description copied from class: AMPrimaryMastHeadViewBean

Creates user interface components used by this view bean.

Overrides:

createChild in class AMPrimaryMastHeadViewBean

Parameters:

name - of component

Returns:

child component

initialize

protected void initialize()

Overrides:

initialize in class AMViewBeanBase

setPageTitle

protected void setPageTitle(String title)

createPageTitleModel

protected void createPageTitleModel()

createTabModel

protected void createTabModel()

Description copied from class: AMPrimaryMastHeadViewBean

code to handle tab related functionality

Overrides:

createTabModel in class AMPrimaryMastHeadViewBean

getEntityModel

protected AMModel getEntityModel()

nodeClicked

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

Event Handlers for the following events: tab selection, save button, reset button, back button.

Specified by:

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

Overrides:

nodeClicked in class AMPrimaryMastHeadViewBean

Parameters:

event - Request Invocation Event.

nodeID - Selected Node ID.

handleButton1Request

public void handleButton1Request(com.iplanet.jato.view.event.RequestInvocationEvent event)
                          throws com.iplanet.jato.model.ModelControlException

Throws:

com.iplanet.jato.model.ModelControlException

handleButton2Request

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

handleButton3Request

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

retrieveCommonProperties

public void retrieveCommonProperties()

This will pull the following properties from the page session: entity name name of the realm where the entity exists location (either hosted or remote)

isHosted

public boolean isHosted()

getProfileName

protected abstract String getProfileName()

createPropertyModel

protected abstract void createPropertyModel()