Keys (OpenIG Project 5.3.3-SNAPSHOT API)

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 and Description
`static String`	`API_PROTECTION_FILTER_HEAP_KEY` Key to retrieve a `Filter` instance from the `Heap` of config.json.
`static String`	`BASEURI_HEAP_KEY` Key to retrieve a `BaseUriDecorator` instance from the `Heap`.
`static String`	`CAPTURE_HEAP_KEY` Key to retrieve a `CaptureDecorator` instance from the `Heap`.
`static String`	`CLIENT_HANDLER_HEAP_KEY` Key to retrieve a default `ClientHandler` instance from the `Heap`.
`static String`	`ENDPOINT_REGISTRY_HEAP_KEY` Key to retrieve the `EndpointRegistry` instance dedicated for the current Route's objects from the `Heap`.
`static String`	`ENVIRONMENT_HEAP_KEY` Key to retrieve an `Environment` instance from the `Heap`.
`static String`	`FORGEROCK_CLIENT_HANDLER_HEAP_KEY` Key to retrieve ForgeRock `ClientHandler` instance from the `Heap`, which chains a `TransactionIdOutboundFilter` to a `ClientHandler`.
`static String`	`RUNMODE_HEAP_KEY` Key to retrieve the `RunMode` from the `Heap`.
`static String`	`SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY` Key to retrieve the default `ScheduledExecutorService` instance from the `Heap`.
`static String`	`SESSION_FACTORY_HEAP_KEY` Key to retrieve the default `SessionManager` instance from the `Heap`.
`static String`	`TEMPORARY_STORAGE_HEAP_KEY` Key to retrieve an implementation of a `org.forgerock.util.Factory` instance from the `Heap`.
`static String`	`TICKER_HEAP_KEY` Key to retrieve a `Ticker` instance from the `Heap`.
`static String`	`TIME_SERVICE_HEAP_KEY` Key to retrieve a `TimeService` instance from the `Heap`.
`static String`	`TIMER_HEAP_KEY` Key to retrieve a `TimerDecorator` instance from the `Heap`.
`static String`	`TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY` Key to retrieve a `TransactionIdOutboundFilter` 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 Detail
  - API_PROTECTION_FILTER_HEAP_KEY
```
public static final String API_PROTECTION_FILTER_HEAP_KEY
```
    Key to retrieve a Filter instance from the Heap of config.json.
    
    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 a default ClientHandler 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
  - RUNMODE_HEAP_KEY
```
public static final String RUNMODE_HEAP_KEY
```
    Key to retrieve the RunMode 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 SessionManager instance from the Heap.
    
    See Also:
    
    Constant Field Values
  - TEMPORARY_STORAGE_HEAP_KEY
```
public static final String TEMPORARY_STORAGE_HEAP_KEY
```
    Key to retrieve an implementation of a org.forgerock.util.Factory 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
  - TIME_SERVICE_HEAP_KEY
```
public static final String TIME_SERVICE_HEAP_KEY
```
    Key to retrieve a TimeService 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

Class Keys

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

API_PROTECTION_FILTER_HEAP_KEY

BASEURI_HEAP_KEY

CAPTURE_HEAP_KEY

CLIENT_HANDLER_HEAP_KEY

ENDPOINT_REGISTRY_HEAP_KEY

ENVIRONMENT_HEAP_KEY

FORGEROCK_CLIENT_HANDLER_HEAP_KEY

RUNMODE_HEAP_KEY

SCHEDULED_EXECUTOR_SERVICE_HEAP_KEY

SESSION_FACTORY_HEAP_KEY

TEMPORARY_STORAGE_HEAP_KEY

TICKER_HEAP_KEY

TIMER_HEAP_KEY

TIME_SERVICE_HEAP_KEY

TRANSACTION_ID_OUTBOUND_FILTER_HEAP_KEY