Package org.forgerock.openig.decoration.capture

Class CaptureDecorator

java.lang.Object

org.forgerock.openig.decoration.helper.AbstractDecorator

org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator

org.forgerock.openig.decoration.capture.CaptureDecorator

All Implemented Interfaces:

Decorator

public class CaptureDecorator
extends AbstractHandlerAndFilterDecorator

The capture decorator can decorates both Filter and Handler instances. It enables the user to see the messages coming in and out of the decorated object.

Multiple input/output can be intercepted:

• CapturePoint.ALL: Prints all of the messages
• CapturePoint.FILTERED_REQUEST: Prints the outgoing request (Filter only)
• CapturePoint.FILTERED_RESPONSE: Prints the outgoing response
• CapturePoint.REQUEST: Prints incoming + outgoing request
• CapturePoint.RESPONSE: Prints incoming + outgoing response

Notice that camel case is not important: all equals ALL and even AlL. It has to be declared inside of the heap objects section:

     
     {
       "name": "capture",
       "type": "CaptureDecorator",
       "config": {
           "captureEntity": false,
           "captureContext": false
       }
     }
     
 

The capture decorator can be configured to globally enable entity capture using the captureEntity boolean attribute (default to false). To capture the context at the capture point as well, use the captureContext boolean attribute (default to false).

To decorate a component, just add the decorator declaration next to the config element:

     
     {
       "type": "...",
       "capture": [ "FILTERED_REQUEST", "RESPONSE" ],
       "config": { ... }
     }
     
 

Notice that the attribute name in the decorated object has to be the same as the decorator heap object name (capture in our example). A default capture decorator is automatically created when OpenIG starts. It can be overridden in the configuration files if default values are not satisfying.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaptureDecorator.Heaplet	Creates and initializes a CaptureDecorator in a heap environment.

Constructor Summary

Constructors

Constructor	Description
CaptureDecorator(String name, boolean captureEntity, boolean captureContext)	Builds a new capture decorator.

Method Summary

Modifier and Type	Method	Description
protected org.forgerock.http.Filter	decorateFilter(org.forgerock.http.Filter delegate, org.forgerock.json.JsonValue decoratorConfig, Context context)	Decorates the provided delegate Filter instance with the provided decoratorConfig configuration.
protected org.forgerock.http.Handler	decorateHandler(org.forgerock.http.Handler delegate, org.forgerock.json.JsonValue decoratorConfig, Context context)	Decorates the provided delegate Handler instance with the provided decoratorConfig configuration.

Methods inherited from class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator

accepts, decorate

Methods inherited from class org.forgerock.openig.decoration.helper.AbstractDecorator

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptureDecorator

public CaptureDecorator(String name,
                        boolean captureEntity,
                        boolean captureContext)

Builds a new capture decorator.

Parameters:

name - The name of this decorator

captureEntity - true if the decorator needs to capture the entity, false otherwise

captureContext - true if the decorator needs to capture the context, false otherwise

Method Detail

decorateFilter

protected org.forgerock.http.Filter decorateFilter(org.forgerock.http.Filter delegate,
                                                   org.forgerock.json.JsonValue decoratorConfig,
                                                   Context context)
                                            throws HeapException

Description copied from class: AbstractHandlerAndFilterDecorator

Decorates the provided delegate Filter instance with the provided decoratorConfig configuration.

Specified by:

decorateFilter in class AbstractHandlerAndFilterDecorator

Parameters:

delegate - Filter instance to be decorated

decoratorConfig - the decorator configuration to apply

context - contextual information of the decorated instance

Returns:

a decorated filter instance (or original filter delegate)

Throws:

HeapException - when decoration fails

decorateHandler

protected org.forgerock.http.Handler decorateHandler(org.forgerock.http.Handler delegate,
                                                     org.forgerock.json.JsonValue decoratorConfig,
                                                     Context context)
                                              throws HeapException

Description copied from class: AbstractHandlerAndFilterDecorator

Decorates the provided delegate Handler instance with the provided decoratorConfig configuration.

Specified by:

decorateHandler in class AbstractHandlerAndFilterDecorator

Parameters:

delegate - Handler instance to be decorated

decoratorConfig - the decorator configuration to apply

context - contextual information of the decorated instance

Returns:

a decorated handler instance (or original handler delegate)

Throws:

HeapException - when decoration fails