Package com.sun.identity.authentication.UI

Class AuthViewBeanBase

  • 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 abstract class AuthViewBeanBase
extends ConsoleViewBeanBase
    This class is a default implementation of ViewBean auth UI.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Locale fallbackLocale  
      static String PAGE_ENCODING
      Parameter name for page encoding.
      ResourceBundle rb
      Resource bundle with Locale
      static AMResourceBundleCache rbCache  
      static String SERVICE_URI
      Parameter name for service uri.
      static String serviceUri
      Configured service uri.
      static Set storeCookies
      When HTTP request is made, we get authcontext and get current locale and store it in fallbackLocale.

      • 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
      AuthViewBeanBase​(String pageName)
      Creates AuthViewBeanBase object.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.iplanet.jato.view.View createChild​(String name)  
      String getEncodedInputValue​(String inputValue)
      Returns the Base64 ecoded URL value.
      String getEncodedQueryParams​(jakarta.servlet.http.HttpServletRequest request)
      Returns the validated and Base64 ecoded query params value.
      Locale getRequestLocale()
      Returns Locale for auth request.
      abstract String getTileIndex()
      Returns tile index for auth UI.
      String getValidatedInputURL​(String inputURL, String encoded, jakarta.servlet.http.HttpServletRequest request)
      Returns the validated and Base64 ecoded URL value.
      protected void registerChildren()
      registers child views
      protected void setPageEncoding​(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)  

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

        clearPageSessionAttributes, forward, forwardTo, forwardTo, getDefaultCommandDescriptor, getDefaultDisplayURL, getDisplayURL, 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, beginDisplay, 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 interface com.iplanet.jato.view.ContainerView

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

      • serviceUri

        public static String serviceUri
        Configured service uri.

      • fallbackLocale

        protected Locale fallbackLocale

      • storeCookies

        public static Set storeCookies
        When HTTP request is made, we get authcontext and get current locale and store it in fallbackLocale. Before the login page is displayed, login modules can have LoginState object which has the locale settings. But after going through login process LoginState might have changed locale based on user preference or LoginState may not exist if LoginFailure in such case we need to fallback to this locale for responding to user

    • Constructor Detail

      • AuthViewBeanBase

        public AuthViewBeanBase​(String pageName)
        Creates AuthViewBeanBase object.
        Parameters:
        pageName - name of page for auth UI.

    • Method Detail

      • registerChildren

        protected void registerChildren()
        registers child views

      • createChild

        protected com.iplanet.jato.view.View createChild​(String name)
        Overrides:
        createChild in class com.iplanet.jato.view.ContainerViewBase

      • setPageEncoding

        protected void setPageEncoding​(jakarta.servlet.http.HttpServletRequest request,
                               jakarta.servlet.http.HttpServletResponse response)

      • getEncodedQueryParams

        public String getEncodedQueryParams​(jakarta.servlet.http.HttpServletRequest request)
        Returns the validated and Base64 ecoded query params value.
        Parameters:
        request - from which query parameters have to be extracted.
        Returns:
        a String the validated and Base64 ecoded query params String

      • getValidatedInputURL

        public String getValidatedInputURL​(String inputURL,
                                   String encoded,
                                   jakarta.servlet.http.HttpServletRequest request)
        Returns the validated and Base64 ecoded URL value.
        Parameters:
        inputURL - input URL string value
        encoded - value of "encoded" parameter to tell wheather the inputURL is already encoded or not
        request - HttpServletRequest object
        Returns:
        a String the validated and Base64 ecoded URL value

      • getEncodedInputValue

        public String getEncodedInputValue​(String inputValue)
        Returns the Base64 ecoded URL value.
        Parameters:
        inputValue - input string value
        Returns:
        a String the Base64 ecoded URL value

      • getRequestLocale

        public Locale getRequestLocale()
        Returns Locale for auth request.
        Returns:
        Locale for auth request.

      • getTileIndex

        public abstract String getTileIndex()
        Returns tile index for auth UI.
        Returns:
        tile index for auth UI.