com.oblix.access

Interface ObPseudoUserSessionInterface

All Known Implementing Classes:

ObPseudoUserSession

Deprecated.

Defines an Interface to perform authenticate and authorize operation for pseudo user session.

public interface ObPseudoUserSessionInterface

ObPseudoUserSessionInterface defines an interface which provides a way to authenticate and authorize without establishing and maintaining a specific corresponding user session in the OAM 11g Server.

Method Summary

Modifier and Type	Method and Description
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 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 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

Method Detail

getAction

java.lang.String getAction(java.lang.String actionType,
                           java.lang.String actionName)

Deprecated.

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.

actionName - name of the action to be retrieved.

Returns:

Action corresponding to the action name and type specified.

getActions

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. 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

int getNumberOfActions(java.lang.String actionType)

Deprecated.

Returns number of actions of the specified type that are associated with the specified user session. 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

java.lang.String[] getActionTypes()

Deprecated.

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

void clearActions()

Deprecated.

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

int getStatus()

Deprecated.

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

getError

int getError()

Deprecated.

Returns the error number from the most recent authentication or authorization Error

Returns:

Error number for error condition.

getErrorMessage

java.lang.String getErrorMessage()

Deprecated.

Returns the detailed error message for the authentication or authorization failure

Returns:

Error message describing error condition.

isAuthorized

boolean isAuthorized(ObResourceRequest res)
              throws ObAccessException

Deprecated.

Checks if the user is authorized to request an operation for a particular resource

Parameters:

res - object representing a requested resource whose authorization is to be checked.

Returns:

Boolean true if authorization succeeds, else false

Throws:

ObAccessException - In case a failure occurs during this operation

isAuthorized

boolean isAuthorized(ObResourceRequest res,
                     java.util.Hashtable parameters)
              throws ObAccessException

Deprecated.

Checks if the user is authorized to request an operation for a particular 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 ObResourceRequest

Returns:

Boolean true if authorization succeeds, else false

Throws:

ObAccessException - In case a failure occurs during this operation

getUserIdentity

java.lang.String getUserIdentity()
                          throws ObAccessException

Deprecated.

Returns the DN of the user's profile entry in the user directory.

Returns:

DN of the user's profile entry

Throws:

ObAccessException - In case a failure occurs during this operation

getLevel

int getLevel()
      throws ObAccessException

Deprecated.

Returns authentication scheme level at which user is authenticated

Returns:

Authentication scheme level.

Throws:

ObAccessException - In case a failure occurs during this operation

getLocation

java.lang.String getLocation()
                      throws ObAccessException

Deprecated.

Returns the IP address of the user's client

Returns:

IP address of the client.

Throws:

ObAccessException - In case a failure occurs during this operation