forgerock-auth

4.8.0

forgerock-auth/org.forgerock.android.auth.callback/AbstractProtectCallback

AbstractProtectCallback

abstract class AbstractProtectCallback : AbstractCallback, NodeAware

Abstract Protect Callback that provides the raw content of the Callback, and common methods for sub classes to access.

Constructors

constructor(jsonObject: JSONObject, index: Int)

Constructor for AbstractProtectCallback. Capable of parsing the MetadataCallback used for Protect.

constructor()

Types

Companion

object Companion

Properties

_id

protected var _id: Int

content

protected var content: String

derivedCallback

protected var derivedCallback: Boolean

Indicates if this callback is derived from a MetadataCallback

node

private lateinit var node: Node

The Node that associate with this Callback

Functions

get_id

open override fun get_id(): Int

Return the unique id for this callback. The id only available with Callback that using PageCallback

getContent

open override fun getContent(): String

Return the raw content of the Callback.

getContentAsJson

protected open fun getContentAsJson(): JSONObject

getInput

private open fun getInput(content: JSONObject, index: Int): JSONObject

getInputValue

open fun getInputValue(): Any

Get the first value for input

open fun getInputValue(index: Int): Any

Get the value for input

getName

protected open fun getName(jsonObject: JSONObject): String

getNode

protected fun getNode(): Node

Get the Node that associate with this Callback

getType

abstract fun getType(): String

Return the type of the Callback, the type name should align with the Callback type returned from AM

setAttribute

protected abstract fun setAttribute(name: String, value: Any)

setClientError

fun setClientError(value: String, index: Int = 0)

Input the Client Error to the server

setClientErrorInHiddenCallback

private fun setClientErrorInHiddenCallback(value: String)

Set the client error to the HiddenValueCallback which associated with the Protect Callback.

setContent

protected open fun setContent(jsonObject: JSONObject)

Sets the value of the Callback

setNode

open override fun setNode(node: Node)

Inject the Node object

setValue

protected open fun setValue(value: Any)

Set the first value for input

protected open fun setValue(value: Any, index: Int)

Set the value for the input.