|
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.ObPseudoUserSession
Deprecated. Implements the ObPseudoUserSession Interface.
public class ObPseudoUserSession
ObPseudoUserSession provides a way to authenticate and authorize without establishing and maintaining a specific corresponding user session in the OAM 11g Server. It supports similar operations that one can perform with user session and has similar constructs but does not actually establish any session at the server.
ObPseudoUserSession could be used when a requirement is to just validate the credentials of the user or get user authorized for a given resource without really establishing the sesion.
It also can be used to prevent accumulation of multiple sessions for a single user.
This constructor takes a ObResourceRequest object, a Hashtable of credentials, and a flag to indicate whether a one time authentication or authentication plus authorization is required. The ObResourceRequest object determines the authentication scheme that is to be applied to the credentials to authenticate the user. The ObResourceRequest object also determines other aspects of authentication policy such as success or failure action.
Constructor Summary | |
---|---|
ObPseudoUserSession(ObResourceRequest resReq, java.util.Hashtable credentials, boolean authorize) Deprecated. Constructs a ObPseudoUserSession object with specified parameters. |
|
ObPseudoUserSession(ObResourceRequest resReq, java.util.Hashtable credentials, boolean authorize, java.lang.String location) Deprecated. Constructs a ObPseudoUserSession object with specified parameters. |
Method Summary | |
---|---|
void |
clearActions() Deprecated. 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) 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 Error |
java.lang.String |
getErrorMessage() Deprecated. Returns the detailed error message for the authentication or authorization failure |
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 associated with the specified user session. |
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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ObPseudoUserSession(ObResourceRequest resReq, java.util.Hashtable credentials, boolean authorize) throws ObAccessException
resReq
- ObResource Request object representing a requested resource.credentials
- 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.authorize
- indicates whether one time authentication is required or authenticate & authorizeObAccessException
- If errors occur during authentication or authorization or some other error during object creationpublic ObPseudoUserSession(ObResourceRequest resReq, java.util.Hashtable credentials, boolean authorize, java.lang.String location) throws ObAccessException
resReq
- ObResource Request object representing a requested resource.credentials
- 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.authorize
- indicates whether one time authentication is required or authenticate and authorizelocation
- IP address of the client as specified by the application.ObAccessException
- If errors occur during authentication or authorization or some other error during object creationMethod Detail |
---|
public java.lang.String getAction(java.lang.String actionType, java.lang.String name)
ObPseudoUserSessionInterface
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 ObPseudoUserSessionInterface
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 int getNumberOfActions(java.lang.String actionType)
ObPseudoUserSessionInterface
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
getNumberOfActions
in interface ObPseudoUserSessionInterface
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)
ObPseudoUserSessionInterface
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 ObPseudoUserSessionInterface
actionType
- type of action to be retrieved. If this is left NULL, the default is "headervar".public java.lang.String[] getActionTypes()
ObPseudoUserSessionInterface
Each resource type defines the following set of action types: cookie, headervar and redirecturl for http resources.
getActionTypes
in interface ObPseudoUserSessionInterface
public void clearActions()
ObPseudoUserSessionInterface
clearActions
in interface ObPseudoUserSessionInterface
public int getStatus()
ObPseudoUserSessionInterface
getStatus
in interface ObPseudoUserSessionInterface
ObAccessRuntimeException
- in case if it fails to create user sessionpublic int getError()
ObPseudoUserSessionInterface
Error
getError
in interface ObPseudoUserSessionInterface
public java.lang.String getErrorMessage()
ObPseudoUserSessionInterface
getErrorMessage
in interface ObPseudoUserSessionInterface
public boolean isAuthorized(ObResourceRequest res) throws ObAccessException
ObPseudoUserSessionInterface
isAuthorized
in interface ObPseudoUserSessionInterface
res
- object representing a requested resource whose authorization is to be checked.true
if authorization succeeds, else false
ObAccessException
- In case a failure occurs during this operationpublic boolean isAuthorized(ObResourceRequest res, java.util.Hashtable parameters) throws ObAccessException
ObPseudoUserSessionInterface
isAuthorized
in interface ObPseudoUserSessionInterface
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 ObResourceRequest
true
if authorization succeeds, else false
ObAccessException
- In case a failure occurs during this operationpublic java.lang.String getUserIdentity() throws ObAccessException
ObPseudoUserSessionInterface
getUserIdentity
in interface ObPseudoUserSessionInterface
ObAccessException
- In case a failure occurs during this operationpublic int getLevel() throws ObAccessException
ObPseudoUserSessionInterface
getLevel
in interface ObPseudoUserSessionInterface
ObAccessException
- In case a failure occurs during this operationpublic java.lang.String getLocation() throws ObAccessException
ObPseudoUserSessionInterface
getLocation
in interface ObPseudoUserSessionInterface
ObAccessException
- In case a failure occurs during this operation
|
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 |