BaseUserSession (Oracle Fusion Middleware Access SDK Java API Reference for Oracle Access Management Access Manager)

java.lang.Object
- oracle.security.am.asdk.BaseUserSession

Direct Known Subclasses:

PseudoUserSession, UserSession
```
public abstract class BaseUserSession
extends java.lang.Object
```
BaseUserSession class implements APIs common to UserSession and PseudoUserSession. BaseUserSession is internal to the implementation of this Access SDK and should not be used or extended by the end application.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`AGID`
`static int`	`AWAITINGLOGIN`
`static int`	`ERR_AUTHN_PLUGIN_DENIED`
`static int`	`ERR_AUTHN_TOKEN_EXPIRED`
`static int`	`ERR_DENY`
`static int`	`ERR_IDLE_TIMEOUT`
`static int`	`ERR_INCONCLUSIVE`
`static int`	`ERR_INSUFFICIENT_LEVEL`
`static int`	`ERR_INVALID_CERTIFICATE`
`static int`	`ERR_MOD_USER_FAILED`
`static int`	`ERR_NEED_MORE_DATA`
`static int`	`ERR_NO_USER`
`static int`	`ERR_NOT_LOGGED_IN`
`static int`	`ERR_PASSWORD_CHANGE_ON_RESET`
`static int`	`ERR_PASSWORD_EXPIRED`
`static int`	`ERR_SESSION_TIMEOUT`
`static int`	`ERR_UNKNOWN`
`static int`	`ERR_USER_LOCKED_OUT`
`static int`	`ERR_USER_REVOKED`
`static int`	`ERR_WRONG_PASSWORD`
`static int`	`EXPIRED`
`static java.lang.String`	`LOGGED_OUT_SESSION_TOKEN`
`static int`	`LOGGEDIN`
`static int`	`LOGGEDOUT`
`static int`	`LOGINFAILED`
`protected AccessClient`	`m_accessClient`
`protected java.util.HashMap<java.lang.String,java.util.Hashtable>`	`m_actionsArray`
`protected java.util.Vector<java.lang.String>`	`m_actionTypes`
`protected ObAuthUser`	`m_authUser`
`protected int`	`m_error`
`protected java.lang.String`	`m_errString`
`protected java.lang.String[]`	`m_getActionTypeReturn`
`protected int`	`m_lastUseTime`
`protected boolean`	`m_lazyload`
`protected int`	`m_level`
`protected LocalAccessClient`	`m_localAccessClient`
`protected java.lang.String`	`m_location`
`protected java.util.logging.Logger`	`m_logger`
`protected java.lang.String`	`m_sessionId`
`protected boolean`	`m_sessionValid`
`protected int`	`m_startTime`
`protected int`	`m_status`
`protected int`	`m_tokenLongestIdleTime`
`protected int`	`m_tokenMaxIdleTime`
`protected java.lang.String`	`m_userIdentity`
`static int`	`OK`
`protected java.lang.String`	`p_error`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseUserSession()` Default Constructor for BaseUserSesion Object
`protected`	`BaseUserSession(AccessClient aClient)` Constructor for BaseUserSesion Object which takes a reference to an AccessClient object.
`protected`	`BaseUserSession(LocalAccessClient aClient)` Constructor for BaseUserSesion Object which takes a reference to an LocalAccessClient object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearActions()` Clears all information pertaining to actions that was retrieved as part of previous authentication or authorization operation.
`java.lang.String`	`getAction(java.lang.String actionType, java.lang.String name)` Returns action corresponding to the action name and type specified.
`java.util.Hashtable`	`getActions(java.lang.String actionType)` Returns hashtable containing actions in the form of name/value pairs of String type for specified actionType.
`java.lang.String[]`	`getActionTypes()` Returns string array of all the action types returned by the OAM server as part of authentication or authorization.
`java.lang.String`	`getCustomError()` Returns plugin error code sent by the custom plugin `Error`
`int`	`getError()` Returns error number determined by the most recent authentication or authorization.
`java.lang.String`	`getErrorMessage()` Returns detailed error message pertaining to authentication or authorization failure.
`int`	`getLevel()` Returns authentication scheme level at which user is authenticated.
`java.lang.String`	`getLocation()` Returns the IP address of the client as specified by the application while creating the session.
`int`	`getNumberOfActions(java.lang.String actionType)` Returns number of actions of the specified type that are returned by OAM server as part of authentication or authorization.
`int`	`getStatus()` Provides integer value representing the current status of the session.
`java.lang.String`	`getUserIdentity()` Returns the DN of the user's profile entry in the user directory.
`boolean`	`isAuthorized(ResourceRequest res)` To check whether the user is authorized to access the resource
`boolean`	`isAuthorized(ResourceRequest res, java.util.Hashtable parameters)` To check whether the user is authorized to access the resource
`protected boolean`	`isAuthorized(ResourceRequest res, ValNameList pRActions, boolean allrActions, ObAAAStatus opStatus)`
`protected void`	`setActions(ObKeyValMap actions)` To set the actions.
`void`	`setLocation(java.lang.String sLocation)` Sets the IP address of the client as provided by the application.
`protected java.lang.String`	`validateIPAddress(java.lang.String ip)` Validates the IP address

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OK
```
public static final int OK
```
    See Also:
    
    Constant Field Values
  - ERR_UNKNOWN
```
public static final int ERR_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - ERR_NO_USER
```
public static final int ERR_NO_USER
```
    See Also:
    
    Constant Field Values
  - ERR_USER_REVOKED
```
public static final int ERR_USER_REVOKED
```
    See Also:
    
    Constant Field Values
  - ERR_WRONG_PASSWORD
```
public static final int ERR_WRONG_PASSWORD
```
    See Also:
    
    Constant Field Values
  - ERR_INVALID_CERTIFICATE
```
public static final int ERR_INVALID_CERTIFICATE
```
    See Also:
    
    Constant Field Values
  - ERR_AUTHN_PLUGIN_DENIED
```
public static final int ERR_AUTHN_PLUGIN_DENIED
```
    See Also:
    
    Constant Field Values
  - ERR_INSUFFICIENT_LEVEL
```
public static final int ERR_INSUFFICIENT_LEVEL
```
    See Also:
    
    Constant Field Values
  - ERR_NOT_LOGGED_IN
```
public static final int ERR_NOT_LOGGED_IN
```
    See Also:
    
    Constant Field Values
  - ERR_SESSION_TIMEOUT
```
public static final int ERR_SESSION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERR_IDLE_TIMEOUT
```
public static final int ERR_IDLE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERR_DENY
```
public static final int ERR_DENY
```
    See Also:
    
    Constant Field Values
  - ERR_PASSWORD_EXPIRED
```
public static final int ERR_PASSWORD_EXPIRED
```
    See Also:
    
    Constant Field Values
  - ERR_PASSWORD_CHANGE_ON_RESET
```
public static final int ERR_PASSWORD_CHANGE_ON_RESET
```
    See Also:
    
    Constant Field Values
  - ERR_USER_LOCKED_OUT
```
public static final int ERR_USER_LOCKED_OUT
```
    See Also:
    
    Constant Field Values
  - ERR_NEED_MORE_DATA
```
public static final int ERR_NEED_MORE_DATA
```
    See Also:
    
    Constant Field Values
  - ERR_INCONCLUSIVE
```
public static final int ERR_INCONCLUSIVE
```
    See Also:
    
    Constant Field Values
  - ERR_MOD_USER_FAILED
```
public static final int ERR_MOD_USER_FAILED
```
    See Also:
    
    Constant Field Values
  - ERR_AUTHN_TOKEN_EXPIRED
```
public static final int ERR_AUTHN_TOKEN_EXPIRED
```
    See Also:
    
    Constant Field Values
  - AWAITINGLOGIN
```
public static final int AWAITINGLOGIN
```
    See Also:
    
    Constant Field Values
  - LOGGEDIN
```
public static final int LOGGEDIN
```
    See Also:
    
    Constant Field Values
  - LOGGEDOUT
```
public static final int LOGGEDOUT
```
    See Also:
    
    Constant Field Values
  - LOGINFAILED
```
public static final int LOGINFAILED
```
    See Also:
    
    Constant Field Values
  - EXPIRED
```
public static final int EXPIRED
```
    See Also:
    
    Constant Field Values
  - LOGGED_OUT_SESSION_TOKEN
```
public static final java.lang.String LOGGED_OUT_SESSION_TOKEN
```
    See Also:
    
    Constant Field Values
  - AGID
```
protected static final java.lang.String AGID
```
    See Also:
    
    Constant Field Values
  - m_errString
```
protected java.lang.String m_errString
```
  - m_error
```
protected int m_error
```
  - m_status
```
protected int m_status
```
  - p_error
```
protected java.lang.String p_error
```
  - m_location
```
protected java.lang.String m_location
```
  - m_sessionId
```
protected java.lang.String m_sessionId
```
  - m_tokenMaxIdleTime
```
protected int m_tokenMaxIdleTime
```
  - m_startTime
```
protected int m_startTime
```
  - m_tokenLongestIdleTime
```
protected int m_tokenLongestIdleTime
```
  - m_level
```
protected int m_level
```
  - m_userIdentity
```
protected java.lang.String m_userIdentity
```
  - m_lastUseTime
```
protected int m_lastUseTime
```
  - m_sessionValid
```
protected boolean m_sessionValid
```
  - m_lazyload
```
protected boolean m_lazyload
```
  - m_authUser
```
protected ObAuthUser m_authUser
```
  - m_getActionTypeReturn
```
protected java.lang.String[] m_getActionTypeReturn
```
  - m_actionsArray
```
protected java.util.HashMap<java.lang.String,java.util.Hashtable> m_actionsArray
```
  - m_actionTypes
```
protected java.util.Vector<java.lang.String> m_actionTypes
```
  - m_logger
```
protected java.util.logging.Logger m_logger
```
  - m_accessClient
```
protected AccessClient m_accessClient
```
  - m_localAccessClient
```
protected LocalAccessClient m_localAccessClient
```
- Constructor Detail
  - BaseUserSession
```
protected BaseUserSession()
                   throws AccessException
```
    Default Constructor for BaseUserSesion Object
    
    Throws:
    
    AccessException
  - BaseUserSession
```
protected BaseUserSession(AccessClient aClient)
                   throws AccessException
```
    Constructor for BaseUserSesion Object which takes a reference to an AccessClient object.
    
    Throws:
    
    AccessException
  - BaseUserSession
```
protected BaseUserSession(LocalAccessClient aClient)
                   throws AccessException
```
    Constructor for BaseUserSesion Object which takes a reference to an LocalAccessClient object.
    
    Throws:
    
    AccessException
- Method Detail
  - getLevel
```
public int getLevel()
             throws AccessException
```
    Returns authentication scheme level at which user is authenticated.
    
    Returns:
    
    Authentication scheme level
    
    Throws:
    
    AccessException - If error occurs during operation
  - getUserIdentity
```
public java.lang.String getUserIdentity()
                                 throws AccessException
```
    Returns the DN of the user's profile entry in the user directory.
    
    Returns:
    
    DN of the user's profile entry
    
    Throws:
    
    AccessException - If error occurs during operation
  - getLocation
```
public java.lang.String getLocation()
                             throws AccessException
```
    Returns the IP address of the client as specified by the application while creating the session.
    
    Returns:
    
    IP address of the client
    
    Throws:
    
    AccessException - If error occurs during operation
  - getAction
```
public java.lang.String getAction(java.lang.String actionType,
                                  java.lang.String name)
```
    Returns action corresponding to the action name and type specified. The actions are the responses that OAM server returns after authentication and authorization. The actions that are returned during authentication or authorization depends on policies configured in the OAM server.
    Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources. The redirecturl action type indicates the url where the user should be redirected to for successful or failed authentication or authorization. To retrieve the redirection url set action type to "redirecturl" and name to "HTTP_REDIRECT".
    
    Parameters:
    
    actionType - type of action to be retrieved. If this is left NULL, the default is headervar.
    
    name - name of the action to be retrieved.
    
    Returns:
    
    Action corresponding to the action name and type specified.
  - getActions
```
public java.util.Hashtable getActions(java.lang.String actionType)
```
    Returns hashtable containing actions in the form of name/value pairs of String type for specified actionType. The actions are the responses that OAM server returns after authentication and authorization. The actions that are returned during authentication or authorization depends on policies configured in the OAM server.
    Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources. The redirecturl action type indicates the url where the user should be redirected to for successful or failed authentication or authorization. To retrieve the redirection url set action type to "redirecturl".
    
    Parameters:
    
    actionType - type of action to be retrieved. If this is left NULL, the default is "headervar".
    
    Returns:
    
    Hashtable containing actions in the form of name/value pairs of String type.
  - getNumberOfActions
```
public int getNumberOfActions(java.lang.String actionType)
```
    Returns number of actions of the specified type that are returned by OAM server as part of authentication or authorization. The actions are the responses that OAM server returns after authentication and authorization. The actions that are returned during authentication or authorization depends on policies configured in the OAM server.
    Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
    
    Parameters:
    
    actionType - type of action to be retrieved. If this is left NULL, the default is headervar.
    
    Returns:
    
    Number of actions of the specified type that are associated with the specified user session.
  - getActionTypes
```
public java.lang.String[] getActionTypes()
```
    Returns string array of all the action types returned by the OAM server as part of authentication or authorization. The actions are the responses that OAM server returns after authentication and authorization. The actions that are returned during authentication or authorization depends on policies configured in the OAM server.
    Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
    
    Returns:
    
    String array of all the action types returned by the OAM server as part of authentication or authorization.
  - clearActions
```
public void clearActions()
```
    Clears all information pertaining to actions that was retrieved as part of previous authentication or authorization operation. The actions are the responses that OAM server returns after authentication and authorization. The actions that are returned during authentication or authorization depends on policies configured in the OAM server.
  - getStatus
```
public int getStatus()
              throws AccessException
```
    Provides integer value representing the current status of the session. The return value of this function can be checked against below constants exposed by this class.
    - 0 for AWAITINGLOGIN
    - 1 for LOGGEDIN
    - 2 for LOGGEDOUT
    - 3 for LOGINFAILED
    - 4 for EXPIRED
    Returns:
    
    Status information of this user session
    
    Throws:
    
    AccessException - If error occurs during operation
  - getError
```
public int getError()
```
    Returns error number determined by the most recent authentication or authorization. Error
    
    Returns:
    
    Error number for error condition
  - getCustomError
```
public java.lang.String getCustomError()
```
    Returns plugin error code sent by the custom plugin Error
    
    Returns:
    
    plugin error code
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns detailed error message pertaining to authentication or authorization failure. The text of this message is derived by the AccessClient and is not intended to be changed by the user.
    
    Returns:
    
    Error message describing error condition
  - setActions
```
protected void setActions(ObKeyValMap actions)
```
    To set the actions.
    
    Parameters:
    
    actions - Contains key/val pair of actions.
  - isAuthorized
```
public boolean isAuthorized(ResourceRequest res,
                            java.util.Hashtable parameters)
                     throws AccessException
```
    To check whether the user is authorized to access the resource
    
    Parameters:
    
    res - object representing a requested resource whose authorization is to be checked.
    
    parameters - Hashtable of name-value pairs of String type required by These parameters are required if the authorization policy requires additional information to perform authorization. The parameters that are required for authorization can be obtained by using getAuthorizationParameters method of ResourceRequest
    
    Returns:
    
    Boolean true if the user is authorized to request an operation for a particular resource else returns false
    
    Throws:
    
    AccessException - In case a failure occurs during the operation
  - isAuthorized
```
public boolean isAuthorized(ResourceRequest res)
                     throws AccessException
```
    To check whether the user is authorized to access the resource
    
    Parameters:
    
    res - object representing a requested resource whose authorization is to be checked.
    
    Returns:
    
    Boolean true if the user is authorized to request an operation for a particular resource else returns false
    
    Throws:
    
    AccessException - In case a failure occurs during the operation
  - setLocation
```
public void setLocation(java.lang.String sLocation)
                 throws AccessException
```
    Sets the IP address of the client as provided by the application.
    
    Parameters:
    
    sLocation - IP address of the client
    
    Throws:
    
    AccessException - In case if it fails to validate Ip address
  - validateIPAddress
```
protected java.lang.String validateIPAddress(java.lang.String ip)
                                      throws AccessException
```
    Validates the IP address
    
    Parameters:
    
    ip -
    
    Returns:
    
    Throws:
    
    java.net.UnknownHostException
    
    AccessException
  - isAuthorized
```
protected boolean isAuthorized(ResourceRequest res,
                               ValNameList pRActions,
                               boolean allrActions,
                               ObAAAStatus opStatus)
                        throws AccessException
```
    Throws:
    
    AccessException

Class BaseUserSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OK

ERR_UNKNOWN

ERR_NO_USER

ERR_USER_REVOKED

ERR_WRONG_PASSWORD

ERR_INVALID_CERTIFICATE

ERR_AUTHN_PLUGIN_DENIED

ERR_INSUFFICIENT_LEVEL

ERR_NOT_LOGGED_IN

ERR_SESSION_TIMEOUT

ERR_IDLE_TIMEOUT

ERR_DENY

ERR_PASSWORD_EXPIRED

ERR_PASSWORD_CHANGE_ON_RESET

ERR_USER_LOCKED_OUT

ERR_NEED_MORE_DATA

ERR_INCONCLUSIVE

ERR_MOD_USER_FAILED

ERR_AUTHN_TOKEN_EXPIRED

AWAITINGLOGIN

LOGGEDIN

LOGGEDOUT

LOGINFAILED

EXPIRED

LOGGED_OUT_SESSION_TOKEN

AGID

m_errString

m_error

m_status

p_error

m_location

m_sessionId

m_tokenMaxIdleTime

m_startTime

m_tokenLongestIdleTime

m_level

m_userIdentity

m_lastUseTime

m_sessionValid

m_lazyload

m_authUser

m_getActionTypeReturn

m_actionsArray

m_actionTypes

m_logger

m_accessClient

m_localAccessClient

Constructor Detail

BaseUserSession

BaseUserSession

BaseUserSession

Method Detail

getLevel

getUserIdentity

getLocation

getAction

getActions

getNumberOfActions

getActionTypes

clearActions

getStatus

getError

getCustomError

getErrorMessage

setActions

isAuthorized

isAuthorized

setLocation

validateIPAddress

isAuthorized