Skip navigation links
A B C D E F G H I J K L M N O P R S T U W Y 

A

ACCESS_TOKEN_EXPIRATION_NO_AUTHENTICATION - Static variable in interface com.microfocus.android.mobile.sdk.library.ServiceContext
As a return value from ServiceContext#getTimeToAccessTokenExpiration(Context, String, String) indicates that no authentication information is available for the indicated Identity Provider, so the time to the access token's expiration could not be calculated.
ACCESS_TOKEN_EXPIRATION_NOT_FOUND - Static variable in interface com.microfocus.android.mobile.sdk.library.ServiceContext
As a return value from ServiceContext#getTimeToAccessTokenExpiration(Context, String, String) indicates that no access token was present in the authentication information for the indicated Identity Provider, so the time to the access token's expiration could not be calculated.
ACCESS_TOKEN_REFRESH_BEFORE_EXPIRATION_BY_DEFAULT - Static variable in interface com.microfocus.android.mobile.sdk.library.ServiceContext
The default value to use as the access token "refresh before exiration by" (1 minute).
ACCESS_TOKEN_REFRESH_REQUIRED_BUT_CLIENT_DISALLOWED - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
accessTokenRefreshBeforeExpirationInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Determine if the Access Token refresh profile was initiated during the authentication process.
accessTokenRefreshInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Determine if the Access Token refresh profile was initiated during the authentication process.
ACTIVE_AUTHENTICATION - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
AuthCodeCanceledActivity - Class in com.microfocus.android.mobile.sdk.library
Defines a callback invoked by the AppAuth SDK when the end user cancels the authentication process.
AuthCodeCanceledActivity() - Constructor for class com.microfocus.android.mobile.sdk.library.AuthCodeCanceledActivity
 
AuthCodeResolutionActivity - Class in com.microfocus.android.mobile.sdk.library
Defines a callback invoked by the AppAuth SDK when the end user completes the authentication process and the authorization code then needs to be resolved.
AuthCodeResolutionActivity() - Constructor for class com.microfocus.android.mobile.sdk.library.AuthCodeResolutionActivity
 
authenticate(Authenticator) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Initiate an authentication.
Authenticator - Interface in com.microfocus.android.mobile.sdk.library
Interface that defines the functionality of an Authenticator.
AUTHENTICATOR_CREATION_NO_APPLICATION_CONTEXT - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
AuthenticatorBuilder - Interface in com.microfocus.android.mobile.sdk.library
A builder interface that enables construction of Authenticator instances.
AuthenticatorClientCallback - Interface in com.microfocus.android.mobile.sdk.library
Defines the client implemented callback that is called when an Authenticator completes authentication.
AuthenticatorException - Exception in com.microfocus.android.mobile.sdk.library
Specific exceptions associated with the authentication process.
AuthenticatorReport - Interface in com.microfocus.android.mobile.sdk.library
Interface that defines the functionality of a Authentication Report object.

B

BROWSER_BASED_LOGOUT_CONFIGURATION_MISSING - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
browserBasedLogoutAborted() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout was aborted during the un-authentication process.
browserBasedLogoutDisallowed() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determines if the initiator of the un-authentication process set the flag disallowing browser based logout.
browserBasedLogoutFailed() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout failed during the un-authentication process.
browserBasedLogoutFinished() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout finished during the un-authentication process.
browserBasedLogoutInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout was attempted during the un-authentication process.
browserBasedLogoutStarted() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout started during the un-authentication process.
build() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
Construct an Authenticator using the settings currently contained in this builder instance.
build() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Construct an Identity Provider using the settings currently contained in this builder instance.
build() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
Construct an UnAuthenticator using the settings currently contained in this builder instance.

C

CANNOT_REUSE_AUTHENTICATOR - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
CLIENT_CALLBACK_MISSING - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
com.microfocus.android.mobile.sdk.library - package com.microfocus.android.mobile.sdk.library
Microfocus Android Mobile SDK
com.microfocus.android.mobile.sdk.library.util - package com.microfocus.android.mobile.sdk.library.util
 

D

DateTimeUtil - Class in com.microfocus.android.mobile.sdk.library.util
Utility class providing basic date and time functionality.
DAY_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 
deleteAuthentication(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Delete from persisted data the Authentication Information for the currently persisted Identity Provider.
deleteIdentityProvider(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Delete from persisted data the IdentityProvider instance.
DeviceUtil - Class in com.microfocus.android.mobile.sdk.library.util
Utility class providing basic device information.
DO_NOT_REFRESH_ACCESS_TOKEN_BEFORE_EXPIRATION - Static variable in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
 
doInBackground(Void...) - Method in class com.microfocus.android.mobile.sdk.library.InvokeTaskHttpGet
 

E

equals(Adapter, List<IdentityProvider>) - Static method in class com.microfocus.android.mobile.sdk.library.IdentityProviderUtil
Perform an order insensitive compare on two sets of Identity Provider objects.
existsAnyExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.Report
A convenience method that checks for existence of all kinds of Exceptions.

F

fromJsonAuthenticatorReport(String) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
A utility method to allow clients to create a AuthenticatorReport from a JSON representation.
fromJsonUnAuthenticatorReport(String) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
A utility method to allow clients to create a UnAuthenticatorReport from a JSON representation.

G

getAccessToken() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Get the access token.
getAccessToken() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Return the access token that was obtained by the Authenticator.
getAccessToken(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get the Access Token for the currently persisted Identity Provider.
getAccessTokenExpirationTime() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Return the expiration time of the access token.
getAccessTokenRefreshExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Get the exception(s) throw during the Access Token Refresh profile execution.
getAssociatedProcessUniqueId() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the unique identifier that may be used to correlate this report instance with any implementation instance objects associated with the process that created this report.
getAuthentication() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get from persisted data the Authentication Information for the currently persisted Identity Provider.
getAuthenticatorBuilder(Context, AuthenticatorClientCallback) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Obtain an Authenticator Builder object that can be used to instantiate a new Authenticator object.
getAuthenticatorExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the exception(s) throw by the Authenticator instance.
getAuthorizationEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 authorization end point URL.
getBrowserBasedLogoutExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Get the exception(s) throw during the browser based logout execution.
getClientId() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 client identifier.
getClientSecret() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 client secret.
getContentLength() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
 
getContentType() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Get the response content type.
getCreationTime() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the time stamp when the associated process was created.
getDestinationUrl() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Get the destination URL..
getDeviceID(Context) - Static method in class com.microfocus.android.mobile.sdk.library.util.DeviceUtil
 
getDeviceName(Context) - Static method in class com.microfocus.android.mobile.sdk.library.util.DeviceUtil
 
getDiscoveryEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 discovery end point URL.
getDuration() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the associated process duration
getDuration(long) - Static method in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 
getDurationSinceCreation() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the duration since the associated process was created.
getDurationSinceStarted() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the duration since the associated process started.
getDurationSinceStopped() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the duration since the associated process stopped.
getException() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Get the Exception that may have been placed in the task by the SDK framework or by the client implementation of doInBackground().
getHost() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the host name (domain name) as defined by the provider URL.
getHttpBinaryPayload() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
CLient implementations will call this method to get the binary payload once the task has been executed and completed.
getHttpResponseCode() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
CLient implementations will call this method to get the HTTP response code once the task has been executed and completed.
getIdentityProvider() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the IdentityProvider used to perform the associated process.
getIdentityProvider() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get the persisted IdentityProvider.
getIdentityProviderBuilder(String, String, String, String) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Obtain an Identity Provider Builder object that can be used to instantiate a new IdentityProvider object.
getIdentityProviderBuilder(String) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Obtain an Identity Provider Builder object that can be used to instantiate a new IdentityProvider object with a JSon document as the template.
getIdentityProviderBuilder(IdentityProvider) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Obtain an Identity Provider Builder object that can be used to instantiate a new IdentityProvider object with a IdentityProvider instance as the template.
getIdentityProviderConfigurationRefreshExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Get the exception(s) throw during the Identity Provider Configuration Discovery profile execution.
getInstance() - Static method in class com.microfocus.android.mobile.sdk.library.ServiceContextFactory
 
getKeyAge() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get the age of the current encryption key in millseconds since epoch.
getLogoutEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the identity provider specific logout end point url.
getProviderUrl() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the provider URL of the OAuth2 server.
getRedirectUri() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 redirect URI.
getRefreshToken() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Return the refresh token that was obtained by the Authenticator.
getRefreshToken(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get the Refresh Token for the currently persisted Identity Provider.
getRefreshTokenRefreshExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Get the exception(s) throw during the Refresh Token Refresh profile execution.
getRegistrationEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 client registration end point URL.
getRequestHeaders() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Get the HTTP request headers that will be included in the HTTP request.
getResponseHeaders() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
 
getScope() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 scope.
getStartTime() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the time stamp when associated process was started.
getStopTime() - Method in interface com.microfocus.android.mobile.sdk.library.Report
Get the time stamp when associated process was completed.
getStringIfDefined(JSONObject, String) - Static method in class com.microfocus.android.mobile.sdk.library.util.JsonUtil
 
getTimeToAccessTokenExpiration(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Get the amount of time until the next Access Token update needs to be performed for the currently persisted Identity Provider.
getTokenEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 token end point URL.
getTokenRevocationEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the refresh token revocation end point url.
getTokenRevocationExceptions() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Get the exception(s) throw during the token revocation execution.
getTokenRevocationMethod() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the refresh token revocation HTTP method: "POST" or "GET".
getTokenRevocationParameterFormatString() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the refresh token revocation parameter format string.
getType() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
getUnAuthenticatorBuilder(Context, UnAuthenticatorClientCallback) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Obtain an Un-Authenticator Builder object that can be used to instantiate a new UnAuthenticator object.
getUniqueId() - Method in interface com.microfocus.android.mobile.sdk.library.Authenticator
Get the unique identifier for an Authenticator.
getUniqueId() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticator
Get the unique identifier for an UnAuthenticator.
getUserInfoEndPoint() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the OAuth2 user information end point URL.

H

hash(int, Uri) - Static method in class com.microfocus.android.mobile.sdk.library.util.HashUtil
 
HashUtil - Class in com.microfocus.android.mobile.sdk.library.util
Utility class providing basic hashing functionality.
HOUR_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 

I

IDENTITY_PROVIDER_CREATION_NO_CLIENT_ID - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_CREATION_NO_CLIENT_SECRET - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_CREATION_NO_DISCOVERY_URL - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_CREATION_NO_PROVIDER_URL - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_CREATION_NO_REDIRECT_URI - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_NOT_RESOLVABLE - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_REFRESH_FORCED_BUT_NO_DISCOVERY_URL - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_REFRESH_REQUIRED_BUT_CLIENT_DISALLOWED - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IDENTITY_PROVIDER_REFRESH_REQUIRED_BUT_NO_DISCOVERY_URL - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
IdentityProvider - Interface in com.microfocus.android.mobile.sdk.library
Defines an OAuth2 Identity Provider with all of its associated identifiers and end points.
IdentityProviderBuilder - Interface in com.microfocus.android.mobile.sdk.library
A builder that enables construction of IdentityProvider instances.
identityProviderConfigurationRefreshInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Determine if the Identity Provider Configuration discovery profile was initiated during the authentication process.
identityProviderHostComparator - Static variable in class com.microfocus.android.mobile.sdk.library.IdentityProviderUtil
Use this comparator instance to sort IdentityProvider instances by host name.
IdentityProviderUtil - Class in com.microfocus.android.mobile.sdk.library
A helper class that defines convience methods for working with IdentityProvider instances.
IdentityProviderUtil() - Constructor for class com.microfocus.android.mobile.sdk.library.IdentityProviderUtil
 
INVOKE_PARAMETER_MISSING - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
InvokeClientCallback - Interface in com.microfocus.android.mobile.sdk.library
Defines the client implemented callback that is called when a call to ServiceContext#invoke(Context, InvokeTask, long) completes.
InvokeTask - Class in com.microfocus.android.mobile.sdk.library
The base asyc task class that allows calls to ServiceContext#invokeWithFreshToken(Context, InvokeTask, long) to be executed asynchronously and customized to perform client operations.
InvokeTask(String) - Constructor for class com.microfocus.android.mobile.sdk.library.InvokeTask
Minimal constructor.
InvokeTask(String, Map<String, String>, InvokeClientCallback) - Constructor for class com.microfocus.android.mobile.sdk.library.InvokeTask
Full parameter constructor.
InvokeTaskHttpGet - Class in com.microfocus.android.mobile.sdk.library
Convenience implementation of a InvokeTask that performs a simple HTTP GET to a destinationUrl and provides components of the response to the client process.
InvokeTaskHttpGet(String, Map<String, String>, InvokeClientCallback) - Constructor for class com.microfocus.android.mobile.sdk.library.InvokeTaskHttpGet
 
invokeWithFreshToken(Context, InvokeTask, long) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Invoke a client implemented task using an access token that will be automatically refreshed if need be.
isAccessTokenRefreshed() - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Determine if the access token required refresh.
isAccessTokenRefreshException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isAuthenticated() - Method in interface com.microfocus.android.mobile.sdk.library.Report
A convenience method that is equivalent to calling Report.getAccessToken() and Report.getRefreshToken() and then comparing the return values to null.
isAuthenticatorCreationException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isAuthenticatorException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isFailedUnAuthentication() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determines if the Un-Authentication process was a complete failure.
isIdentityProviderCreationException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isIdentityProviderRefreshException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isInvalidAuthenticateStateException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isMutuallyExclusiveFlagException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isPartialUnAuthentication() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determines if the Un-Authentication process was a partial failure/success.
isRefreshTokenRefreshException() - Method in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
isStarted() - Method in interface com.microfocus.android.mobile.sdk.library.Report
A convenience method equivalent to calling Report.getStartTime() and then comparing the returned value to Report.NOT_STARTED
isStopped() - Method in interface com.microfocus.android.mobile.sdk.library.Report
A convenience method equivalent to calling Report.getStopTime() and then comparing the returned value to Report.NOT_STOPPED
isSuccessfulUnAuthentication() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determines if the Un-Authentication process was a complete success.

J

JsonUtil - Class in com.microfocus.android.mobile.sdk.library.util
Utility class providing basic JSON functionality.

K

KEYAGE_UNKNOWN - Static variable in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Initial state of the age of the encryption key.

L

logoutTimedOut() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the browser based logout timed out before all required operations were completed.

M

MAGIC_PRIME - Static variable in class com.microfocus.android.mobile.sdk.library.util.HashUtil
 
MINUTE_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 
MUTUALLY_EXCLUSIVE_FLAGS_ACCESS_TOKEN_REFRESH - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
MUTUALLY_EXCLUSIVE_FLAGS_IDENTITY_PROVIDER_REFRESH - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
MUTUALLY_EXCLUSIVE_FLAGS_REFRESH_TOKEN_REFRESH - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 

N

NOT_STARTED - Static variable in interface com.microfocus.android.mobile.sdk.library.Report
Indicates that associated process has not yet been started (initiated).
NOT_STOPPED - Static variable in interface com.microfocus.android.mobile.sdk.library.Report
Indicates that associated process has not yet been stopped (completed).

O

onAuthenticationComplete(AuthenticatorReport) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorClientCallback
The client implemented callback invoked when an authentication is complete.
onBrowserLogoutComplete() - Method in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
The Browser Logout was attempted but resulted in an exception.
onComplete(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext.RollKeyCallback
Called as part of a key update (roll) once all persisted data has been converted to use the new key.
onCreate(Bundle) - Method in class com.microfocus.android.mobile.sdk.library.AuthCodeCanceledActivity
 
onCreate(Bundle) - Method in class com.microfocus.android.mobile.sdk.library.AuthCodeResolutionActivity
 
onInvokeComplete(InvokeTask) - Method in interface com.microfocus.android.mobile.sdk.library.InvokeClientCallback
The client implemented callback invoked when a url invoke completes.
onPause() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Android activity lifecycle onPause() method.
onPostExecute(Void) - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
 
onResume() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Android activity lifecycle onResume() method.
onStart(Context) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Android activity lifecycle onStart() method.
onStop() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Android activity lifecycle onStop() method.
onTokenRevocationComplete() - Method in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
Token Revocation was not attempted.
onTokenRevocationComplete(Exception) - Method in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
Token Revocation was attempted, but it resulted in an exception.
onTokenRevocationComplete(int) - Method in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
Token Revocation was attempted and a resonse was received from the identity provider.
onUnAuthenticationComplete(UnAuthenticatorReport) - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorClientCallback
The client implemented callback invoked when an un-authentication (logout) is complete.

P

PARAMETER_FORMATTING_TAG_ACCESSTOKEN - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
PARAMETER_FORMATTING_TAG_CLIENTID - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
PARAMETER_FORMATTING_TAG_CLIENTSECRET - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
PARAMETER_FORMATTING_TAG_REFRESHTOKEN - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
putIdentityProvider(Context, IdentityProvider) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Persist the provided IdentityProvider instance.

R

REFRESH_TOKEN_MISSING - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
REFRESH_TOKEN_REFRESH_REQUIRED_BUT_CLIENT_DISALLOWED - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
refreshTokenRefreshInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorReport
Determine if the Refresh Token refresh profile was initiated during the authentication process.
Report - Interface in com.microfocus.android.mobile.sdk.library
Defines the base report interface.
REVOCATION_TOKEN_METHOD_DEFAULT - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
REVOCATION_TOKEN_METHOD_GET - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
REVOCATION_TOKEN_METHOD_POST - Static variable in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
 
rollKey(Context, ServiceContext.RollKeyCallback) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Update the current encryption key to a new randomly generated key.

S

SECOND_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 
ServiceContext - Interface in com.microfocus.android.mobile.sdk.library
The principal SDK service context interface containing methods for: SDK cached content life cycle Symmetric Key Management Symmetric Key Management Identity Provider Persistence Authentication Persistence SDK Settings
ServiceContext.RollKeyCallback - Interface in com.microfocus.android.mobile.sdk.library
Defines the interface that must be implemented by the callback object passed to the rollKey(Context, ServiceContext.RollKeyCallback) method.
ServiceContextFactory - Class in com.microfocus.android.mobile.sdk.library
A factory that produces instances of ServiceContext
ServiceContextFactory() - Constructor for class com.microfocus.android.mobile.sdk.library.ServiceContextFactory
 
setAccessTokenRefreshBeforeExpirationBy(long) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setAuthorizationEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 authorization end point URL.
setBrowserDescriptor(BrowserDescriptor) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
Set the browser descriptor indicating which browser to use to perform the authentication.
setBrowserDescriptor(BrowserDescriptor) - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
Set the browser descriptor indicating which browser to use to perform the authentication.
setDisallowAccessTokenRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setDisallowBrowserBasedLogout(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
Set the flag to disallow browser based logout.
setDisallowIdentityProviderRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
Set the flag to disallow the Identity Provider configuration from being discovered (retrieved from the OAuth server) even if the discovery is required.
setDisallowRefreshTokenRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setDisallowTokenRevocation(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
Set the flag to disallow refresh token revocation.
setDiscoveryEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 Identity Provider configuration discovery end point URL.
setException(Exception) - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
Set any exception that may happen during the preparation and execution if this task.
setForceAccessTokenRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setForceIdentityProviderRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setForceRefreshTokenRefresh(boolean) - Method in interface com.microfocus.android.mobile.sdk.library.AuthenticatorBuilder
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.
setHttpBinaryPayload(ByteArrayOutputStream) - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
The sub-class will call this method from the doInBackground() method to set the payload once the HTTP request is obtained.
setHttpResponseCode(int) - Method in class com.microfocus.android.mobile.sdk.library.InvokeTask
The sub-class will call this method from the doInBackground() method to set the HTTP response code once the HTTP response is obtained.
setLogoutEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the Identity Provider Un-Authenticate (logout) end point URL.
setRegistrationEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 client registration end point URL.
setScope(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 scope.
setTimeout(long) - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
Set the maximum amount of time that the logout may consume.
setTokenEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 token end point URL.
setTokenRevocationEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the refresh token revocation end point url.
setTokenRevocationMethod(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the refresh token revocation HTTP method: "POST" or "GET".
setTokenRevocationParameterFormatString(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the refresh token revocation parameter format string.
setUserInfoEndPoint(String) - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProviderBuilder
Set the OAuth2 user information end point URL.
STATUS_RESPONSE_EXCEPTION - Static variable in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
 
STATUS_RESPONSE_NOT_ATTEMPTED - Static variable in class com.microfocus.android.mobile.sdk.library.UnAuthenticateCompleteCallback
 

T

TIMEOUT_DEFAULT - Static variable in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
 
TIMEOUT_MINIMUM - Static variable in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorBuilder
 
toJson() - Method in interface com.microfocus.android.mobile.sdk.library.IdentityProvider
Get the JSON representation of this Identity Provider.
toJson(AuthenticatorReport) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
A utility method to allow clients to convert a AuthenticatorReport to a JSON representation.
toJson(UnAuthenticatorReport) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
A utility method to allow clients to convert a UnAuthenticatorReport to a JSON representation.
TOKEN_REVOCATION_CONFIGURATION_MISSING - Static variable in exception com.microfocus.android.mobile.sdk.library.AuthenticatorException
 
tokenRevocationDisallowed() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determines if the initiator of the un-authentication process set the flag disallowing token revocation.
tokenRevocationInitiated() - Method in interface com.microfocus.android.mobile.sdk.library.UnAuthenticatorReport
Determine if the token revocation was attempted during the un-authentication process.

U

unauthenticate(UnAuthenticator) - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
Initiate an un-authentication (logout).
UnAuthenticateCompleteCallback - Class in com.microfocus.android.mobile.sdk.library
Created by SJensen on 4/13/2017.
UnAuthenticator - Interface in com.microfocus.android.mobile.sdk.library
Interface that defines the functionality of an UnAuthenticator.
UnAuthenticatorBuilder - Interface in com.microfocus.android.mobile.sdk.library
A builder interface that enables construction of UnAuthenticator instances.
UnAuthenticatorClientCallback - Interface in com.microfocus.android.mobile.sdk.library
Defines the client implemented callback that is called when an UnAuthenticator completes un-authentication.
UnAuthenticatorReport - Interface in com.microfocus.android.mobile.sdk.library
Interface that defines the functionality of a Un-Authentication Report object.
UNKNOWN_EXPIRATION - Static variable in interface com.microfocus.android.mobile.sdk.library.Report
 

W

WEEK_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 

Y

YEAR_IN_MILLIS - Static variable in class com.microfocus.android.mobile.sdk.library.util.DateTimeUtil
 
A B C D E F G H I J K L M N O P R S T U W Y 
Skip navigation links