Skip to content

Commit 50db9c0

Browse files
authored
Fix javadoc links and update JwtBuilderFilter title (#153)
1 parent a520ea0 commit 50db9c0

12 files changed

Lines changed: 97 additions & 97 deletions

openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -581,13 +581,13 @@ Interface Stability: Evolving (For information, see xref:../reference/appendix-i
581581
--
582582
The following interfaces are available:
583583
584-
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/Decorator.html[Decorator, window=\_blank]::
584+
link:{apidocs-url}/org/forgerock/openig/decoration/Decorator.html[Decorator, window=\_blank]::
585585
A `Decorator` adds new behavior to another object without changing the base type of the object.
586586
587587
+
588588
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`.
589589
590-
link:{apidocs-url}/index.html?org/forgerock/openig/el/ExpressionPlugin.html[ExpressionPlugin, window=\_blank]::
590+
link:{apidocs-url}/org/forgerock/openig/el/ExpressionPlugin.html[ExpressionPlugin, window=\_blank]::
591591
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.
592592
593593
+
@@ -599,28 +599,28 @@ When you add your own `ExpressionPlugin`, you must make it discoverable within y
599599
+
600600
Be sure to provide some documentation for OpenIG administrators on how your plugin extends expressions.
601601
602-
link:{apidocs-url}/index.html?org/forgerock/http/Filter.html[Filter, window=\_blank]::
602+
link:{apidocs-url}/org/forgerock/http/Filter.html[Filter, window=\_blank]::
603603
+
604604
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.
605605
606606
+
607-
The `Filter` interface exposes a `filter()` method, which takes a link:{apidocs-url}/index.html?org/forgerock/http/Context.html[Context, window=\_blank], a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank], and the link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[Handler, window=\_blank], which is the next filter or handler to dispatch to. The `filter()` method returns a link:{apidocs-url}/index.html?org/forgerock/util/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions.
607+
The `Filter` interface exposes a `filter()` method, which takes a link:{apidocs-url}/org/forgerock/http/Context.html[Context, window=\_blank], a link:{apidocs-url}/org/forgerock/http/protocol/Request.html[Request, window=\_blank], and the link:{apidocs-url}/org/forgerock/http/Handler.html[Handler, window=\_blank], which is the next filter or handler to dispatch to. The `filter()` method returns a link:{apidocs-url}/org/forgerock/util/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions.
608608
609609
+
610610
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.
611611
612612
+
613-
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
613+
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
614614
615-
link:{apidocs-url}/index.html?org/forgerock/http/Handler.html[Handler, window=\_blank]::
615+
link:{apidocs-url}/org/forgerock/http/Handler.html[Handler, window=\_blank]::
616616
+
617617
A `Handler` generates a response for a request.
618618
619619
+
620-
The `Handler` interface exposes a `handle()` method, which takes a link:{apidocs-url}/index.html?org/forgerock/http/Context.html[Context, window=\_blank], and a link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[Request, window=\_blank]. It processes the request and returns a link:{apidocs-url}/index.html?org/forgerock/util/promise/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/index.html?org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions. A handler can elect to dispatch the request to another handler or chain.
620+
The `Handler` interface exposes a `handle()` method, which takes a link:{apidocs-url}/org/forgerock/http/Context.html[Context, window=\_blank], and a link:{apidocs-url}/org/forgerock/http/protocol/Request.html[Request, window=\_blank]. It processes the request and returns a link:{apidocs-url}/org/forgerock/util/promise/Promise.html[Promise, window=\_blank] that provides access to the link:{apidocs-url}/org/forgerock/http/protocol/Response.html[Response, window=\_blank] with methods for dealing with both success and failure conditions. A handler can elect to dispatch the request to another handler or chain.
621621
622622
+
623-
OpenIG also provides the convenience class, link:{apidocs-url}/index.html?org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
623+
OpenIG also provides the convenience class, link:{apidocs-url}/org/forgerock/openig/heap/GenericHeapObject.html[GenericHeapObject, window=\_blank], to help with configuration.
624624
625625
--
626626

openig-doc/src/main/asciidoc/partials/sec-duration-description.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
Copyright 2025 3A Systems LLC.
1515
////
1616
+
17-
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
17+
A link:{apidocs-url}/org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
1818
+
1919
Durations are not case sensitive.
2020
+

openig-doc/src/main/asciidoc/reference/audit-conf.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ The following example route uses the audit service:
176176
177177
[#d210e10206]
178178
==== Javadoc
179-
link:{apidocs-url}/index.html?org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank]
179+
link:{apidocs-url}/org/forgerock/audit/AuditService.html[org.forgerock.audit.AuditService, window=\_blank]
180180
181181
'''
182182
[#CsvAuditEventHandler]
@@ -531,7 +531,7 @@ The following example configures a CSV audit event handler to write a log file,
531531
532532
[#d210e11344]
533533
==== Javadoc
534-
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank]
534+
link:{apidocs-url}/org/forgerock/audit/handlers/csv/CsvAuditEventHandler.html[org.forgerock.audit.handlers.csv.CsvAuditEventHandler, window=\_blank]
535535
536536
'''
537537
[#JdbcAuditEventHandler]
@@ -611,7 +611,7 @@ Set this to `"topics": [ "access" ]`.
611611
The database type name.
612612
613613
+
614-
Built-in support is provided for `oracle`, `mysql`, and `h2`. Unrecognized database types rely on a link:{apidocs-url}/index.html?org/forgerock/audit/handlers/jdbc/providers/GenericDatabaseStatementProvider.html[GenericDatabaseStatementProvider, window=\_top].
614+
Built-in support is provided for `oracle`, `mysql`, and `h2`. Unrecognized database types rely on a link:{apidocs-url}/org/forgerock/audit/handlers/jdbc/providers/GenericDatabaseStatementProvider.html[GenericDatabaseStatementProvider, window=\_top].
615615
616616
`"enabled"`: __boolean, optional__::
617617
Whether this event handler is active.
@@ -812,7 +812,7 @@ Examples including statements to create tables are provided in the JDBC handler
812812
813813
[#d210e11910]
814814
==== Javadoc
815-
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank]
815+
link:{apidocs-url}/org/forgerock/audit/handlers/jdbc/JdbcAuditEventHandler.html[org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler, window=\_blank]
816816
817817
'''
818818
[#SyslogAuditEventHandler]
@@ -1080,7 +1080,7 @@ The following example configures a Syslog audit event handler that writes to the
10801080
10811081
[#d210e12388]
10821082
==== Javadoc
1083-
link:{apidocs-url}/index.html?org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank]
1083+
link:{apidocs-url}/org/forgerock/audit/handlers/syslog/SyslogAuditEventHandler.html[org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler, window=\_blank]
10841084
10851085
'''
10861086
[#ElasticsearchAuditEventHandler]

openig-doc/src/main/asciidoc/reference/decorators-conf.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,15 +149,15 @@ A reference to the data involved in the event, providing access to the `request`
149149
The source of the audit event, meaning the name of the object under audit.
150150
151151
+
152-
For details, see link:{apidocs-url}/index.html?org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].
152+
For details, see link:{apidocs-url}/org/forgerock/openig/audit/AuditSource.html[org.forgerock.openig.audit.AuditSource, window=\_blank].
153153
154154
`event.tags`::
155155
Strings that qualify the event. Entities receiving notifications can use the tags to select audit events of interest.
156156
157157
+
158158
Define your own audit tags in order to identify particular events or routes.
159159
+
160-
OpenIG provides the following built-in tags in link:{apidocs-url}/index.html?org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]:
160+
OpenIG provides the following built-in tags in link:{apidocs-url}/org/forgerock/openig/audit/Tag.html[org.forgerock.openig.audit.Tag, window=\_blank]:
161161
162162
* `request`: This event happens before OpenIG calls the decorated object.
163163
@@ -245,7 +245,7 @@ To observe audit events, use a registered audit agent such as a MonitorEndpointH
245245
246246
[#d210e9106]
247247
==== Javadoc
248-
link:{apidocs-url}/index.html?org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank]
248+
link:{apidocs-url}/org/forgerock/openig/audit/decoration/AuditDecorator.html[org.forgerock.openig.audit.decoration.AuditDecorator, window=\_blank]
249249
250250
'''
251251
[#BaseUriDecorator]
@@ -327,7 +327,7 @@ Set a Router's base URI to `\https://www.example.com:8443`:
327327
328328
[#d210e9209]
329329
==== Javadoc
330-
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank]
330+
link:{apidocs-url}/org/forgerock/openig/decoration/baseuri/BaseUriDecorator.html[org.forgerock.openig.decoration.baseuri.BaseUriDecorator, window=\_blank]
331331
332332
'''
333333
[#CaptureDecorator]
@@ -576,7 +576,7 @@ To capture the context as JSON, excluding the request and response, before sendi
576576
577577
[#d210e9420]
578578
==== Javadoc
579-
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank]
579+
link:{apidocs-url}/org/forgerock/openig/decoration/capture/CaptureDecorator.html[org.forgerock.openig.decoration.capture.CaptureDecorator, window=\_blank]
580580
581581
'''
582582
[#TimerDecorator]
@@ -771,6 +771,6 @@ You can then deactivate the timer by setting the values to `false`:
771771
772772
[#d210e9567]
773773
==== Javadoc
774-
link:{apidocs-url}/index.html?org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank]
774+
link:{apidocs-url}/org/forgerock/openig/decoration/timer/TimerDecorator.html[org.forgerock.openig.decoration.timer.TimerDecorator, window=\_blank]
775775
776776

openig-doc/src/main/asciidoc/reference/expressions-conf.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -880,9 +880,9 @@ The string resulting from URL encoding the provided userInfo as per RFC 3986.
880880
881881
[#functions-javadoc]
882882
==== Javadoc
883-
Some functions are provided by link:{apidocs-url}/index.html?org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].
883+
Some functions are provided by link:{apidocs-url}/org/forgerock/openig/el/Functions.html[org.forgerock.openig.el.Functions, window=\_blank].
884884
885-
Other functions are provided by link:{apidocs-url}/index.html?org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].
885+
Other functions are provided by link:{apidocs-url}/org/forgerock/http/util/Uris.html[org.forgerock.http.util.Uris, window=\_blank].
886886
887887
'''
888888
[#Patterns]

0 commit comments

Comments
 (0)