PolicyRuntime (Oracle Fusion Middleware Extensibility Java API Reference for Oracle Access Management Access Manager)

All Known Implementing Classes:

PolicyRuntimeImpl
```
public interface PolicyRuntime
```
PolicyRuntime provides the policy runtime evaluation functionality. It delegates requests to the associated PolicyRuntimeProvider instance. PolicyRuntime implementation object is instantiated by PolicyRuntimeFactory with a PolicyRuntimeProvider.

Since:

11gR1

See Also:

oracle.security.am.common.policy.PolicyRuntimeFactory, oracle.security.am.common.policy.PolicyRuntimeProvider

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPolicyChangeEventListener(PolicyChangeEventListener listener)` Adds the specified event listener to receive policy runtime change events.
`java.util.List<PolicyChangeEvent>`	`getAllPolicyChangeEvents()` Returns all the policy change events.
`java.util.List<PolicyChangeEvent>`	`getAllPolicyChangeEvents(long fromChangeVersion)` Returns all the policy change events starting from the input change version to the latest version.
`RuntimeAuthnScheme`	`getAuthnScheme(java.lang.String schemeName)` Returns `RuntimeAuthnScheme` for the given scheme name.
`OAuthClient`	`getClient(java.lang.String clientId, java.lang.String domainName)`
`java.lang.String`	`getHostIdentifier(java.lang.String host, int port)` Returns Host Identifier associated with a host and port.
`OAuthIdentityDomain`	`getIdentityDomain(java.lang.String domainName)`
`PolicyChangeEvent`	`getLatestPolicyChangeEvent()` Returns the latest policy change event.
`PolicyChangeEvent`	`getPolicyChangeEvent(long changeVersion)` Returns the policy change event associated with the input change version.
`OAuthResourceServer`	`getResource(java.lang.String resourceId, java.lang.String domainName)`
`long`	`getStoreVersionInUse()` Returns the policy store version currently in use.
`AccessResult`	`isAuthorized(AccessRequest request)` Determines if a given Subject is permitted to access a RuntimeResource.
`AccessResult`	`isResourceProtected(AccessRequest request)` Determines if a given RuntimeResource is protected with an authentication policy, if so, it evaluates the policy and returns the evaluation result,the authentication scheme specified for the resource, and any responses specified in the authentication policy.
`AccessResult`	`isSessionValid(AccessRequest request)` Determines if a given user session is valid for the access request.
`AccessResult`	`isTokenRequestAuthorized(AccessRequest request)` Determines if a given Subject is permitted to request a token that will be used to access RuntimeResource.
`void`	`removePolicyChangeEventListener(PolicyChangeEventListener listener)` Removes the specified policy runtime change event listener.

- Method Detail
  - isResourceProtected
```
AccessResult isResourceProtected(AccessRequest request)
                          throws PolicyEvaluationException
```
    Determines if a given RuntimeResource is protected with an authentication policy, if so, it evaluates the policy and returns the evaluation result,the authentication scheme specified for the resource, and any responses specified in the authentication policy. (It does not do the processing by itself, it forwards the requests to PolicyRuntimeProvider for the actual processing of the request)
    
    Parameters:
    
    request - AccessRequest containing resource (required), identity (optional), and access context (optional).
    
    Returns:
    
    AccessResult Access Result containing the policy evaluation result and authentication scheme
    
    Throws:
    
    PolicyEvaluationException - stores root cause for failure.
  - isAuthorized
```
AccessResult isAuthorized(AccessRequest request)
                   throws PolicyEvaluationException
```
    Determines if a given Subject is permitted to access a RuntimeResource. It returns the authorization policy evaluation result and any responses specified in the authorization policy. (It does not do the processing by itself, it forwards the requests to PolicyRuntimeProvider for the actual processing of the request)
    
    Parameters:
    
    request - AccessRequest containing resource (required), identity (required), and access context (optional).
    
    Returns:
    
    AccessResult Access Result containing the authorization policy evaluation result and responses
    
    Throws:
    
    PolicyEvaluationException - stores root cause for failure.
  - isSessionValid
```
AccessResult isSessionValid(AccessRequest request)
                     throws PolicyEvaluationException
```
    Determines if a given user session is valid for the access request.
    
    Parameters:
    
    request - AccessRequest containing resource (required), and access context (required, should contain session)
    
    Returns:
    
    access result containing the session validity check result.
    
    Throws:
    
    PolicyEvaluationException
  - isTokenRequestAuthorized
```
AccessResult isTokenRequestAuthorized(AccessRequest request)
                               throws PolicyEvaluationException
```
    Determines if a given Subject is permitted to request a token that will be used to access RuntimeResource.
    
    Parameters:
    
    request - access request
    
    Returns:
    
    AccessResult token issuance authorization policy evaluation result
    
    Throws:
    
    PolicyEvaluationException
    
    Since:
    
    11gR1PS1
  - getAuthnScheme
```
RuntimeAuthnScheme getAuthnScheme(java.lang.String schemeName)
                           throws PolicyEvaluationException
```
    Returns RuntimeAuthnScheme for the given scheme name.
    
    Parameters:
    
    String - scheme name.
    
    Returns:
    
    RuntimeAuthnScheme
    
    Throws:
    
    PolicyEvaluationException
  - getHostIdentifier
```
java.lang.String getHostIdentifier(java.lang.String host,
                                   int port)
                            throws PolicyEvaluationException
```
    Returns Host Identifier associated with a host and port.
    
    Parameters:
    
    host - - hostname
    
    port - - for preferred hosts port value is 0
    
    Returns:
    
    String Host Identifier Name
    
    Throws:
    
    PolicyEvaluationException
  - getPolicyChangeEvent
```
PolicyChangeEvent getPolicyChangeEvent(long changeVersion)
                                throws PolicyEvaluationException
```
    Returns the policy change event associated with the input change version.
    
    Parameters:
    
    version -
    
    Returns:
    
    policy change event list
    
    Throws:
    
    PolicyEvaluationException
  - getAllPolicyChangeEvents
```
java.util.List<PolicyChangeEvent> getAllPolicyChangeEvents()
                                                    throws PolicyEvaluationException
```
    Returns all the policy change events.
    
    Parameters:
    
    version -
    
    Returns:
    
    policy change event list
    
    Throws:
    
    PolicyEvaluationException
  - getAllPolicyChangeEvents
```
java.util.List<PolicyChangeEvent> getAllPolicyChangeEvents(long fromChangeVersion)
                                                    throws PolicyEvaluationException
```
    Returns all the policy change events starting from the input change version to the latest version.
    
    Parameters:
    
    version -
    
    Returns:
    
    policy change event list
    
    Throws:
    
    PolicyEvaluationException
  - getLatestPolicyChangeEvent
```
PolicyChangeEvent getLatestPolicyChangeEvent()
                                      throws PolicyEvaluationException
```
    Returns the latest policy change event.
    
    Parameters:
    
    version -
    
    Returns:
    
    policy change event
    
    Throws:
    
    PolicyEvaluationException
  - addPolicyChangeEventListener
```
void addPolicyChangeEventListener(PolicyChangeEventListener listener)
                           throws PolicyEvaluationException
```
    Adds the specified event listener to receive policy runtime change events.
    
    Parameters:
    
    listener -
    
    Throws:
    
    PolicyEvaluationException
  - removePolicyChangeEventListener
```
void removePolicyChangeEventListener(PolicyChangeEventListener listener)
                              throws PolicyEvaluationException
```
    Removes the specified policy runtime change event listener.
    
    Parameters:
    
    listener -
    
    Throws:
    
    PolicyEvaluationException
  - getStoreVersionInUse
```
long getStoreVersionInUse()
                   throws PolicyEvaluationException
```
    Returns the policy store version currently in use.
    
    Returns:
    
    store version
    
    Throws:
    
    PolicyEvaluationException
    
    Since:
    
    11gR1PS1
  - getClient
```
OAuthClient getClient(java.lang.String clientId,
                      java.lang.String domainName)
               throws PolicyEvaluationException
```
    Throws:
    
    PolicyEvaluationException
  - getResource
```
OAuthResourceServer getResource(java.lang.String resourceId,
                                java.lang.String domainName)
                         throws PolicyEvaluationException
```
    Throws:
    
    PolicyEvaluationException
  - getIdentityDomain
```
OAuthIdentityDomain getIdentityDomain(java.lang.String domainName)
                               throws PolicyEvaluationException
```
    Throws:
    
    PolicyEvaluationException

Interface PolicyRuntime

Method Summary

Method Detail

isResourceProtected

isAuthorized

isSessionValid

isTokenRequestAuthorized

getAuthnScheme

getHostIdentifier

getPolicyChangeEvent

getAllPolicyChangeEvents

getAllPolicyChangeEvents

getLatestPolicyChangeEvent

addPolicyChangeEventListener

removePolicyChangeEventListener

getStoreVersionInUse

getClient

getResource

getIdentityDomain