From effb5b338a509a49fc06c864fb63242e4d2a94f8 Mon Sep 17 00:00:00 2001 From: maximthomas Date: Wed, 25 Mar 2026 12:58:04 +0300 Subject: [PATCH] Fix documentation issues --- .../gateway-guide/chap-extending.adoc | 16 ++--- .../partials/sec-duration-description.adoc | 2 +- .../main/asciidoc/reference/audit-conf.adoc | 10 ++-- .../asciidoc/reference/decorators-conf.adoc | 12 ++-- .../asciidoc/reference/expressions-conf.adoc | 4 +- .../main/asciidoc/reference/filters-conf.adoc | 60 +++++++++---------- .../asciidoc/reference/handlers-conf.adoc | 34 +++++------ .../main/asciidoc/reference/logging-conf.adoc | 6 +- .../main/asciidoc/reference/misc-conf.adoc | 20 +++---- .../asciidoc/reference/object-model-conf.adoc | 20 +++---- .../asciidoc/reference/required-conf.adoc | 2 +- .../asciidoc/reference/throttling-conf.adoc | 8 +-- 12 files changed, 97 insertions(+), 97 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 76b1dce8..bbbbdc45 100644 --- a/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc +++ b/openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc @@ -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. + @@ -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. -- diff --git a/openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc b/openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc index 41737abd..e609a521 100644 --- a/openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc +++ b/openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc @@ -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. + diff --git a/openig-doc/src/main/asciidoc/reference/audit-conf.adoc b/openig-doc/src/main/asciidoc/reference/audit-conf.adoc index cc4956ca..3346bef2 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-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] @@ -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] @@ -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. @@ -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] @@ -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] diff --git a/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc b/openig-doc/src/main/asciidoc/reference/decorators-conf.adoc index 7a983863..688259f4 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-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. @@ -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-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. @@ -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] @@ -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] @@ -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] @@ -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] diff --git a/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc b/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc index 86685eeb..8f7260a3 100644 --- a/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/expressions-conf.adoc @@ -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] diff --git a/openig-doc/src/main/asciidoc/reference/filters-conf.adoc b/openig-doc/src/main/asciidoc/reference/filters-conf.adoc index ce8dc120..aee97d2f 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-url}/index.html?org/forgerock/openig/filter/AssignmentFilter.html[org.forgerock.openig.filter.AssignmentFilter, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/filter/ConditionEnforcementFilter.html[org.forgerock.openig.filter.ConditionEnforcementFilter, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/filter/CookieFilter.html[org.forgerock.openig.filter.CookieFilter, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/filter/CryptoHeaderFilter.html[org.forgerock.openig.filter.CryptoHeaderFilter, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/filter/EntityExtractFilter.html[org.forgerock.openig.filter.EntityExtractFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/EntityExtractFilter.html[org.forgerock.openig.filter.EntityExtractFilter, window=\_blank] ''' [#FileAttributesFilter] @@ -568,11 +568,11 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e5410] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/FileAttributesFilter.html[org.forgerock.openig.filter.FileAttributesFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/FileAttributesFilter.html[org.forgerock.openig.filter.FileAttributesFilter, window=\_blank] ''' [#JwtBuilderFilter] -=== JwtBuilderFilter — remove and add headers +=== JwtBuilderFilter — creates a JSON Web Token (JWT) Creates a JSON Web Token (JWT) with runtime data and puts the JWT into the link:{apidocs-url}/org/openidentityplatform/openig/filter/JwtBuilderContext.java[JwtBuilderContext, window=\_blank] @@ -775,7 +775,7 @@ Add headers `custom1` and `custom2` to the request: [#d210e5514] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/HeaderFilter.html[org.forgerock.openig.filter.HeaderFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/HeaderFilter.html[org.forgerock.openig.filter.HeaderFilter, window=\_blank] ''' [#HttpBasicAuthFilter] @@ -861,7 +861,7 @@ Default: `true` [#d210e5632] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/HttpBasicAuthFilter.html[org.forgerock.openig.filter.HttpBasicAuthFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/HttpBasicAuthFilter.html[org.forgerock.openig.filter.HttpBasicAuthFilter, window=\_blank] ''' @@ -1193,7 +1193,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e5710] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/LocationHeaderFilter.html[org.forgerock.openig.filter.LocationHeaderFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/LocationHeaderFilter.html[org.forgerock.openig.filter.LocationHeaderFilter, window=\_blank] ''' [#MCPServerFeaturesFilter] @@ -1590,7 +1590,7 @@ Notice that this configuration is for development and testing purposes only, and [#d210e6327] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/client/OAuth2ClientFilter.html[org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/oauth2/client/OAuth2ClientFilter.html[org.forgerock.openig.filter.oauth2.client.OAuth2ClientFilter, window=\_blank] [#d210e6334] ==== See Also @@ -1662,7 +1662,7 @@ An alternative value for type is OAuth2RSFilter. -- `"accessTokenResolver"`: __reference, optional__:: -Resolves an access token against an Authorization Server. Currently, supports the link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/ScriptableAccessTokenResolver.html[`ScriptableAccessTokenResolver`, window=\_blank] to customize the default access token resolution algorithm. The example below utilizes the `token.groovy` script to resolve an access token. +Resolves an access token against an Authorization Server. Currently, supports the link:{apidocs-url}/org/forgerock/openig/filter/oauth2/ScriptableAccessTokenResolver.html[`ScriptableAccessTokenResolver`, window=\_blank] to customize the default access token resolution algorithm. The example below utilizes the `token.groovy` script to resolve an access token. + [source, json] ---- @@ -1758,7 +1758,7 @@ The following example configures an OAuth 2.0 protected resource filter that exp [#d210e6706] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/OAuth2ResourceServerFilterHeaplet.html[org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/oauth2/OAuth2ResourceServerFilterHeaplet.html[org.forgerock.openig.filter.oauth2.OAuth2ResourceServerFilterHeaplet, window=\_blank] [#d210e6713] ==== See Also @@ -2154,7 +2154,7 @@ For additional examples, see xref:../gateway-guide/chap-gateway-templates.adoc#c [#d210e7113] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/PasswordReplayFilterHeaplet.html[org.forgerock.openig.filter.PasswordReplayFilterHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/PasswordReplayFilterHeaplet.html[org.forgerock.openig.filter.PasswordReplayFilterHeaplet, window=\_blank] ''' [#PolicyEnforcementFilter] @@ -2399,7 +2399,7 @@ The following example requests a policy decision from OpenAM before allowing a r [#d210e7646] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/openam/PolicyEnforcementFilter.html[org.forgerock.openig.openam.PolicyEnforcementFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/openam/PolicyEnforcementFilter.html[org.forgerock.openig.openam.PolicyEnforcementFilter, window=\_blank] [#d210e7654] ==== See Also @@ -2414,7 +2414,7 @@ link:https://doc.openidentityplatform.org/openam/dev-guide/chap-client-dev#rest- ==== Description Processes requests and responses by using a script. -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]. +The script must return either a link:{apidocs-url}/org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank]. [IMPORTANT] ==== @@ -2461,25 +2461,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-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. +The link:{apidocs-url}/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-url}/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. +The processing link:{apidocs-url}/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-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. +The HTTP link:{apidocs-url}/org/forgerock/http/protocol/Request.html[request, window=\_blank]. `globals`:: This object is a link:https://docs.groovy-lang.org/latest/html/groovy-jdk/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-url}/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}/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. @@ -2488,19 +2488,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-url}/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. +The link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. +The link:{apidocs-url}/org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. `next`:: -The link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[next, window=\_blank] object refers to the next handler in the filter chain. +The link:{apidocs-url}/org/forgerock/http/Handler.html[next, window=\_blank] object refers to the next handler in the filter chain. `session`:: -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. +The link:{apidocs-url}/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. @@ -2640,7 +2640,7 @@ For details, see xref:handlers-conf.adoc#handlers-conf[Handlers]. [#d210e8065] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/ScriptableFilter.html[org.forgerock.openig.filter.ScriptableFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/ScriptableFilter.html[org.forgerock.openig.filter.ScriptableFilter, window=\_blank] ''' [#SqlAttributesFilter] @@ -2728,7 +2728,7 @@ Lines are folded for readability in this example. In your JSON, keep the values [#d210e8177] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/SqlAttributesFilter.html[org.forgerock.openig.filter.SqlAttributesFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/SqlAttributesFilter.html[org.forgerock.openig.filter.SqlAttributesFilter, window=\_blank] ''' [#StaticRequestFilter] @@ -2824,7 +2824,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e8350] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/StaticRequestFilter.html[org.forgerock.openig.filter.StaticRequestFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/StaticRequestFilter.html[org.forgerock.openig.filter.StaticRequestFilter, window=\_blank] ''' [#SwitchFilter] @@ -2913,7 +2913,7 @@ This example intercepts the response if it is equal to 200 and executes the Logi [#d210e8466] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/SwitchFilter.html[org.forgerock.openig.filter.SwitchFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/SwitchFilter.html[org.forgerock.openig.filter.SwitchFilter, window=\_blank] ''' [#TokenTransformationFilter] @@ -3051,7 +3051,7 @@ The following example uses the REST STS instance `oidc-to-saml` to request trans [#d210e8700] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/openam/TokenTransformationFilter.html[org.forgerock.openig.openam.TokenTransformationFilter, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/openam/TokenTransformationFilter.html[org.forgerock.openig.openam.TokenTransformationFilter, window=\_blank] ''' [#UmaFilter] @@ -3104,6 +3104,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-url}/index.html?org/forgerock/openig/uma/UmaResourceServerFilter.html[org.forgerock.openig.uma.UmaResourceServerFilter, window=\_blank] +link:{apidocs-url}/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 872599a4..e24e1d11 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-url}/index.html?org/forgerock/openig/filter/Chain.html[org.forgerock.openig.filter.Chain, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/Chain.html[org.forgerock.openig.filter.Chain, window=\_blank] ''' [#ClientHandler] @@ -288,7 +288,7 @@ The following object configures a `ClientHandler` named `Client`, with non-defau [#d210e3071] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/ClientHandler.html[org.forgerock.openig.handler.ClientHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/ClientHandler.html[org.forgerock.openig.handler.ClientHandler, window=\_blank] ''' [#DesKeyGenHandler] @@ -311,7 +311,7 @@ Generates a DES key for use with OpenAM as described in xref:../gateway-guide/ch [#d210e3107] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/DesKeyGenHandler.html[org.forgerock.openig.handler.DesKeyGenHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/DesKeyGenHandler.html[org.forgerock.openig.handler.DesKeyGenHandler, window=\_blank] ''' [#DispatchHandler] @@ -402,7 +402,7 @@ The following sample is from a SAML 2.0 federation configuration. If the incomin [#d210e3219] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/DispatchHandler.html[org.forgerock.openig.handler.DispatchHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/DispatchHandler.html[org.forgerock.openig.handler.DispatchHandler, window=\_blank] ''' [#MonitorEndpointHandler] @@ -477,7 +477,7 @@ After adding audit tags to a number of other routes, the JSON returned from the [#d210e3277] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/audit/monitor/MonitorEndpointHandler.html[org.forgerock.openig.audit.monitor.MonitorEndpointHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/audit/monitor/MonitorEndpointHandler.html[org.forgerock.openig.audit.monitor.MonitorEndpointHandler, window=\_blank] ''' [#Route] @@ -1009,7 +1009,7 @@ The following sample configuration is corresponds to a scenario where OpenIG rec [#d210e3986] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/saml/SamlFederationHandler.html[org.forgerock.openig.handler.saml.SamlFederationHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/saml/SamlFederationHandler.html[org.forgerock.openig.handler.saml.SamlFederationHandler, window=\_blank] ''' [#ScriptableHandler] @@ -1019,7 +1019,7 @@ link:{apidocs-url}/index.html?org/forgerock/openig/handler/saml/SamlFederationHa ==== Description Handles a request by using a script. -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]. +The script must return either a link:{apidocs-url}/org/forgerock/util/promise/Promise.html[Promise, window=\_blank] or a link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank]. [IMPORTANT] ==== @@ -1066,25 +1066,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-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. +The link:{apidocs-url}/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-url}/index.html?org/forgerock/services/context/Context.html[context, window=\_blank]. +The processing link:{apidocs-url}/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-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank]. +The HTTP link:{apidocs-url}/org/forgerock/http/protocol/Request.html[request, window=\_blank]. `globals`:: This object is a link:https://docs.groovy-lang.org/latest/html/groovy-jdk/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-url}/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}/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. @@ -1093,16 +1093,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-url}/index.html?org/forgerock/openig/ldap/LdapClient.html[ldap, window=\_blank] object provides an embedded LDAP client. +The link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. +The link:{apidocs-url}/org/forgerock/openig/log/Logger.html[logger, window=\_blank] object provides access to the server log sink. `session`:: -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. +The link:{apidocs-url}/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. @@ -1235,7 +1235,7 @@ For details, see xref:#handlers-conf[Handlers]. [#d210e4374] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/ScriptableHandler.html[org.forgerock.openig.handler.ScriptableHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/ScriptableHandler.html[org.forgerock.openig.handler.ScriptableHandler, window=\_blank] ''' [#SequenceHandler] @@ -1293,7 +1293,7 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e4465] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/SequenceHandler.html[org.forgerock.openig.handler.SequenceHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/SequenceHandler.html[org.forgerock.openig.handler.SequenceHandler, window=\_blank] ''' [#StaticResponseHandler] @@ -1370,6 +1370,6 @@ See also xref:expressions-conf.adoc#Expressions[Expressions(5)]. [#d210e4582] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/handler/StaticResponseHandler.html[org.forgerock.openig.handler.StaticResponseHandler, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/handler/StaticResponseHandler.html[org.forgerock.openig.handler.StaticResponseHandler, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/logging-conf.adoc b/openig-doc/src/main/asciidoc/reference/logging-conf.adoc index 55e49632..95a042c3 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-url}/index.html?org/forgerock/openig/log/ConsoleLogSink.html[org.forgerock.openig.log.ConsoleLogSink, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/log/ConsoleLogSink.html[org.forgerock.openig.log.ConsoleLogSink, window=\_blank] ''' [#FileLogSink] @@ -190,7 +190,7 @@ Default: `INFO`. [#d210e9864] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/log/FileLogSink.html[org.forgerock.openig.log.FileLogSink, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/openig/log/Slf4jLogSink.html[org.forgerock.openig.log.Slf4jLogSink, window=\_blank] +link:{apidocs-url}/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 97bd1c00..ffee642d 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-url}/index.html?org/forgerock/openig/filter/oauth2/client/ClientRegistration.html[org.forgerock.openig.filter.oauth2.client.ClientRegistration, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/oauth2/client/ClientRegistration.html[org.forgerock.openig.filter.oauth2.client.ClientRegistration, window=\_blank] [#d210e14125] ==== See Also @@ -310,7 +310,7 @@ The following example defines a JwtSession for storing session information in a [#d210e14490] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/jwt/JwtSessionManager.html[org.forgerock.openig.jwt.JwtSessionManager, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/jwt/JwtSessionManager.html[org.forgerock.openig.jwt.JwtSessionManager, window=\_blank] ''' [#KeyManager] @@ -387,7 +387,7 @@ The following example configures a key manager that depends on a KeyStore config [#d210e14591] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyManagerHeaplet.html[org.forgerock.openig.security.KeyManagerHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/security/KeyManagerHeaplet.html[org.forgerock.openig.security.KeyManagerHeaplet, window=\_blank] [#d210e14599] ==== See Also @@ -465,7 +465,7 @@ The following example configures a keystore that references a Java Keystore file [#d210e14710] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyStoreHeaplet.html[org.forgerock.openig.security.KeyStoreHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/security/KeyStoreHeaplet.html[org.forgerock.openig.security.KeyStoreHeaplet, window=\_blank] [#d210e14718] ==== See Also @@ -608,7 +608,7 @@ The following example shows an issuer configuration for Google: [#d210e14921] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/oauth2/client/Issuer.html[org.forgerock.openig.filter.oauth2.client.Issuer, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/oauth2/client/Issuer.html[org.forgerock.openig.filter.oauth2.client.Issuer, window=\_blank] ''' [#ScheduledExecutorService] @@ -710,7 +710,7 @@ The following example creates a thread pool to execute tasks. When the executor [#d210e15205] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/thread/ScheduledExecutorServiceHeaplet.html[org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/thread/ScheduledExecutorServiceHeaplet.html[org.forgerock.openig.thread.ScheduledExecutorServiceHeaplet, window=\_blank] ''' [#SystemAndEnvSecretStore] @@ -803,7 +803,7 @@ The directory where temporary files are created. If omitted, then the system-dep [#d210e15288] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/io/TemporaryStorage.html[org.forgerock.openig.io.TemporaryStorage, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/io/TemporaryStorage.html[org.forgerock.openig.io.TemporaryStorage, window=\_blank] ''' [#TrustManager] @@ -872,7 +872,7 @@ The following example configures a trust manager that depends on a KeyStore conf [#d210e15368] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/security/TrustManagerHeaplet.html[org.forgerock.openig.security.TrustManagerHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/security/TrustManagerHeaplet.html[org.forgerock.openig.security.TrustManagerHeaplet, window=\_blank] [#d210e15376] ==== See Also @@ -918,7 +918,7 @@ The following example configures a client handler that blindly trusts server cer [#d210e15431] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/security/TrustAllManager.html[org.forgerock.openig.security.TrustAllManager, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/security/TrustAllManager.html[org.forgerock.openig.security.TrustAllManager, window=\_blank] ''' [#UmaService] @@ -1088,6 +1088,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-url}/index.html?org/forgerock/openig/uma/UmaSharingService.html[org.forgerock.openig.uma.UmaSharingService, window=\_blank] +link:{apidocs-url}/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 e8771e09..9b8bc174 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-url}/index.html?org/forgerock/services/context/AttributesContext.html[org.forgerock.services.context.AttributesContext, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/services/context/ClientContext.html[org.forgerock.services.context.ClientContext, window=\_blank] +link:{apidocs-url}/org/forgerock/services/context/ClientContext.html[org.forgerock.services.context.ClientContext, window=\_blank] ''' [#Contexts] @@ -113,7 +113,7 @@ link:{apidocs-url}/index.html?org/forgerock/services/context/ClientContext.html[ ==== Description The root object for request context information. -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. +Contexts is a map of available contexts, which implement the link:{apidocs-url}/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-url}/index.html?org/forgerock/services/context/Context.html[org.forgerock.services.context.Context, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/protocol/Request.html[org.forgerock.http.protocol.Request, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/protocol/Response.html[org.forgerock.http.protocol.Response, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/session/SessionContext.html[org.forgerock.http.session.SessionContext, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/protocol/Status.html[org.forgerock.http.protocol.Status, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/MutableUri.html[org.forgerock.http.MutableUri, window=\_blank] +link:{apidocs-url}/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-url}/index.html?org/forgerock/http/routing/UriRouterContext.html[org.forgerock.http.routing.UriRouterContext, window=\_blank] +link:{apidocs-url}/org/forgerock/http/routing/UriRouterContext.html[org.forgerock.http.routing.UriRouterContext, window=\_blank] diff --git a/openig-doc/src/main/asciidoc/reference/required-conf.adoc b/openig-doc/src/main/asciidoc/reference/required-conf.adoc index 718ae63e..7ae5db77 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-url}/index.html?org/forgerock/openig/http/GatewayHttpApplication.html[org.forgerock.openig.http.GatewayHttpApplication, window=\_blank] +link:{apidocs-url}/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 dac99b30..96be3633 100644 --- a/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc +++ b/openig-doc/src/main/asciidoc/reference/throttling-conf.adoc @@ -154,7 +154,7 @@ The following route defines a throttling rate of 6 requests/10 seconds to reques [#d210e13170] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/ThrottlingFilterHeaplet.html[org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/throttling/ThrottlingFilterHeaplet.html[org.forgerock.openig.filter.throttling.ThrottlingFilterHeaplet, window=\_blank] ''' [#MappedThrottlingPolicy] @@ -283,7 +283,7 @@ image::images/throttling-mapped.png[] [#d210e13495] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/MappedThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/throttling/MappedThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet, window=\_blank] ''' [#ScriptableThrottlingPolicy] @@ -402,7 +402,7 @@ if (request.headers['X-Forwarded-For'].values[0] == 'accounts.example.com') { [#d210e13638] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/ScriptableThrottlingPolicy.Heaplet.html[org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/throttling/ScriptableThrottlingPolicy.Heaplet.html[org.forgerock.openig.filter.throttling.ScriptableThrottlingPolicy.Heaplet, window=\_blank] ''' [#DefaultRateThrottlingPolicy] @@ -467,6 +467,6 @@ For an example of how this policy is used, see xref:#example-throttling-scriptab [#d210e13916] ==== Javadoc -link:{apidocs-url}/index.html?org/forgerock/openig/filter/throttling/DefaultRateThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet, window=\_blank] +link:{apidocs-url}/org/forgerock/openig/filter/throttling/DefaultRateThrottlingPolicyHeaplet.html[org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet, window=\_blank]