public abstract class AuthenticationPlatform
extends Object
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 and Description |
---|
AuthenticationPlatform() |
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.
|
public static final String IDLE_TIMER
public static final String SESSION_TIMER
public static final long NOT_AUTHENTICATED
public static final long AUTHENTICATED_FOR_LOCAL_ACCESS
public static final long AUTHENTICATED_FOR_REMOTE_ACCESS
public static final long AUTHENTICATED_BY_IDLE_TIMEOUT
public static final long TIMEOUT_UNDEFINED
public abstract void addLoginCallback(LoginCallback loginCallback)
public abstract void addLogoutCallback(LogoutCallback logoutCallback)
public abstract void loginComplete(String username, long actualAuthMode)
public abstract void loginFailed(int errorCode, String errorMsg)
errorCode
- the code for the error.errorMsg
- the message for the error.public abstract String getAuthenticationStatus()
public abstract String getAuthenticationMechanism()
public abstract long getAuthenticationTimerTimeout(String timer)
timer
- the timer to query for.public abstract java.util.Map<String,String> getLoginProperties()
public abstract String getCredentialStoreKey()
public abstract boolean isLogoutInProgress()
public abstract boolean isUserAuthenticated()
public abstract boolean isUserAuthenticatedLocally()
public abstract boolean isUserAuthenticatedRemotely()
public abstract void login(java.util.Map<String,String> loginProperties, AuthenticationHandler handler)
loginProperties
- the property map containing all the requested login propertiesAuthenticationHandler
- provides all of the login actionspublic abstract void login(java.util.Map<String,String> loginProperties, java.util.Map<String,String> additionalProperties, AuthenticationHandler handler)
loginProperties
- is the property map containing all the requested login propertiesadditionalProperties
- additional properties that may have been retrieved during the
initial login attemptAuthenticationHandler
- to provide all the login actionspublic abstract void logout()
public abstract void logoutComplete()
public abstract void realignAuthenticationTimer(String timer, long delta)
time
- the current timerdelta
- the new value to align the timer topublic abstract void removeLoginCallback(LoginCallback loginCallback)
loginCallback
- the callback to remove.public abstract void removeLogoutCallback(LogoutCallback logoutCallback)
logoutCallback
- the callback to remove.public abstract void resumeTimeout(String timer)
timer
- the timer to resume.public abstract void setAuthenticationTimerOverride(AuthenticationTimerOverride overrideHandler)
overrideHandler
- the override handler to set.public abstract void setAuthenticationTimerTimeout(String timer, long duration)
timer
- the timer to set the timeout to.duration
- the timeout duration to set.public abstract void suspendTimeout(String timer)
timer
- the timer to suspend.public abstract void timerExpirationNotification(String timer)
public abstract Object getToken(String tokenName)
tokenName
- the token name to look uppublic abstract String getCookie(String url, String cookieName)
url
- the url of the cookie to look upcookieName
- the cookie name to look uppublic abstract String getUserName()