com.ibm.wsspi.security.auth.callback

Class WSAppContextCallback

  • java.lang.Object
    • com.ibm.wsspi.security.auth.callback.WSAppContextCallback
  • All Implemented Interfaces:
    javax.security.auth.callback.Callback


    public class WSAppContextCallback
    extends java.lang.Object
    implements javax.security.auth.callback.Callback

    The WSAppContextCallback allows an Context object to be gathered by CallbackHandler and pass it to the LoginModule stack.

    Since:
    1.0
    • Constructor Summary

      Constructors 
      Constructor and Description
      WSAppContextCallback(java.lang.String prompt)
      Construct a WSAppContextCallback object with a prompt hint.
      WSAppContextCallback(java.lang.String prompt, java.util.Map context)
      Construct a WSAppContextCallback object with a prompt hint and an Context instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Map getContext()
      Return the Context.
      java.lang.String getPrompt()
      Return the prompt.
      void setContext(java.util.Map context)
      Set the application context.
      java.lang.String toString()
      Returns the name of the Callback.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • WSAppContextCallback

        public WSAppContextCallback(java.lang.String prompt)

        Construct a WSAppContextCallback object with a prompt hint.

        Parameters:
        prompt - The prompt hint.
      • WSAppContextCallback

        public WSAppContextCallback(java.lang.String prompt,
                                    java.util.Map context)

        Construct a WSAppContextCallback object with a prompt hint and an Context instance.

        Parameters:
        prompt - The prompt hint.
        Context - context
    • Method Detail

      • setContext

        public void setContext(java.util.Map context)

        Set the application context.

        Parameters:
        context: - The application context.
      • getContext

        public java.util.Map getContext()

        Return the Context. If the Context instance set in Constructor is null, then null is returned.

        Returns:
        The Context, could be null.
      • getPrompt

        public java.lang.String getPrompt()

        Return the prompt. If the prompt set in Constructor is null, then null is returned.

        Returns:
        The prompt, could be null.
      • toString

        public java.lang.String toString()

        Returns the name of the Callback. Typically, it is the name of the class.

        Overrides:
        toString in class java.lang.Object
        Returns:
        The name of the Callback.