com.ibm.wsspi.security.auth.callback

Class WSAppContextCallback

  1. java.lang.Object
  2. extended bycom.ibm.wsspi.security.auth.callback.WSAppContextCallback
All implemented interfaces:
javax.security.auth.callback.Callback

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

The WSAppContextCallback allows an Context object to be gathered by CallbackHandler and pass it to the LoginModule stack. This is used by PreAuthenLoginModule and AuthenLoginModule.

Since:
1.0
Version:
1.0
See Also:
CallbackHandler, WSCallbackHandlerImpl

Constructor Summary

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

Modifier and Type Method and Description
  1. java.util.Map
getContext()
Return the Context.
  1. java.lang.String
getPrompt()
Return the prompt.
  1. void
setContext(java.util.Map context)
Set the application context.
  1. java.lang.String
toString()
Returns the name of the Callback.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WSAppContextCallback

  1. public WSAppContextCallback(java.lang.String prompt)

Construct a WSAppContextCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSAppContextCallback

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

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

Parameters:
prompt - The prompt hint.

Method Detail

setContext

  1. public void setContext(java.util.Map context)

Set the application context.


getContext

  1. 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

  1. 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

  1. 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.