com.ibm.websphere.security.auth.callback

Class WSRealmNameCallbackImpl

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

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

The WSRealmNameCallbackImpl allows realm name to be gathered by CallbackHandler and pass it to the LoginModule. This is used by WSClientLoginModuleImpl and WSLoginModuleImpl.

Since:
7.0
Version:
7.0
See Also:
CallbackHandler, WSCallbackHandlerImpl, com.ibm.websphere.security.auth.module.WSClientLoginModuleImpl, com.ibm.websphere.security.auth.module.WSLoginModuleImpl

Constructor Summary

Constructor and Description
WSRealmNameCallbackImpl(java.lang.String prompt)
Construct a WSRealmNameCallbackImpl object with a prompt hint.
WSRealmNameCallbackImpl(java.lang.String prompt,java.lang.String defaultRealmName)
Construct a WSRealmNameCallbackImpl object with a prompt hint and a default realm name.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getDefaultRealmName()
Return the default realm name.
  1. java.lang.String
getPrompt()
Return the prompt.
  1. java.lang.String
getRealmName()
Return the realm name.
  1. void
setRealmName(java.lang.String realmName)
Set the realm name.
  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

WSRealmNameCallbackImpl

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

Construct a WSRealmNameCallbackImpl object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSRealmNameCallbackImpl

  1. public WSRealmNameCallbackImpl( java.lang.String prompt,
  2. java.lang.String defaultRealmName)

Construct a WSRealmNameCallbackImpl object with a prompt hint and a default realm name.

Parameters:
prompt - The prompt hint.
defaultRealmName - The default realm name.

Method Detail

setRealmName

  1. public void setRealmName(java.lang.String realmName)

Set the realm name.

Parameters:
realmName - The realm name.

getRealmName

  1. public java.lang.String getRealmName( )

Return the realm name. If the realm name set in WSRealmNameCallbackImpl.setRealmName() is null, then null is returned.

Returns:
The realm name, could be null.

getDefaultRealmName

  1. public java.lang.String getDefaultRealmName( )

Return the default realm name. If the default realm name set in Constructor is null, then null is returned.

Returns:
The default realm name, 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.