- 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.
- 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
-
- 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
-
- 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
-
- getIdentityProvider() - Method in interface com.microfocus.android.mobile.sdk.library.ServiceContext
-
- 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
-
- 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.
- 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
-
- 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
-