|
Oracle Access Manager Access SDK Java API Reference 11g Release 1 (11.1.1) E22472-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.am.asdk.ResourceRequest
public final class ResourceRequest
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 |
---|
public ResourceRequest(java.lang.String resType, java.lang.String resource, java.lang.String operation) throws AccessException
resType
- Resource type, for example http, ejb etc. If null, defaults to httpresource
- Resource nameoperation
- operation for the resource object, for example GET, POST , PUT, HEAD, DELETE, TRACE, OPTIONS, CONNECT, OTHER.AccessException
- In case of errors during object creation or if resource or operation string is nullpublic ResourceRequest(AccessClient aClient, java.lang.String resType, java.lang.String resource, java.lang.String operation) throws AccessException
aClient
- AccessClient object to be used for perfoming operations.resType
- Resource type, for example http, ejb etc. If null, defaults to httpresource
- Resource nameoperation
- operation for the resource object, for example GET, POST , PUT, HEAD, DELETE, TRACE, OPTIONS, CONNECT, OTHER.AccessException
- In case of errors during object creation or if resource or operation string is nullpublic ResourceRequest(java.lang.String resType, java.lang.String resource, java.lang.String operation, java.util.Hashtable parameters) throws AccessException
resType
- Resource type, for example http, ejb etc., If null defaults to httpresource
- Resource nameoperation
- 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.AccessException
- In case of errors during object creation or if resource or operation string is nullpublic ResourceRequest(AccessClient aClient, java.lang.String resType, java.lang.String resource, java.lang.String operation, java.util.Hashtable parameters) throws AccessException
aClient
- AccessClient object to be used for perfoming operations.resType
- Resource type, for example http, ejb etc., If null defaults to httpresource
- Resource nameoperation
- 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.AccessException
- In case of errors during object creation or if resource or operation string is nullMethod Detail |
---|
public boolean isProtected() throws AccessException
AccessException
- In case server could not determine the protected status of the resource or some other errorpublic java.lang.String getSchemeId() throws AccessException
AccessException
- In case if resource request object is not initialized.public java.lang.String getResourceType()
public java.lang.String getResource()
public java.lang.String getOperation()
public java.util.Hashtable getParameters()
public java.util.Hashtable getAuthorizationParameters() throws AccessException
AccessException
- In case if it resource request object is not initialized.public int getNumberOfAuthorizationParameters() throws AccessException
AccessException
- In case if resource request object is not initialized.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
Oracle Access Manager Access SDK Java API Reference 11g Release 1 (11.1.1) E22472-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |