Skip navigation links

oracle.security.am.asdk
Class ResourceRequest

java.lang.Object
oracle.security.am.asdk.ResourceRequest

All Implemented Interfaces:

java.lang.Cloneable

public final class ResourceRequest

extends java.lang.Object

implements java.lang.Cloneable

Represents a resource request for which access operations are to be performed. ResourceRequest objects are used by the AuthenticationScheme constructors to retrieve information about the resource's authentication scheme and by the isAuthorized() method of the UserSession class to determine if a user is authorized to access the resource.

Constructor Summary

ResourceRequest(AccessClient aClient, java.lang.String resType, java.lang.String resource, java.lang.String operation)
Constructs a ResourceRequest object with specified AccessClient object, resource type, name and operation.

ResourceRequest(AccessClient aClient, java.lang.String resType, java.lang.String resource, java.lang.String operation, java.util.Hashtable parameters)
Constructs a ResourceRequest object with specified AccessClient object, resource type, name, operation and parameters name/value pair hashtable.

ResourceRequest(java.lang.String resType, java.lang.String resource, java.lang.String operation)
Constructs a ResourceRequest object with specified resource type, name and operation.

ResourceRequest(java.lang.String resType, java.lang.String resource, java.lang.String operation, java.util.Hashtable parameters)
Constructs a ResourceRequest object with specified resource type, name, operation and parameters name/value pair hashtable.

Method Summary

java.lang.Object	clone() Used to clone ResourceRequest Objects.
java.util.Hashtable	getAuthorizationParameters() Returns parameters required for authorization of the resource.
int	getNumberOfAuthorizationParameters() Returns count of parameters required for authorization of the resource request object.
java.lang.String	getOperation() Returns Http method for resource request object
java.util.Hashtable	getParameters() Returns query parameters in the form of name/value pairs of String type.
java.lang.String	getResource() Returns resource
java.lang.String	getResourceType() Returns resource type
java.lang.String	getSchemeId() Returns authentication scheme id used to protect the resource
boolean	isProtected() Checks whether resource is protected.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRequest

public ResourceRequest(java.lang.String resType,
                       java.lang.String resource,
                       java.lang.String operation)
                throws AccessException

Constructs a ResourceRequest object with specified resource type, name and operation.

Parameters:

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

resource - Resource name

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

Throws:

AccessException - In case of errors during object creation or if resource or operation string is null

ResourceRequest

public ResourceRequest(AccessClient aClient,
                       java.lang.String resType,
                       java.lang.String resource,
                       java.lang.String operation)
                throws AccessException

Constructs a ResourceRequest object with specified AccessClient object, resource type, name and operation.

Parameters:

aClient - AccessClient object to be used for perfoming operations.

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

resource - Resource name

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

Throws:

AccessException - In case of errors during object creation or if resource or operation string is null

ResourceRequest

public ResourceRequest(java.lang.String resType,
                       java.lang.String resource,
                       java.lang.String operation,
                       java.util.Hashtable parameters)
                throws AccessException

Constructs a ResourceRequest 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

resource - 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:

AccessException - In case of errors during object creation or if resource or operation string is null

ResourceRequest

public ResourceRequest(AccessClient aClient,
                       java.lang.String resType,
                       java.lang.String resource,
                       java.lang.String operation,
                       java.util.Hashtable parameters)
                throws AccessException

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

Parameters:

aClient - AccessClient object to be used for perfoming operations.

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

resource - 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:

AccessException - In case of errors during object creation or if resource or operation string is null

Method Detail

isProtected

public boolean isProtected()
                    throws AccessException

Checks whether resource is protected.

Returns:

Boolean true if resource is protected.

Throws:

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

getSchemeId

public java.lang.String getSchemeId()
                             throws AccessException

Returns authentication scheme id used to protect the resource

Returns:

Authentication scheme id used to protect the resource

Throws:

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

getResourceType

public java.lang.String getResourceType()

Returns resource type

Returns:

String representing resource type

getResource

public java.lang.String getResource()

Returns resource

Returns:

String representing the resource

getOperation

public java.lang.String getOperation()

Returns Http method for resource request object

Returns:

Http method for resource request object

getParameters

public java.util.Hashtable getParameters()

Returns query parameters in the form of name/value pairs of String type.

Returns:

Hashtable of query string parameters in the form of name/value pairs of String type. It returns null value if query parameters were not passed while constructing ResourceRequest object.

getAuthorizationParameters

public java.util.Hashtable getAuthorizationParameters()
                                               throws AccessException

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.

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:

AccessException - In case if it resource request object is not initialized.

getNumberOfAuthorizationParameters

public int getNumberOfAuthorizationParameters()
                                       throws AccessException

Returns count of parameters required for authorization of the resource request object.

Returns:

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

Throws:

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

clone

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

Used to clone ResourceRequest Objects.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

Skip navigation links