A B C D E F G H I M O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- accept(String, String, boolean, AppCompatActivity, FRAListener<Void>) - Method in class org.forgerock.android.auth.PushNotification
-
Accepts the push notification request with Biometric Authentication.
- accept(String, FRAListener<Void>) - Method in class org.forgerock.android.auth.PushNotification
-
Accepts the push notification request with the challenge response.
- accept(FRAListener<Void>) - Method in class org.forgerock.android.auth.PushNotification
-
Accepts the push authentication request.
- Account - Class in org.forgerock.android.auth
-
Account model represents an identity for the user with an issuer.
- Account(String, String, String, String, String, String, Calendar) - Constructor for class org.forgerock.android.auth.Account
-
Creates Account object with given information.
- Account.AccountBuilder - Class in org.forgerock.android.auth
-
Builder class responsible for producing Accounts.
- AccountBuilder() - Constructor for class org.forgerock.android.auth.Account.AccountBuilder
- accountName - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- algorithm - Variable in class org.forgerock.android.auth.OathMechanism
-
Algorithm of HMAC-based OTP
- algorithm - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- authenticate() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
- AuthenticatorException - Exception in org.forgerock.android.auth.exception
-
Represents an error on the Authenticator SDK.
- AuthenticatorException(String) - Constructor for exception org.forgerock.android.auth.exception.AuthenticatorException
-
Create a new exception containing a message.
- AuthenticatorException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.AuthenticatorException
-
Create a new exception containing a message.
B
- Base32String - Class in org.forgerock.android.auth.util
-
Encodes arbitrary byte arrays as case-insensitive base-32 strings.
- Base32String(String) - Constructor for class org.forgerock.android.auth.util.Base32String
- Base32String.DecodingException - Exception in org.forgerock.android.auth.util
- BIOMETRIC - org.forgerock.android.auth.PushType
-
Push to Biometric notification.
- BiometricAuth - Class in org.forgerock.android.auth.biometric
-
Helper class for managing Biometric Authentication Process.
- BiometricAuth(String, String, boolean, FragmentActivity, BiometricAuthCompletionHandler) - Constructor for class org.forgerock.android.auth.biometric.BiometricAuth
-
Initializes Biometric authentication with the caller and callback handlers.
- BiometricAuthCompletionHandler - Interface in org.forgerock.android.auth.biometric
-
Interface to listen to Biometric Authentication callbacks.
- build() - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Produces the Account object that was being constructed.
- build() - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Produce the described OathMechanism Token.
- build() - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Produce the described Mechanism.
- build() - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Build the notification.
- builder() - Static method in class org.forgerock.android.auth.Account
-
Returns a builder for creating an Account.
- builder() - Static method in class org.forgerock.android.auth.FRAClient
-
Obtain FRAClient builder.
- builder() - Static method in class org.forgerock.android.auth.HOTPMechanism
-
Returns a builder for creating a HOTPMechanism Mechanism.
- builder() - Static method in class org.forgerock.android.auth.PushMechanism
-
Returns a builder for creating the Push Mechanism.
- builder() - Static method in class org.forgerock.android.auth.PushNotification
-
Returns a builder for creating a PushNotification.
- builder() - Static method in class org.forgerock.android.auth.TOTPMechanism
-
Returns a builder for creating a TOTPMechanism Mechanism.
C
- CHALLENGE - org.forgerock.android.auth.PushType
-
Push to Challenge notification.
- ChallengeResponseException - Exception in org.forgerock.android.auth.exception
-
Represents an error in generate a challenge response.
- ChallengeResponseException(String) - Constructor for exception org.forgerock.android.auth.exception.ChallengeResponseException
-
Create a new exception containing a message.
- ChallengeResponseException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.ChallengeResponseException
-
Create a new exception containing a message.
- clone() - Method in class org.forgerock.android.auth.util.Base32String
- compareTo(Account) - Method in class org.forgerock.android.auth.Account
- compareTo(Mechanism) - Method in class org.forgerock.android.auth.Mechanism
- compareTo(PushNotification) - Method in class org.forgerock.android.auth.PushNotification
- counter - Variable in class org.forgerock.android.auth.HOTPMechanism
-
Counter as in Int for number of OTP credentials generated
- createMechanismFromUri(String, FRAListener<Mechanism>) - Method in class org.forgerock.android.auth.FRAClient
-
Create a Mechanism using the URL extracted from the QRCode.
D
- decode(String) - Static method in class org.forgerock.android.auth.util.Base32String
- decodeInternal(String) - Method in class org.forgerock.android.auth.util.Base32String
- DecodingException(String) - Constructor for exception org.forgerock.android.auth.util.Base32String.DecodingException
- DEFAULT - org.forgerock.android.auth.PushType
-
Default.
- deny(FRAListener<Void>) - Method in class org.forgerock.android.auth.PushNotification
-
Deny any type of push authentication request.
- deserialize(String) - Static method in class org.forgerock.android.auth.Account
-
Deserializes the specified Json into an object of the
Accountobject. - deserialize(String) - Static method in class org.forgerock.android.auth.HOTPMechanism
-
Deserializes the specified Json into an object of the
HOTPMechanismobject. - deserialize(String) - Static method in class org.forgerock.android.auth.Mechanism
-
Deserializes the specified Json into an object of the
Mechanismobject. - deserialize(String) - Static method in class org.forgerock.android.auth.OathMechanism
-
Deserializes the specified Json into an object of the
OathMechanismobject. - deserialize(String) - Static method in class org.forgerock.android.auth.PushMechanism
-
Deserializes the specified Json into an object of the
PushMechanismobject. - deserialize(String) - Static method in class org.forgerock.android.auth.PushNotification
-
Deserializes the specified Json into an object of the
PushNotificationobject. - deserialize(String) - Static method in class org.forgerock.android.auth.TOTPMechanism
-
Deserializes the specified Json into an object of the
TOTPMechanismobject. - DeviceCredentialFragment - Class in org.forgerock.android.auth.biometric
-
Headless Fragment to receive result from KeyguardManager library.
- DeviceCredentialFragment() - Constructor for class org.forgerock.android.auth.biometric.DeviceCredentialFragment
- digits - Variable in class org.forgerock.android.auth.OathMechanism
-
Digits as in Int for length of OTP credentials
- digits - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- DuplicateMechanismException - Exception in org.forgerock.android.auth.exception
-
Represents an error in setting up a mechanism, caused by a matching mechanism already existing.
- DuplicateMechanismException(String, Mechanism) - Constructor for exception org.forgerock.android.auth.exception.DuplicateMechanismException
-
Create a new exception containing a message.
E
- encode(byte[]) - Static method in class org.forgerock.android.auth.util.Base32String
- encodeInternal(byte[]) - Method in class org.forgerock.android.auth.util.Base32String
- equals(Object) - Method in class org.forgerock.android.auth.Account
- equals(Object) - Method in class org.forgerock.android.auth.Mechanism
- equals(Object) - Method in class org.forgerock.android.auth.PushNotification
- ERROR_NO_BIOMETRICS - Static variable in class org.forgerock.android.auth.biometric.BiometricAuth
- ERROR_NO_DEVICE_CREDENTIAL - Static variable in class org.forgerock.android.auth.biometric.BiometricAuth
F
- FRAClient - Class in org.forgerock.android.auth
-
The top level FRAClient object represents the Authenticator module of the ForgeRock Mobile SDK.
- FRAClient.FRAClientBuilder - Class in org.forgerock.android.auth
-
The asynchronous Authenticator client builder.
- FRAClientBuilder() - Constructor for class org.forgerock.android.auth.FRAClient.FRAClientBuilder
- FRAListener<T> - Interface in org.forgerock.android.auth
-
Listener to listen for event
- fromString(String) - Static method in enum org.forgerock.android.auth.PushType
-
Return the push type for a given string.
G
- getAccount(String) - Method in class org.forgerock.android.auth.FRAClient
-
Get the Account object with its id.
- getAccount(String) - Method in interface org.forgerock.android.auth.StorageClient
-
Get the Account object with its id
- getAccount(Mechanism) - Method in class org.forgerock.android.auth.FRAClient
-
Get the Account object with its associated Mechanism.
- getAccountName() - Method in class org.forgerock.android.auth.Account
-
Returns the name of this account.
- getAccountName() - Method in class org.forgerock.android.auth.Mechanism
-
Returns the name of this Account.
- getActivity() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
-
Return the activity of the client application that will host the prompt.
- getAlgorithm() - Method in class org.forgerock.android.auth.OathMechanism
-
Returns the algorithm used by this OathMechanism.
- getAllAccounts() - Method in class org.forgerock.android.auth.FRAClient
-
Get all accounts stored in the system.
- getAllAccounts() - Method in interface org.forgerock.android.auth.StorageClient
-
Get all accounts stored in the system.
- getAllNotifications() - Method in class org.forgerock.android.auth.FRAClient
-
Get single list of notifications across all mechanisms.
- getAllNotifications() - Method in class org.forgerock.android.auth.PushMechanism
-
Get all of the notifications that belong to this Push mechanism.
- getAllNotifications() - Method in interface org.forgerock.android.auth.StorageClient
-
Get all notifications from the storage system.
- getAllNotifications(Mechanism) - Method in class org.forgerock.android.auth.FRAClient
-
Get all of the notifications that belong to a
PushMechanismobject. - getAllNotificationsForMechanism(Mechanism) - Method in interface org.forgerock.android.auth.StorageClient
-
Get all notifications for within the mechanism.
- getAmlbCookie() - Method in class org.forgerock.android.auth.PushNotification
-
Get load balance cookie from OpenAM
- getBackgroundColor() - Method in class org.forgerock.android.auth.Account
-
Gets the background color for the IDP that issued this account.
- getBiometricAuthListener() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
-
Return the Biometric Authentication listener used to return authentication result.
- getCausingMechanism() - Method in exception org.forgerock.android.auth.exception.DuplicateMechanismException
- getChallenge() - Method in class org.forgerock.android.auth.PushNotification
-
Get challenge from message payload
- getContextInfo() - Method in class org.forgerock.android.auth.PushNotification
-
Get the contextual information to this notification.
- getCurrentCode() - Method in class org.forgerock.android.auth.OathTokenCode
-
Gets the code which is currently active.
- getCurrentTimeMillis() - Method in class org.forgerock.android.auth.util.TimeKeeper
-
Get the current time in milliseconds.
- getCustomPayload() - Method in class org.forgerock.android.auth.PushNotification
-
Get the custom attributes added to this notification.
- getDigits() - Method in class org.forgerock.android.auth.OathMechanism
-
Returns the number of digits that are in OTPs generated by this Token.
- getDisplayAccountName() - Method in class org.forgerock.android.auth.Account
-
Returns the name of this account.
- getDisplayIssuer() - Method in class org.forgerock.android.auth.Account
-
Gets the alternative name of the IDP that issued this account.
- getId() - Method in class org.forgerock.android.auth.Account
-
Gets the unique identifier for the Account.
- getId() - Method in class org.forgerock.android.auth.Mechanism
-
Gets the storage id of the Mechanism.
- getId() - Method in class org.forgerock.android.auth.PushNotification
-
Gets the unique identifier for the PushNotification.
- getImageURL() - Method in class org.forgerock.android.auth.Account
-
Gets the image URL for the IDP that issued this account.
- getIssuer() - Method in class org.forgerock.android.auth.Account
-
Gets the name of the IDP that issued this account.
- getIssuer() - Method in class org.forgerock.android.auth.Mechanism
-
Gets the name of the IDP that issued this account.
- getKeyguardManager() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
-
Return the mechanism used to lock and unlock the device.
- getMechanism(PushNotification) - Method in class org.forgerock.android.auth.FRAClient
-
Get the Mechanism object associated with the PushNotification object.
- getMechanismByUUID(String) - Method in interface org.forgerock.android.auth.StorageClient
-
Get the mechanism by UUID.
- getMechanisms() - Method in class org.forgerock.android.auth.Account
-
Get the list of mechanisms associates with this account.
- getMechanismsForAccount(Account) - Method in interface org.forgerock.android.auth.StorageClient
-
Get the mechanisms associated with an account.
- getMechanismUID() - Method in class org.forgerock.android.auth.Mechanism
-
Get the mechanism unique Id.
- getMechanismUID() - Method in class org.forgerock.android.auth.PushNotification
-
Get the mechanism Id that this notification was intended for.
- getMessage() - Method in class org.forgerock.android.auth.PushNotification
-
Get the message of this notification
- getMessageId() - Method in class org.forgerock.android.auth.PushNotification
-
Get the message Id of this notification
- getNotification(String) - Method in class org.forgerock.android.auth.FRAClient
-
Get the PushNotification object with its id.
- getNotification(String) - Method in interface org.forgerock.android.auth.StorageClient
-
Get the PushNotification object with its id
- getNumbersChallenge() - Method in class org.forgerock.android.auth.PushNotification
-
Get numbers used for push challenge
- getOathTokenCode() - Method in class org.forgerock.android.auth.HOTPMechanism
- getOathTokenCode() - Method in class org.forgerock.android.auth.OathMechanism
-
Generates a new set of codes for this OathMechanism Token.
- getOathTokenCode() - Method in class org.forgerock.android.auth.TOTPMechanism
- getOathType() - Method in class org.forgerock.android.auth.OathMechanism
-
Returns the token type (HOTPMechanism, TOTPMechanism).
- getOathType() - Method in class org.forgerock.android.auth.OathTokenCode
-
Returns the token type (HOTP, TOTP)
- getPendingNotifications() - Method in class org.forgerock.android.auth.PushMechanism
-
Get pending notifications that belong to this Push mechanism.
- getPeriod() - Method in class org.forgerock.android.auth.TOTPMechanism
-
Returns the period of this OathMechanism.
- getProgress() - Method in class org.forgerock.android.auth.OathTokenCode
-
Get the current percent progress of the code for
TOTPMechanism. - getPushType() - Method in class org.forgerock.android.auth.PushNotification
-
Get the type of Push notification.
- getStart() - Method in class org.forgerock.android.auth.OathTokenCode
-
Get the started timestamp of current Oath token.
- getSubtitle() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
-
The subtitle to be displayed on the prompt.
- getThis() - Method in class org.forgerock.android.auth.HOTPMechanism.HOTPBuilder
- getThis() - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
- getThis() - Method in class org.forgerock.android.auth.TOTPMechanism.TOTPBuilder
- getTimeAdded() - Method in class org.forgerock.android.auth.Account
-
Get the Date and Time this Account was stored.
- getTimeAdded() - Method in class org.forgerock.android.auth.Mechanism
-
Get the Date and Time this mechanism was stored.
- getTimeAdded() - Method in class org.forgerock.android.auth.PushNotification
-
Get the time that this notification was received.
- getTimeExpired() - Method in class org.forgerock.android.auth.PushNotification
-
Get the time that the notification will or did expire.
- getTitle() - Method in class org.forgerock.android.auth.biometric.BiometricAuth
-
The title to be displayed on the prompt.
- getTtl() - Method in class org.forgerock.android.auth.PushNotification
-
Get time-to-live value from message payload
- getType() - Method in class org.forgerock.android.auth.Mechanism
-
Get the string used to represent this type of mechanism.
- getUntil() - Method in class org.forgerock.android.auth.OathTokenCode
-
Get the expiration timestamp for TOTP tokens.
H
- handleMessage(RemoteMessage) - Method in class org.forgerock.android.auth.FRAClient
-
Receives a FCM remote message and covert into a
PushNotificationobject, which allows accept or deny Push Authentication requests. - handleMessage(String, String) - Method in class org.forgerock.android.auth.FRAClient
-
Receives the parameters from a FCM remote message and covert into a
PushNotificationobject, which allows accept or deny Push Authentication requests. - hashCode() - Method in class org.forgerock.android.auth.Account
- hashCode() - Method in class org.forgerock.android.auth.Mechanism
- hashCode() - Method in class org.forgerock.android.auth.PushNotification
- HOTP - org.forgerock.android.auth.OathMechanism.TokenType
- HOTPBuilder() - Constructor for class org.forgerock.android.auth.HOTPMechanism.HOTPBuilder
- HOTPMechanism - Class in org.forgerock.android.auth
-
Represents HMAC-based OTP authentication mechanism and is responsible for its related operation.
- HOTPMechanism.HOTPBuilder - Class in org.forgerock.android.auth
-
Builder class responsible for producing a TOTPMechanism Token.
I
- InvalidNotificationException - Exception in org.forgerock.android.auth.exception
-
Represents an error on creating a PushNotification.
- InvalidNotificationException(String) - Constructor for exception org.forgerock.android.auth.exception.InvalidNotificationException
-
Create a new exception containing a message.
- InvalidNotificationException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.InvalidNotificationException
-
Create a new exception containing a message.
- isApproved() - Method in class org.forgerock.android.auth.PushNotification
-
Determine whether the authentication the notification is related to succeeded.
- isEmpty() - Method in interface org.forgerock.android.auth.StorageClient
-
Whether the storage system currently contains any data.
- isExpired() - Method in class org.forgerock.android.auth.PushNotification
-
Determine if the notification has expired.
- isPending() - Method in class org.forgerock.android.auth.PushNotification
-
Determines if the PushNotification has been interacted with by the user.
- issuer - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- isValid() - Method in class org.forgerock.android.auth.OathTokenCode
-
Indicates whether the current OathTokenCode is valid or not.
M
- matches(Account) - Method in class org.forgerock.android.auth.Account
- matches(Mechanism) - Method in class org.forgerock.android.auth.Mechanism
- matches(PushNotification) - Method in class org.forgerock.android.auth.PushNotification
- Mechanism - Class in org.forgerock.android.auth
-
The Mechanism model represents the two-factor way used for authentication.
- Mechanism(String, String, String, String, String, Calendar) - Constructor for class org.forgerock.android.auth.Mechanism
-
Base constructor which encapsulates common elements of all Mechanisms.
- MechanismCreationException - Exception in org.forgerock.android.auth.exception
-
Represents an error in setting up a mechanism.
- MechanismCreationException(String) - Constructor for exception org.forgerock.android.auth.exception.MechanismCreationException
-
Create a new exception containing a message.
- MechanismCreationException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.MechanismCreationException
-
Create a new exception containing a message.
- MechanismParsingException - Exception in org.forgerock.android.auth.exception
-
Represents an error in parsing a Configuration URI, or in creating a Configuration URI from a set of attributes.
- MechanismParsingException(String) - Constructor for exception org.forgerock.android.auth.exception.MechanismParsingException
-
Create a new exception containing a message.
- MechanismParsingException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.MechanismParsingException
-
Create a new exception containing a message.
- mechanismUID - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
O
- OATH - Static variable in class org.forgerock.android.auth.Mechanism
- OathBuilder() - Constructor for class org.forgerock.android.auth.OathMechanism.OathBuilder
- OathMechanism - Class in org.forgerock.android.auth
-
Represents an instance of a OATH authentication mechanism.
- OathMechanism(String, String, String, String, OathMechanism.TokenType, String, String, int, Calendar) - Constructor for class org.forgerock.android.auth.OathMechanism
- OathMechanism.OathBuilder<T extends OathMechanism.OathBuilder> - Class in org.forgerock.android.auth
-
Builder class responsible for producing a Token.
- OathMechanism.TokenType - Enum in org.forgerock.android.auth
- OathMechanismException - Exception in org.forgerock.android.auth.exception
-
Represents an error on generating OTP codes.
- OathMechanismException(String) - Constructor for exception org.forgerock.android.auth.exception.OathMechanismException
-
Create a new exception containing a message.
- OathMechanismException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.OathMechanismException
-
Create a new exception containing a message.
- OathTokenCode - Class in org.forgerock.android.auth
-
Represents a currently active OTP token.
- OathTokenCode(TimeKeeper, String, long, long, OathMechanism.TokenType) - Constructor for class org.forgerock.android.auth.OathTokenCode
-
Creates a OathTokenCode wrap with given data
- onActivityResult(int, int, Intent) - Method in class org.forgerock.android.auth.biometric.DeviceCredentialFragment
- onCreate(Bundle) - Method in class org.forgerock.android.auth.biometric.DeviceCredentialFragment
- onError(int, String) - Method in interface org.forgerock.android.auth.biometric.BiometricAuthCompletionHandler
-
Called when the Biometric Authentication fails to complete.
- onException(Exception) - Method in interface org.forgerock.android.auth.FRAListener
-
Called when an asynchronous call fails to complete.
- onSuccess(BiometricPrompt.AuthenticationResult) - Method in interface org.forgerock.android.auth.biometric.BiometricAuthCompletionHandler
-
Called when the Biometric Authentication completes successfully.
- onSuccess(T) - Method in interface org.forgerock.android.auth.FRAListener
-
Called when an asynchronous call completes successfully.
- org.forgerock.android.auth - package org.forgerock.android.auth
- org.forgerock.android.auth.biometric - package org.forgerock.android.auth.biometric
- org.forgerock.android.auth.exception - package org.forgerock.android.auth.exception
- org.forgerock.android.auth.util - package org.forgerock.android.auth.util
P
- PUSH - Static variable in class org.forgerock.android.auth.Mechanism
- PushBuilder() - Constructor for class org.forgerock.android.auth.PushMechanism.PushBuilder
- PushMechanism - Class in org.forgerock.android.auth
-
Represents an instance of a Push authentication mechanism.
- PushMechanism.PushBuilder - Class in org.forgerock.android.auth
-
Builder class responsible for building a Push mechanism.
- PushMechanismException - Exception in org.forgerock.android.auth.exception
-
Represents an error in process a PushMechanism registration or PushMechanism authentication request.
- PushMechanismException(String) - Constructor for exception org.forgerock.android.auth.exception.PushMechanismException
-
Create a new exception containing a message.
- PushMechanismException(String, Throwable) - Constructor for exception org.forgerock.android.auth.exception.PushMechanismException
-
Create a new exception containing a message.
- PushNotification - Class in org.forgerock.android.auth
-
PushNotification is a model class which represents a message that was received from an external source.
- PushNotification.PushNotificationBuilder - Class in org.forgerock.android.auth
-
Builder class responsible for producing Notifications.
- PushNotificationBuilder() - Constructor for class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
- PushType - Enum in org.forgerock.android.auth
-
The supported Push types.
R
- registerForRemoteNotifications(String) - Method in class org.forgerock.android.auth.FRAClient
-
This method allows to register the FCM device token to handle Push mechanisms after the SDK initialization.
- removeAccount(Account) - Method in class org.forgerock.android.auth.FRAClient
-
Remove from the storage the
Accountthat was passed in, allMechanismobjects and anyPushNotificationobjects associated with it. - removeAccount(Account) - Method in interface org.forgerock.android.auth.StorageClient
-
Delete the Account that was passed in.
- removeMechanism(Mechanism) - Method in class org.forgerock.android.auth.FRAClient
-
Remove from the storage the
Mechanismthat was passed in and any notifications associated with it. - removeMechanism(Mechanism) - Method in interface org.forgerock.android.auth.StorageClient
-
Delete the mechanism uniquely identified by an id.
- removeNotification(PushNotification) - Method in class org.forgerock.android.auth.FRAClient
-
Remove from the storage the
PushNotificationthat was passed in. - removeNotification(PushNotification) - Method in interface org.forgerock.android.auth.StorageClient
-
Delete the pushNotification uniquely identified by an id.
S
- secret - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- setAccount(Account) - Method in interface org.forgerock.android.auth.StorageClient
-
Add or Update the Account to the storage system.
- setAccountName(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the name of the account.
- setAccountName(String) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the name of the account.
- setAccountName(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Sets the name of the account.
- setAlgorithm(String) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the algorithm used for generating the OTP.
- setAmlbCookie(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Set the he AM load balance cookie with this notification.
- setApproved(boolean) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets whether the authentication the notification is related to was approved.
- setAuthenticationEndpoint(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Set the endpoint that will be used for Push authentication
- setBackgroundColor(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the background color for the IDP that issued this account.
- setChallenge(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Set the challenge that was sent with this notification.
- setContextInfo(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets context information for this notification.
- setCounter(long) - Method in class org.forgerock.android.auth.HOTPMechanism.HOTPBuilder
-
Sets the counter for the OTP.
- setCustomPayload(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets custom attributes associated with this notification.
- setDigits(int) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the length of the OTP to generate.
- setDisplayAccountName(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the alternative name of the account.
- setDisplayAccountName(String) - Method in class org.forgerock.android.auth.Account
-
Sets an alternative name for the account.
- setDisplayIssuer(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the alternative name of the IDP that issued this account.
- setDisplayIssuer(String) - Method in class org.forgerock.android.auth.Account
-
Sets an alternative Issuer for this account.
- setImageURL(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the imageURL for the IDP that issued this account.
- setIssuer(String) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the name of the IDP that issued this account.
- setIssuer(String) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the name of the IDP that issued this account.
- setIssuer(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Sets the name of the IDP that issued this account.
- setMechanism(Mechanism) - Method in interface org.forgerock.android.auth.StorageClient
-
Add or update the mechanism to the storage system.
- setMechanismUID(String) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the mechanism unique Id.
- setMechanismUID(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Sets the mechanism unique Id.
- setMechanismUID(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the mechanism unique Id.
- setMessage(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the message that was received with this notification.
- setMessageId(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the message id that was received with this notification.
- setNotification(PushNotification) - Method in interface org.forgerock.android.auth.StorageClient
-
Add or update the pushNotification to the storage system.
- setNumbersChallenge(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the numbers used in the Push challenge.
- setPending(boolean) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets whether the authentication the notification is related to has been handled.
- setPeriod(int) - Method in class org.forgerock.android.auth.TOTPMechanism.TOTPBuilder
-
Sets the frequency with which the OTP changes.
- setPushType(String) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the type of Push notification.
- setRegistrationEndpoint(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Set the endpoint that will be used for Push registration.
- setSecret(String) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the secret used for generating the OTP.
- setSecret(String) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Set the secret that this mechanism shares with the server.
- setTimeAdded(Calendar) - Method in class org.forgerock.android.auth.Account.AccountBuilder
-
Sets the Date and Time this Account was stored.
- setTimeAdded(Calendar) - Method in class org.forgerock.android.auth.OathMechanism.OathBuilder
-
Sets the Date and Time this mechanism was stored.
- setTimeAdded(Calendar) - Method in class org.forgerock.android.auth.PushMechanism.PushBuilder
-
Sets the Date and Time this mechanism was stored.
- setTimeAdded(Calendar) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the date that the notification was received.
- setTimeExpired(Calendar) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the date that the notification will automatically fail.
- setTtl(long) - Method in class org.forgerock.android.auth.PushNotification.PushNotificationBuilder
-
Sets the time to live for the notification.
- start() - Method in class org.forgerock.android.auth.FRAClient.FRAClientBuilder
-
Initialize the authenticator client
FRAClient. - StorageClient - Interface in org.forgerock.android.auth
-
Data Access interface used to store and load Accounts, Mechanisms and Notifications.
T
- timeAdded - Variable in class org.forgerock.android.auth.OathMechanism.OathBuilder
- TimeKeeper - Class in org.forgerock.android.auth.util
-
Class used to wrap timekeeping functionality.
- TimeKeeper() - Constructor for class org.forgerock.android.auth.util.TimeKeeper
- timeTravel(long) - Method in class org.forgerock.android.auth.util.TimeKeeper
-
Throws a RuntimeException by default.
- toJson() - Method in class org.forgerock.android.auth.Account
- toJson() - Method in class org.forgerock.android.auth.HOTPMechanism
- toJson() - Method in class org.forgerock.android.auth.Mechanism
- toJson() - Method in class org.forgerock.android.auth.OathMechanism
- toJson() - Method in class org.forgerock.android.auth.OathTokenCode
-
Creates a JSON string representation of
OathTokenCodeobject. - toJson() - Method in class org.forgerock.android.auth.PushMechanism
- toJson() - Method in class org.forgerock.android.auth.PushNotification
- toJson() - Method in class org.forgerock.android.auth.TOTPMechanism
- TOTP - org.forgerock.android.auth.OathMechanism.TokenType
- TOTPBuilder() - Constructor for class org.forgerock.android.auth.TOTPMechanism.TOTPBuilder
- TOTPMechanism - Class in org.forgerock.android.auth
-
Represents Time-based OTP authentication mechanism and is responsible for its related operation.
- TOTPMechanism.TOTPBuilder - Class in org.forgerock.android.auth
-
Builder class responsible for producing a TOTPMechanism Token.
U
- updateAccount(Account) - Method in class org.forgerock.android.auth.FRAClient
-
Update the
Accountobject the storage system.
V
- valueOf(String) - Static method in enum org.forgerock.android.auth.OathMechanism.TokenType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.forgerock.android.auth.PushType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.forgerock.android.auth.OathMechanism.TokenType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.forgerock.android.auth.PushType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- withContext(Context) - Method in class org.forgerock.android.auth.FRAClient.FRAClientBuilder
-
Initialize the FRAClient instance with an Android Context.
- withDeviceToken(String) - Method in class org.forgerock.android.auth.FRAClient.FRAClientBuilder
-
Initialize the FRAClient instance with the FCM device token obtained from FCM service
FirebaseMessagingService. - withStorage(StorageClient) - Method in class org.forgerock.android.auth.FRAClient.FRAClientBuilder
-
Initialize the FRAClient instance with a custom storage implementation.
All Classes All Packages