Package com.sun.identity.authentication.spi

Class PagePropertiesCallback

java.lang.Object
com.sun.identity.authentication.spi.PagePropertiesCallback
All Implemented Interfaces:
Callback
@Supported public class PagePropertiesCallback extends Object implements Callback
PagePropertiesCallback class implements Callback and used for exchanging all UI related attributes information such as template name, errorState to indicate whether a template is an error page, page header, image name , page timeout value, name of module.

  • Constructor Details

    • PagePropertiesCallback

      @Supported public PagePropertiesCallback(String name, String header, String image, int timeOut, String templateName, boolean error, String pageState)
      Creates a PagePropertiesCallback for a given module name, header string, page image, page time out, JSP template name, error state and page state.
      Parameters:
      name - Name of the authentication module.
      header - Header string for the authentication module display page.
      image - Image for the authentication module display page.
      timeOut - Time out value for the authentication module display page.
      templateName - JSP page name for the authentication module display.
      error - Error state for the authentication module.
      pageState - State of the authentication module display page.

  • Method Details

    • getImage

      @Supported public String getImage()
      Returns the authentication module display page image.
      Returns:
      the image for the authentication module display page.

    • getTimeOutValue

      @Supported public int getTimeOutValue()
      Returns the authentication module display page time out value.
      Returns:
      the time out value for the authentication module display page.

    • getPageState

      @Supported public String getPageState()
      Returns the authentication module display page state.
      Returns:
      the state for the authentication module display page.

    • getTemplateName

      @Supported public String getTemplateName()
      Returns the authentication module display page template name.
      Returns:
      the JSP page template of the authentication module display.

    • getModuleName

      @Supported public String getModuleName()
      Returns the authentication module name.
      Returns:
      the name of the authentication module.

    • getHeader

      @Supported public String getHeader()
      Returns the authentication module header string display.
      Returns:
      the header string display for the authentication module page.

    • getErrorState

      @Supported public boolean getErrorState()
      Returns the authentication module error state.
      Returns:
      the error state for the authentication module page.

    • getAttribute

      @Supported public List getAttribute()
      Returns the list of authentication module data store specific attributes.
      Returns:
      the list of authentication module data store specific attributes.

    • getRequire

      @Supported public List getRequire()
      Returns the list of authentication module display attributes which are required to be entered by the end user.
      Returns:
      the list of authentication module display attributes which are required to be entered by the end user.

    • getInfoText

      @Supported public List<String> getInfoText()
      Returns the list of infoText elements to display alongside the authentication module display attributes.
      Returns:
      the list of infoText elements

    • setHeader

      @Supported public void setHeader(String header)
      Sets the authentication module header string display.
      Parameters:
      header - Header string display for the authentication module page.

    • setAttribute

      @Supported public void setAttribute(List attribute)
      Sets the list of authentication module data store specific attributes.
      Parameters:
      attribute - the list of authentication module data store specific attributes.

    • setRequire

      @Supported public void setRequire(List require)
      Sets the list of authentication module display attributes which are required to be entered by the end user.
      Parameters:
      require - the list of authentication module display attributes which are required to be entered by the end user.

    • setInfoText

      @Supported public void setInfoText(List<String> infoText)
      Sets the list of infoText elements to display alongside the authentication
      Parameters:
      infoText - the list of infoText elements

    • setPageState

      @Supported public void setPageState(String pageState)
      Sets the authentication module display page state.
      Parameters:
      pageState - the state for the authentication module display page.