Package com.ibm.wsspi.security.auth.callback

Class WSServletRequestCallback

java.lang.Object

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

All Implemented Interfaces:

Callback

public class WSServletRequestCallback
extends Object
implements Callback

The WSServletRequestCallback allows an HttpServletRequest object to be gathered by CallbackHandler and pass it to the LoginModule stack.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
WSServletRequestCallback(String prompt)	Construct a WSServletRequestCallback object with a prompt hint.
WSServletRequestCallback(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	Description
javax.servlet.http.HttpServletRequest	getHttpServletRequest()	Return the HttpServletRequest.
String	getPrompt()	Return the prompt.
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest req)	Set the HttpServletRequest instance.
String	toString()	Returns the name of the Callback.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WSServletRequestCallback

public WSServletRequestCallback(String prompt)

Construct a WSServletRequestCallback object with a prompt hint.

Parameters:

prompt - The prompt hint.

WSServletRequestCallback

public WSServletRequestCallback(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 Details

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 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 String toString()

Returns the name of the Callback. Typically, it is the name of the class.

Overrides:

toString in class Object

Returns:

The name of the Callback.