From 0dbe307a4cc8c86c18c6a6e80a9196be6192813f Mon Sep 17 00:00:00 2001 From: maximthomas Date: Tue, 1 Oct 2024 14:05:35 +0300 Subject: [PATCH] Fix documentation links --- .../gateway-guide/chap-extending.adoc | 54 +++++----------- .../asciidoc/gateway-guide/chap-install.adoc | 2 +- ...chap-password-capture-replay-tutorial.adoc | 6 +- .../gateway-guide/chap-quickstart.adoc | 10 +-- .../main/asciidoc/gateway-guide/chap-uma.adoc | 2 +- .../main/asciidoc/gateway-guide/index.adoc | 2 + .../main/asciidoc/reference/audit-conf.adoc | 22 +++---- .../asciidoc/reference/decorators-conf.adoc | 12 ++-- .../asciidoc/reference/expressions-conf.adoc | 4 +- .../main/asciidoc/reference/filters-conf.adoc | 64 +++++++++---------- .../asciidoc/reference/handlers-conf.adoc | 40 ++++++------ .../src/main/asciidoc/reference/index.adoc | 2 + .../main/asciidoc/reference/logging-conf.adoc | 6 +- .../main/asciidoc/reference/misc-conf.adoc | 24 +++---- .../asciidoc/reference/object-model-conf.adoc | 20 +++--- .../src/main/asciidoc/reference/preface.adoc | 4 +- .../asciidoc/reference/required-conf.adoc | 2 +- .../asciidoc/reference/throttling-conf.adoc | 14 ++-- 18 files changed, 137 insertions(+), 153 deletions(-) diff --git a/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc b/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc index 321f0d6c..7f3c9153 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc @@ -570,22 +570,22 @@ If the lookup and authentication are successful, you see the profile page of the [#about-custom-extensions] === Developing Custom Extensions -OpenIG includes a complete Java link:../apidocs/index.html[application programming interface, window=\_blank] to allow you to customize OpenIG to perform complex server interactions or intensive data transformations that you cannot achieve with scripts or the existing handlers, filters, and expressions described in xref:../reference/expressions-conf.adoc#Expressions[Expressions(5)] in the __Configuration Reference__. +OpenIG includes a complete Java link:{apidocs-url}/index.html[application programming interface, window=\_blank] to allow you to customize OpenIG to perform complex server interactions or intensive data transformations that you cannot achieve with scripts or the existing handlers, filters, and expressions described in xref:../reference/expressions-conf.adoc#Expressions[Expressions(5)] in the __Configuration Reference__. [#extension-points] ==== Key Extension Points -Interface Stability: Evolving (For information, see xref:../reference/appendix-interface-stability.adoc#interface-stability[ForgeRock Product Interface Stability] in the __Configuration Reference__.) +Interface Stability: Evolving (For information, see xref:../reference/appendix-interface-stability.adoc#interface-stability[Product Interface Stability] in the __Configuration Reference__.) -- The following interfaces are available: -link:../apidocs/index.html?org/forgerock/openig/decoration/Decorator.html[Decorator, window=\_blank]:: +link:{apidocs-url}/index.html?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/index.html?org/forgerock/openig/el/ExpressionPlugin.html[ExpressionPlugin, window=\_blank]:: +link:{apidocs-url}/index.html?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. + @@ -597,28 +597,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/index.html?org/forgerock/http/Filter.html[Filter, window=\_blank]:: +link:{apidocs-url}/index.html?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/index.html?org/forgerock/http/Context.html[Context, window=\_blank], a link:../apidocs/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank], and the link:../apidocs/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/index.html?org/forgerock/util/Promise.html[Promise, window=\_blank] that provides access to the link:../apidocs/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}/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. + 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/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration. +OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration. -link:../apidocs/index.html?org/forgerock/http/Handler.html[Handler, window=\_blank]:: +link:{apidocs-url}/index.html?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/index.html?org/forgerock/http/Context.html[Context, window=\_blank], and a link:../apidocs/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank]. It processes the request and returns a link:../apidocs/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] that provides access to the link:../apidocs/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}/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. + -OpenIG also provides the convenience class, link:../apidocs/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration. +OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration. -- @@ -785,44 +785,24 @@ The corresponding heap object configuration then looks as follows: [#custom-heap-config] ==== Configuring the Heap Object for the Customization -Objects are added to the heap and supplied with configuration artifacts at initialization time. To be integrated with the configuration, a class must have an accompanying implementation of the link:../apidocs/index.html/org/forgerock/openig/heap/Heaplet.html[Heaplet, window=\_blank] interface. The easiest and most common way of exposing the heaplet is to extend the link:../apidocs/index.html/org/forgerock/openig/heap/GenericHeaplet.html[GenericHeaplet, window=\_blank] class in a nested class of the class you want to create and initialize, overriding the heaplet's link:../apidocs/index.html/org/forgerock/openig/heap/GenericHeaplet.html#create()[create(), window=\_blank] method. +Objects are added to the heap and supplied with configuration artifacts at initialization time. To be integrated with the configuration, a class must have an accompanying implementation of the link:{apidocs-url}/index.html/org/forgerock/openig/heap/Heaplet.html[Heaplet, window=\_blank] interface. The easiest and most common way of exposing the heaplet is to extend the link:{apidocs-url}/index.html/org/forgerock/openig/heap/GenericHeaplet.html[GenericHeaplet, window=\_blank] class in a nested class of the class you want to create and initialize, overriding the heaplet's link:{apidocs-url}/index.html/org/forgerock/openig/heap/GenericHeaplet.html#create()[create(), window=\_blank] method. -Within the `create()` method, you can access the object's configuration through the link:../apidocs/index.html/org/forgerock/openig/heap/GenericHeaplet.html#config[config, window=\_blank] field. +Within the `create()` method, you can access the object's configuration through the link:{apidocs-url}/index.html/org/forgerock/openig/heap/GenericHeaplet.html#config[config, window=\_blank] field. [#custom-build] ==== Building the Customization -You can use Apache Maven to manage dependencies on OpenIG. The dependencies are found in the ForgeRock Maven repository. +You can use Apache Maven to manage dependencies on OpenIG. The dependencies are found in the Central Maven repository. -The following listing shows the Maven POM configuration for the ForgeRock Maven repository and the dependency to build the sample filter: [source, xml] ---- - - - forgerock-staging-repository - ForgeRock Release Repository - http://maven.forgerock.org/repo/releases - - false - - - - forgerock-snapshots-repository - ForgeRock Snapshot Repository - http://maven.forgerock.org/repo/snapshots - - false - - - - - org.forgerock.openig + org.openidentityplatform.openig openig-core - 4.5.0 + 5.3.0 ---- @@ -854,11 +834,11 @@ For example, if your .jar file is in a project named `sample-filter`, and the de [source, console] ---- $ mkdir root && cd root - $ jar -xf ~/Downloads/OpenIG-4.5.0.war + $ jar -xf ~/Downloads/OpenIG-5.3.0.war $ cp ~/Documents/sample-filter/target/sample-filter-1.0.0-SNAPSHOT.jar WEB-INF/lib $ jar -cf ../custom.war * ---- -In this example, the resulting `custom.war` contains the custom sample filter. You can deploy the custom .war file as you would deploy `OpenIG-4.5.0.war`. +In this example, the resulting `custom.war` contains the custom sample filter. You can deploy the custom .war file as you would deploy `OpenIG-5.3.0.war`. diff --git a/openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc b/openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc index 288ce5d0..b9b61379 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc @@ -373,7 +373,7 @@ Follow these steps to install OpenIG: . Get OpenIG software. + -Enterprise software releases are available through the ForgeRock link:https://backstage.forgerock.com/[BackStage, window=\_blank] site. Enterprise releases are thoroughly validated builds for ForgeRock customers who run OpenIG in production deployments, and for those who want to try or test with release builds. Make sure you review and agree with the Software License and Subscription Agreement in order to use the software. +OpenIG releases are available on the link:https://github.com/OpenIdentityPlatform/OpenIG/releases[GitHub, window=\_blank]. . Deploy the OpenIG .war file __to the root context__ of the web application container. + diff --git a/openig-doc/src/main/asciidoc/gateway-guide/chap-password-capture-replay-tutorial.adoc b/openig-doc/src/main/asciidoc/gateway-guide/chap-password-capture-replay-tutorial.adoc index 7b44565b..f932fbab 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-password-capture-replay-tutorial.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-password-capture-replay-tutorial.adoc @@ -71,9 +71,9 @@ This tutorial calls for you to set up several different software components: * OpenAM is installed on `\http://openam.example.com:8088/openam`. -* Download and run the link:https://maven.forgerock.org/repo/private-releases/org/forgerock/openig/openig-doc/4.5.0/openig-doc-4.5.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect: +* Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/5.3.0/openig-doc-5.3.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect: + -The openig-doc-4.5.0-jar-with-dependencies.jar application listens at `\http://app.example.com:8081`. The minimal HTTP server is run with the `java -jar openig-doc-4.5.0-jar-with-dependencies.jar` command, as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started]. +The openig-doc-5.3.0-jar-with-dependencies.jar application listens at `\http://app.example.com:8081`. The minimal HTTP server is run with the `java -jar openig-doc-5.3.0-jar-with-dependencies.jar` command, as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started]. * OpenIG is deployed in Jetty as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started]. OpenIG listens at `\http://openig.example.com:8080`. @@ -84,7 +84,7 @@ The openig-doc-4.5.0-jar-with-dependencies.jar application listens at `\http://a [#capture-replay-setup] === Setup Details -In this section, it is assumed that you are familiar with the components involved. For OpenAM and OpenAM policy agent documentation, see link:https://backstage.forgerock.com/docs/am[https://backstage.forgerock.com/docs/am, window=\_blank]. +In this section, it is assumed that you are familiar with the components involved. For OpenAM and OpenAM policy agent documentation, see link:https://doc.openidentityplatform.org/openam[https://doc.openidentityplatform.org/openam, window=\_blank]. [#capture-relay-setup-openam] ==== Setting Up OpenAM Server diff --git a/openig-doc/src/main/asciidoc/gateway-guide/chap-quickstart.adoc b/openig-doc/src/main/asciidoc/gateway-guide/chap-quickstart.adoc index 953b353d..2b5402d7 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-quickstart.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-quickstart.adoc @@ -58,7 +58,7 @@ OpenIG runs in the following web application containers: * Jetty 8, 9 or 10 -. link:https://backstage.forgerock.com/downloads[Download, window=\_blank] the OpenIG .war file. +. link:https://github.com/OpenIdentityPlatform/OpenIG/releases[Download, window=\_blank] the OpenIG.war file. . Deploy OpenIG in the root context. + @@ -67,7 +67,7 @@ Copy the OpenIG .war file as `root.war` to the `/path/to/jetty/webapps/`: [source, console] ---- -$ cp OpenIG-4.5.0.war /path/to/jetty/webapps/root.war +$ cp OpenIG-5.3.0.war /path/to/jetty/webapps/root.war ---- + Jetty automatically deploys OpenIG in the root context on startup. @@ -114,12 +114,12 @@ Now that OpenIG is installed, set up a sample application to protect. ==== Follow these steps: -. Download and run the link:https://maven.forgerock.org/repo/private-releases/org/forgerock/openig/openig-doc/4.5.0/openig-doc-4.5.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect: +. Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/5.3.0/openig-doc-5.3.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect: + [source, console] ---- -$ java -jar openig-doc-4.5.0-jar-with-dependencies.jar +$ java -jar openig-doc-5.3.0-jar-with-dependencies.jar Preparing to listen for HTTP on port 8081. Preparing to listen for HTTPS on port 8444. The server will use a self-signed certificate not known to browsers. @@ -140,7 +140,7 @@ By default, this server listens for HTTP on port 8081, and for HTTPS on port 844 [source, console] ---- -$ java -jar openig-doc-4.5.0-jar-with-dependencies.jar 8888 8889 +$ java -jar openig-doc-5.3.0-jar-with-dependencies.jar 8888 8889 Preparing to listen for HTTP on port 8888. Preparing to listen for HTTPS on port 8889. The server will use a self-signed certificate not known to browsers. diff --git a/openig-doc/src/main/asciidoc/gateway-guide/chap-uma.adoc b/openig-doc/src/main/asciidoc/gateway-guide/chap-uma.adoc index 3fa8b8e6..3c4386e8 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-uma.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-uma.adoc @@ -591,7 +591,7 @@ The settings match if you are using the defaults described in this chapter. If n [source, console] ---- $ cd /path/to/web/server/files/ -$ jar -xvf /path/to/openig-doc-4.5.0-jar-with-dependencies.jar uma +$ jar -xvf /path/to/openig-doc-5.3.0-jar-with-dependencies.jar uma created: uma/ inflated: uma/alice.html inflated: uma/bob.html diff --git a/openig-doc/src/main/asciidoc/gateway-guide/index.adoc b/openig-doc/src/main/asciidoc/gateway-guide/index.adoc index 42f17a10..5d830c1c 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/index.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/index.adoc @@ -26,6 +26,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:apidocs-url: https://doc.openidentityplatform.org/openig/apidocs + [abstract] Instructions for installing and configuring OpenIG, a high-performance reverse proxy server with specialized session management and credential replay functionality. diff --git a/openig-doc/src/main/asciidoc/reference/audit-conf.adoc b/openig-doc/src/main/asciidoc/reference/audit-conf.adoc index 9aacdffd..9f3966dd 100644 --- a/openig-doc/src/main/asciidoc/reference/audit-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/audit-conf.adoc @@ -176,7 +176,7 @@ The following example route uses the audit service: [#d210e10206] ==== Javadoc -link:../apidocs/index.html?org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank] ''' [#CsvAuditEventHandler] @@ -339,7 +339,7 @@ This password is used for the keystore and for private keys. For details, see xr `"signatureInterval"`: __duration, required__:: The time interval after which to insert a signature in the CSV file. This duration must not be zero, and must not be unlimited. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -435,7 +435,7 @@ The time interval after which to rotate log files. This duration must not be zer + This has the effect of enabling time-based file rotation. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -476,7 +476,7 @@ The following example schedules rotation six and twelve hours after midnight: + This has the effect of enabling time-based file rotation. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -511,7 +511,7 @@ The time interval after which to check file rotation and retention policies for + Default: 5 seconds + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -631,7 +631,7 @@ The following example configures a CSV audit event handler to write a log file, [#d210e11344] ==== Javadoc -link:../apidocs/index.html?org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank] ''' [#JdbcAuditEventHandler] @@ -711,7 +711,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/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}/index.html?org/forgerock/audit/handlers/jdbc/providers/GenericDatabaseStatementProvider.html[GenericDatabaseStatementProvider, window=\_top]. `"enabled"`: __boolean, optional__:: Whether this event handler is active. @@ -738,7 +738,7 @@ The interval at which to send buffered event messages to the database. + This interval must be greater than 0 if buffering is enabled. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -936,7 +936,7 @@ Examples including statements to create tables are provided in the JDBC handler [#d210e11910] ==== Javadoc -link:../apidocs/index.html?org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank] ''' [#SyslogAuditEventHandler] @@ -1204,7 +1204,7 @@ The following example configures a Syslog audit event handler that writes to the [#d210e12388] ==== Javadoc -link:../apidocs/index.html?org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank] ''' [#ElasticsearchAuditEventHandler] @@ -1330,7 +1330,7 @@ The interval at which to send buffered event messages to Elasticsearch. If buffe + Default: 1 second + -A link:../apidocs/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}/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`. Durations are not case sensitive. diff --git a/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc b/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc index f51e9497..a7d93471 100644 --- a/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc @@ -149,7 +149,7 @@ 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/index.html?org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank]. +For details, see link:{apidocs-url}/index.html?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. @@ -157,7 +157,7 @@ Strings that qualify the event. Entities receiving notifications can use the tag + Define your own audit tags in order to identify particular events or routes. + -OpenIG provides the following built-in tags in link:../apidocs/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}/index.html?org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]: * `request`: This event happens before OpenIG calls the decorated object. @@ -245,7 +245,7 @@ To observe audit events, use a registered audit agent such as a MonitorEndpointH [#d210e9106] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank] ''' [#BaseUriDecorator] @@ -327,7 +327,7 @@ Set a Router's base URI to `\https://www.example.com:8443`: [#d210e9209] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank] ''' [#CaptureDecorator] @@ -576,7 +576,7 @@ To capture the context as JSON, excluding the request and response, before sendi [#d210e9420] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank] ''' [#TimerDecorator] @@ -771,6 +771,6 @@ You can then deactivate the timer by setting the values to `false`: [#d210e9567] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc b/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc index 3bc77743..2d43eb24 100644 --- a/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc @@ -856,9 +856,9 @@ The string resulting from URL encoding the provided userInfo as per RFC 3986. [#functions-javadoc] ==== Javadoc -Some functions are provided by link:../apidocs/index.html?org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank]. +Some functions are provided by link:{apidocs-url}/index.html?org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank]. -Other functions are provided by link:../apidocs/index.html?org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, 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]. ''' [#Patterns] diff --git a/openig-doc/src/main/asciidoc/reference/filters-conf.adoc b/openig-doc/src/main/asciidoc/reference/filters-conf.adoc index 232e36cd..652f85da 100644 --- a/openig-doc/src/main/asciidoc/reference/filters-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/filters-conf.adoc @@ -126,7 +126,7 @@ This is an example of how you would capture credentials and store them in the Op [#d210e4696] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/AssignmentFilter.html[org.forgerock.openig.filter.AssignmentFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/AssignmentFilter.html[org.forgerock.openig.filter.AssignmentFilter, window=\_blank] ''' [#ConditionEnforcementFilter] @@ -192,7 +192,7 @@ The following example tests whether a request contains a session username. If it [#d210e4788] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/ConditionEnforcementFilter.html[org.forgerock.openig.filter.ConditionEnforcementFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/ConditionEnforcementFilter.html[org.forgerock.openig.filter.ConditionEnforcementFilter, window=\_blank] ''' [#CookieFilter] @@ -241,7 +241,7 @@ Action to perform for cookies that do not match an action set. Must be one of: ` [#d210e4885] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/CookieFilter.html[org.forgerock.openig.filter.CookieFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/CookieFilter.html[org.forgerock.openig.filter.CookieFilter, window=\_blank] ''' [#CryptoHeaderFilter] @@ -335,7 +335,7 @@ Default: Do not encrypt or decrypt any headers [#d210e5021] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/CryptoHeaderFilter.html[org.forgerock.openig.filter.CryptoHeaderFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/CryptoHeaderFilter.html[org.forgerock.openig.filter.CryptoHeaderFilter, window=\_blank] ''' [#EntityExtractFilter] @@ -463,7 +463,7 @@ The following example reads the response looking for the OpenAM login page. When [#d210e5196] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/EntityExtractFilter.html[org.forgerock.openig.filter.EntityExtractFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/EntityExtractFilter.html[org.forgerock.openig.filter.EntityExtractFilter, window=\_blank] ''' [#FileAttributesFilter] @@ -568,7 +568,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e5410] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/FileAttributesFilter.html[org.forgerock.openig.filter.FileAttributesFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/FileAttributesFilter.html[org.forgerock.openig.filter.FileAttributesFilter, window=\_blank] ''' [#HeaderFilter] @@ -663,7 +663,7 @@ Add headers `custom1` and `custom2` to the request: [#d210e5514] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/HeaderFilter.html[org.forgerock.openig.filter.HeaderFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/HeaderFilter.html[org.forgerock.openig.filter.HeaderFilter, window=\_blank] ''' [#HttpBasicAuthFilter] @@ -749,7 +749,7 @@ Default: `true` [#d210e5632] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/HttpBasicAuthFilter.html[org.forgerock.openig.filter.HttpBasicAuthFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/HttpBasicAuthFilter.html[org.forgerock.openig.filter.HttpBasicAuthFilter, window=\_blank] ''' [#LocationHeaderFilter] @@ -807,7 +807,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e5710] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/LocationHeaderFilter.html[org.forgerock.openig.filter.LocationHeaderFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/LocationHeaderFilter.html[org.forgerock.openig.filter.LocationHeaderFilter, window=\_blank] ''' [#OAuth2ClientFilter] @@ -1017,7 +1017,7 @@ Duration for which to cache user-info resources. + OpenIG lazily fetches user info from the OpenID provider. In other words, OpenIG only fetches the information when a downstream Filter or Handler uses the user info. Caching allows OpenIG to avoid repeated calls to OpenID providers when reusing the information over a short period. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -1133,7 +1133,7 @@ Notice that this configuration is for development and testing purposes only, and [#d210e6327] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/oauth2/client/OAuth2ClientFilter.html[org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/client/OAuth2ClientFilter.html[org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter, window=\_blank] [#d210e6334] ==== See Also @@ -1230,7 +1230,7 @@ Duration for which to cache OAuth 2.0 access tokens. + Caching allows OpenIG to avoid repeated requests for token info when reusing the information over a short period. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -1308,7 +1308,7 @@ The following example configures an OAuth 2.0 protected resource filter that exp [#d210e6706] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/oauth2/OAuth2ResourceServerFilterHeaplet.html[org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/OAuth2ResourceServerFilterHeaplet.html[org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet, window=\_blank] [#d210e6713] ==== See Also @@ -1541,7 +1541,7 @@ For additional examples, see xref:../gateway-guide/chap-gateway-templates.adoc#c [#d210e7113] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/PasswordReplayFilterHeaplet.html[org.forgerock.openig.filter.PasswordReplayFilterHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/PasswordReplayFilterHeaplet.html[org.forgerock.openig.filter.PasswordReplayFilterHeaplet, window=\_blank] ''' [#PolicyEnforcementFilter] @@ -1706,7 +1706,7 @@ This setting prevents OpenIG from having to issue a new request for every policy Cached policy decisions remain in the OpenIG cache even after a user logs out of OpenAM and the OpenAM session becomes invalid. ====== + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -1811,11 +1811,11 @@ The following example requests a policy decision from OpenAM before allowing a r [#d210e7646] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/openam/PolicyEnforcementFilter.html[org.forgerock.openig.openam.PolicyEnforcementFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/openam/PolicyEnforcementFilter.html[org.forgerock.openig.openam.PolicyEnforcementFilter, window=\_blank] [#d210e7654] ==== See Also -link:https://backstage.forgerock.com/docs/openam/13.5/dev-guide/#rest-api-authz-policy-decisions[Requesting Policy Decisions in OpenAM, window=\_blank] +link:https://doc.openidentityplatform.org/openam/dev-guide/chap-client-dev#rest-api-authz-policy-decisions[Requesting Policy Decisions, window=\_blank] ''' [#ScriptableFilter] @@ -1825,7 +1825,7 @@ link:https://backstage.forgerock.com/docs/openam/13.5/dev-guide/#rest-api-authz- ==== Description Processes requests and responses by using a script. -The script must return either a link:../apidocs/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:../apidocs/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank]. +The script must return either a link:{apidocs-url}/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank]. [IMPORTANT] ==== @@ -1872,25 +1872,25 @@ You can use the configuration to pass parameters to the script by specifying an Take care when naming keys in the args object. If you reuse the name of another global object, cause the script to fail and OpenIG to return a response with HTTP status code 500 Internal Server Error. `attributes`:: -The link:../apidocs/index.html?org/forgerock/services/context/AttributesContext.html[attributes, window=\_blank] object provides access to a context map of arbitrary attributes, which is a mechanism for transferring transient state between components when processing a single request. +The link:{apidocs-url}/index.html?org/forgerock/services/context/AttributesContext.html[attributes, window=\_blank] object provides access to a context map of arbitrary attributes, which is a mechanism for transferring transient state between components when processing a single request. + Use `session` for maintaining state between successive requests from the same logical client. `context`:: -The processing link:../apidocs/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. +The processing link:{apidocs-url}/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. + This context is the leaf of a chain of contexts. It provides access to other Context types, such as SessionContext, AttributesContext, and ClientContext, through the `context.asContext(ContextClass.class)` method. `request`:: -The HTTP link:../apidocs/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. +The HTTP link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. `globals`:: This object is a link:http://groovy.codehaus.org/groovy-jdk/index.html?java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations. `http`:: -An embedded client for making outbound HTTP requests, which is an link:../apidocs/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank]. +An embedded client for making outbound HTTP requests, which is an link:{apidocs-url}/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank]. + If a `"clientHandler"` is set in the configuration, then that Handler is used. Otherwise, the default ClientHandler configuration is used. @@ -1899,19 +1899,19 @@ If a `"clientHandler"` is set in the configuration, then that Handler is used. O For details, see xref:handlers-conf.adoc#handlers-conf[Handlers]. `ldap`:: -The link:../apidocs/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. +The link:{apidocs-url}/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. + Use this client to perform outbound LDAP requests, such as LDAP authentication. `logger`:: -The link:../apidocs/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. +The link:{apidocs-url}/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. `next`:: -The link:../apidocs/index.html?org/forgerock/http/Handler.html[next, window=\_blank] object refers to the next handler in the filter chain. +The link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[next, window=\_blank] object refers to the next handler in the filter chain. `session`:: -The link:../apidocs/index.html?org/forgerock/http/session/SessionContext.html[session, window=\_blank] object provides access to the session context, which is a mechanism for maintaining state when processing a successive requests from the same logical client or end-user. +The link:{apidocs-url}/index.html?org/forgerock/http/session/SessionContext.html[session, window=\_blank] object provides access to the session context, which is a mechanism for maintaining state when processing a successive requests from the same logical client or end-user. + Use `attributes` for transferring transient state between components when processing a single request. @@ -2051,7 +2051,7 @@ For details, see xref:handlers-conf.adoc#handlers-conf[Handlers]. [#d210e8065] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/ScriptableFilter.html[org.forgerock.openig.filter.ScriptableFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/ScriptableFilter.html[org.forgerock.openig.filter.ScriptableFilter, window=\_blank] ''' [#SqlAttributesFilter] @@ -2139,7 +2139,7 @@ Lines are folded for readability in this example. In your JSON, keep the values [#d210e8177] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/SqlAttributesFilter.html[org.forgerock.openig.filter.SqlAttributesFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/SqlAttributesFilter.html[org.forgerock.openig.filter.SqlAttributesFilter, window=\_blank] ''' [#StaticRequestFilter] @@ -2235,7 +2235,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e8350] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/StaticRequestFilter.html[org.forgerock.openig.filter.StaticRequestFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/StaticRequestFilter.html[org.forgerock.openig.filter.StaticRequestFilter, window=\_blank] ''' [#SwitchFilter] @@ -2324,7 +2324,7 @@ This example intercepts the response if it is equal to 200 and executes the Logi [#d210e8466] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/SwitchFilter.html[org.forgerock.openig.filter.SwitchFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/SwitchFilter.html[org.forgerock.openig.filter.SwitchFilter, window=\_blank] ''' [#TokenTransformationFilter] @@ -2462,7 +2462,7 @@ The following example uses the REST STS instance `oidc-to-saml` to request trans [#d210e8700] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/openam/TokenTransformationFilter.html[org.forgerock.openig.openam.TokenTransformationFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/openam/TokenTransformationFilter.html[org.forgerock.openig.openam.TokenTransformationFilter, window=\_blank] ''' [#UmaFilter] @@ -2515,6 +2515,6 @@ Default: `uma` ==== See Also link:https://docs.kantarainitiative.org/uma/rec-uma-core.html[User-Managed Access (UMA) Profile of OAuth 2.0, window=\_blank] -link:../apidocs/index.html?org/forgerock/openig/uma/UmaResourceServerFilter.html[org.forgerock.openig.uma.UmaResourceServerFilter, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/uma/UmaResourceServerFilter.html[org.forgerock.openig.uma.UmaResourceServerFilter, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/handlers-conf.adoc b/openig-doc/src/main/asciidoc/reference/handlers-conf.adoc index 7f85b9e2..1c913cd3 100644 --- a/openig-doc/src/main/asciidoc/reference/handlers-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/handlers-conf.adoc @@ -87,7 +87,7 @@ See also xref:#handlers-conf[Handlers]. [#d210e2464] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/Chain.html[org.forgerock.openig.filter.Chain, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/Chain.html[org.forgerock.openig.filter.Chain, window=\_blank] ''' [#ClientHandler] @@ -135,7 +135,7 @@ Default: 64 `"connectionTimeout"`: __duration string, optional__:: Amount of time to wait to establish a connection, expressed as a duration + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -220,7 +220,7 @@ See also xref:misc-conf.adoc#KeyManager[KeyManager(5)]. `"soTimeout"`: __duration string, optional__:: Socket timeout, after which stalled connections are destroyed, expressed as a duration + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -336,7 +336,7 @@ The following object configures a `ClientHandler` named `Client`, with non-defau [#d210e3071] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/ClientHandler.html[org.forgerock.openig.handler.ClientHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/ClientHandler.html[org.forgerock.openig.handler.ClientHandler, window=\_blank] ''' [#DesKeyGenHandler] @@ -359,7 +359,7 @@ Generates a DES key for use with OpenAM as described in xref:../gateway-guide/ch [#d210e3107] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/DesKeyGenHandler.html[org.forgerock.openig.handler.DesKeyGenHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/DesKeyGenHandler.html[org.forgerock.openig.handler.DesKeyGenHandler, window=\_blank] ''' [#DispatchHandler] @@ -450,7 +450,7 @@ The following sample is from a SAML 2.0 federation configuration. If the incomin [#d210e3219] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/DispatchHandler.html[org.forgerock.openig.handler.DispatchHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/DispatchHandler.html[org.forgerock.openig.handler.DispatchHandler, window=\_blank] ''' [#MonitorEndpointHandler] @@ -525,7 +525,7 @@ After adding audit tags to a number of other routes, the JSON returned from the [#d210e3277] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/audit/monitor/MonitorEndpointHandler.html[org.forgerock.openig.audit.monitor.MonitorEndpointHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/audit/monitor/MonitorEndpointHandler.html[org.forgerock.openig.audit.monitor.MonitorEndpointHandler, window=\_blank] ''' [#Route] @@ -791,7 +791,7 @@ To prevent OpenIG from reloading Route configurations after you except at startu [#d210e3636] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/router/RouterHandler.html[org.forgerock.openig.handler.router.RouterHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/router/RouterHandler.html[org.forgerock.openig.handler.router.RouterHandler, window=\_blank] ''' [#SamlFederationHandler] @@ -996,7 +996,7 @@ The following sample configuration is corresponds to a scenario where OpenIG rec [#d210e3986] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/saml/SamlFederationHandler.html[org.forgerock.openig.handler.saml.SamlFederationHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/saml/SamlFederationHandler.html[org.forgerock.openig.handler.saml.SamlFederationHandler, window=\_blank] ''' [#ScriptableHandler] @@ -1006,7 +1006,7 @@ link:../apidocs/index.html?org/forgerock/openig/handler/saml/SamlFederationHandl ==== Description Handles a request by using a script. -The script must return either a link:../apidocs/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:../apidocs/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank]. +The script must return either a link:{apidocs-url}/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank]. [IMPORTANT] ==== @@ -1053,25 +1053,25 @@ You can use the configuration to pass parameters to the script by specifying an Take care when naming keys in the args object. Attempts to reuse the name of another global object cause the script to fail and OpenIG to return a response with HTTP status code 500 Internal Server Error. `attributes`:: -The link:../apidocs/index.html?org/forgerock/services/context/AttributesContext.html[attributes, window=\_blank] object provides access to a context map of arbitrary attributes, which is a mechanism for transferring transient state between components when processing a single request. +The link:{apidocs-url}/index.html?org/forgerock/services/context/AttributesContext.html[attributes, window=\_blank] object provides access to a context map of arbitrary attributes, which is a mechanism for transferring transient state between components when processing a single request. + Use `session` for maintaining state between successive requests from the same logical client. `context`:: -The processing link:../apidocs/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. +The processing link:{apidocs-url}/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. + This context is the leaf of a chain of contexts. It provides access to other Context types, such as SessionContext, AttributesContext, and ClientContext, through the `context.asContext(ContextClass.class)` method. `request`:: -The HTTP link:../apidocs/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. +The HTTP link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. `globals`:: This object is a link:http://groovy.codehaus.org/groovy-jdk/index.html?java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations. `http`:: -An embedded client for making outbound HTTP requests, which is an link:../apidocs/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank]. +An embedded client for making outbound HTTP requests, which is an link:{apidocs-url}/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank]. + If a `"clientHandler"` is set in the configuration, then that Handler is used. Otherwise, the default ClientHandler configuration is used. @@ -1080,16 +1080,16 @@ If a `"clientHandler"` is set in the configuration, then that Handler is used. O For details, see xref:#handlers-conf[Handlers]. `ldap`:: -The link:../apidocs/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. +The link:{apidocs-url}/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. + Use this client to perform outbound LDAP requests, such as LDAP authentication. `logger`:: -The link:../apidocs/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. +The link:{apidocs-url}/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. `session`:: -The link:../apidocs/index.html?org/forgerock/http/session/SessionContext.html[session, window=\_blank] object provides access to the session context, which is a mechanism for maintaining state when processing a successive requests from the same logical client or end-user. +The link:{apidocs-url}/index.html?org/forgerock/http/session/SessionContext.html[session, window=\_blank] object provides access to the session context, which is a mechanism for maintaining state when processing a successive requests from the same logical client or end-user. + Use `attributes` for transferring transient state between components when processing a single request. @@ -1222,7 +1222,7 @@ For details, see xref:#handlers-conf[Handlers]. [#d210e4374] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/ScriptableHandler.html[org.forgerock.openig.handler.ScriptableHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/ScriptableHandler.html[org.forgerock.openig.handler.ScriptableHandler, window=\_blank] ''' [#SequenceHandler] @@ -1280,7 +1280,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e4465] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/SequenceHandler.html[org.forgerock.openig.handler.SequenceHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/SequenceHandler.html[org.forgerock.openig.handler.SequenceHandler, window=\_blank] ''' [#StaticResponseHandler] @@ -1357,6 +1357,6 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e4582] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/handler/StaticResponseHandler.html[org.forgerock.openig.handler.StaticResponseHandler, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/handler/StaticResponseHandler.html[org.forgerock.openig.handler.StaticResponseHandler, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/index.adoc b/openig-doc/src/main/asciidoc/reference/index.adoc index ea82984c..6720763f 100644 --- a/openig-doc/src/main/asciidoc/reference/index.adoc +++ b/openig-doc/src/main/asciidoc/reference/index.adoc @@ -26,6 +26,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:apidocs-url: https://doc.openidentityplatform.org/openig/apidocs + [abstract] Reference documentation for OpenIG. OpenIG provides a high-performance reverse proxy server with specialized session management and credential replay functionality. diff --git a/openig-doc/src/main/asciidoc/reference/logging-conf.adoc b/openig-doc/src/main/asciidoc/reference/logging-conf.adoc index eeaf42d3..55e49632 100644 --- a/openig-doc/src/main/asciidoc/reference/logging-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/logging-conf.adoc @@ -110,7 +110,7 @@ Default: `ERR`. [#d210e9725] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/log/ConsoleLogSink.html[org.forgerock.openig.log.ConsoleLogSink, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/log/ConsoleLogSink.html[org.forgerock.openig.log.ConsoleLogSink, window=\_blank] ''' [#FileLogSink] @@ -190,7 +190,7 @@ Default: `INFO`. [#d210e9864] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/log/FileLogSink.html[org.forgerock.openig.log.FileLogSink, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/log/FileLogSink.html[org.forgerock.openig.log.FileLogSink, window=\_blank] ''' [#Slf4jLogSink] @@ -282,6 +282,6 @@ For an example configuration, see xref:../gateway-guide/chap-logging.adoc#chap-l [#d210e9986] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/log/Slf4jLogSink.html[org.forgerock.openig.log.Slf4jLogSink, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/log/Slf4jLogSink.html[org.forgerock.openig.log.Slf4jLogSink, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/misc-conf.adoc b/openig-doc/src/main/asciidoc/reference/misc-conf.adoc index 8cb038f7..766fbce4 100644 --- a/openig-doc/src/main/asciidoc/reference/misc-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/misc-conf.adoc @@ -178,7 +178,7 @@ The following example shows a client registration for OpenAM. In this example cl [#d210e14118] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/oauth2/client/ClientRegistration.html[org.forgerock.openig.filter.oauth2.client.ClientRegistration, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/client/ClientRegistration.html[org.forgerock.openig.filter.oauth2.client.ClientRegistration, window=\_blank] [#d210e14125] ==== See Also @@ -264,7 +264,7 @@ Default: `openig-jwt-session` `"sessionTimeout"` __duration, optional__:: The amount of time before the cookie session expires. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -333,7 +333,7 @@ The following example defines a JwtSession for storing session information in a [#d210e14490] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/jwt/JwtSessionManager.html[org.forgerock.openig.jwt.JwtSessionManager, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/jwt/JwtSessionManager.html[org.forgerock.openig.jwt.JwtSessionManager, window=\_blank] ''' [#KeyManager] @@ -410,7 +410,7 @@ The following example configures a key manager that depends on a KeyStore config [#d210e14591] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/security/KeyManagerHeaplet.html[org.forgerock.openig.security.KeyManagerHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyManagerHeaplet.html[org.forgerock.openig.security.KeyManagerHeaplet, window=\_blank] [#d210e14599] ==== See Also @@ -488,7 +488,7 @@ The following example configures a keystore that references a Java Keystore file [#d210e14710] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/security/KeyStoreHeaplet.html[org.forgerock.openig.security.KeyStoreHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyStoreHeaplet.html[org.forgerock.openig.security.KeyStoreHeaplet, window=\_blank] [#d210e14718] ==== See Also @@ -631,7 +631,7 @@ The following example shows an issuer configuration for Google: [#d210e14921] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/oauth2/client/Issuer.html[org.forgerock.openig.filter.oauth2.client.Issuer, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/client/Issuer.html[org.forgerock.openig.filter.oauth2.client.Issuer, window=\_blank] ''' [#ScheduledExecutorService] @@ -706,7 +706,7 @@ If all jobs finish before the grace period, the executor service stops without w + When `gracefulStop` is `false`, the grace period is ignored. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -757,7 +757,7 @@ The following example creates a thread pool to execute tasks. When the executor [#d210e15205] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/thread/ScheduledExecutorServiceHeaplet.html[org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/thread/ScheduledExecutorServiceHeaplet.html[org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet, window=\_blank] ''' [#TemporaryStorage] @@ -804,7 +804,7 @@ The directory where temporary files are created. If omitted, then the system-dep [#d210e15288] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/io/TemporaryStorage.html[org.forgerock.openig.io.TemporaryStorage, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/io/TemporaryStorage.html[org.forgerock.openig.io.TemporaryStorage, window=\_blank] ''' [#TrustManager] @@ -873,7 +873,7 @@ The following example configures a trust manager that depends on a KeyStore conf [#d210e15368] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/security/TrustManagerHeaplet.html[org.forgerock.openig.security.TrustManagerHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/security/TrustManagerHeaplet.html[org.forgerock.openig.security.TrustManagerHeaplet, window=\_blank] [#d210e15376] ==== See Also @@ -919,7 +919,7 @@ The following example configures a client handler that blindly trusts server cer [#d210e15431] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/security/TrustAllManager.html[org.forgerock.openig.security.TrustAllManager, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/security/TrustAllManager.html[org.forgerock.openig.security.TrustAllManager, window=\_blank] ''' [#UmaService] @@ -1089,6 +1089,6 @@ This URI indicates the location on the UMA authorization server where the resour ==== See Also link:https://docs.kantarainitiative.org/uma/rec-uma-core.html[User-Managed Access (UMA) Profile of OAuth 2.0, window=\_blank] -link:../apidocs/index.html?org/forgerock/openig/uma/UmaSharingService.html[org.forgerock.openig.uma.UmaSharingService, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/uma/UmaSharingService.html[org.forgerock.openig.uma.UmaSharingService, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/object-model-conf.adoc b/openig-doc/src/main/asciidoc/reference/object-model-conf.adoc index aca64b4a..dce0d636 100644 --- a/openig-doc/src/main/asciidoc/reference/object-model-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/object-model-conf.adoc @@ -47,7 +47,7 @@ This is never `null`. [#d210e17202] ==== Javadoc -link:../apidocs/index.html?org/forgerock/services/context/AttributesContext.html[org.forgerock.services.context.AttributesContext, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/services/context/AttributesContext.html[org.forgerock.services.context.AttributesContext, window=\_blank] ''' [#Client] @@ -103,7 +103,7 @@ The value of the User-Agent HTTP header in the request if any, otherwise `null` [#d210e17330] ==== Javadoc -link:../apidocs/index.html?org/forgerock/services/context/ClientContext.html[org.forgerock.services.context.ClientContext, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/services/context/ClientContext.html[org.forgerock.services.context.ClientContext, window=\_blank] ''' [#Contexts] @@ -113,7 +113,7 @@ link:../apidocs/index.html?org/forgerock/services/context/ClientContext.html[org ==== Description The root object for request context information. -Contexts is a map of available contexts, which implement the link:../apidocs/index.html?org/forgerock/services/context/Context.html[Context, window=\_blank] interface. The contexts map's keys are strings and the values are context objects. A context holds type-safe information useful for processing requests and responses. The `contexts` map is populated dynamically when creating bindings for evaluation of expressions and scripts. +Contexts is a map of available contexts, which implement the link:{apidocs-url}/index.html?org/forgerock/services/context/Context.html[Context, window=\_blank] interface. The contexts map's keys are strings and the values are context objects. A context holds type-safe information useful for processing requests and responses. The `contexts` map is populated dynamically when creating bindings for evaluation of expressions and scripts. -- All context objects have the following properties: @@ -167,7 +167,7 @@ See also xref:#Session[Session(5)]. [#d210e17457] ==== Javadoc -link:../apidocs/index.html?org/forgerock/services/context/Context.html[org.forgerock.services.context.Context, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/services/context/Context.html[org.forgerock.services.context.Context, window=\_blank] ''' [#Request] @@ -209,7 +209,7 @@ The message entity body (no accessible properties). [#d210e17575] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/protocol/Request.html[org.forgerock.http.protocol.Request, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[org.forgerock.http.protocol.Request, window=\_blank] ''' [#Response] @@ -245,7 +245,7 @@ The message entity body (no accessible properties). [#d210e17662] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/protocol/Response.html[org.forgerock.http.protocol.Response, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[org.forgerock.http.protocol.Response, window=\_blank] ''' [#Session] @@ -268,7 +268,7 @@ Provides access to the HTTP session, which is a map. Session attributes are name [#d210e17706] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/session/SessionContext.html[org.forgerock.http.session.SessionContext, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/session/SessionContext.html[org.forgerock.http.session.SessionContext, window=\_blank] ''' [#Status] @@ -336,7 +336,7 @@ True if Family.SUCCESSFUL. [#d210e17875] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/protocol/Status.html[org.forgerock.http.protocol.Status, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/protocol/Status.html[org.forgerock.http.protocol.Status, window=\_blank] ''' [#URI] @@ -393,7 +393,7 @@ Use "rawFragment" to access the raw (encoded) component. [#d210e18023] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/MutableUri.html[org.forgerock.http.MutableUri, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/MutableUri.html[org.forgerock.http.MutableUri, window=\_blank] ''' [#UriRouterContext] @@ -428,6 +428,6 @@ An unmodifiable Map where the keys and values are strings. The map contains the [#d210e18098] ==== Javadoc -link:../apidocs/index.html?org/forgerock/http/routing/UriRouterContext.html[org.forgerock.http.routing.UriRouterContext, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/http/routing/UriRouterContext.html[org.forgerock.http.routing.UriRouterContext, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/preface.adoc b/openig-doc/src/main/asciidoc/reference/preface.adoc index bb130ee5..01dde59b 100644 --- a/openig-doc/src/main/asciidoc/reference/preface.adoc +++ b/openig-doc/src/main/asciidoc/reference/preface.adoc @@ -31,7 +31,7 @@ This reference covers OpenIG configuration. This reference is for OpenIG designers, developers, and administrators. -For API specifications, see the appropriate link:../apidocs/index.html[Javadoc, window=\_blank]. +For API specifications, see the appropriate link:{apidocs-url}/index.html[Javadoc, window=\_blank]. [#reserved-routes] @@ -74,7 +74,7 @@ A configuration expression, described in xref:expressions-conf.adoc#Expressions[ [#definition-duration] duration:: -A link:../apidocs/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}/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`. Durations are not case sensitive. diff --git a/openig-doc/src/main/asciidoc/reference/required-conf.adoc b/openig-doc/src/main/asciidoc/reference/required-conf.adoc index d6c51395..303d30a0 100644 --- a/openig-doc/src/main/asciidoc/reference/required-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/required-conf.adoc @@ -105,7 +105,7 @@ See also xref:misc-conf.adoc#TemporaryStorage[TemporaryStorage(5)]. [#d210e2165] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/http/GatewayHttpApplication.html[org.forgerock.openig.http.GatewayHttpApplication, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/http/GatewayHttpApplication.html[org.forgerock.openig.http.GatewayHttpApplication, window=\_blank] ''' [#heap-objects] diff --git a/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc b/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc index 9cd570f1..d21a9176 100644 --- a/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc @@ -100,7 +100,7 @@ The number of requests allowed through the filter in the time specified by `"dur `"duration"`: __duration string, required__:: A time interval during which the number of requests passing through the filter is counted. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -178,7 +178,7 @@ The following route defines a throttling rate of 6 requests/10 seconds to reques [#d210e13170] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/throttling/ThrottlingFilterHeaplet.html[org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/ThrottlingFilterHeaplet.html[org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet, window=\_blank] ''' [#MappedThrottlingPolicy] @@ -249,7 +249,7 @@ The number of requests allowed through the filter in the time specified by `"dur `"duration"`: __duration string, required__:: A time interval during which the number of requests passing through the filter is counted. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -332,7 +332,7 @@ image::images/throttling-mapped.png[] [#d210e13495] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/throttling/MappedThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/MappedThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet, window=\_blank] ''' [#ScriptableThrottlingPolicy] @@ -451,7 +451,7 @@ if (request.headers['X-Forwarded-For'].values[0] == 'accounts.example.com') { [#d210e13638] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/throttling/ScriptableThrottlingPolicy.Heaplet.html[org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/ScriptableThrottlingPolicy.Heaplet.html[org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet, window=\_blank] ''' [#DefaultRateThrottlingPolicy] @@ -506,7 +506,7 @@ The number of requests allowed through the filter in the time specified by `"dur `"duration"`: __duration string, required__:: A time interval during which the number of requests passing through the filter is counted. + -A link:../apidocs/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}/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`. Durations are not case sensitive. @@ -541,6 +541,6 @@ For an example of how this policy is used, see xref:#example-throttling-scriptab [#d210e13916] ==== Javadoc -link:../apidocs/index.html?org/forgerock/openig/filter/throttling/DefaultRateThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet, window=\_blank] +link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/DefaultRateThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet, window=\_blank]