Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -581,13 +581,13 @@ Interface Stability: Evolving (For information, see xref:../reference/appendix-i
--
The following interfaces are available:

link:{apidocs-url}/index.html?org/forgerock/openig/decoration/Decorator.html[Decorator, window=\_blank]::
link:{apidocs-url}/org/forgerock/openig/decoration/Decorator.html[Decorator, window=\_blank]::
A `Decorator` adds new behavior to another object without changing the base type of the object.

+
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`.

link:{apidocs-url}/index.html?org/forgerock/openig/el/ExpressionPlugin.html[ExpressionPlugin, window=\_blank]::
link:{apidocs-url}/org/forgerock/openig/el/ExpressionPlugin.html[ExpressionPlugin, window=\_blank]::
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.

+
Expand All @@ -599,28 +599,28 @@ When you add your own `ExpressionPlugin`, you must make it discoverable within y
+
Be sure to provide some documentation for OpenIG administrators on how your plugin extends expressions.

link:{apidocs-url}/index.html?org/forgerock/http/Filter.html[Filter, window=\_blank]::
link:{apidocs-url}/org/forgerock/http/Filter.html[Filter, window=\_blank]::
+
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.

+
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.
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.

+
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.

+
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.

link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[Handler, window=\_blank]::
link:{apidocs-url}/org/forgerock/http/Handler.html[Handler, window=\_blank]::
+
A `Handler` generates a response for a request.

+
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.
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.

+
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.

--

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
Copyright 2025 3A Systems LLC.
////
+
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`.
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`.
+
Durations are not case sensitive.
+
Expand Down
10 changes: 5 additions & 5 deletions openig-doc/src/main/asciidoc/reference/audit-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ The following example route uses the audit service:

[#d210e10206]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank]
link:{apidocs-url}/org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank]

'''
[#CsvAuditEventHandler]
Expand Down Expand Up @@ -531,7 +531,7 @@ The following example configures a CSV audit event handler to write a log file,

[#d210e11344]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank]
link:{apidocs-url}/org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank]

'''
[#JdbcAuditEventHandler]
Expand Down Expand Up @@ -611,7 +611,7 @@ Set this to `"topics": [ "access" ]`.
The database type name.

+
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].
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].

`"enabled"`: __boolean, optional__::
Whether this event handler is active.
Expand Down Expand Up @@ -812,7 +812,7 @@ Examples including statements to create tables are provided in the JDBC handler

[#d210e11910]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank]
link:{apidocs-url}/org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank]

'''
[#SyslogAuditEventHandler]
Expand Down Expand Up @@ -1080,7 +1080,7 @@ The following example configures a Syslog audit event handler that writes to the

[#d210e12388]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank]
link:{apidocs-url}/org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank]

'''
[#ElasticsearchAuditEventHandler]
Expand Down
12 changes: 6 additions & 6 deletions openig-doc/src/main/asciidoc/reference/decorators-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,15 +149,15 @@ A reference to the data involved in the event, providing access to the `request`
The source of the audit event, meaning the name of the object under audit.

+
For details, see link:{apidocs-url}/index.html?org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].
For details, see link:{apidocs-url}/org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].

`event.tags`::
Strings that qualify the event. Entities receiving notifications can use the tags to select audit events of interest.

+
Define your own audit tags in order to identify particular events or routes.
+
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]:
OpenIG provides the following built-in tags in link:{apidocs-url}/org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]:

* `request`: This event happens before OpenIG calls the decorated object.

Expand Down Expand Up @@ -245,7 +245,7 @@ To observe audit events, use a registered audit agent such as a MonitorEndpointH

[#d210e9106]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank]
link:{apidocs-url}/org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank]

'''
[#BaseUriDecorator]
Expand Down Expand Up @@ -327,7 +327,7 @@ Set a Router's base URI to `\https://www.example.com:8443`:

[#d210e9209]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank]
link:{apidocs-url}/org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank]

'''
[#CaptureDecorator]
Expand Down Expand Up @@ -576,7 +576,7 @@ To capture the context as JSON, excluding the request and response, before sendi

[#d210e9420]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank]
link:{apidocs-url}/org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank]

'''
[#TimerDecorator]
Expand Down Expand Up @@ -771,6 +771,6 @@ You can then deactivate the timer by setting the values to `false`:

[#d210e9567]
==== Javadoc
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank]
link:{apidocs-url}/org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank]


4 changes: 2 additions & 2 deletions openig-doc/src/main/asciidoc/reference/expressions-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -880,9 +880,9 @@ The string resulting from URL encoding the provided userInfo as per RFC 3986.

[#functions-javadoc]
==== Javadoc
Some functions are provided by link:{apidocs-url}/index.html?org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].
Some functions are provided by link:{apidocs-url}/org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].

Other functions are provided by link:{apidocs-url}/index.html?org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].
Other functions are provided by link:{apidocs-url}/org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].

'''
[#Patterns]
Expand Down
Loading
Loading