com.ibm.wsspi.security.auth.callback

Class WSServletRequestCallback

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

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

The WSServletRequestCallback allows an HttpServletRequest 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
WSServletRequestCallback(java.lang.String prompt)
Construct a WSServletRequestCallback object with a prompt hint.
WSServletRequestCallback(java.lang.String prompt,javax.servlet.http.HttpServletRequest req)
Construct a WSServletRequestCallback object with a prompt hint and an HttpServletRequest instance.

Method Summary

Modifier and Type Method and Description
  1. javax.servlet.http.HttpServletRequest
getHttpServletRequest()
Return the HttpServletRequest.
  1. java.lang.String
getPrompt()
Return the prompt.
  1. void
setHttpServletRequest(javax.servlet.http.HttpServletRequest req)
Set the HttpServletRequest instance.
  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

WSServletRequestCallback

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

Construct a WSServletRequestCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSServletRequestCallback

  1. public WSServletRequestCallback( java.lang.String prompt,
  2. javax.servlet.http.HttpServletRequest req)

Construct a WSServletRequestCallback object with a prompt hint and an HttpServletRequest instance.

Parameters:
prompt - The prompt hint.

Method Detail

setHttpServletRequest

  1. public void setHttpServletRequest( javax.servlet.http.HttpServletRequest req)

Set the HttpServletRequest instance.

Parameters:
req - The HttpServletRequest object.

getHttpServletRequest

  1. public javax.servlet.http.HttpServletRequest getHttpServletRequest( )

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

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