IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.security.auth.callback
Class WSServletRequestCallback

java.lang.Object
  extended by com.ibm.wsspi.security.auth.callback.WSServletRequestCallback
All Implemented Interfaces:
javax.security.auth.callback.Callback

public class WSServletRequestCallback
extends java.lang.Object
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
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
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
           Return the HttpServletRequest.
 java.lang.String getPrompt()
           Return the prompt.
 void setHttpServletRequest(javax.servlet.http.HttpServletRequest req)
           Set the HttpServletRequest instance.
 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

public WSServletRequestCallback(java.lang.String prompt)

Construct a WSServletRequestCallback object with a prompt hint.

Parameters:
prompt - The prompt hint.

WSServletRequestCallback

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

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

Parameters:
prompt - The prompt hint.
HttpServletRequest - req
Method Detail

setHttpServletRequest

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

Set the HttpServletRequest instance.

Parameters:
req - The HttpServletRequest object.

getHttpServletRequest

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

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

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.

IBM WebSphere Application ServerTM
Release 8