com.microfocus.android.mobile.sdk.library

Interface UnAuthenticatorBuilder

public interface UnAuthenticatorBuilder

A builder interface that enables construction of UnAuthenticator instances.

Field Summary

Fields

Modifier and Type	Field and Description
static long	TIMEOUT_DEFAULT
static long	TIMEOUT_MINIMUM

Method Summary

Modifier and Type	Method and Description
UnAuthenticator	build() Construct an UnAuthenticator using the settings currently contained in this builder instance.
UnAuthenticatorBuilder	setBrowserDescriptor(BrowserDescriptor browserDescriptor) Set the browser descriptor indicating which browser to use to perform the authentication.
UnAuthenticatorBuilder	setDisallowBrowserBasedLogout(boolean bDisallowBrowserBasedLogout) Set the flag to disallow browser based logout.
UnAuthenticatorBuilder	setDisallowTokenRevocation(boolean bDisallowTokenRevocation) Set the flag to disallow refresh token revocation.
UnAuthenticatorBuilder	setTimeout(long lTimeoutInMilliseconds) Set the maximum amount of time that the logout may consume.

Field Detail

TIMEOUT_DEFAULT

static final long TIMEOUT_DEFAULT

See Also:

Constant Field Values

TIMEOUT_MINIMUM

static final long TIMEOUT_MINIMUM

See Also:

Constant Field Values

Method Detail

setTimeout

UnAuthenticatorBuilder setTimeout(long lTimeoutInMilliseconds)

Set the maximum amount of time that the logout may consume. If this time limit is reached, then the UnAuthenticatorClientCallback will be called with a report containing all data gathered up to the time the time out happened.

Parameters:

lTimeoutInMilliseconds - The number of millseconds before the logout will auto-terminate.

Returns:

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

setDisallowTokenRevocation

UnAuthenticatorBuilder setDisallowTokenRevocation(boolean bDisallowTokenRevocation)

Set the flag to disallow refresh token revocation.

Parameters:

bDisallowTokenRevocation - 'true' to disallow the refresh token from being revoked at the identity provider. The defaulr behavior is to allow refresh token revocation.

Returns:

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

setDisallowBrowserBasedLogout

UnAuthenticatorBuilder setDisallowBrowserBasedLogout(boolean bDisallowBrowserBasedLogout)

Set the flag to disallow browser based logout. If browser based logout is not performed, then authentication cookies held by the browser remain in play and may cause an automatic login the next time the browser sends a request to the Identity Provider.

Parameters:

bDisallowBrowserBasedLogout - 'true' to disallow browser based logout from being performed at the identity provider. The defaulr behavior is to allow browser based logout.

Returns:

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

setBrowserDescriptor

UnAuthenticatorBuilder 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' UnAuthenticatorBuilder reference. Will never return null.

build

UnAuthenticator build()
               throws AuthenticatorException

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

Returns:

A newly created UnAuthenticator.

Throws:

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