forgerock-auth

ConfigHelper Provide the helper methods to persist and load the configurations on start of the SDK This class also verify if the configuration changes on the current and previous launch.

CookieMarshaller

open class CookieMarshaller

Class to support marshal and unmarshal of Cookie Object

DefaultSingleSignOnManager

open class DefaultSingleSignOnManager : SingleSignOnManager, ResponseHandler

Manage the Single Sign On Token, the token will be encrypted and store to SharedPreferences.

DefaultTokenManager

open class DefaultTokenManager : TokenManager

Default implementation for TokenManager.

DeviceIdentifier

open class DeviceIdentifier

Model of Device Identifier

EventDispatcher

open class EventDispatcher : Observable

Dispatch an event to Observer(s) which listens for the event.

ExchangeAccessTokenInterceptor

open class ExchangeAccessTokenInterceptor : Interceptor<T>

Interceptor to intercept the received authorization code and exchange to AccessToken.

FRAuth

open class FRAuth

Model of an FRAuth.

FRDevice

open class FRDevice

FRLifecycle

open class FRLifecycle

Class for handling SDK Lifecycle event.

FRLifecycleListener

interface FRLifecycleListener

Listener to listen for FR SDK Event

FRListener

interface FRListener<T>

Listener to listen for event

FRListenerFuture

open class FRListenerFuture<T> : FRListener<T> , Future<V>

A Future represents the result of an FRListener

FROptions

data class FROptions(val server: Server, val oauth: OAuth, val service: Service, val urlPath: UrlPath, val sslPinning: SSLPinning, val logger: Log)

Manages SDK configuration information

FROptionsBuilder

class FROptionsBuilder

Option builder to build the SDK configuration information

FRSession

open class FRSession

Object which represent the User Session

FRUser

open class FRUser

FRUserKeys

class FRUserKeys @JvmOverloads constructor(val context: Context, val userKeyService: UserKeyService = UserDeviceKeyService( context))

Manage UserKey that created by the SDK The UserKey are created with DeviceBindingCallback

InitProvider

open class InitProvider : ContentProvider

Content Provider to register Activity Lifecycle Callbacks and keep track of the last active activity.

Interceptor

interface Interceptor<T>

Interceptor interface, generic interface for interceptor pattern.

InterceptorHandler

open class InterceptorHandler : Interceptor.Chain

Follow the Interceptor.Chain and executes each Interceptor in the chain.

Listener

open class Listener

Utility to send events to FRListener

Log

data class Log(val logLevel: Logger.Level? = null, val customLogger: FRLogger? = null)

Data class to set the log level and custom logger configurations

LoggerBuilder

class LoggerBuilder

Logger builder to build the SDK configuration information specific to loggers

Node

open class Node : Serializable

NodeInterceptorHandler

open class NodeInterceptorHandler : InterceptorHandler, NodeListener<T>

Follow the Interceptor.Chain and executes each Interceptor in the chain.

NodeListener

interface NodeListener<T> : FRListener<T>

Interface for an object that listens to changes resulting from a AuthService.

NodeListenerFuture

abstract class NodeListenerFuture<T> : NodeListener<T> , Future<V>

OAuth

data class OAuth(val oauthClientId: String = "", val oauthRedirectUri: String = "", val oauthScope: String = "", val oauthThresholdSeconds: Long = 0, val oauthCacheSeconds: Long = 0)

Data class for the OAuth configurations

OAuth2

open class OAuth2

Constants for OAuth

OAuth2Client

open class OAuth2Client

Class to handle OAuth2 related endpoint

OAuth2ResponseHandler

open class OAuth2ResponseHandler : ResponseHandler

Implementation for handling OAuth2Client response, and provide feedback to the registered FRListener

OAuthBuilder

class OAuthBuilder

Oauth builder to build the SDK configuration information specific to oauth

OAuthInterceptor

open class OAuthInterceptor : Interceptor<T>

Interceptor to intercept the received token and exchange to AccessToken.

PKCE

open class PKCE

Domain object to store PKCE related data.

PolicyAdvice

class PolicyAdvice(val type: String, val value: String) : Serializable

Domain object for advice. The Advice is received from resource API for Step up authentication

RemoteDeviceBindingRepository

internal class RemoteDeviceBindingRepository(val serverConfig: ServerConfig = Config.getInstance().serverConfig) : DeviceBindingRepository

ResponseHandler

interface ResponseHandler

RetrieveAccessTokenInterceptor

open class RetrieveAccessTokenInterceptor : Interceptor<T>

Interceptor to intercept the received token and exchange to AccessToken.

RetrieveSSOTokenInterceptor

open class RetrieveSSOTokenInterceptor : Interceptor<T>

Interceptor to intercept the received token and exchange to AccessToken.

SecureCookieJar

class SecureCookieJar(context: Context, singleSignOnManager: SingleSignOnManager?, cacheIntervalMillis: Long?) : CookieJar, OkHttpCookieInterceptor

SerializableCookie

open class SerializableCookie : Serializable

A Serializable Cookie Object

Server

data class Server(val url: String, val realm: String = "root", val timeout: Int = 30, val cookieName: String = "iPlanetDirectoryPro", val cookieCacheSeconds: Long = 0)

Data class for the server configurations

ServerBuilder

class ServerBuilder

Server builder to build the SDK configuration information specific to server

ServerConfig

open class ServerConfig : NetworkConfig

Manages Server configuration information

Service

data class Service(val authServiceName: String = "Login", val registrationServiceName: String = "Registration")

Data class for the Service configurations

ServiceBuilder

class ServiceBuilder

Service builder to build the SDK configuration information specific to services

SessionManager

open class SessionManager

Manage the user session

SharedPreferencesSignOnManager

open class SharedPreferencesSignOnManager : SingleSignOnManager

Manage SSO Token with SharedPreferences as the storage.

SingleSignOnInterceptor

open class SingleSignOnInterceptor : Interceptor<T>

Interceptor to intercept the received token.

SingleSignOnManager

interface SingleSignOnManager

Manage SSO related attributes

SSLPinning

data class SSLPinning(val buildSteps: List<BuildStep<OkHttpClient.Builder>> = emptyList(), val pins: List<String> = emptyList())

Data class for the SSL pinning configurations

SSLPinningBuilder

class SSLPinningBuilder

SSL builder to build the SDK configuration information specific to SSL

SSOBroadcastModel

internal class SSOBroadcastModel @JvmOverloads constructor(val context: Context? = InitProvider.getCurrentActivity(), val broadcastIntent: Intent = Intent(context?.resources?.getString(R.string.forgerock_sso_logout)))

SSOBroadcastModel to broadcast the SSO SignOut message to single sign on apps

SSOBroadcastReceiver

class SSOBroadcastReceiver(var config: Config? = null) : BroadcastReceiver

Broadcast receiver to receive the logout SSO message

SSOToken

open class SSOToken : Token

StringUtils

open class StringUtils

Utility class for handling Strings.

Token

open class Token(val value: String) : Serializable

Domain object to hold generic Token

TokenManager

interface TokenManager

Interface to Manage OAuth2 Tokens

UrlPath

data class UrlPath(val authenticateEndpoint: String? = null, val revokeEndpoint: String? = null, val sessionEndpoint: String? = null, val tokenEndpoint: String? = null, val userinfoEndpoint: String? = null, val authorizeEndpoint: String? = null, val endSessionEndpoint: String? = null)

Data class for the URL configurations

UrlPathBuilder

class UrlPathBuilder

URL Path builder to build the SDK configuration information specific to endpoints

UserInfo

open class UserInfo

This class hold the response of OpenId Connect userinfo endpoint

UserService

open class UserService : ResponseHandler

Service Client

WebAuthnDataRepository