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 Object implements AuthenticationMechanismResultTask
This class represents a task that returns an JSON page.

  • Field Details

    • EMPTY_JSON

      public static final String EMPTY_JSON
      See Also:

    • 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 Details

    • JsonPageTask

      public JsonPageTask()
      Create an JSON page task.

  • Method Details

    • getPageId

      public String getPageId()
      Get the identifier of the JSON page.
      Returns:
      The identifier.

    • setPageId

      public void setPageId(String pageId)
      Set the identifier of the JSON page.
      Parameters:
      pageId - The identifier.

    • getPageContent

      public String getPageContent()
      Get the content of the JSON page.
      Returns:
      The content.

    • setPageContent

      public void setPageContent(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 Map<String,String> getMacros()
      Get the JSON page macro set.
      Returns:
      The macro set.

    • setMacros

      public void setMacros(Map<String,String> macros)
      Set the JSON page macro set.
      Parameters:
      macros - The macro set.

    • getMacro

      public String getMacro(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(String name, 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(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 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.