Class 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:

    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 set a limit on the maximum length of entities to capture, use maxEntityLength and set it to a value in bytes, the default is 512K. 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 IG starts. It can be overridden in the configuration files if default values are not satisfying.
    • 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
      • CaptureDecorator

        public CaptureDecorator​(String name,
                                boolean captureEntity,
                                boolean captureContext,
                                int maxEntityLength)
        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
        maxEntityLength - Set the maximum entity length to capture if captureEntity is enabled.