com.ibm.wsspi.wssecurity.auth.callback

Class BinaryTokenCallback

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

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

The BinaryTokenCallback allows a credential token to be gathered by the CallbackHandler and pass it to the LoginModule.

However, since the credential token is typically in byte format and difficult to input interactively, it is usually passed to the LoginModule programmatically.

Version:
1.0
See Also:
CallbackHandler

Constructor Summary

Constructor and Description
BinaryTokenCallback(java.lang.String prompt)
Construct a BinaryTokenCallback object with a prompt hint.
BinaryTokenCallback(java.lang.String prompt,byte[] defaultCredToken)
Construct a BinaryTokenCallback object with a prompt hint and a default credential token.

Method Summary

Modifier and Type Method and Description
  1. byte[]
getCredToken()
Return the credential token.
  1. byte[]
getDefaultCredToken()
Return the default credential token.
  1. java.lang.String
getPrompt()
Return the prompt.
  1. void
setCredToken(byte[] credToken)
Set the credential 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

BinaryTokenCallback

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

Construct a BinaryTokenCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

BinaryTokenCallback

  1. public BinaryTokenCallback(java.lang.String prompt,
  2. byte[] defaultCredToken)

Construct a BinaryTokenCallback object with a prompt hint and a default credential token.

Parameters:
prompt - The prompt hint.
defaultCredToken - The default credential token.

Method Detail

setCredToken

  1. public void setCredToken(byte[] credToken)

Set the credential token.

Parameters:
credToken - The credential token.

getCredToken

  1. public byte[] getCredToken()

Return the credential token. If the credential token set in BinaryTokenCallback.setCredToken() is null, the null is returned.

Returns:
The credential token. Can be null.

getDefaultCredToken

  1. public byte[] getDefaultCredToken( )

Return the default credential token. If the credential token set in the Constructor is null, then null is returned.

Returns:
The default credential token. Can be null.

getPrompt

  1. public java.lang.String getPrompt( )

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

Returns:
The prompt. Can 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.