org.forgerock.openig.openam

Class RequestResourceUriProvider

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.openam.RequestResourceUriProvider

All Implemented Interfaces:

Heaplet, ResourceUriProvider

public class RequestResourceUriProvider
extends GenericHeaplet
implements ResourceUriProvider

The RequestResourceUriProvider has the following configuration:

  {
      "type": "RequestResourceUriProvider",
      "config": {
        "useOriginalUri"     :  boolean      [OPTIONAL - default to false. When true, the original URI rather than
                                                         the request URI will be used to create the resourceUri.]
        "includeQueryParams" :  boolean      [OPTIONAL - default to true. When false, any query parameters
                                                         in the URI will be excluded from the resourceUri.]
      }
    }
 
 

Returns the URI to be used as the resource for the policy request based on either the request URI or the original URI.

Since:

7.0

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor and Description
RequestResourceUriProvider() Create a new RequestResourceUriProvider based on the defaults.
RequestResourceUriProvider(boolean useOriginalUri, boolean includeQueryParams) Create a new RequestResourceUriProvider based on the passed parameters.

Method Summary

Modifier and Type	Method and Description
Object	create() Called to request the heaplet create an object.
String	resourceUri(Context context, Request request) Returns the resource URI as a String to be used when making policy requests.

Methods inherited from class org.forgerock.openig.heap.GenericHeaplet

create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestResourceUriProvider

public RequestResourceUriProvider()

Create a new RequestResourceUriProvider based on the defaults.

RequestResourceUriProvider

public RequestResourceUriProvider(boolean useOriginalUri,
                                  boolean includeQueryParams)

Create a new RequestResourceUriProvider based on the passed parameters.

Parameters:

useOriginalUri - Set to true to make use of the original URI when creating the resourceUri.

includeQueryParams - Set to false to exclude any query parameters in the resourceUri.

Method Detail

resourceUri

public String resourceUri(Context context,
                          Request request)

Description copied from interface: ResourceUriProvider

Returns the resource URI as a String to be used when making policy requests.

Specified by:

resourceUri in interface ResourceUriProvider

Parameters:

context - The request context.

request - The request.

Returns:

a String representing the resource URI.

create

public Object create()
              throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.create(Name, JsonValue, Heap) after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.