Package com.sun.identity.console.agentconfig

Class AgentProfileViewBean

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.agentconfig.AgentProfileViewBean

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:

GenericAgentProfileViewBean, WebServiceEditViewBean

public abstract class AgentProfileViewBean
extends AMPrimaryMastHeadViewBean

Base class for all agent profile view bean.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set	inheritedPropertyNames
protected boolean	isGroup
static String	MODIFIED_PROFILE
protected static String	PROPERTY_ATTRIBUTE
protected AMPropertySheetModel	propertySheetModel
protected com.sun.web.ui.model.CCPageTitleModel	ptModel
protected boolean	rcSet
protected boolean	submitCycle

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

Method Summary

Modifier and Type	Method	Description
boolean	beginBtnDumpDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)
boolean	beginBtnInheritDisplay(com.iplanet.jato.view.event.ChildDisplayEvent event)	Disables inheritance setting button if the agent does not belong a group.
void	beginDisplay(com.iplanet.jato.view.event.DisplayEvent event)	Sets the property sheet values and agent title.
protected boolean	checkAgentType(String type)
protected com.iplanet.jato.view.View	createChild(String name)	Creates user interface components used by this view bean.
protected void	createPageTitleModel()
protected boolean	createPropertyModel()
protected abstract AMPropertySheetModel	createPropertySheetModel(String type)
protected void	createTabModel()	code to handle tab related functionality
protected String	getAgentType()
protected String	getBackButtonLabel()
protected abstract Map	getFormValues()
protected AMModel	getModelInternal()	Returns model for this view bean.
protected abstract HashSet	getPropertyNames()
protected String	getTrackingTabIDName()
protected static String	getValueFromMap(Map attrValues, String name)
void	handleBtnDumpRequest(com.iplanet.jato.view.event.RequestInvocationEvent event)
void	handleBtnInheritRequest(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles inheritance setting button click.
void	handleButton1Request(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles Save button click.
void	handleButton2Request(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles reset button click.
void	handleButton3Request(com.iplanet.jato.view.event.RequestInvocationEvent event)	Handles back to main page button click.
protected void	initialize()
protected boolean	is2dot2Agent()
protected boolean	isAgentAuthenticator()
protected abstract boolean	isFirstTab()
protected static Set	putStringInSet(String value)
protected void	registerChildren()	Registers user interface components used by this view bean.
protected void	setAgentTitle()
protected abstract void	setDefaultValues(String type)
protected void	setPropertySheetValues()
protected void	setRequestContentInitialize(com.iplanet.jato.RequestContext rc)

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

addPageTrail, backTrail, beginDisplay, forwardTo, getBreadCrumbDisplayName, getDefaultTabId, getTabNodeAssociatedViewBean, handleBreadCrumbHrefRequest, handleRealmNameInTabSwitch, initPageTrail, isRootRealm, lockPageTrail, nodeClicked, 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, getPageSessionAttributes, getPageSessionAttributeString, getPath, getRequestURL, getServiceNameForAccessControl, getUserLocale, getValues, handleGRequest, hexToString, hideTableSelectionIcons, isInlineAlertMessageSet, mapRequestParameter, passPgSessionMap, passPgSessionMap, performDelegationTasks, redirectToStartURL, resetButtonState, resetView, setCurrentLocation, setInlineAlertMessage, setInlineAlertMessage, setPageSessionAttributes, 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

MODIFIED_PROFILE

public static final String MODIFIED_PROFILE

See Also:

Constant Field Values

PROPERTY_ATTRIBUTE

protected static final String PROPERTY_ATTRIBUTE

See Also:

Constant Field Values

ptModel

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

propertySheetModel

protected AMPropertySheetModel propertySheetModel

submitCycle

protected boolean submitCycle

inheritedPropertyNames

protected Set inheritedPropertyNames

isGroup

protected boolean isGroup

rcSet

protected boolean rcSet

Method Detail

setRequestContentInitialize

protected void setRequestContentInitialize(com.iplanet.jato.RequestContext rc)

Overrides:

setRequestContentInitialize in class AMViewBeanBase

initialize

protected void initialize()

Overrides:

initialize in class AMViewBeanBase

createPropertyModel

protected boolean createPropertyModel()

getModelInternal

protected AMModel getModelInternal()

Description copied from class: AMViewBeanBase

Returns model for this view bean. Dervived class need to implement this method.

Specified by:

getModelInternal in class AMViewBeanBase

Returns:

model for this view bean.

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

createPageTitleModel

protected void createPageTitleModel()

getBackButtonLabel

protected String getBackButtonLabel()

beginDisplay

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

Sets the property sheet values and agent title.

Specified by:

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

Overrides:

beginDisplay in class AMPrimaryMastHeadViewBean

Parameters:

event - Display Event.

Throws:

com.iplanet.jato.model.ModelControlException - if cannot access to framework model.

setPropertySheetValues

protected void setPropertySheetValues()

setAgentTitle

protected void setAgentTitle()

getValueFromMap

protected static String getValueFromMap(Map attrValues,
                                        String name)

putStringInSet

protected static Set putStringInSet(String value)

handleButton1Request

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

Handles Save button click.

Parameters:

event - Request Invocation Event.

Throws:

com.iplanet.jato.model.ModelControlException - if cannot access to framework model.

beginBtnInheritDisplay

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

Disables inheritance setting button if the agent does not belong a group.

Parameters:

event - Child Display Event.

Returns:

true if the agent belongs to a group.

beginBtnDumpDisplay

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

handleBtnInheritRequest

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

Handles inheritance setting button click.

Parameters:

event - Request Invocation Event.

Throws:

com.iplanet.jato.model.ModelControlException - if cannot access to framework model.

handleBtnDumpRequest

public void handleBtnDumpRequest(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)

Handles reset button click.

Parameters:

event - Request Invocation Event.

handleButton3Request

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

Handles back to main page button click.

Parameters:

event - Request Invocation Event.

createTabModel

protected void createTabModel()

Description copied from class: AMPrimaryMastHeadViewBean

code to handle tab related functionality

Overrides:

createTabModel in class AMPrimaryMastHeadViewBean

getTrackingTabIDName

protected String getTrackingTabIDName()

Overrides:

getTrackingTabIDName in class AMPrimaryMastHeadViewBean

is2dot2Agent

protected boolean is2dot2Agent()

isAgentAuthenticator

protected boolean isAgentAuthenticator()

checkAgentType

protected boolean checkAgentType(String type)

getAgentType

protected String getAgentType()

isFirstTab

protected abstract boolean isFirstTab()

setDefaultValues

protected abstract void setDefaultValues(String type)
                                  throws AMConsoleException

Throws:

AMConsoleException

createPropertySheetModel

protected abstract AMPropertySheetModel createPropertySheetModel(String type)

getFormValues

protected abstract Map getFormValues()
                              throws AMConsoleException,
                                     com.iplanet.jato.model.ModelControlException

Throws:

AMConsoleException

com.iplanet.jato.model.ModelControlException

getPropertyNames

protected abstract HashSet getPropertyNames()