com.ibm.wsspi.wssecurity.auth.callback

Class GUIPromptCallbackHandler

  • java.lang.Object
    • com.ibm.websphere.security.auth.callback.WSGUICallbackHandlerImpl
      • com.ibm.wsspi.wssecurity.auth.callback.GUIPromptCallbackHandler
  • All Implemented Interfaces:
    javax.security.auth.callback.CallbackHandler


    public class GUIPromptCallbackHandler
    extends com.ibm.websphere.security.auth.callback.WSGUICallbackHandlerImpl

    The GUIPromptCallbackHandler gathers the authentication data from the GUI and pushs the data to the login module. These data includes principal name and password. If the realm name can not be determined at the time of the login prompt, a "<default>" realm name will be displayed.

    Supported Callbacks:

    • javax.security.auth.callback.NameCallback
    • javax.security.auth.callback.PasswordCallback

    Since:
    1.0
    Version:
    1.0
    See Also:
    NameCallback, PasswordCallback
    • Constructor Summary

      Constructors 
      Constructor and Description
      GUIPromptCallbackHandler()
      Constructor with no parameters.
      GUIPromptCallbackHandler(java.lang.String userid, char[] password, java.util.Map properties)
      Constructs a GUIPromptCallbackHandler using userid, password and properties parameters.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void handle(javax.security.auth.callback.Callback[] callbacks)
      Invokes the callback handlers specified to collect the username and password data.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GUIPromptCallbackHandler

        public GUIPromptCallbackHandler()
        Constructor with no parameters.
      • GUIPromptCallbackHandler

        public GUIPromptCallbackHandler(java.lang.String userid,
                                char[] password,
                                java.util.Map properties)
        Constructs a GUIPromptCallbackHandler using userid, password and properties parameters. The parameters should include only stateless information.
        Parameters:
        userid - The user name.
        password - The user password.
        properties - A set of name-value pairs.
    • Method Detail

      • handle

        public void handle(javax.security.auth.callback.Callback[] callbacks)
                    throws java.io.IOException,
                           javax.security.auth.callback.UnsupportedCallbackException
        Invokes the callback handlers specified to collect the username and password data. Uses the prompt strings of each callback object passed the the method. If no prompt string is supplied, a default prompt string is used.
        Specified by:
        handle in interface javax.security.auth.callback.CallbackHandler
        Overrides:
        handle in class com.ibm.websphere.security.auth.callback.WSGUICallbackHandlerImpl
        Parameters:
        callbacks - An array of Callback objects provided by the underlying security service which contains the information requested to be retrieved or displayed.
        Throws:
        java.io.IOException - If an input or output error occurs.
        javax.security.auth.callback.UnsupportedCallbackException - If the implementation of this method does not support one or more of the Callbacks specified in the callbacks parameter.
IBM WebSphere Application ServerTM
Release 9.0