OpenIG 3.1.0 fixes a number of issues, and provides the following additional features.

• OpenIG can now store session information in encrypted JSON Web Token (JWT) cookies on the user-agent (OPENIG-224, OPENIG-278). By default, OpenIG continues to back session information with HttpSession from the container where OpenIG runs.

  With this change, you can specify the session storage at the global level, or in a particular route configuration. For details, see JwtSession in the Reference and Setting Up Keys For JWT Encryption in the Gateway Guide.

• OpenIG now allows you to inline configuration objects (OPENIG-311), to omit "config" fields when all values are optional (OPENIG-300), to omit the "objects" field from the "heap" (OPENIG-380), and even to omit the "heap" when it is empty or would only contain a single handler (OPENIG-329).

  When you bring an object inline, you no longer need to specify the "name".

  For example, suppose your former config.json file looks like this:

  {
      "heap": {
          "objects": [
              {
                  "name": "Chain",
                  "type": "Chain",
                  "config": {
                      "filters": [
                          "ReplaceHostFilter"
                      ],
                      "handler": "Router"
                  }
              },
              {
                  "name": "ReplaceHostFilter",
                  "type": "HeaderFilter",
                  "config": {
                      "messageType": "REQUEST",
                      "remove": [
                          "host"
                      ],
                      "add": {
                          "host": [
                              "example.com"
                          ]
                      }
                  }
              },
              {
                  "name": "Router",
                  "type": "Router",
                  "config": {}
              }
          ]
      },
      "handler": "Chain"
  }
      

  OpenIG now lets you rewrite the config.json file like this:

  {
      "handler": {
          "type": "Chain",
          "config": {
              "filters": [
                  {
                      "type": "HeaderFilter",
                      "config": {
                          "messageType": "REQUEST",
                          "remove": [
                              "host"
                          ],
                          "add": {
                              "host": [
                                  "example.com"
                              ]
                          }
                      }
                  }
              ],
              "handler": {
                  "type": "Router"
              }
          }
      }
  }
      

  Examples in the documentation now use streamlined configurations where it makes sense.

• OpenIG now supports object decorators (OPENIG-340). Decorators allow you to define heap objects that decorate other objects, adding the new behavior that the decorator provides.

  OpenIG provides the following decorators out of the box.

  • A CaptureDecorator that extends what the CaptureFilter could do to capture requests, responses, and exchange data on any decorated object (OPENIG-299, OPENIG-301)

  • A TimerDecorator that records times to process the exchange through any decorated object (OPENIG-352, OPENIG-353)

  • An AuditDecorator that allows you to audit operation for any decorated object.

  For detailed information about decorators, see the Reference on Decorators in the Reference.

• OpenIG now provides a publish-and-subscribe audit framework and a sample monitoring handler that returns basic statistics (OPENIG-359, OPENIG-386). To learn more, start by reading the chapter about the OpenIG Audit Framework in the Gateway Guide.

• OpenIG script configurations can now include arguments (OPENIG-240).

• The OAuth2ClientFilter and OAuth2ResourceServerFilter now cache data to avoid unnecessarily calls to the provider (OPENIG-350).

• OpenIG uses improved object names in log messages that make it easier to identify the source of the message (OPENIG-358, OPENIG-371).

• The OpenIG Exchange now provides information about the client (OPENIG-333).

  For details see the Reference on ClientInfo in the Reference.

OpenIG runs in the following web application containers.

• Apache Tomcat 7

• Jetty 8 (8.1.13 or later)

This release deprecates the following API classes, which are likely to be removed in a future release.

• org.forgerock.openig.filter.CaptureFilter

• org.forgerock.openig.heap.NestedHeaplet