|
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 |
java.lang.Object
com.oblix.access.ObUserSession
Deprecated. Implements the ObUserSession Interface
public class ObUserSession
Field Summary | |
---|---|
static int |
AWAITINGLOGIN Deprecated. |
static int |
ERR_AUTHN_PLUGIN_DENIED Deprecated. |
static int |
ERR_DENY Deprecated. |
static int |
ERR_IDLE_TIMEOUT Deprecated. |
static int |
ERR_INCONCLUSIVE Deprecated. |
static int |
ERR_INSUFFICIENT_LEVEL Deprecated. |
static int |
ERR_INVALID_CERTIFICATE Deprecated. |
static int |
ERR_NEED_MORE_DATA Deprecated. |
static int |
ERR_NO_USER Deprecated. |
static int |
ERR_NOT_LOGGED_IN Deprecated. |
static int |
ERR_PASSWORD_CHANGE_ON_RESET Deprecated. |
static int |
ERR_PASSWORD_EXPIRED Deprecated. |
static int |
ERR_SESSION_TIMEOUT Deprecated. |
static int |
ERR_UNKNOWN Deprecated. |
static int |
ERR_USER_LOCKED_OUT Deprecated. |
static int |
ERR_USER_REVOKED Deprecated. |
static int |
ERR_WRONG_PASSWORD Deprecated. |
static int |
EXPIRED Deprecated. |
static int |
LOGGEDIN Deprecated. |
static int |
LOGGEDOUT Deprecated. |
static int |
LOGINFAILED Deprecated. |
static int |
OK Deprecated. |
Constructor Summary | |
---|---|
ObUserSession() Deprecated. Default Constructor for ObUserSesion Object |
|
ObUserSession(ObResourceRequest res, java.util.Hashtable credentials) Deprecated. Constructor for ObUserSession object for the specified resource and credentials |
|
ObUserSession(ObResourceRequest res, java.util.Hashtable credentials, java.lang.String location) Deprecated. Constructor for ObUserSession object for the specified resource and credentials |
|
ObUserSession(java.lang.String sessionToken) Deprecated. Constructor for ObUserSession object for the specified session token |
|
ObUserSession(java.lang.String sessionToken, boolean lazyload) Deprecated. Constructor for ObUserSession object for the specified session token with lazy load flag |
Method Summary | |
---|---|
void |
clearActions() Deprecated. Clears all information pertaining to actions that was retrieved as part of previous authentication or authorization operation. |
java.lang.Object |
clone() Deprecated. Used to clone ObUserSession Objects. |
void |
finalize() Deprecated. Cleans up native ObUserSession objects. |
java.lang.String |
getAction(java.lang.String actionType, java.lang.String name) 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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int AWAITINGLOGIN
public static final int LOGGEDIN
public static final int LOGGEDOUT
public static final int LOGINFAILED
public static final int EXPIRED
public static final int OK
public static final int ERR_UNKNOWN
public static final int ERR_NO_USER
public static final int ERR_USER_REVOKED
public static final int ERR_WRONG_PASSWORD
public static final int ERR_INVALID_CERTIFICATE
public static final int ERR_AUTHN_PLUGIN_DENIED
public static final int ERR_INSUFFICIENT_LEVEL
public static final int ERR_NOT_LOGGED_IN
public static final int ERR_SESSION_TIMEOUT
public static final int ERR_IDLE_TIMEOUT
public static final int ERR_DENY
public static final int ERR_PASSWORD_EXPIRED
public static final int ERR_PASSWORD_CHANGE_ON_RESET
public static final int ERR_USER_LOCKED_OUT
public static final int ERR_NEED_MORE_DATA
public static final int ERR_INCONCLUSIVE
Constructor Detail |
---|
public ObUserSession() throws ObAccessException
ObAccessException
- in case of failure to create the objectpublic ObUserSession(java.lang.String sessionToken) throws ObAccessException
sessionToken
- serailized user session object representationObAccessException
- in case of failure to create the object or if session token is nullpublic ObUserSession(ObResourceRequest res, java.util.Hashtable credentials, java.lang.String location) throws ObAccessException
res
- resource object for which user is being authenticatedcredentials
- Hashtable containing the key/value pairs of String type.
ObAuthenticationScheme
ObAuthenticationScheme
ObAuthenticationScheme
. The value for this certificate key should be Base64 Encoded string which represent a valid X.509 certificate.location
- used if the client location needs to be specified. Valid DNS name or IP address can be used to specify the locationObAccessException
- in case of failure to create the object, or in case resource object is nullpublic ObUserSession(ObResourceRequest res, java.util.Hashtable credentials) throws ObAccessException
res
- resource object for which user is being authenticatedcredentials
- Hashtable containing the key/value pairs of String type.
ObAuthenticationScheme
ObAuthenticationScheme
ObAuthenticationScheme
. The value for this certificate key should be Base64 Encoded string which represent a valid X.509 certificate.ObAccessException
- in case of failure to create the object or if resource object is invalidpublic ObUserSession(java.lang.String sessionToken, boolean lazyload) throws ObAccessException
sessionToken
- serailized user session object representation, bool flag to indicte lazy load of sessioninfoObAccessException
- in case of failure to create the object or if session token is nullMethod Detail |
---|
public java.lang.String getUserIdentity() throws ObAccessException
ObUserSessionInterface
getUserIdentity
in interface ObUserSessionInterface
ObAccessException
- If error occurs during operationpublic int getLevel() throws ObAccessException
ObUserSessionInterface
getLevel
in interface ObUserSessionInterface
ObAccessException
- If error occurs during operationpublic java.lang.String getLocation() throws ObAccessException
ObUserSessionInterface
getLocation
in interface ObUserSessionInterface
ObAccessException
- If error occurs during operationpublic void setLocation(java.lang.String location)
ObUserSessionInterface
setLocation
in interface ObUserSessionInterface
ObAccessRuntimeException
- in case if fails to validate Ip addresspublic int getStartTime() throws ObAccessException
ObUserSessionInterface
getStartTime
in interface ObUserSessionInterface
ObAccessException
- If failed to retrieve session informationpublic int getLastUseTime() throws ObAccessException
ObUserSessionInterface
getLastUseTime
in interface ObUserSessionInterface
ObAccessException
- In case if operation fails.public int getNumberOfActions(java.lang.String actionType)
ObUserSessionInterface
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
getNumberOfActions
in interface ObUserSessionInterface
actionType
- type of action to be retrieved. If this is left NULL, the default is headervar.public java.util.Hashtable getActions(java.lang.String actionType)
ObUserSessionInterface
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".
getActions
in interface ObUserSessionInterface
actionType
- type of action to be retrieved. If this is left NULL, the default is "headervar".public java.lang.String getAction(java.lang.String actionType, java.lang.String name)
ObUserSessionInterface
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".
getAction
in interface ObUserSessionInterface
actionType
- type of action to be retrieved. If this is left NULL, the default is headervar.name
- name of the action to be retrieved.public java.lang.String[] getActionTypes()
ObUserSessionInterface
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
getActionTypes
in interface ObUserSessionInterface
public void clearActions()
ObUserSessionInterface
clearActions
in interface ObUserSessionInterface
public int getStatus()
ObUserSessionInterface
getStatus
in interface ObUserSessionInterface
ObAccessRuntimeException
- in case if it fails to create user sessionpublic int getError()
ObUserSessionInterface
Error
getError
in interface ObUserSessionInterface
public java.lang.String getErrorMessage()
ObUserSessionInterface
getErrorMessage
in interface ObUserSessionInterface
public boolean isAuthorized(ObResourceRequest res) throws ObAccessException
ObUserSessionInterface
isAuthorized
in interface ObUserSessionInterface
res
- resource object being checked for authorizationObAccessException
- In case a failure occurs during the operationpublic boolean isAuthorized(ObResourceRequest res, java.util.Hashtable parameters) throws ObAccessException
ObUserSessionInterface
isAuthorized
in interface ObUserSessionInterface
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 operationpublic java.lang.String getSessionToken()
ObUserSessionInterface
getSessionToken
in interface ObUserSessionInterface
ObAccessRuntimeException
- in case if it fails to generate the session token.public void logoff()
ObUserSessionInterface
logoff
in interface ObUserSessionInterface
ObAccessRuntimeException
- in case if it fails to perform logout for authenticated user.public void finalize()
ObUserSessionInterface
finalize
in interface ObUserSessionInterface
finalize
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
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 |