IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.security.auth.callback
Class WSIdentityCallback

java.lang.Object
  extended by com.ibm.wsspi.security.auth.callback.WSIdentityCallback
All Implemented Interfaces:
javax.security.auth.callback.Callback

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

The WSIdentityCallback allows a caller identity String 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
WSIdentityCallback(java.lang.String prompt)
           Construct a WSIdentityCallback object with a prompt hint.
WSIdentityCallback(java.lang.String prompt, java.lang.String identity)
           Construct a WSIdentityCallback object with a prompt hint and a String identity instance.
 
Method Summary
 java.lang.String getClientIdentity()
           Return the client identity.
 java.lang.String getPrompt()
           Return the prompt.
 void setClientIdentity(java.lang.String identity)
           Set the client identity token.
 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

WSIdentityCallback

public WSIdentityCallback(java.lang.String prompt)

Construct a WSIdentityCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSIdentityCallback

public WSIdentityCallback(java.lang.String prompt,
                          java.lang.String identity)

Construct a WSIdentityCallback object with a prompt hint and a String identity instance.

Parameters:
prompt - The prompt hint.
HttpServletResponse - resp
Method Detail

setClientIdentity

public void setClientIdentity(java.lang.String identity)

Set the client identity token.

Parameters:
identity: - The client identity.

getClientIdentity

public java.lang.String getClientIdentity()

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

Returns:
The client identity, 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.

IBM WebSphere Application ServerTM
Release 7