Package org.forgerock.openig.heap

Class Keys

java.lang.Object

org.forgerock.openig.heap.Keys

public final class Keys
extends Object

Define here the constants that can be used as Heap's keys.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_PROTECTION_FILTER_HEAP_KEY	Key to retrieve a Filter instance from the Heap of admin.json.
static final String	AUDIT_DATASOURCE_HEAP_KEY	Key to retrieve the DataSource to use for auditing.
static final String	AUDIT_SERVICE_HEAP_KEY	Key to retrieve an AuditService instance from the Heap.
static final String	BASE64_PROPERTY_FORMAT	Key to retrieve a SecretPropertyFormat that decodes BASE64 strings.
static final String	BASEURI_HEAP_KEY	Key to retrieve a BaseUriDecorator instance from the Heap.
static final String	CAPTURE_HEAP_KEY	Key to retrieve a CaptureDecorator instance from the Heap.
static final String	CLIENT_HANDLER_HEAP_KEY	Key to retrieve the default ClientHandler instance from the Heap.
static final String	CLIENT_HANDLER_PROVIDER_HEAP_KEY	Key to retrieve the ClientHandler's loader instance from the Heap.
static final String	CLOCK_HEAP_KEY	Key to retrieve a Clock instance from the Heap.
static final String	ENDPOINT_REGISTRY_HEAP_KEY	Key to retrieve the EndpointRegistry instance dedicated for the current Route's objects from the Heap.
static final String	ENVIRONMENT_HEAP_KEY	Key to retrieve an Environment instance from the Heap.
static final String	FORGEROCK_CLIENT_HANDLER_HEAP_KEY	Key to retrieve ForgeRock ClientHandler instance from the Heap, which chains a TransactionIdOutboundFilter to a ClientHandler.
static final String	GLOBAL_METER_REGISTRY_HEAP_KEY	Key to retrieve the global MeterRegistry from the Heap.
static final String	HEAP_METER_REGISTRY_HEAP_KEY	Key to retrieve the local MeterRegistry from the Heap.
static final String	METRICS_PROTECTION_FILTER_HEAP_KEY	Key to retrieve a Filter instance from the Heap of config.json to protect the metrics endpoint.
static final String	PLAIN_PROPERTY_FORMAT	Key to retrieve a SecretPropertyFormat that decodes PLAIN strings.
static final String	PRODUCT_INFO_HEAP_KEY	Key to retrieve the ProductInfo from the Heap.
static final String	PROXY_OPTIONS_HEAP_KEY	Key to retrieve the default ProxyOptions instance from the Heap.
static final String	REVERSE_PROXY_HANDLER_HEAP_KEY	Key to retrieve a default ReverseProxyHandler instance from the Heap.
static final String	RUNMODE_HEAP_KEY	Key to retrieve the RunMode from the Heap.
static final String	SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY	Key to retrieve the default ScheduledExecutorService instance from the Heap.
static final String	SCRIPT_FACTORY_MANAGER_HEAP_KEY	Key to retrieve the global ScriptFactoryManager from the Heap.
static final String	SESSION_FACTORY_HEAP_KEY	Key to retrieve the default AsyncSessionManager instance from the Heap.
static final String	STUDIO_PROTECTION_FILTER_HEAP_KEY	Key to retrieve a Filter instance from the Heap of admin.json.
static final String	TEMPORARY_STORAGE_HEAP_KEY	Key to retrieve an implementation of a Factory of Buffer instance from the Heap.
static final String	TICKER_HEAP_KEY	Key to retrieve a Ticker instance from the Heap.
static final String	TIMER_HEAP_KEY	Key to retrieve a TimerDecorator instance from the Heap.
static final String	TRACING_HEAP_KEY	Key to retrieve a TracingDecorator instance from the Heap.
static final String	TRACING_PROVIDER_HEAP_KEY	Key to retrieve an TracingProvider instance from the Heap.
static final String	TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY	Key to retrieve a TransactionIdOutboundFilter instance from the Heap.
static final String	WEBSOCKET_CLIENT_PROVIDER_KEY	Key to retrieve the WebSocketClientProvider instance from the Heap.
static final String	WEBSOCKET_PROXY_FILTER_PROVIDER_KEY	Key to retrieve the WebSocketProxyFilterProvider instance from the Heap.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

API_PROTECTION_FILTER_HEAP_KEY

public static final String API_PROTECTION_FILTER_HEAP_KEY

Key to retrieve a Filter instance from the Heap of admin.json.

See Also:

• Constant Field Values

AUDIT_DATASOURCE_HEAP_KEY

public static final String AUDIT_DATASOURCE_HEAP_KEY

Key to retrieve the DataSource to use for auditing.

See Also:

• Constant Field Values

AUDIT_SERVICE_HEAP_KEY

public static final String AUDIT_SERVICE_HEAP_KEY

Key to retrieve an AuditService instance from the Heap.

See Also:

• Constant Field Values

BASE64_PROPERTY_FORMAT

public static final String BASE64_PROPERTY_FORMAT

Key to retrieve a SecretPropertyFormat that decodes BASE64 strings.

See Also:

• Constant Field Values

BASEURI_HEAP_KEY

public static final String BASEURI_HEAP_KEY

Key to retrieve a BaseUriDecorator instance from the Heap.

See Also:

• Constant Field Values

CAPTURE_HEAP_KEY

public static final String CAPTURE_HEAP_KEY

Key to retrieve a CaptureDecorator instance from the Heap.

See Also:

• Constant Field Values

CLIENT_HANDLER_HEAP_KEY

public static final String CLIENT_HANDLER_HEAP_KEY

Key to retrieve the default ClientHandler instance from the Heap. This instance is dedicated for services interactions.

See Also:

• Constant Field Values

CLIENT_HANDLER_PROVIDER_HEAP_KEY

public static final String CLIENT_HANDLER_PROVIDER_HEAP_KEY

Key to retrieve the ClientHandler's loader instance from the Heap.

See Also:

• Constant Field Values

CLOCK_HEAP_KEY

public static final String CLOCK_HEAP_KEY

Key to retrieve a Clock instance from the Heap.

See Also:

• Constant Field Values

ENDPOINT_REGISTRY_HEAP_KEY

public static final String ENDPOINT_REGISTRY_HEAP_KEY

Key to retrieve the EndpointRegistry instance dedicated for the current Route's objects from the Heap.

Objects declared in config.json will have a registry pointing to /openig/system/objects.

Objects declared into routes will have another registry that is dedicated to the host route: /openig/system/objects/.../[route-name]/objects.

Note that generic heaplets may use their private registry (using their own namespace based on their name) through endpointRegistry().

See Also:

• GenericHeaplet.endpointRegistry()
• Constant Field Values

ENVIRONMENT_HEAP_KEY

public static final String ENVIRONMENT_HEAP_KEY

Key to retrieve an Environment instance from the Heap.

See Also:

• Constant Field Values

FORGEROCK_CLIENT_HANDLER_HEAP_KEY

public static final String FORGEROCK_CLIENT_HANDLER_HEAP_KEY

Key to retrieve ForgeRock ClientHandler instance from the Heap, which chains a TransactionIdOutboundFilter to a ClientHandler. This Handler is used by audit to forward custom audit header.

See Also:

• Constant Field Values

GLOBAL_METER_REGISTRY_HEAP_KEY

public static final String GLOBAL_METER_REGISTRY_HEAP_KEY

Key to retrieve the global MeterRegistry from the Heap.

See Also:

• Constant Field Values

SCRIPT_FACTORY_MANAGER_HEAP_KEY

public static final String SCRIPT_FACTORY_MANAGER_HEAP_KEY

Key to retrieve the global ScriptFactoryManager from the Heap.

See Also:

• Constant Field Values

HEAP_METER_REGISTRY_HEAP_KEY

public static final String HEAP_METER_REGISTRY_HEAP_KEY

Key to retrieve the local MeterRegistry from the Heap. ThisMeterRegistry may be tagged with common tags.

See Also:

• Constant Field Values

METRICS_PROTECTION_FILTER_HEAP_KEY

public static final String METRICS_PROTECTION_FILTER_HEAP_KEY

Key to retrieve a Filter instance from the Heap of config.json to protect the metrics endpoint.

See Also:

• Constant Field Values

PROXY_OPTIONS_HEAP_KEY

public static final String PROXY_OPTIONS_HEAP_KEY

Key to retrieve the default ProxyOptions instance from the Heap.

See Also:

• Constant Field Values

PLAIN_PROPERTY_FORMAT

public static final String PLAIN_PROPERTY_FORMAT

Key to retrieve a SecretPropertyFormat that decodes PLAIN strings.

See Also:

• Constant Field Values

REVERSE_PROXY_HANDLER_HEAP_KEY

public static final String REVERSE_PROXY_HANDLER_HEAP_KEY

Key to retrieve a default ReverseProxyHandler instance from the Heap.

See Also:

• Constant Field Values

RUNMODE_HEAP_KEY

public static final String RUNMODE_HEAP_KEY

Key to retrieve the RunMode from the Heap.

See Also:

• Constant Field Values

PRODUCT_INFO_HEAP_KEY

public static final String PRODUCT_INFO_HEAP_KEY

Key to retrieve the ProductInfo from the Heap.

See Also:

• Constant Field Values

SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY

public static final String SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY

Key to retrieve the default ScheduledExecutorService instance from the Heap.

See Also:

• Constant Field Values

SESSION_FACTORY_HEAP_KEY

public static final String SESSION_FACTORY_HEAP_KEY

Key to retrieve the default AsyncSessionManager instance from the Heap.

See Also:

• Constant Field Values

STUDIO_PROTECTION_FILTER_HEAP_KEY

public static final String STUDIO_PROTECTION_FILTER_HEAP_KEY

Key to retrieve a Filter instance from the Heap of admin.json.

See Also:

• Constant Field Values

TEMPORARY_STORAGE_HEAP_KEY

public static final String TEMPORARY_STORAGE_HEAP_KEY

Key to retrieve an implementation of a Factory of Buffer instance from the Heap.

See Also:

• Constant Field Values

TICKER_HEAP_KEY

public static final String TICKER_HEAP_KEY

Key to retrieve a Ticker instance from the Heap.

See Also:

• Constant Field Values

TIMER_HEAP_KEY

public static final String TIMER_HEAP_KEY

Key to retrieve a TimerDecorator instance from the Heap.

See Also:

• Constant Field Values

TRACING_HEAP_KEY

public static final String TRACING_HEAP_KEY

Key to retrieve a TracingDecorator instance from the Heap.

See Also:

• Constant Field Values

TRACING_PROVIDER_HEAP_KEY

public static final String TRACING_PROVIDER_HEAP_KEY

Key to retrieve an TracingProvider instance from the Heap.

See Also:

• Constant Field Values

TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY

public static final String TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY

Key to retrieve a TransactionIdOutboundFilter instance from the Heap.

See Also:

• Constant Field Values

WEBSOCKET_CLIENT_PROVIDER_KEY

public static final String WEBSOCKET_CLIENT_PROVIDER_KEY

Key to retrieve the WebSocketClientProvider instance from the Heap.

See Also:

• Constant Field Values

WEBSOCKET_PROXY_FILTER_PROVIDER_KEY

public static final String WEBSOCKET_PROXY_FILTER_PROVIDER_KEY

Key to retrieve the WebSocketProxyFilterProvider instance from the Heap.

See Also:

• Constant Field Values