AuthorizationAgent (omce-android-sdk v18.2.1.0.201804130626 API)

All Known Subinterfaces:

SocialAuthorizationAgent
```
public interface AuthorizationAgent
```
Module responsible for handling OAuth 2.0, Basic Authentication, and other authentication modes. The API allows for authentication, validity check, refresh (if applicable) and logout. Optionally, the underlying toolkit supplies a login dialog to get the user ID and password. In the documentation below, the term “authentication” refers to what is appropriate for the authentication type in use. For OAuth, authentication acquires an OAuth token, whereas for Basic Authentication, the authentication simply validates that the user/password combination is correct. Note an Authorization instance is capable of holding only one valid set of authentication credentials at a time, so subsequent calls to acquire a token will overwrite any previous token that has not been released. The methods in this class are not thread-safe, so the caller must use appropriate synchronization methods when the potential for concurrent invocation exists. For methods that use asynchronous callbacks, the lifetime of the concurrency includes completion of the user callback.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AUTH_HEADER`
`static java.lang.String`	`BACKEND_ID`
`static java.lang.String`	`CONTENT_TYPE_HEADER`
`static java.lang.String`	`ENCODING`
`static java.lang.String`	`TAG`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`authenticate(Context context, java.lang.String username, java.lang.String password, AuthorizationCallback callback)` Authenticates the current client session against OMCe with the supplied user name and password.
`void`	`authenticateAnonymous(Context context, AuthorizationCallback callback)` Authenticates the current client session anonymously against OMCe without a username and password.
`void`	`authenticateUsingTokenExchange(Context context, java.lang.String token, AuthorizationCallback callback)` Exchange's third party token with OMCe token.
`void`	`authenticateUsingTokenExchange(Context context, java.lang.String token, boolean storeToken, AuthorizationCallback callback)` Exchanges third party token with OMCe token.
`boolean`	`clearSSOTokenExchange(Context context)` Removes token from memory and secure store.
`void`	`fetchCurrentUser(UserRegistrationCallback callback)` Fetches the latest details of the current user from OMCe.
`java.lang.String`	`getAccessToken()` Returns OMCe token.
`User`	`getCurrentUser()` Returns the current logged in user.
`java.util.Map<java.lang.String,java.lang.String>`	`getHTTPHeaders()` Returns the http headers.
`void`	`invokeCustomCodeJSONRequest(GenericCustomCodeClientCallBack genericCustomCodeClientCallBack, JSONObject data, java.lang.String functionName, RestClient.HttpMethod httpMethod)` Calls an OMCe custom API REST endpoint.
`boolean`	`isAuthorized()` Checks if the user is authorized.
`boolean`	`loadSSOTokenExchange(Context context)` Loads OMCe SSO token into memory from secure store.
`void`	`logout(AuthorizationCallback callback)` Deprecated. use `AuthorizationAgent.logout(Context, AuthorizationCallback)` instead. Logs the current user out of OMCe.
`void`	`logout(Context context, AuthorizationCallback callback)` Logs the current user out of OMCe.
`void`	`refreshToken(RefreshTokenCallback callback)` Validates token, if it is invalid tries to get new token.
`void`	`refreshTokenAsync(RefreshTokenCallback callback)` Refreshes the current token asynchronously.
`boolean`	`validateToken(boolean autoRefresh)` Validates the current token.

- Field Detail
  - ENCODING
```
static final java.lang.String ENCODING
```
    See Also:
    
    Constant Field Values
  - TAG
```
static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - AUTH_HEADER
```
static final java.lang.String AUTH_HEADER
```
    See Also:
    
    Constant Field Values
  - BACKEND_ID
```
static final java.lang.String BACKEND_ID
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_HEADER
```
static final java.lang.String CONTENT_TYPE_HEADER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - authenticate
```
void authenticate(Context context,
                  java.lang.String username,
                  java.lang.String password,
                  AuthorizationCallback callback)
```
    Authenticates the current client session against OMCe with the supplied user name and password. Any additional required credentials are retrieved from the mobile backend.
    
    Parameters:
    
    context - Context
    
    username - Username
    
    password - Password
    
    callback - Authorization callback
  - authenticateAnonymous
```
void authenticateAnonymous(Context context,
                           AuthorizationCallback callback)
```
    Authenticates the current client session anonymously against OMCe without a username and password.
    
    Parameters:
    
    context - Context
    
    callback - AuthorizationCallback object to be called after execution of request
  - logout
```
@Deprecated
void logout(AuthorizationCallback callback)
```
    Deprecated. use AuthorizationAgent.logout(Context, AuthorizationCallback) instead. Logs the current user out of OMCe.
    
    Parameters:
    
    callback - AuthorizationCallback object to be called after execution of request
  - logout
```
void logout(Context context,
            AuthorizationCallback callback)
```
    Logs the current user out of OMCe.
    
    Parameters:
    
    context - Context
    
    callback - AuthorizationCallback object to be called after execution of request
  - validateToken
```
boolean validateToken(boolean autoRefresh)
```
    Validates the current token.
    
    Parameters:
    
    autoRefresh - Boolean value . if set to true, refreshes expired token.
    
    Returns:
    
    returns true if token is valid otherwise returns false.
  - refreshTokenAsync
```
void refreshTokenAsync(RefreshTokenCallback callback)
```
    Refreshes the current token asynchronously.
    
    Parameters:
    
    callback - RefreshTokenCallback object to be called after execution of request
  - getHTTPHeaders
```
java.util.Map<java.lang.String,java.lang.String> getHTTPHeaders()
```
    Returns the http headers.
    
    Returns:
    
    returns a map containing http headers.
  - getCurrentUser
```
User getCurrentUser()
```
    Returns the current logged in user.
    
    Returns:
    
    user object containing details of logged in user.
  - isAuthorized
```
boolean isAuthorized()
```
    Checks if the user is authorized.
    
    Returns:
    
    true if user is authorized otherwise returns false.
  - fetchCurrentUser
```
void fetchCurrentUser(UserRegistrationCallback callback)
```
    Fetches the latest details of the current user from OMCe.
    
    Parameters:
    
    callback - UserRegistrationCallback object to be called after execution of request
  - refreshToken
```
void refreshToken(RefreshTokenCallback callback)
```
    Validates token, if it is invalid tries to get new token.
    
    Parameters:
    
    callback - RefreshTokenCallback object to be called after execution of request
  - invokeCustomCodeJSONRequest
```
void invokeCustomCodeJSONRequest(GenericCustomCodeClientCallBack genericCustomCodeClientCallBack,
                                 JSONObject data,
                                 java.lang.String functionName,
                                 RestClient.HttpMethod httpMethod)
```
    Calls an OMCe custom API REST endpoint.
    
    Parameters:
    
    genericCustomCodeClientCallBack - GenericCustomCodeClientCallBack object to be called after execution of rest request
    
    data - jsonObject containing the object to be passed with the REST request body
    
    functionName - REST request endpoint
    
    httpMethod - HTTP verb for the REST request
  - authenticateUsingTokenExchange
```
void authenticateUsingTokenExchange(Context context,
                                    java.lang.String token,
                                    AuthorizationCallback callback)
```
    Exchange's third party token with OMCe token.
    
    Parameters:
    
    context - Context
    
    token - Third party token to be exchanged with OMCe token
    
    callback - AuthorizationCallback object to be called after execution of request
  - getAccessToken
```
java.lang.String getAccessToken()
```
    Returns OMCe token.
  - authenticateUsingTokenExchange
```
void authenticateUsingTokenExchange(Context context,
                                    java.lang.String token,
                                    boolean storeToken,
                                    AuthorizationCallback callback)
```
    Exchanges third party token with OMCe token.
    
    Parameters:
    
    context - Context
    
    token - Third party token to be exchanged with OMCe token
    
    storeToken - Boolean value. if set to true, stores token in secure store
    
    callback - AuthorizationCallback object to be called after execution of request
  - loadSSOTokenExchange
```
boolean loadSSOTokenExchange(Context context)
```
    Loads OMCe SSO token into memory from secure store. returns true if token has been loaded from secure store (token is not null).
    
    Parameters:
    
    context - Context
  - clearSSOTokenExchange
```
boolean clearSSOTokenExchange(Context context)
```
    Removes token from memory and secure store.
    
    Parameters:
    
    context - Context

Interface AuthorizationAgent

Field Summary

Method Summary

Field Detail

ENCODING

TAG

AUTH_HEADER

BACKEND_ID

CONTENT_TYPE_HEADER

Method Detail

authenticate

authenticateAnonymous

logout

logout

validateToken

refreshTokenAsync

getHTTPHeaders

getCurrentUser

isAuthorized

fetchCurrentUser

refreshToken

invokeCustomCodeJSONRequest

authenticateUsingTokenExchange

getAccessToken

authenticateUsingTokenExchange

loadSSOTokenExchange

clearSSOTokenExchange