You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A `Decorator` adds new behavior to another object without changing the base type of the object.
586
586
587
587
+
588
588
When suggesting custom `Decorator` names, know that OpenIG reserves all field names that use only alphanumeric characters. To avoid clashes, use dots or dashes in your field names, such as `my-decorator`.
An `ExpressionPlugin` adds a node to the `Expression` context tree, alongside `env` (for environment variables), and `system` (for system properties). For example, the expression `${system['user.home']}` yields the home directory of the user running the application server for OpenIG.
592
592
593
593
+
@@ -599,28 +599,28 @@ When you add your own `ExpressionPlugin`, you must make it discoverable within y
599
599
+
600
600
Be sure to provide some documentation for OpenIG administrators on how your plugin extends expressions.
A `Filter` serves to process a request before handing it off to the next element in the chain, in a similar way to an interceptor programming model.
605
605
606
606
+
607
-
The `Filter` interface exposes a `filter()` method, which takes a link:{apidocs-url}/index.html?org/forgerock/http/Context.html[Context, window=\_blank], a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank], and the link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[Handler, window=\_blank], which is the next filter or handler to dispatch to. The `filter()` method returns a link:{apidocs-url}/index.html?org/forgerock/util/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions.
607
+
The `Filter` interface exposes a `filter()` method, which takes a link:{apidocs-url}/org/forgerock/http/Context.html[Context, window=\_blank], a link:{apidocs-url}/org/forgerock/http/protocol/Request.html[Request, window=\_blank], and the link:{apidocs-url}/org/forgerock/http/Handler.html[Handler, window=\_blank], which is the next filter or handler to dispatch to. The `filter()` method returns a link:{apidocs-url}/org/forgerock/util/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions.
608
608
609
609
+
610
610
A filter can elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to `next.handle(context, request)`, creating its own response object and returning that in the promise. The filter is also at liberty to replace a response with another of its own. A filter can exist in more than one chain, therefore should make no assumptions or correlations using the chain it is supplied. The only valid use of a chain by a filter is to call its `handle()` method to dispatch the request to the rest of the chain.
611
611
612
612
+
613
-
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
613
+
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
The `Handler` interface exposes a `handle()` method, which takes a link:{apidocs-url}/index.html?org/forgerock/http/Context.html[Context, window=\_blank], and a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank]. It processes the request and returns a link:{apidocs-url}/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions. A handler can elect to dispatch the request to another handler or chain.
620
+
The `Handler` interface exposes a `handle()` method, which takes a link:{apidocs-url}/org/forgerock/http/Context.html[Context, window=\_blank], and a link:{apidocs-url}/org/forgerock/http/protocol/Request.html[Request, window=\_blank]. It processes the request and returns a link:{apidocs-url}/org/forgerock/util/promise/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions. A handler can elect to dispatch the request to another handler or chain.
621
621
622
622
+
623
-
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
623
+
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
Copy file name to clipboardExpand all lines: openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@
14
14
Copyright 2025 3A Systems LLC.
15
15
////
16
16
+
17
-
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
17
+
A link:{apidocs-url}/org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
@@ -611,7 +611,7 @@ Set this to `"topics": [ "access" ]`.
611
611
The database type name.
612
612
613
613
+
614
-
Built-in support is provided for `oracle`, `mysql`, and `h2`. Unrecognized database types rely on a link:{apidocs-url}/index.html?org/forgerock/audit/handlers/jdbc/providers/GenericDatabaseStatementProvider.html[GenericDatabaseStatementProvider, window=\_top].
614
+
Built-in support is provided for `oracle`, `mysql`, and `h2`. Unrecognized database types rely on a link:{apidocs-url}/org/forgerock/audit/handlers/jdbc/providers/GenericDatabaseStatementProvider.html[GenericDatabaseStatementProvider, window=\_top].
615
615
616
616
`"enabled"`: __boolean, optional__::
617
617
Whether this event handler is active.
@@ -812,7 +812,7 @@ Examples including statements to create tables are provided in the JDBC handler
Copy file name to clipboardExpand all lines: openig-doc/src/main/asciidoc/reference/decorators-conf.adoc
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,15 +149,15 @@ A reference to the data involved in the event, providing access to the `request`
149
149
The source of the audit event, meaning the name of the object under audit.
150
150
151
151
+
152
-
For details, see link:{apidocs-url}/index.html?org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].
152
+
For details, see link:{apidocs-url}/org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].
153
153
154
154
`event.tags`::
155
155
Strings that qualify the event. Entities receiving notifications can use the tags to select audit events of interest.
156
156
157
157
+
158
158
Define your own audit tags in order to identify particular events or routes.
159
159
+
160
-
OpenIG provides the following built-in tags in link:{apidocs-url}/index.html?org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]:
160
+
OpenIG provides the following built-in tags in link:{apidocs-url}/org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]:
161
161
162
162
* `request`: This event happens before OpenIG calls the decorated object.
163
163
@@ -245,7 +245,7 @@ To observe audit events, use a registered audit agent such as a MonitorEndpointH
Copy file name to clipboardExpand all lines: openig-doc/src/main/asciidoc/reference/expressions-conf.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -880,9 +880,9 @@ The string resulting from URL encoding the provided userInfo as per RFC 3986.
880
880
881
881
[#functions-javadoc]
882
882
==== Javadoc
883
-
Some functions are provided by link:{apidocs-url}/index.html?org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].
883
+
Some functions are provided by link:{apidocs-url}/org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].
884
884
885
-
Other functions are provided by link:{apidocs-url}/index.html?org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].
885
+
Other functions are provided by link:{apidocs-url}/org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].
0 commit comments