AuthenticationPlatform (Oracle Fusion Middleware Java API Reference for Oracle Mobile Application Framework)

Object
- oracle.maf.api.authentication.AuthenticationPlatform

```
public abstract class AuthenticationPlatform
extends Object
```
AuthenticationPlatform provides a platform that abstracts all the authentication complexities into a pluggable module. By having an authentication platform abstraction, application and framework code can be implemented independent to how the actual authentication happens or what it needs.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`AUTHENTICATED_BY_IDLE_TIMEOUT`
`static long`	`AUTHENTICATED_FOR_LOCAL_ACCESS`
`static long`	`AUTHENTICATED_FOR_REMOTE_ACCESS`
`static String`	`IDLE_TIMER`
`static long`	`NOT_AUTHENTICATED`
`static String`	`SESSION_TIMER`
`static long`	`TIMEOUT_UNDEFINED`

Constructor Summary

Constructors
Constructor and Description

AuthenticationPlatform()

Constructors
Constructor and Description
`AuthenticationPlatform()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract void`	`addLoginCallback(LoginCallback loginCallback)` Add a login callback for the authentication platform.
`abstract void`	`addLogoutCallback(LogoutCallback logoutCallback)` Add a logout callback for the authentication platform
`abstract String`	`getAuthenticationMechanism()`
`abstract String`	`getAuthenticationStatus()` Retrieves the authentication status in an easy-to-read String.
`abstract long`	`getAuthenticationTimerTimeout(String timer)`
`abstract String`	`getCookie(String url, String cookieName)` Retrieves a cookie.
`abstract String`	`getCredentialStoreKey()`
`abstract java.util.Map<String,String>`	`getLoginProperties()` Obtain all the login properties and seeded values from the underlying authentication layer.
`abstract Object`	`getToken(String tokenName)` Retrieves a token.
`abstract String`	`getUserName()` Returns the current user name.
`abstract boolean`	`isLogoutInProgress()`
`abstract boolean`	`isUserAuthenticated()`
`abstract boolean`	`isUserAuthenticatedLocally()`
`abstract boolean`	`isUserAuthenticatedRemotely()`
`abstract void`	`login(java.util.Map<String,String> loginProperties, AuthenticationHandler handler)` Log the user in.
`abstract void`	`login(java.util.Map<String,String> loginProperties, java.util.Map<String,String> additionalProperties, AuthenticationHandler handler)` Log the user in.
`abstract void`	`loginComplete(String username, long actualAuthMode)` Invoked by the authentication platform login method to update the current login status and invoke the proper callback.
`abstract void`	`loginFailed(int errorCode, String errorMsg)` Called when login fails.
`abstract void`	`logout()` Logout all the features associated with this authentication platform
`abstract void`	`logoutComplete()` This is invoked as the last step of the remote logout process.
`abstract void`	`realignAuthenticationTimer(String timer, long delta)` Realign the current authentication timer (timer) to the following delta.
`abstract void`	`removeLoginCallback(LoginCallback loginCallback)` Remove a login callback for the authentication platform
`abstract void`	`removeLogoutCallback(LogoutCallback logoutCallback)` Remove a logout callback for the authentication platform
`abstract void`	`resumeTimeout(String timer)` Resume the specified timer.
`abstract void`	`setAuthenticationTimerOverride(AuthenticationTimerOverride overrideHandler)` set the callback to invoke when any of the timeouts are reached.
`abstract void`	`setAuthenticationTimerTimeout(String timer, long duration)` Set the timer's timeout setting to be the duration.
`abstract void`	`suspendTimeout(String timer)` Suspend the specified timer.
`abstract void`	`timerExpirationNotification(String timer)` The underlying (possible native) authentication platform should utilize this method to inform to authentication platform abstraction layer a timer has expired and the authentication timeout callback should be invoked.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IDLE_TIMER
```
public static final String IDLE_TIMER
```
    See Also:
    
    Constant Field Values
  - SESSION_TIMER
```
public static final String SESSION_TIMER
```
    See Also:
    
    Constant Field Values
  - NOT_AUTHENTICATED
```
public static final long NOT_AUTHENTICATED
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATED_FOR_LOCAL_ACCESS
```
public static final long AUTHENTICATED_FOR_LOCAL_ACCESS
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATED_FOR_REMOTE_ACCESS
```
public static final long AUTHENTICATED_FOR_REMOTE_ACCESS
```
    See Also:
    
    Constant Field Values
  - AUTHENTICATED_BY_IDLE_TIMEOUT
```
public static final long AUTHENTICATED_BY_IDLE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_UNDEFINED
```
public static final long TIMEOUT_UNDEFINED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AuthenticationPlatform
```
public AuthenticationPlatform()
```
- Method Detail
  - addLoginCallback
```
public abstract void addLoginCallback(LoginCallback loginCallback)
```
    Add a login callback for the authentication platform.
  - addLogoutCallback
```
public abstract void addLogoutCallback(LogoutCallback logoutCallback)
```
    Add a logout callback for the authentication platform
  - loginComplete
```
public abstract void loginComplete(String username,
                                   long actualAuthMode)
```
    Invoked by the authentication platform login method to update the current login status and invoke the proper callback.
  - loginFailed
```
public abstract void loginFailed(int errorCode,
                                 String errorMsg)
```
    Called when login fails. The error code and message are platform and handler specific.
    
    Parameters:
    
    errorCode - the code for the error.
    
    errorMsg - the message for the error.
  - getAuthenticationStatus
```
public abstract String getAuthenticationStatus()
```
    Retrieves the authentication status in an easy-to-read String.
    
    Returns:
    
    the current authentication status as a String.
  - getAuthenticationMechanism
```
public abstract String getAuthenticationMechanism()
```
    Returns:
    
    the authentication mechanism used
  - getAuthenticationTimerTimeout
```
public abstract long getAuthenticationTimerTimeout(String timer)
```
    Parameters:
    
    timer - the timer to query for.
    
    Returns:
    
    the timer's timeout setting
  - getLoginProperties
```
public abstract java.util.Map<String,String> getLoginProperties()
```
    Obtain all the login properties and seeded values from the underlying authentication layer. i.e.:
    username - "jdoe"
    password - "" <-- implying the UI needs to obtain the value but it is not seeded with a given value
    tenant - null <-- implying the tenant name is not needed
    rememberUsername - "true"
    rememberPassword - null
    autoLogin - "false"
    outOfBandURL - null
    localLoginPermitted - "true"
    remoteLoginPermitted - "true"
    
    Returns:
    
    an immutable property map that contains the saved login information
  - getCredentialStoreKey
```
public abstract String getCredentialStoreKey()
```
    Returns:
    
    the credential store key
  - isLogoutInProgress
```
public abstract boolean isLogoutInProgress()
```
    Returns:
    
    true if logout is in progress, false otherwise
  - isUserAuthenticated
```
public abstract boolean isUserAuthenticated()
```
    Returns:
    
    if the user is authenticated in any form for this AuthenticationPlatform.
  - isUserAuthenticatedLocally
```
public abstract boolean isUserAuthenticatedLocally()
```
    Returns:
    
    if the user is authenticated for at least locally for this AuthenticationPlatform.
  - isUserAuthenticatedRemotely
```
public abstract boolean isUserAuthenticatedRemotely()
```
    Returns:
    
    if the user is authenticated for at least remotely for this AuthenticationPlatform.
  - login
```
public abstract void login(java.util.Map<String,String> loginProperties,
                           AuthenticationHandler handler)
```
    Log the user in.
    
    Parameters:
    
    loginProperties - the property map containing all the requested login properties
    
    AuthenticationHandler - provides all of the login actions
  - login
```
public abstract void login(java.util.Map<String,String> loginProperties,
                           java.util.Map<String,String> additionalProperties,
                           AuthenticationHandler handler)
```
    Log the user in.
    
    Parameters:
    
    loginProperties - is the property map containing all the requested login properties
    
    additionalProperties - additional properties that may have been retrieved during the initial login attempt
    
    AuthenticationHandler - to provide all the login actions
  - logout
```
public abstract void logout()
```
    Logout all the features associated with this authentication platform
  - logoutComplete
```
public abstract void logoutComplete()
```
    This is invoked as the last step of the remote logout process. This ensures after all of the logout callbacks have completed. At this stage any analytic events need to be emitted and allow the underlying containerization platform to do any final logout activities it may need to do (i.e. do the actual logout on the server).
  - realignAuthenticationTimer
```
public abstract void realignAuthenticationTimer(String timer,
                                                long delta)
```
    Realign the current authentication timer (timer) to the following delta.
    
    Parameters:
    
    time - the current timer
    
    delta - the new value to align the timer to
  - removeLoginCallback
```
public abstract void removeLoginCallback(LoginCallback loginCallback)
```
    Remove a login callback for the authentication platform
    
    Parameters:
    
    loginCallback - the callback to remove.
  - removeLogoutCallback
```
public abstract void removeLogoutCallback(LogoutCallback logoutCallback)
```
    Remove a logout callback for the authentication platform
    
    Parameters:
    
    logoutCallback - the callback to remove.
  - resumeTimeout
```
public abstract void resumeTimeout(String timer)
```
    Resume the specified timer.
    
    Parameters:
    
    timer - the timer to resume.
  - setAuthenticationTimerOverride
```
public abstract void setAuthenticationTimerOverride(AuthenticationTimerOverride overrideHandler)
```
    set the callback to invoke when any of the timeouts are reached.
    
    Parameters:
    
    overrideHandler - the override handler to set.
  - setAuthenticationTimerTimeout
```
public abstract void setAuthenticationTimerTimeout(String timer,
                                                   long duration)
```
    Set the timer's timeout setting to be the duration.
    
    Parameters:
    
    timer - the timer to set the timeout to.
    
    duration - the timeout duration to set.
  - suspendTimeout
```
public abstract void suspendTimeout(String timer)
```
    Suspend the specified timer.
    
    Parameters:
    
    timer - the timer to suspend.
  - timerExpirationNotification
```
public abstract void timerExpirationNotification(String timer)
```
    The underlying (possible native) authentication platform should utilize this method to inform to authentication platform abstraction layer a timer has expired and the authentication timeout callback should be invoked.
  - getToken
```
public abstract Object getToken(String tokenName)
```
    Retrieves a token. The returned token can be a String or a Map, depending on what is requested. It is up to the caller to check the type and handle it appropriately. For example, passing in the tokenName "Authorization" will return a String with the "Authorization" token value. However, passing in the tokenName "oauth_access_token" will return a Map containing all of the OAuth tokens with key values "oauth_access_token1", "oauth_access_token2", ..., "oauth_access_tokenN", where N is the number of tokens returned. In common cases, N is 1, so only a single key will be returned in the Map.
    
    Parameters:
    
    tokenName - the token name to look up
    
    Returns:
    
    the Object representing the token or null if it does not exist
  - getCookie
```
public abstract String getCookie(String url,
                                 String cookieName)
```
    Retrieves a cookie.
    
    Parameters:
    
    url - the url of the cookie to look up
    
    cookieName - the cookie name to look up
    
    Returns:
    
    the String value of the cookie or null if it does not exist
  - getUserName
```
public abstract String getUserName()
```
    Returns the current user name.
    
    Returns:
    
    the current user name

Class AuthenticationPlatform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

IDLE_TIMER

SESSION_TIMER

NOT_AUTHENTICATED

AUTHENTICATED_FOR_LOCAL_ACCESS

AUTHENTICATED_FOR_REMOTE_ACCESS

AUTHENTICATED_BY_IDLE_TIMEOUT

TIMEOUT_UNDEFINED

Constructor Detail

AuthenticationPlatform

Method Detail

addLoginCallback

addLogoutCallback

loginComplete

loginFailed

getAuthenticationStatus

getAuthenticationMechanism

getAuthenticationTimerTimeout

getLoginProperties

getCredentialStoreKey

isLogoutInProgress

isUserAuthenticated

isUserAuthenticatedLocally

isUserAuthenticatedRemotely

login

login

logout

logoutComplete

realignAuthenticationTimer

removeLoginCallback

removeLogoutCallback

resumeTimeout

setAuthenticationTimerOverride

setAuthenticationTimerTimeout

suspendTimeout

timerExpirationNotification

getToken

getCookie

getUserName