Package com.sun.identity.console.base

Class AMViewBeanBase

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static String BTN_GHOST  
      static Debug debug  
      protected boolean initialized  
      protected static String PG_SESSION_ATTR  
      protected static String PG_SESSION_ATTR_ID  
      protected static String PG_SESSION_SSO_ID  
      protected static String 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
      AMViewBeanBase​(String name)
      Creates an instance of base view bean object

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addBlankTextField​(String name)
      Includes a static text field that should be blanked.
      protected String appendPgSession​(String url)
      Appends page session string to URL
      boolean beginChildDisplay​(com.iplanet.jato.view.event.ChildDisplayEvent event)  
      void beginDisplay​(com.iplanet.jato.view.event.DisplayEvent event)  
      protected void bypassForwardTo​(com.iplanet.jato.RequestContext rc)  
      static String charToHex​(char c)  
      protected com.iplanet.jato.view.View createChild​(String name)
      Creates user interface components used by this view bean.
      com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection)
      Returns an option list object that contains options for a given collection of string.
      static com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection, Locale locale)
      Returns an option list object that contains options for a given collection of string.
      static com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection, Locale locale, boolean bSort)
      Returns an option list object that contains options for a given collection of string.
      com.iplanet.jato.view.html.OptionList createOptionList​(Map map)
      Returns a option list object that contains options for a given map of value to its localized string.
      static com.iplanet.jato.view.html.OptionList createOptionList​(Map map, Locale locale)
      Returns a option list object that contains options for a given map of value to its localized string.
      protected void deserializePageAttributes()  
      void disableButton​(String btnName, boolean disable)  
      void forwardTo​(com.iplanet.jato.RequestContext rc)  
      protected String getBackButtonLabel​(String label)
      Creates the label used to take the user back to the previous page they were viewing.
      Set getBlankTextFields()
      Returns a set of static text field' names that should be blanked.
      AMViewBeanBase getCallingView()  
      protected String getCharset()  
      String getCharset​(AMModel model)
      Gets current charset
      protected String getContentType()  
      String getCurrentLocation()
      Gets the name of the current location.
      String getCurrentLocationDN()
      Gets the current location DN.
      protected String getCurrentRealm()  
      protected String getCurrentRealmEncoded()
      Get the current realm, encoded as a path element.
      static List getList​(com.iplanet.jato.view.html.OptionList optList)
      Returns a list of string from a option list items.
      AMModel getModel()
      Returns model for this view bean.
      protected abstract AMModel getModelInternal()
      Returns model for this view bean.
      protected Map getPageSessionAttributes()  
      String getPageSessionAttributeString()  
      String getPath​(String child)  
      protected String getRequestURL()  
      protected String getServiceNameForAccessControl()  
      Locale getUserLocale()  
      static Set getValues​(com.iplanet.jato.view.html.OptionList optList)
      Returns a set of string from a option list items.
      void handleGRequest​(com.iplanet.jato.view.event.RequestInvocationEvent event)
      Does nothing, just forwards to the same view bean
      static String hexToString​(String str)  
      void hideTableSelectionIcons​(String tableName)
      Hides the selection checkboxes in table.
      protected void initialize()  
      protected boolean isInlineAlertMessageSet()
      Returns true if inline alert message is set.
      protected void mapRequestParameter​(com.iplanet.jato.view.DisplayField field, Object[] childValues)
      Overwriting this map so that we correct the set value for OpenSSO's proprietory taglib component, SerializedField.
      void passPgSessionMap​(com.iplanet.jato.view.ViewBean other)
      Pass session attribute map to other view bean
      void passPgSessionMap​(com.iplanet.jato.view.ViewBean other, Map attributes)
      Pass session attribute map to other view bean
      protected void performDelegationTasks()  
      protected void redirectToStartURL()  
      protected void registerChildren()
      Registers user interface components used by this view bean.
      protected void resetButtonState​(String btnName)  
      void resetView()
      Reset the view bean.
      void setCurrentLocation​(String dn)
      Set location DN
      protected void setInlineAlertMessage​(String type, String title, String message)
      Set inline alert message.
      protected void setInlineAlertMessage​(String type, String title, String message, boolean encode)
      Set inline alert message.
      protected void setPageSessionAttributes​(Map value)  
      protected void setRequestContentInitialize​(com.iplanet.jato.RequestContext context)  
      void setRequestContext​(com.iplanet.jato.RequestContext context)  
      static String stringToHex​(String str)  

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

    • Constructor Detail

      • AMViewBeanBase

        public AMViewBeanBase​(String name)
        Creates an instance of base view bean object
        Parameters:
        name - of page

    • Method Detail

      • forwardTo

        public void forwardTo​(com.iplanet.jato.RequestContext rc)
               throws com.iplanet.jato.NavigationException
        Specified by:
        forwardTo in interface com.iplanet.jato.view.ViewBean
        Overrides:
        forwardTo in class com.iplanet.jato.view.ViewBeanBase
        Throws:
        com.iplanet.jato.NavigationException

      • setRequestContext

        public void setRequestContext​(com.iplanet.jato.RequestContext context)
        Specified by:
        setRequestContext in interface com.iplanet.jato.RequestParticipant
        Overrides:
        setRequestContext in class com.iplanet.jato.view.ViewBeanBase

      • setRequestContentInitialize

        protected void setRequestContentInitialize​(com.iplanet.jato.RequestContext context)

      • initialize

        protected void initialize()

      • registerChildren

        protected void registerChildren()
        Registers user interface components used by this view bean.

      • createChild

        protected com.iplanet.jato.view.View createChild​(String name)
        Creates user interface components used by this view bean.
        Overrides:
        createChild in class com.iplanet.jato.view.ContainerViewBase
        Parameters:
        name - of component
        Returns:
        child component

      • getCharset

        public String getCharset​(AMModel model)
        Gets current charset
        Parameters:
        model - object
        Returns:
        current charset

      • 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 com.iplanet.jato.view.RequestHandlingViewBase
        Throws:
        com.iplanet.jato.model.ModelControlException

      • passPgSessionMap

        public void passPgSessionMap​(com.iplanet.jato.view.ViewBean other)
        Pass session attribute map to other view bean
        Parameters:
        other - view bean

      • passPgSessionMap

        public void passPgSessionMap​(com.iplanet.jato.view.ViewBean other,
                             Map attributes)
        Pass session attribute map to other view bean
        Parameters:
        other - view bean
        attributes - Map of attribute name to values.

      • getModel

        public AMModel getModel()
        Returns model for this view bean. Dervived class need to implement this method.
        Returns:
        model for this view bean.

      • setInlineAlertMessage

        protected void setInlineAlertMessage​(String type,
                                     String title,
                                     String message,
                                     boolean encode)
        Set inline alert message.
        Parameters:
        type - Type of message such as Error, Warning, etc.
        title - Title of message.
        message - Message.
        encode - Should the message be encoded for HTML.

      • setInlineAlertMessage

        protected void setInlineAlertMessage​(String type,
                                     String title,
                                     String message)
        Set inline alert message.
        Parameters:
        type - Type of message such as Error, Warning, etc.
        title - Title of message.
        message - Message.

      • isInlineAlertMessageSet

        protected boolean isInlineAlertMessageSet()
        Returns true if inline alert message is set.
        Returns:
        true if inline alert message is set.

      • mapRequestParameter

        protected void mapRequestParameter​(com.iplanet.jato.view.DisplayField field,
                                   Object[] childValues)
        Overwriting this map so that we correct the set value for OpenSSO's proprietory taglib component, SerializedField. Without doing this, string value will be set to the value of this component, this is incorrect because the string value of this component is actually a serialized string of the value. Doing a setValue on this component will serialize the original twice and thus this component returns incorrect value in the execution cycle.
        Overrides:
        mapRequestParameter in class com.iplanet.jato.view.ContainerViewBase
        Parameters:
        field - Display field.
        childValues - Values of child component.

      • getModelInternal

        protected abstract AMModel getModelInternal()
        Returns model for this view bean. Dervived class need to implement this method.
        Returns:
        model for this view bean.

      • createOptionList

        public com.iplanet.jato.view.html.OptionList createOptionList​(Map map)
        Returns a option list object that contains options for a given map of value to its localized string.
        Parameters:
        map - Map of value to its localized string.
        Returns:
        a option list object that contains options for a given map of value to its localized string.

      • createOptionList

        public static com.iplanet.jato.view.html.OptionList createOptionList​(Map map,
                                                                     Locale locale)
        Returns a option list object that contains options for a given map of value to its localized string.
        Parameters:
        map - Map of value to its localized string.
        Returns:
        a option list object that contains options for a given map of value to its localized string.

      • createOptionList

        public static com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection,
                                                                     Locale locale)
        Returns an option list object that contains options for a given collection of string.
        Parameters:
        collection - Collection of strings to be included in option list.
        locale - Locale defining how the entries should be sorted.
        Returns:
        a option list object that contains options for a given collection of string.

      • createOptionList

        public com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection)
        Returns an option list object that contains options for a given collection of string.
        Parameters:
        collection - Collection of strings to be included in option list.
        Returns:
        a option list object that contains options for a given collection of string.

      • createOptionList

        public static com.iplanet.jato.view.html.OptionList createOptionList​(Collection collection,
                                                                     Locale locale,
                                                                     boolean bSort)
        Returns an option list object that contains options for a given collection of string.
        Parameters:
        collection - Collection of strings to be included in option list.
        locale - Locale defining how the entries should be sorted.
        bSort - true to sort the options.
        Returns:
        a option list object that contains options for a given collection of string.

      • getValues

        public static Set getValues​(com.iplanet.jato.view.html.OptionList optList)
        Returns a set of string from a option list items.
        Parameters:
        optList - Option list that contains the items.
        Returns:
        Set of string from a option list items.

      • getList

        public static List getList​(com.iplanet.jato.view.html.OptionList optList)
        Returns a list of string from a option list items.
        Parameters:
        optList - Option list that contains the items.
        Returns:
        list of string from a option list items.

      • appendPgSession

        protected String appendPgSession​(String url)
        Appends page session string to URL
        Parameters:
        url - Target URL

      • resetButtonState

        protected void resetButtonState​(String btnName)

      • disableButton

        public void disableButton​(String btnName,
                          boolean disable)

      • getCharset

        protected String getCharset()

      • getContentType

        protected String getContentType()

      • handleGRequest

        public void handleGRequest​(com.iplanet.jato.view.event.RequestInvocationEvent event)
        Does nothing, just forwards to the same view bean
        Parameters:
        event - - request invocation event

      • resetView

        public void resetView()
        Reset the view bean.

      • bypassForwardTo

        protected void bypassForwardTo​(com.iplanet.jato.RequestContext rc)

      • setCurrentLocation

        public void setCurrentLocation​(String dn)
        Set location DN
        Parameters:
        dn - the location distinguished name to set

      • getCurrentLocationDN

        public String getCurrentLocationDN()
        Gets the current location DN.
        Returns:
        location DN

      • getCurrentLocation

        public String getCurrentLocation()
        Gets the name of the current location.
        Returns:
        name of location

      • hideTableSelectionIcons

        public void hideTableSelectionIcons​(String tableName)
        Hides the selection checkboxes in table.
        Parameters:
        tableName - Name of table.

      • getBlankTextFields

        public Set getBlankTextFields()
        Returns a set of static text field' names that should be blanked. This field is a a action table as a label for a hyperlink. Blanking it out will hide the hyperlink accordingly.
        Returns:
        Set of static text field' names that should be blanked.

      • addBlankTextField

        public void addBlankTextField​(String name)
        Includes a static text field that should be blanked. This field is a a action table as a label for a hyperlink. Blanking it out will hide the hyperlink accordingly.
        Parameters:
        name - Name of static text field.

      • performDelegationTasks

        protected void performDelegationTasks()

      • beginChildDisplay

        public boolean beginChildDisplay​(com.iplanet.jato.view.event.ChildDisplayEvent event)
        Specified by:
        beginChildDisplay in interface com.iplanet.jato.view.ContainerView
        Overrides:
        beginChildDisplay in class com.iplanet.jato.view.ContainerViewBase

      • getServiceNameForAccessControl

        protected String getServiceNameForAccessControl()

      • getUserLocale

        public Locale getUserLocale()

      • getPageSessionAttributeString

        public String getPageSessionAttributeString()
        Overrides:
        getPageSessionAttributeString in class com.iplanet.jato.view.ViewBeanBase

      • setPageSessionAttributes

        protected void setPageSessionAttributes​(Map value)
        Overrides:
        setPageSessionAttributes in class com.iplanet.jato.view.ViewBeanBase

      • getPageSessionAttributes

        protected Map getPageSessionAttributes()
        Overrides:
        getPageSessionAttributes in class com.iplanet.jato.view.ViewBeanBase

      • redirectToStartURL

        protected void redirectToStartURL()

      • getBackButtonLabel

        protected String getBackButtonLabel​(String label)
        Creates the label used to take the user back to the previous page they were viewing. The label is defined in the property file as "Back to {0}" which lets us control the format of the label in different locales. If the label passed in cannot be found it will use the default value of "previous view".

      • getCurrentRealm

        protected String getCurrentRealm()

      • getCurrentRealmEncoded

        protected String getCurrentRealmEncoded()
        Get the current realm, encoded as a path element.
        Returns:
        The current realm encoded as a path element.

      • getRequestURL

        protected String getRequestURL()

      • stringToHex

        public static String stringToHex​(String str)

      • charToHex

        public static String charToHex​(char c)

      • hexToString

        public static String hexToString​(String str)