com.microfocus.android.mobile.sdk.library

Interface AuthenticatorReport

All Superinterfaces:

Report

public interface AuthenticatorReport
extends Report

Interface that defines the functionality of a Authentication Report object.

Field Summary

Fields inherited from interface com.microfocus.android.mobile.sdk.library.Report

NOT_STARTED, NOT_STOPPED, UNKNOWN_EXPIRATION

Method Summary

Modifier and Type	Method and Description
boolean	accessTokenRefreshBeforeExpirationInitiated() Determine if the Access Token refresh profile was initiated during the authentication process.
boolean	accessTokenRefreshInitiated() Determine if the Access Token refresh profile was initiated during the authentication process.
java.util.Collection<java.lang.Exception>	getAccessTokenRefreshExceptions() Get the exception(s) throw during the Access Token Refresh profile execution.
java.util.Collection<java.lang.Exception>	getIdentityProviderConfigurationRefreshExceptions() Get the exception(s) throw during the Identity Provider Configuration Discovery profile execution.
java.util.Collection<java.lang.Exception>	getRefreshTokenRefreshExceptions() Get the exception(s) throw during the Refresh Token Refresh profile execution.
boolean	identityProviderConfigurationRefreshInitiated() Determine if the Identity Provider Configuration discovery profile was initiated during the authentication process.
boolean	refreshTokenRefreshInitiated() Determine if the Refresh Token refresh profile was initiated during the authentication process.

Methods inherited from interface com.microfocus.android.mobile.sdk.library.Report

existsAnyExceptions, getAccessToken, getAccessTokenExpirationTime, getAssociatedProcessUniqueId, getAuthenticatorExceptions, getCreationTime, getDuration, getDurationSinceCreation, getDurationSinceStarted, getDurationSinceStopped, getIdentityProvider, getRefreshToken, getStartTime, getStopTime, isAuthenticated, isStarted, isStopped

Method Detail

identityProviderConfigurationRefreshInitiated

boolean identityProviderConfigurationRefreshInitiated()

Determine if the Identity Provider Configuration discovery profile was initiated during the authentication process.

This information is probably not essential to the operation of any client implementation, but may be used for monitoring or statistics gathering.

Returns:

true iff the Identity Provider Configuration discovery profile was initiated during the authentication process.

getIdentityProviderConfigurationRefreshExceptions

java.util.Collection<java.lang.Exception> getIdentityProviderConfigurationRefreshExceptions()

Get the exception(s) throw during the Identity Provider Configuration Discovery profile execution.

Returns:

The Collection of Exception instances were thrown during the Identity Provider Configuration Discovery profile execution. The existence of an exception indicates that the profile did not run to successful completion. May be null if no exception exists.

accessTokenRefreshInitiated

boolean accessTokenRefreshInitiated()

Determine if the Access Token refresh profile was initiated during the authentication process. This is different from (@link #accessTokenRefreshBeforeExpirationInitiated()} in that the Access Token refresh profile was initiated because the access token was fully expired.

This information is probably not essential to the operation of any client implementation, but may be used for monitoring or statistics gathering.

Returns:

true iff the Access Token refresh profile was initiated during the authentication process.

accessTokenRefreshBeforeExpirationInitiated

boolean accessTokenRefreshBeforeExpirationInitiated()

Determine if the Access Token refresh profile was initiated during the authentication process. This is different from (@link #accessTokenRefreshInitiated()} in that the Access Token refresh profile was initiated because the access token was within the specified "before expiration" time window. The access token was not yet fully expired.

This information is probably not essential to the operation of any client implementation, but may be used for monitoring or statistics gathering.

Returns:

true iff the Access Token refresh profile was initiated during the authentication process.

getAccessTokenRefreshExceptions

java.util.Collection<java.lang.Exception> getAccessTokenRefreshExceptions()

Get the exception(s) throw during the Access Token Refresh profile execution.

Returns:

The Collection of Exception instances were thrown during the Access Token Refresh profile execution. The existence of an exception indicates that the profile did not run to successful completion. May be null if no exception exists.

refreshTokenRefreshInitiated

boolean refreshTokenRefreshInitiated()

Determine if the Refresh Token refresh profile was initiated during the authentication process.

This information is probably not essential to the operation of any client implementation, but may be used for monitoring or statistics gathering.

Returns:

true iff the Refresh Token refresh profile was initiated during the authentication process.

getRefreshTokenRefreshExceptions

java.util.Collection<java.lang.Exception> getRefreshTokenRefreshExceptions()

Get the exception(s) throw during the Refresh Token Refresh profile execution.

Returns:

The Collection of Exception instances were thrown during the Refresh Token Refresh profile execution. The existence of an exception indicates that the profile did not run to successful completion. May be null if no exception exists.