forgerock-authenticator

4.4.0

forgerock-authenticator/org.forgerock.android.auth/PushParser

PushParser

Provides the ability to parse URI scheme into a convenient format to use with configuring a PushMechanism to receive push notifications.

Constructors

PushParser

constructor()

Properties

ACCOUNT_NAME

val ACCOUNT_NAME: String = "accountname"

The identity account name

AM_LOAD_BALANCER_COOKIE

val AM_LOAD_BALANCER_COOKIE: String = "l"

The AM load balance cookie

AUTHENTICATION_ENDPOINT

val AUTHENTICATION_ENDPOINT: String = "a"

The endpoint used for authentication

BASE_64_AM_LOAD_BALANCER_COOKIE_KEY

private val BASE_64_AM_LOAD_BALANCER_COOKIE_KEY: String = "l"

BASE_64_URL_AUTH_ENDPOINT

private val BASE_64_URL_AUTH_ENDPOINT: String = "a"

BASE_64_URL_CHALLENGE

private val BASE_64_URL_CHALLENGE: String = "c"

BASE_64_URL_IMAGE

private val BASE_64_URL_IMAGE: String = "image"

BASE_64_URL_REG_ENDPOINT

private val BASE_64_URL_REG_ENDPOINT: String = "r"

BASE_64_URL_SHARED_SECRET

private val BASE_64_URL_SHARED_SECRET: String = "s"

BG_COLOR

val BG_COLOR: String = "b"

The identity color

CHALLENGE

val CHALLENGE: String = "c"

The challenge to use for the response

CONTEXT_INFO

val CONTEXT_INFO: String = "x"

The key for the context info.

CUSTOM_PAYLOAD

val CUSTOM_PAYLOAD: String = "p"

The Time To Live of the notification

IMAGE

val IMAGE: String = "image"

The identity image

ISSUER

val ISSUER: String = "issuer"

The IDP that issued the URI

MECHANISM_UID

val MECHANISM_UID: String = "u"

The mechanism UID associated with the notification

MESSAGE_ID

val MESSAGE_ID: String = "m"

The message id to use for response

NOTIFICATION_MESSAGE

val NOTIFICATION_MESSAGE: String = "m"

The notification message

NUMBERS_CHALLENGE

val NUMBERS_CHALLENGE: String = "n"

The key for the challenge numbers type.

POLICIES

val POLICIES: String = "policies"

The Authenticator Policies.

PUSH_TYPE

val PUSH_TYPE: String = "k"

The key for the push notification type.

REGISTRATION_ENDPOINT

val REGISTRATION_ENDPOINT: String = "r"

The endpoint used for registration

SCHEME

val SCHEME: String = "scheme"

The protocol of the URI

SHARED_SECRET

val SHARED_SECRET: String = "s"

The shared secret used for signing

SLASH

private val SLASH: String = "/"

TAG

private val TAG: String

TIME_INTERVAL

val TIME_INTERVAL: String = "i"

The time interval when the notification was created.

TTL

val TTL: String = "t"

The Time To Live of the notification

TYPE

val TYPE: String = "authority"

The type of OTP (TOTP or HOTP)

UNTITLED

val UNTITLED: String = "Untitled"

Unknown identity

VERSION

val VERSION: String = "version"

The URI API Version

Functions

containsNonEmpty

protected fun containsNonEmpty(values: Map<String, String>, key: String): Boolean

decodeValueWithValidation

open fun decodeValueWithValidation(data: Map<String, String>, key: String): Array<Byte>

getBase64DecodedString

protected open fun getBase64DecodedString(value: String): String

getUriParameters

protected open fun getUriParameters(uriString: String): Map<String, String>

isBase64Encoded

protected open fun isBase64Encoded(value: String): Boolean

map

fun map(uriScheme: String): Map<String, String>

Call through to map

postProcess

protected open fun postProcess(values: Map<String, String>): Map<String, String>

Validates the parsed URI values

recodeBase64UrlValueToBase64WithValidation

open fun recodeBase64UrlValueToBase64WithValidation(data: Map<String, String>, key: String): String

recodeBase64UrlValueToStringWithValidation

open fun recodeBase64UrlValueToStringWithValidation(data: Map<String, String>, key: String): String

split

protected open fun split(s: String, sep: String): Array<String>