Skip to content

Commit b3521df

Browse files
maximthomasmaximthomas
authored
Docs: fix links and move duration description to partials (#104)
1 parent b7f9ead commit b3521df

File tree

9 files changed

+71
-442
lines changed

9 files changed

+71
-442
lines changed

‎openig-doc/src/main/asciidoc/gateway-guide/appendix-multiple-sps.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -47,19 +47,19 @@ a|xref:#prepare-network-multi[Preparing the Network]
4747
a|Prepare the configuration for two OpenIG service providers.
4848
a|xref:#prepare-cot-multi[Configuring the Circle of Trust]
4949
50-
xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]
50+
xref:#prepare-saml-conf1-multi[Configuring the Service Provider for Application One]
5151
52-
xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]
52+
xref:#prepare-saml-conf2-multi[Configuring the Service Provider for Application Two]
5353
5454
a|Import the service provider configurations into OpenAM.
5555
a|xref:#multisp-create-saml-entities[Importing Service Provider Configurations Into OpenAM]
5656
5757
a|Add OpenIG routes.
5858
a|xref:#multisp-conf[Preparing the Base Configuration File]
5959
60-
xref:#multisp-conf-sp1[Preparing Routes for Application One]
60+
xref:#multisp-conf-sp1[Preparing Routes for Application One]
6161
62-
xref:#multisp-conf-sp2[Preparing Routes for Application Two]
62+
xref:#multisp-conf-sp2[Preparing Routes for Application Two]
6363
|===
6464
6565

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -93,16 +93,17 @@ a|xref:#prepare-network[Preparing the Network]
9393
a|Configure OpenAM As an IDP.
9494
a|xref:#set-up-openam[ Setting Up OpenAM for This Tutorial ]
9595
96-
xref:#hosted-id[ Setting Up a Hosted Identity Provider ]
96+
xref:#hosted-id[ Setting Up a Hosted Identity Provider ]
9797
98-
xref:#fedlet[ Setting up a Fedlet ]
98+
xref:#fedlet[ Setting up a Fedlet ]
9999
100100
a|Configuring OpenIG as a SP.
101101
a|xref:#copy-conf-files[ Retrieve the Fedlet Configuration Files ]
102102
103-
xref:#route-credential-injection[ Adding a Route for Credential Injection ]
103+
xref:#route-credential-injection[ Adding a Route for Credential Injection ]
104+
105+
xref:#route-saml-fed[ Adding a Route for SAML Federation ]
104106
105-
xref:#route-saml-fed[ Adding a Route for SAML Federation ]
106107
|===
107108
108109
[#d2528e3373]

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

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
////
2+
The contents of this file are subject to the terms of the Common Development and
3+
Distribution License (the License). You may not use this file except in compliance with the
4+
License.
5+
6+
You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7+
specific language governing permission and limitations under the License.
8+
9+
When distributing Covered Software, include this CDDL Header Notice in each file and include
10+
the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11+
Header, with the fields enclosed by brackets [] replaced by your own identifying
12+
information: "Portions copyright [year] [name of copyright owner]".
13+
14+
Copyright 2025 3A Systems LLC.
15+
////
16+
+
17+
A link:{apidocs-url}/index.html?org/forgerock/openig/util/Duration.html[duration, window=\_blank] is a lapse of time expressed in English, such as `23 hours 59 minutes and 59 seconds`.
18+
+
19+
Durations are not case sensitive.
20+
+
21+
Negative durations are not supported.
22+
+
23+
The following units can be used in durations:
24+
25+
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
26+
27+
* `zero`, `disabled`: zero-length duration
28+
29+
* `days`, `day`, `d`: days
30+
31+
* `hours`, `hour`, `h`: hours
32+
33+
* `minutes`, `minute`, `min`, `m`: minutes
34+
35+
* `seconds`, `second`, `sec`, `s`: seconds
36+
37+
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
38+
39+
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
40+
41+
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds

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

Lines changed: 6 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -339,32 +339,7 @@ This password is used for the keystore and for private keys. For details, see xr
339339
`"signatureInterval"`: __duration, required__::
340340
The time interval after which to insert a signature in the CSV file. This duration must not be zero, and must not be unlimited.
341341
+
342-
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`.
343-
344-
Durations are not case sensitive.
345-
346-
Negative durations are not supported.
347-
348-
The following units can be used in durations:
349-
350-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
351-
352-
* `zero`, `disabled`: zero-length duration
353-
354-
* `days`, `day`, `d`: days
355-
356-
* `hours`, `hour`, `h`: hours
357-
358-
* `minutes`, `minute`, `min`, `m`: minutes
359-
360-
* `seconds`, `second`, `sec`, `s`: seconds
361-
362-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
363-
364-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
365-
366-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
367-
342+
include::../partials/sec-duration-description.adoc[]
368343
369344
====
370345
@@ -431,35 +406,10 @@ Default: `-yyyy.MM.dd-HH.mm.ss`, where __yyyy__ characters are replaced with the
431406
432407
`"rotationInterval"`: __duration, optional__::
433408
The time interval after which to rotate log files. This duration must not be zero.
434-
435409
+
436410
This has the effect of enabling time-based file rotation.
437411
+
438-
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`.
439-
440-
Durations are not case sensitive.
441-
442-
Negative durations are not supported.
443-
444-
The following units can be used in durations:
445-
446-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
447-
448-
* `zero`, `disabled`: zero-length duration
449-
450-
* `days`, `day`, `d`: days
451-
452-
* `hours`, `hour`, `h`: hours
453-
454-
* `minutes`, `minute`, `min`, `m`: minutes
455-
456-
* `seconds`, `second`, `sec`, `s`: seconds
457-
458-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
459-
460-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
461-
462-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
412+
include::../partials/sec-duration-description.adoc[]
463413
464414
465415
`"rotationTimes"`: __array of durations, optional__::
@@ -476,67 +426,17 @@ The following example schedules rotation six and twelve hours after midnight:
476426
+
477427
This has the effect of enabling time-based file rotation.
478428
+
479-
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`.
480-
481-
Durations are not case sensitive.
482-
483-
Negative durations are not supported.
484-
485-
The following units can be used in durations:
486-
487-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
488-
489-
* `zero`, `disabled`: zero-length duration
490-
491-
* `days`, `day`, `d`: days
492-
493-
* `hours`, `hour`, `h`: hours
494-
495-
* `minutes`, `minute`, `min`, `m`: minutes
496-
497-
* `seconds`, `second`, `sec`, `s`: seconds
498-
499-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
500-
501-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
502-
503-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
429+
include::../partials/sec-duration-description.adoc[]
504430
505431
506432
====
507433
508434
`"rotationRetentionCheckInterval"`: __duration, optional__::
509435
The time interval after which to check file rotation and retention policies for updates.
510-
511436
+
512437
Default: 5 seconds
513438
+
514-
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`.
515-
516-
Durations are not case sensitive.
517-
518-
Negative durations are not supported.
519-
520-
The following units can be used in durations:
521-
522-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
523-
524-
* `zero`, `disabled`: zero-length duration
525-
526-
* `days`, `day`, `d`: days
527-
528-
* `hours`, `hour`, `h`: hours
529-
530-
* `minutes`, `minute`, `min`, `m`: minutes
531-
532-
* `seconds`, `second`, `sec`, `s`: seconds
533-
534-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
535-
536-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
537-
538-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
539-
439+
include::../partials/sec-duration-description.adoc[]
540440
541441
--
542442
@@ -738,31 +638,7 @@ The interval at which to send buffered event messages to the database.
738638
+
739639
This interval must be greater than 0 if buffering is enabled.
740640
+
741-
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`.
742-
743-
Durations are not case sensitive.
744-
745-
Negative durations are not supported.
746-
747-
The following units can be used in durations:
748-
749-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
750-
751-
* `zero`, `disabled`: zero-length duration
752-
753-
* `days`, `day`, `d`: days
754-
755-
* `hours`, `hour`, `h`: hours
756-
757-
* `minutes`, `minute`, `min`, `m`: minutes
758-
759-
* `seconds`, `second`, `sec`, `s`: seconds
760-
761-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
762-
763-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
764-
765-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
641+
include::../partials/sec-duration-description.adoc[]
766642
767643
768644
`"autoFlush"`: __boolean, optional__::
@@ -1330,31 +1206,7 @@ The interval at which to send buffered event messages to Elasticsearch. If buffe
13301206
+
13311207
Default: 1 second
13321208
+
1333-
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`.
1334-
1335-
Durations are not case sensitive.
1336-
1337-
Negative durations are not supported.
1338-
1339-
The following units can be used in durations:
1340-
1341-
* `indefinite`, `infinity`, `undefined`, `unlimited`: unlimited duration
1342-
1343-
* `zero`, `disabled`: zero-length duration
1344-
1345-
* `days`, `day`, `d`: days
1346-
1347-
* `hours`, `hour`, `h`: hours
1348-
1349-
* `minutes`, `minute`, `min`, `m`: minutes
1350-
1351-
* `seconds`, `second`, `sec`, `s`: seconds
1352-
1353-
* `milliseconds`, `millisecond`, `millisec`, `millis`, `milli`, `ms`: milliseconds
1354-
1355-
* `microseconds`, `microsecond`, `microsec`, `micros`, `micro`, `us`: microseconds
1356-
1357-
* `nanoseconds`, `nanosecond`, `nanosec`, `nanos`, `nano`, `ns`: nanoseconds
1209+
include::../partials/sec-duration-description.adoc[]
13581210
13591211
13601212
`"maxBatchedEvents"`: __number, optional__::

0 commit comments

Comments
 (0)