com.oblix.access

Class ObResourceRequest

java.lang.Object

com.oblix.access.ObResourceRequest

All Implemented Interfaces:

ObResourceRequestInterface, java.lang.Cloneable

Deprecated.

Implements the ObResourceRequestInterface.

public class ObResourceRequest
extends java.lang.Object
implements ObResourceRequestInterface, java.lang.Cloneable

ObResourceRequest objects are used by the ObAuthenticationScheme constructors to retrieve information about the resource's authentication scheme and by the isAuthorized() method of the ObUserSession class to determine if a user is authorized to access the resource. In Oracle package, methods getName(), isBasic(), isCertificate() etc. from class AuthenticationScheme throws AccessException in case if Access Server API not initialized or if scheme id is null. And this is affecting on methods from Oblix package. So to retain backward compatibility the calling methods from this class such as getName(), isBasic(), isCertificate() etc. catches the checked exception and throws ObAccessRuntimeException.

Constructor Summary

Constructors

Constructor and Description
ObResourceRequest(java.lang.String resType, java.lang.String resName, java.lang.String operation) Deprecated. Constructs ObResourceRequest object with specified resource type, name and operation.
ObResourceRequest(java.lang.String resType, java.lang.String resName, java.lang.String operation, java.util.Hashtable parameters) Deprecated. Constructs ObResourceRequest object with specified resource type, name, operation and parameters name/value pair hashtable.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deprecated. Used to clone ObResourceRequest Objects.
void	finalize() Deprecated. Internal Use Only.
java.util.Hashtable	getAuthorizationParameters() Deprecated. Returns parameters required for authorization of the resource.
int	getNumberOfAuthorizationParameters() Deprecated. Returns count of parameters required for authorization of this resource.
java.lang.String	getOperation() Deprecated. Returns method configured for resource request object for example HTTP methods like GET, POST.
java.util.Hashtable	getParameters() Deprecated. Returns query parameters used to define a resource.
java.lang.String	getResource() Deprecated. Returns resource
protected ResourceRequest	getResourceRequest() Deprecated.
java.lang.String	getResourceType() Deprecated. Returns resource type
java.lang.String[][]	hashtableToArr(java.util.Hashtable h) Deprecated. Internal Use Only
boolean	isProtected() Deprecated. Checks if the resource defined by the ObResourceRequest is protected

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObResourceRequest

public ObResourceRequest(java.lang.String resType,
                         java.lang.String resName,
                         java.lang.String operation)
                  throws ObAccessException

Deprecated.

Constructs ObResourceRequest object with specified resource type, name and operation.

Parameters:

resType - Resource type, for example http, ejb etc. If null, defaults to http

resName - Resource name

operation - Operation for the resource object. For example GET, POST , PUT, HEAD, DELETE, TRACE, OPTIONS, CONNECT, OTHER.

Throws:

ObAccessException - In case of errors during object creation or if resName or operation string is null

ObResourceRequest

public ObResourceRequest(java.lang.String resType,
                         java.lang.String resName,
                         java.lang.String operation,
                         java.util.Hashtable parameters)
                  throws ObAccessException

Deprecated.

Constructs ObResourceRequest object with specified resource type, name, operation and parameters name/value pair hashtable.

Parameters:

resType - Resource type, for example http, ejb etc., If null defaults to http

resName - Resource name

operation - Operation for the resource object. For example GET, POST , PUT, HEAD, DELETE, TRACE, OPTIONS, CONNECT, OTHER.

parameters - (Optional) Hashtable of query string parameters in the form of name/value pairs of String type. These parameters will be used by the OAM server in order to determine the policy that protects this resource. This argument is optional if the policies configured does not rely on the query string parameters.

Throws:

ObAccessException - In case of errors during object creation or if resName or operation string is null

Method Detail

isProtected

public boolean isProtected()
                    throws ObAccessException

Deprecated.

Description copied from interface: ObResourceRequestInterface

Checks if the resource defined by the ObResourceRequest is protected

Specified by:

isProtected in interface ObResourceRequestInterface

Returns:

Boolean true if resource is protected.

Throws:

ObAccessException - In case server could not determine the protected status of the resource or some other error

getResourceType

public java.lang.String getResourceType()

Deprecated.

Description copied from interface: ObResourceRequestInterface

Returns resource type

Specified by:

getResourceType in interface ObResourceRequestInterface

Returns:

String representing resource type

getResource

public java.lang.String getResource()

Deprecated.

Description copied from interface: ObResourceRequestInterface

Returns resource

Specified by:

getResource in interface ObResourceRequestInterface

Returns:

String representing the resource

getOperation

public java.lang.String getOperation()

Deprecated.

Description copied from interface: ObResourceRequestInterface

Returns method configured for resource request object for example HTTP methods like GET, POST.

Specified by:

getOperation in interface ObResourceRequestInterface

Returns:

Method configured for given ObResourceRequest object

getParameters

public java.util.Hashtable getParameters()

Deprecated.

Description copied from interface: ObResourceRequestInterface

Returns query parameters used to define a resource.

Specified by:

getParameters in interface ObResourceRequestInterface

Returns:

Hashtable of query parameters in form of name/value pairs of String type used to define a resource. It returns null value if query parameters were not passed while creating ObResourceRequest object.

getAuthorizationParameters

public java.util.Hashtable getAuthorizationParameters()

Deprecated.

Returns parameters required for authorization of the resource. Parameters will be returned only if a authorization request fails with ERR_NEED_MORE_DATA error. This error indicates that additional information is required for authorization.

Specified by:

getAuthorizationParameters in interface ObResourceRequestInterface

Returns:

Hashtable containing parameters of String type required for authorization of the resource. It returns null if called before performing any authorization or if authorization for this resource has never failed with ERR_NEED_MORE_DATA error.

Throws:

ObAccessRuntimeException - In case if resource request object is not initialized.

getNumberOfAuthorizationParameters

public int getNumberOfAuthorizationParameters()

Deprecated.

Returns count of parameters required for authorization of this resource.

Returns:

Count of parameters required for authorization of this resource. It returns 0 if there are no authorization parameters.

Throws:

ObAccessRuntimeException - In case if resource request object is not initialized.

getResourceRequest

protected ResourceRequest getResourceRequest()

Deprecated.

hashtableToArr

public java.lang.String[][] hashtableToArr(java.util.Hashtable h)

Deprecated.

Internal Use Only

finalize

public void finalize()

Deprecated.

Internal Use Only.

Specified by:

finalize in interface ObResourceRequestInterface

Overrides:

finalize in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Deprecated.

Used to clone ObResourceRequest Objects. When using this function care must be taken to use finalize() to clean up any unused old references

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException