forgerock-authenticator

4.4.0

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

PushMechanism

Represents an instance of a Push authentication mechanism. Associated with an Account.

Constructors

private constructor(mechanismUID: String, issuer: String, accountName: String, type: String, secret: String, registrationEndpoint: String, authenticationEndpoint: String, timeCreated: Calendar)

Creates a Push mechanism with given data.

Types

PushBuilder

open class PushBuilder

Builder class responsible for building a Push mechanism.

Properties

account

private open var account: Account

The Account associated with this mechanism

accountName

val accountName: String

AccountName, or Username of the account for the issuer

authenticationEndpoint

private open var authenticationEndpoint: String

The authentication URL for Push mechanism

open val id: String

Unique identifier of the Mechanism

issuer

val issuer: String

Issuer of the account

mechanismUID

val mechanismUID: String

Uniquely identifiable UUID for current mechanism

MFAUTH

val MFAUTH: String = "mfauth"

URI scheme for combined registration OATH and PUSH at once

OATH

val OATH: String = "otpauth"

URI scheme for OATH registration

PUSH

val PUSH: String = "pushauth"

URI scheme for PUSH registration

pushNotificationList

private open var pushNotificationList: List<PushNotification>

List of PushNotification objects associated with this mechanism

registrationEndpoint

private open var registrationEndpoint: String

The registration URL for Push mechanism

secret

private val secret: String

The shared secret of the Mechanism

timeAdded

val timeAdded: Calendar

Date this object was stored

type

val type: String

The type of the Mechanism

Functions

builder

open fun builder(): PushMechanism.PushBuilder

Returns a builder for creating the Push Mechanism.

compareTo

abstract fun compareTo(p: T): Int

open fun compareTo(another: Mechanism): Int

deserialize

open fun deserialize(jsonString: String): Mechanism

Deserializes the specified Json into an object of the Mechanism object.

open fun deserialize(jsonString: String): PushMechanism

Deserializes the specified Json into an object of the PushMechanism object.

equals

open fun equals(o: Any): Boolean

getAccount

open fun getAccount(): Account

Gets the account object associated with the mechanism.

getAccountId

open fun getAccountId(): String

Gets the storage Account id associated with this Mechanism.

getAllNotifications

open fun getAllNotifications(): List<PushNotification>

Get all of the notifications that belong to this Push mechanism.

getAuthenticationEndpoint

open fun getAuthenticationEndpoint(): String

The authentication URL for Push mechanism.

getDate

open fun getDate(milliSeconds: Long): Calendar

Return date from milliseconds.

getPendingNotifications

open fun getPendingNotifications(): List<PushNotification>

Get pending notifications that belong to this Push mechanism.

getRegistrationEndpoint

open fun getRegistrationEndpoint(): String

The registration URL for Push mechanism.

getSecret

open fun getSecret(): String

Get the string used to represent the shared secret of the mechanism.

hashCode

open fun hashCode(): Int

matches

fun matches(other: Mechanism): Boolean

abstract fun matches(object: T): Boolean

Returns true if the two objects would conflict if added to a storage system.

serialize

open fun serialize(): String

Serializes the T object into its equivalent Json representation.

setAccount

open fun setAccount(account: Account)

Sets the account object associated with the mechanism.

setPushNotificationList

open fun setPushNotificationList(pushNotificationList: List<PushNotification>)

toJson

open fun toJson(): String

Creates a JSON string representation of T object.