com.ibm.wsspi.security.auth.callback
Class WSTokenHolderCallback
- java.lang.Object
com.ibm.wsspi.security.auth.callback.WSTokenHolderCallback
- public class WSTokenHolderCallback
- extends java.lang.Object
- implements javax.security.auth.callback.Callback
The WSTokenHolderCallback
allows a List of TokenHolder objects to
be gathered by CallbackHandler
and pass it to the LoginModule
stack. This is used by AuthenLoginModule
and ltpaLoginModule
.
CallbackHandler
,
WSCallbackHandlerImpl
Constructor Summary
Constructor and Description |
---|
WSTokenHolderCallback(java.lang.String prompt)
Construct a
WSTokenHolderCallback object with a prompt hint.
|
WSTokenHolderCallback(java.lang.String prompt,java.util.List list,boolean requiresLogin)
Construct a
WSTokenHolderCallback object with a prompt hint and
a List instance.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getPrompt()
Return the prompt.
|
|
getRequiresLogin()
Returns the requiresLogin boolean.
|
|
getTokenHolderList()
Return the TokenHolder List.
|
|
setRequiresLogin(boolean requiresLogin)
Sets the requiresLogin field.
|
|
setTokenHolderList(java.util.List list)
Set the TokenHolder array list.
|
|
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
WSTokenHolderCallback
- public WSTokenHolderCallback(java.lang.String prompt)
prompt
- The prompt hint. WSTokenHolderCallback
- public WSTokenHolderCallback(java.lang.String prompt,
- java.util.List list,
- boolean requiresLogin)
Construct a WSTokenHolderCallback
object with a prompt hint and
a List instance.
prompt
- The prompt hint. Method Detail
setTokenHolderList
- public void setTokenHolderList( java.util.List list)
Set the TokenHolder array list.
getTokenHolderList
- public java.util.List getTokenHolderList( )
Return the TokenHolder List. If the List instance set in
Constructor is null
, then null
is returned.
null
. setRequiresLogin
- public void setRequiresLogin(boolean requiresLogin)
Sets the requiresLogin field. See getRequiresLogin() method for information about this value.
getRequiresLogin
- public boolean getRequiresLogin( )
Returns the requiresLogin boolean. When true, this provides a hint to the service provider login module that there is insufficient information propagated and a new login will be required. This hint can be used to provide a hashtable of login attributes, if preferred. When false, it's best not to specify a hashtable of login attributes and instead use the propagated information to recreate the Subject. If one wants to override (map) the identity, then this can be ignored and a hashtable may be specified anyway.
getPrompt
- public java.lang.String getPrompt( )
Return the prompt. If the prompt set in Constructor
is null
, then null
is returned.
null
. toString
- public java.lang.String toString( )
Returns the name of the Callback. Typically, it is the name of the class.
toString
in class java.lang.Object
Construct a
WSTokenHolderCallback
object with a prompt hint.