Package com.sun.identity.authentication.spi

Class PagePropertiesCallback

java.lang.Object
com.sun.identity.authentication.spi.PagePropertiesCallback
All Implemented Interfaces:
Callback
@SupportedAll 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 Summary

    Constructors
    Constructor
    Description
    PagePropertiesCallback(String name, String header, String image, int timeOut, String templateName, boolean error, String page_state)
    Creates a PagePropertiesCallback for a given module name, header string, page image, page time out, JSP template name, error state and page state.

  • Method Summary

    Modifier and Type
    Method
    Description
    List
    getAttribute()
    Returns the list of authentication module data store specific attributes.
    boolean
    getErrorState()
    Returns the authentication module error state.
    String
    getHeader()
    Returns the authentication module header string display.
    String
    getImage()
    Returns the authentication module display page image.
    List<String>
    getInfoText()
    Returns the list of infoText elements to display alongside the authentication module display attributes.
    String
    getModuleName()
    Returns the authentication module name.
    String
    getPageState()
    Returns the authentication module display page state.
    List
    getRequire()
    Returns the list of authentication module display attributes which are required to be entered by the end user.
    String
    getTemplateName()
    Returns the authentication module display page template name.
    int
    getTimeOutValue()
    Returns the authentication module display page time out value.
    void
    setAttribute(List attribute)
    Sets the list of authentication module data store specific attributes.
    void
    setHeader(String header)
    Sets the authentication module header string display.
    void
    setInfoText(List<String> infoText)
     
    void
    setPageState(String page_state)
    Sets the authentication module display page state.
    void
    setRequire(List require)
    Sets the list of authentication module display attributes which are required to be entered by the end user.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PagePropertiesCallback

      public PagePropertiesCallback(String name, String header, String image, int timeOut, String templateName, boolean error, String page_state)
      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.
      page_state - State of the authentication module display page.

  • Method Details

    • getImage

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

    • getTimeOutValue

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

    • getPageState

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

    • getTemplateName

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

    • getModuleName

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

    • getHeader

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

    • getErrorState

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

    • getAttribute

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

    • getRequire

      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

      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

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

    • setAttribute

      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

      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

      public void setInfoText(List<String> infoText)

    • setPageState

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