com.ibm.wsspi.security.auth.callback

Class WSIdentityCallback

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

  1. public class WSIdentityCallback
  2. extends java.lang.Object
  3. 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

Constructor and Description
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

Modifier and Type Method and Description
  1. java.lang.String
getClientIdentity()
Return the client identity.
  1. java.lang.String
getPrompt()
Return the prompt.
  1. void
setClientIdentity(java.lang.String identity)
Set the client identity token.
  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

WSIdentityCallback

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

Construct a WSIdentityCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSIdentityCallback

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

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

Parameters:
prompt - The prompt hint.

Method Detail

setClientIdentity

  1. public void setClientIdentity(java.lang.String identity)

Set the client identity token.


getClientIdentity

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

  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.