Class TimerDecorator
java.lang.Object
org.forgerock.openig.decoration.helper.AbstractDecorator
org.forgerock.openig.decoration.timer.TimerDecorator
- All Implemented Interfaces:
Decorator
The timer decorator can decorate both
Filter
and
Handler
instances. It will log elapsed time within the decorated heap
object.
It has to be declared inside of the heap objects section:
{
"name": "myTimerDecorator",
"type": "TimerDecorator"
}
If you want to specify the time unit:
{
"name": "myTimerDecorator",
"type": "TimerDecorator"
"config": {
"timeUnit": "ms"
}
}
The value of the timeUnit is a single string representation of the
elapsed time unit as those supported by Duration
. An invalid string
or non recognized time unit will throw an error.
To decorate a component, just add the decorator declaration next to the
config
element:
{
"type": "...",
"timer": true,
"config": { ... }
}
A default timer decorator is automatically created when IG
starts.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Creates and initializes a TimerDecorator in a heap environment. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returnstrue
if this decorator is compatible with the provided component type.Decorates the provideddelegate
instance with the provideddecoratorConfig
configuration.Methods inherited from class org.forgerock.openig.decoration.helper.AbstractDecorator
getLogger
-
Method Details
-
accepts
Description copied from interface:Decorator
Returnstrue
if this decorator is compatible with the provided component type. Note that a return value oftrue
does not necessarily indicate that decoration will be performed since it may also depend on other factors- Parameters:
type
- type under test- Returns:
true
if the decorator can decorate instance of the given type,false
otherwise.
-
decorate
public DecorationHandle decorate(Object delegate, JsonValue decoratorConfig, Context context) throws HeapException Description copied from interface:Decorator
Decorates the provideddelegate
instance with the provideddecoratorConfig
configuration. The implementation should take care of not changing the base type of the delegate.- Parameters:
delegate
- instance to be decorateddecoratorConfig
- the decorator configuration to applycontext
- contextual information of the decorated instance- Returns:
- a handle of the decoration that was setup, never
null
. - Throws:
HeapException
- when decoration fails
-