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

Class JsonPageTask

java.lang.Object

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

All Implemented Interfaces:

AuthenticationMechanismResultTask

Direct Known Subclasses:

JsonPageAbortTask, JsonPagePauseTask

public abstract class JsonPageTask
extends java.lang.Object
implements AuthenticationMechanismResultTask

This class represents a task that returns an JSON page.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EMPTY_JSON
static int	HTTP_BAD_REQUEST
static int	HTTP_NOT_IMPLEMENTED
static int	HTTP_OK
static int	HTTP_OK_CREATED
static int	HTTP_OK_NO_CONTENT
static int	HTTP_SERVICE_UNAVALIABLE

Constructor Summary

Constructors

Constructor	Description
JsonPageTask()	Create an JSON page task.

Method Summary

Modifier and Type	Method	Description
void	execute(AuthenticationMechanismContext context)	This method is invoked by authentication service when it processes the authentication result.
java.lang.String	getMacro(java.lang.String name)	Get the value of the JSON page macro with the specified name.
java.util.Map<java.lang.String,java.lang.String>	getMacros()	Get the JSON page macro set.
java.lang.String	getPageContent()	Get the content of the JSON page.
java.lang.String	getPageId()	Get the identifier of the JSON page.
java.lang.Integer	getStatusCode()	Get the current status code of the return task
void	setMacro(java.lang.String name, java.lang.String value)	Set the value of the JSON page macro with the specified name with the specified value.
void	setMacro(java.lang.String name, JsonValue value)	Set the value of the JSON page macro with the specified name with the specified value.
void	setMacros(java.util.Map<java.lang.String,java.lang.String> macros)	Set the JSON page macro set.
void	setPageContent(java.lang.String jsonString)	Set the content of the JSON page.
void	setPageContent(JsonObject json)	Set the content of the JSON page.
void	setPageId(java.lang.String pageId)	Set the identifier of the JSON page.
void	setStatusCode(int code)	Set the HTTP stataus code returned to the user

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_JSON

public static final java.lang.String EMPTY_JSON

See Also:

Constant Field Values

HTTP_OK

public static int HTTP_OK

HTTP_OK_CREATED

public static int HTTP_OK_CREATED

HTTP_OK_NO_CONTENT

public static int HTTP_OK_NO_CONTENT

HTTP_BAD_REQUEST

public static int HTTP_BAD_REQUEST

HTTP_NOT_IMPLEMENTED

public static int HTTP_NOT_IMPLEMENTED

HTTP_SERVICE_UNAVALIABLE

public static int HTTP_SERVICE_UNAVALIABLE

Constructor Detail

JsonPageTask

public JsonPageTask()

Create an JSON page task.

Method Detail

getPageId

public java.lang.String getPageId()

Get the identifier of the JSON page.

Returns:

The identifier.

setPageId

public void setPageId(java.lang.String pageId)

Set the identifier of the JSON page.

Parameters:

pageId - The identifier.

getPageContent

public java.lang.String getPageContent()

Get the content of the JSON page.

Returns:

The content.

setPageContent

public void setPageContent(java.lang.String jsonString)

Set the content of the JSON page. This MUST be a valid json string.

Parameters:

pageContent - The content.

setPageContent

public void setPageContent(JsonObject json)

Set the content of the JSON page.

Parameters:

pageContent - The content.

getMacros

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

Get the JSON page macro set.

Returns:

The macro set.

setMacros

public void setMacros(java.util.Map<java.lang.String,java.lang.String> macros)

Set the JSON page macro set.

Parameters:

macros - The macro set.

getMacro

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

Get the value of the JSON page macro with the specified name.

Parameters:

name - The name.

Returns:

The value.

setMacro

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

Set the value of the JSON page macro with the specified name with the specified value.

Parameters:

name - The name.

value - The value.

setMacro

public void setMacro(java.lang.String name,
                     JsonValue value)

Set the value of the JSON page macro with the specified name with the specified value.

Parameters:

name - The name.

value - The value.

setStatusCode

public void setStatusCode(int code)

Set the HTTP stataus code returned to the user

Parameters:

code - HTTP status code to set

getStatusCode

public java.lang.Integer getStatusCode()

Get the current status code of the return task

Returns:

HTTP status code

execute

public void execute(AuthenticationMechanismContext context)

Description copied from interface: AuthenticationMechanismResultTask

This method is invoked by authentication service when it processes the authentication result. Authentication service passes the specified authentication context.

Specified by:

execute in interface AuthenticationMechanismResultTask

Parameters:

context - The authentication context.