com.microfocus.android.mobile.sdk.library

Interface AuthenticatorBuilder

public interface AuthenticatorBuilder

A builder interface that enables construction of Authenticator instances.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DO_NOT_REFRESH_ACCESS_TOKEN_BEFORE_EXPIRATION

Method Summary

Modifier and Type	Method and Description
Authenticator	build() Construct an Authenticator using the settings currently contained in this builder instance.
AuthenticatorBuilder	setAccessTokenRefreshBeforeExpirationBy(long lAccessTokenRefreshBeforeExpirationBy) Set the number of milliseconds that defines the time window, before access token expiration, in which the access token will be refreshed even though it is not yet expired.
AuthenticatorBuilder	setBrowserDescriptor(BrowserDescriptor browserDescriptor) Set the browser descriptor indicating which browser to use to perform the authentication.
AuthenticatorBuilder	setDisallowAccessTokenRefresh(boolean bDisallowAccessTokenRefresh) Set the flag to disallow the access token from being refreshed (a new token retrieved from the OAuth server) even if the current access token is expired.
AuthenticatorBuilder	setDisallowIdentityProviderRefresh(boolean bDisallowIdentityProviderRefresh) Set the flag to disallow the Identity Provider configuration from being discovered (retrieved from the OAuth server) even if the discovery is required.
AuthenticatorBuilder	setDisallowRefreshTokenRefresh(boolean bDisallowRefreshTokenRefresh) Set the flag to disallow the refresh token from being refreshed (a new token retrieved from the OAuth server) even if there is no current refresh token.
AuthenticatorBuilder	setForceAccessTokenRefresh(boolean bForceAccessTokenRefresh) Set the flag to force the access token to be refreshed (a new token retrieved from the OAuth server) even if current access token is not expired.
AuthenticatorBuilder	setForceIdentityProviderRefresh(boolean bForceIdentityProviderRefresh) Set the flag to force the Identity Provider configuration to be discovered (retrieved from the OAuth server) even if the discovery is not necessarily required.
AuthenticatorBuilder	setForceRefreshTokenRefresh(boolean bForceRefreshTokenRefresh) Set the flag to force the refresh token to be refreshed (a new token retrieved from the OAuth server) even if there is a current refresh token.

Field Detail

DO_NOT_REFRESH_ACCESS_TOKEN_BEFORE_EXPIRATION

static final long DO_NOT_REFRESH_ACCESS_TOKEN_BEFORE_EXPIRATION

See Also:

Constant Field Values

Method Detail

setBrowserDescriptor

AuthenticatorBuilder setBrowserDescriptor(BrowserDescriptor browserDescriptor)

Set the browser descriptor indicating which browser to use to perform the authentication.

Parameters:

browserDescriptor - The browser descriptor indicating which browser to use to perform the authentication.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setAccessTokenRefreshBeforeExpirationBy

AuthenticatorBuilder setAccessTokenRefreshBeforeExpirationBy(long lAccessTokenRefreshBeforeExpirationBy)

Set the number of milliseconds that defines the time window, before access token expiration, in which the access token will be refreshed even though it is not yet expired.

Parameters:

lAccessTokenRefreshBeforeExpirationBy - The the number of milliseconds that defines the time window, before access token expiration, in which the access token will be refreshed even though it is not yet expired.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setForceIdentityProviderRefresh

AuthenticatorBuilder setForceIdentityProviderRefresh(boolean bForceIdentityProviderRefresh)

Set the flag to force the Identity Provider configuration to be discovered (retrieved from the OAuth server) even if the discovery is not necessarily required.

This flag is mutually exclusive to setDisallowIdentityProviderRefresh(boolean)

Parameters:

bForceIdentityProviderRefresh - 'true' to force the Identity Provider configuration to be discovered (retrieved from the OAuth server) even if the discovery is not necessarily required.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setForceAccessTokenRefresh

AuthenticatorBuilder setForceAccessTokenRefresh(boolean bForceAccessTokenRefresh)

Set the flag to force the access token to be refreshed (a new token retrieved from the OAuth server) even if current access token is not expired.

This flag is mutually exclusive to setDisallowAccessTokenRefresh(boolean)

Parameters:

bForceAccessTokenRefresh - 'true' to force the access token to be refreshed (a new token retrieved from the OAuth server) even if current access token is not expired

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setForceRefreshTokenRefresh

AuthenticatorBuilder setForceRefreshTokenRefresh(boolean bForceRefreshTokenRefresh)

Set the flag to force the refresh token to be refreshed (a new token retrieved from the OAuth server) even if there is a current refresh token.

This flag is mutually exclusive to setDisallowRefreshTokenRefresh(boolean)

Parameters:

bForceRefreshTokenRefresh - 'true' to force the refresh token to be refreshed (a new token retrieved from the OAuth server) even if there is a current refresh token.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setDisallowIdentityProviderRefresh

AuthenticatorBuilder setDisallowIdentityProviderRefresh(boolean bDisallowIdentityProviderRefresh)

Set the flag to disallow the Identity Provider configuration from being discovered (retrieved from the OAuth server) even if the discovery is required.

This flag is mutually exclusive to setForceIdentityProviderRefresh(boolean)

Parameters:

bDisallowIdentityProviderRefresh - 'true' to disallow the Identity Provider configuration from being discovered (retrieved from the OAuth server) even if the discovery is required.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setDisallowAccessTokenRefresh

AuthenticatorBuilder setDisallowAccessTokenRefresh(boolean bDisallowAccessTokenRefresh)

Set the flag to disallow the access token from being refreshed (a new token retrieved from the OAuth server) even if the current access token is expired.

This flag is mutually exclusive to setForceAccessTokenRefresh(boolean)

Parameters:

bDisallowAccessTokenRefresh - 'true' to disallow the access token from being refreshed (a new token retrieved from the OAuth server) even if current access token is expired.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

setDisallowRefreshTokenRefresh

AuthenticatorBuilder setDisallowRefreshTokenRefresh(boolean bDisallowRefreshTokenRefresh)

Set the flag to disallow the refresh token from being refreshed (a new token retrieved from the OAuth server) even if there is no current refresh token.

This flag is mutually exclusive to setForceRefreshTokenRefresh(boolean)

Parameters:

bDisallowRefreshTokenRefresh - 'true' to disallow the refresh token from being refreshed (a new token retrieved from the OAuth server) even if there is no current refresh token.

Returns:

The 'this' AuthenticatorBuilder reference. Will never return null.

build

Authenticator build()
             throws AuthenticatorException

Construct an Authenticator using the settings currently contained in this builder instance.

Returns:

A newly created Authenticator.

Throws:

AuthenticatorException - on any attempt to create an Authenticator with an invalid configuration.