Package com.ibm.security.access.extension.authn.task

Class HtmlPagePauseTask

java.lang.Object

com.ibm.security.access.extension.authn.task.HtmlPageTask

com.ibm.security.access.extension.authn.task.HtmlPagePauseTask

All Implemented Interfaces:

AuthenticationMechanismResultPauseTask, AuthenticationMechanismResultTask

public class HtmlPagePauseTask
extends HtmlPageTask
implements AuthenticationMechanismResultPauseTask

This class represents a pause task that returns an HTML page.

Field Summary

Fields inherited from class com.ibm.security.access.extension.authn.task.HtmlPageTask

HTTP_BAD_REQUEST, HTTP_NOT_IMPLEMENTED, HTTP_OK, HTTP_OK_CREATED, HTTP_OK_NO_CONTENT, HTTP_SERVICE_UNAVALIABLE

Constructor Summary

Constructors

Constructor	Description
HtmlPagePauseTask()	Create an HTML page pause task.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getResumeUriBase()	Get the base of the URI that the user must access to resume the execution of the current authentication mechanism.
java.lang.String	getResumeUriParameter(java.lang.String name)	Get the value of query string parameter with the specified name of the URI that the user must access to resume the execution of the current authentication mechanism.
java.util.Map<java.lang.String,java.lang.String>	getResumeUriParameters()	Get the query string parameters of the URI that the user must access to resume the execution of the current authentication mechanism.
void	setResumeUriBase(java.lang.String base)	This method is invoked by authentication service to inform this result pause task the base of the URI that the user must access to resume the execution of the current authentication mechanism.
void	setResumeUriParameter(java.lang.String name, java.lang.String value)	This method is invoked by authentication service to inform this result pause task the query string parameter of the URI that the user must access to resume the execution of the current authentication mechanism.
void	setResumeUriParameters(java.util.Map<java.lang.String,java.lang.String> parameters)	Set the query string parameters of the URI that the user must access to resume the execution of the current authentication mechanism.

Methods inherited from class com.ibm.security.access.extension.authn.task.HtmlPageTask

execute, getMacro, getMacros, getPageContent, getPageId, getStatusCode, setMacro, setMacros, setPageContent, setPageId, setStatusCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.security.access.extension.authn.AuthenticationMechanismResultTask

execute

Constructor Detail

HtmlPagePauseTask

public HtmlPagePauseTask()

Create an HTML page pause task.

Method Detail

getResumeUriBase

public java.lang.String getResumeUriBase()

Get the base of the URI that the user must access to resume the execution of the current authentication mechanism.

Returns:

The base of the URI.

setResumeUriBase

public void setResumeUriBase(java.lang.String base)

Description copied from interface: AuthenticationMechanismResultPauseTask

This method is invoked by authentication service to inform this result pause task the base of the URI that the user must access to resume the execution of the current authentication mechanism.

Specified by:

setResumeUriBase in interface AuthenticationMechanismResultPauseTask

Parameters:

base - The base of the URI.

getResumeUriParameters

public java.util.Map<java.lang.String,java.lang.String> getResumeUriParameters()

Get the query string parameters of the URI that the user must access to resume the execution of the current authentication mechanism.

Returns:

The query string parameters.

setResumeUriParameters

public void setResumeUriParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set the query string parameters of the URI that the user must access to resume the execution of the current authentication mechanism.

Parameters:

parameters - The query string parameters.

getResumeUriParameter

public java.lang.String getResumeUriParameter(java.lang.String name)

Get the value of query string parameter with the specified name of the URI that the user must access to resume the execution of the current authentication mechanism.

Parameters:

name - The query string parameter name.

Returns:

The query string parameter value.

setResumeUriParameter

public void setResumeUriParameter(java.lang.String name,
                                  java.lang.String value)

Description copied from interface: AuthenticationMechanismResultPauseTask

This method is invoked by authentication service to inform this result pause task the query string parameter of the URI that the user must access to resume the execution of the current authentication mechanism.

Specified by:

setResumeUriParameter in interface AuthenticationMechanismResultPauseTask

Parameters:

name - The query string parameter name.

value - The query string parameter value.