DumpFilter

The task of the DumpFilter is to dump the request and response in a file. The DumpFilter (as well as the CacheFilter) creates directories whose permissions are set to 0772 so that anyone may dump into the directory, but only users of the same group have read access. Dumping of all requests without any limitation will lead to problems in production environments.

DumpFilter should therefore only be used for trouble shooting and integration tasks!

Classname

```script title="Classname"
ch::nevis::isiweb4::filter::debug::DumpFilter

Library

```script title="Library"
libDebugFilters.so.1

Configuration

DumpDirectory

Type: string
Usage Constraint: required

Defines the directory where all requests are to be dumped to files.

MaxSession

Type: integer
Usage Constraint: optional
Default: 50

Limits number of dumped files to MaxSession+1 x MaxRequest.

MaxRequest

Type: integer
Usage Constraint: optional
Default: 50

Limits number of dumped files to MaxSession+1 x MaxRequest.

DumpRequest

Type: enum: none, head, body, both
Usage Constraint: optional
Default: none

Configures which parts of the request will be dumped.

DumpResponse

Type: enum: none, head, body, both
Usage Constraint: optional
Default: none

Configures which parts of the response will be dumped.

CreateSession

Type: boolean
Usage Constraint: optional
Default: false

Defines if a session will be created that is used for the tracking of the files.

MaxBufferSize

Type: integer
Usage Constraint: optional
Default: 8192

Defines the maximal buffer size for incoming requests.

Disable

Type: boolean
Usage Constraint: optional, conditions are supported
Supported pragmas: break

Conditional attribute (only pragma: break supported) if the filter is disabled or not. If it is disabled, nothing will be dumped.

Sample configuration

<filter>
  <filter-name>DumpReqRes</filter-name>
  <filter-class>ch::nevis::isiweb4::filter::debug::DumpFilter</filter-class>
    <init-param>
       <param-name>DumpDirectory</param-name>
       <param-value>/var/opt/nevisproxy/default/run</param-value>
    </init-param>
    <init-param>
       <param-name>MaxRequest</param-name>
       <param-value>100</param-value>
    </init-param>
    <init-param>
       <param-name>DumpRequest</param-name>
       <param-value>both</param-value>
    </init-param>
    <init-param>
       <param-name>DumpResponse</param-name>
       <param-value>both</param-value>
    </init-param>
</filter>