|
Oracle Fusion Middleware Access SDK Java API Reference for Oracle Access Management Access Manager 11g Release 2 Patch Set 1(11.1.2.1.0) E27136-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Deprecated. Defines an Interface for the class that represents an authenticated user.
public interface ObUserSessionInterface
ObUserSession object represents an authenticated user. A user session object is initially created through a constructor that authenticates the user. This constructor takes an ObResourceRequest object and an ObMap of credentials. The resource request determines the authentication scheme that is to be applied to the credentials to authenticate the user. The resource request also determines other aspects of authentication policy: success or failure actions and audit rules.
A session token string is a serialized representation of the user session. An user session object can be constructed from a valid session token, and a session token can be generated from a user session object.
Elements of a user session object are
The isAuthorized() method determines if the user is authorized to request an operation against a resource. Results of the authorization can be obtained through ObUserSession methods: an error number if the authorization failed, and authorization success or failure policy actions (name-value pairs). For simplicity, a redirection URL action is returned with the name redirectionUrl). An authorization audit record may be generated as specified by the audit rule associated with the resource request.
Method Summary | |
---|---|
void |
clearActions() Deprecated. Clears all information pertaining to actions that was retrieved as part of previous authentication or authorization operation. |
void |
finalize() Deprecated. Cleans up native ObUserSession objects. |
java.lang.String |
getAction(java.lang.String actionType, java.lang.String actionName) Deprecated. Returns action corresponding to the action name and type specified. |
java.util.Hashtable |
getActions(java.lang.String actionType) Deprecated. Returns hashtable containing actions in the form of name/value pairs of String type for specified actionType. |
java.lang.String[] |
getActionTypes() Deprecated. Returns string array of all the action types returned by the OAM server as part of authentication or authorization. |
int |
getError() Deprecated. Returns the error number from the most recent authentication or authorization failure Error |
java.lang.String |
getErrorMessage() Deprecated. Returns the detailed error message for the authentication or authorization failure |
int |
getLastUseTime() Deprecated. Returns the time in seconds from Jan 1, 1970 till the most recent user request was authorized. |
int |
getLevel() Deprecated. Returns authentication scheme level at which user is authenticated. |
java.lang.String |
getLocation() Deprecated. Returns the IP address of the user's client |
int |
getNumberOfActions(java.lang.String actionType) Deprecated. Returns number of actions of the specified type that are returned by OAM server as part of authentication or authorization. |
java.lang.String |
getSessionToken() Deprecated. Returns the serialized representation of user session |
int |
getStartTime() Deprecated. Returns time in seconds from Jan 1, 1970 till authenticated user session was started. |
int |
getStatus() Deprecated. Provides integer value representing the current status of the session. |
java.lang.String |
getUserIdentity() Deprecated. Returns the DN of the user's profile entry in the user directory. |
boolean |
isAuthorized(ObResourceRequest res) Deprecated. Checks if the user is authorized to request an operation for a particular resource |
boolean |
isAuthorized(ObResourceRequest res, java.util.Hashtable parameters) Deprecated. Checks if the user is authorized to request an operation for a particular resource |
void |
logoff() Deprecated. Logs off the authenticated user and terminates the session |
void |
setLocation(java.lang.String location) Deprecated. Sets the IP address of the user's client |
Method Detail |
---|
java.lang.String getUserIdentity() throws ObAccessException
ObAccessException
- If error occurs during operationint getLevel() throws ObAccessException
ObAccessException
- If error occurs during operationjava.lang.String getLocation() throws ObAccessException
ObAccessException
- If error occurs during operationvoid setLocation(java.lang.String location)
int getStartTime() throws ObAccessException
ObAccessException
- If failed to retrieve session informationint getLastUseTime() throws ObAccessException
ObAccessException
- In case if operation fails.int getNumberOfActions(java.lang.String actionType)
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
actionType
- type of action to be retrieved. If this is left NULL, the default is headervar.java.util.Hashtable getActions(java.lang.String actionType)
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".
actionType
- type of action to be retrieved. If this is left NULL, the default is "headervar".java.lang.String getAction(java.lang.String actionType, java.lang.String actionName)
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".
actionType
- type of action to be retrieved. If this is left NULL, the default is headervar.actionName
- name of the action to be retrieved.java.lang.String[] getActionTypes()
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
void clearActions()
int getStatus()
int getError()
Error
java.lang.String getErrorMessage()
boolean isAuthorized(ObResourceRequest res) throws ObAccessException
res
- resource object being checked for authorizationObAccessException
- In case a failure occurs during the operationboolean isAuthorized(ObResourceRequest res, java.util.Hashtable parameters) throws ObAccessException
res
- resource object being checked for authorizationparameters
- 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 ObResourceRequest
ObAccessException
- In case a failure occurs during the operationjava.lang.String getSessionToken()
void logoff()
void finalize()
|
Oracle Fusion Middleware Access SDK Java API Reference for Oracle Access Management Access Manager 11g Release 2 Patch Set 1(11.1.2.1.0) E27136-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |