Skip to content

Commit 2ddc79c

Browse files
authored
Docs: set supported Java and Tomcat versions (#944)
1 parent 375284c commit 2ddc79c

File tree

14 files changed

+124
-1780
lines changed

14 files changed

+124
-1780
lines changed

openam-documentation/openam-doc-source/src/main/asciidoc/admin-guide/chap-monitoring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ You can also browse the MBeans by connecting to your web application container,
106106
107107
[#figure-jconsole-to-openam]
108108
image::images/jconsole-to-openam.png[]
109-
Also see link:http://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html[Monitoring and Management Using JMX, window=\_blank] for instructions on how to connect remotely, how to use SSL, and so forth.
109+
Also see link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Monitoring and Management Using JMX Technology, window=\_blank] for instructions on how to connect remotely, how to use SSL, and so forth.
110110
111111
[IMPORTANT]
112112
====

openam-documentation/openam-doc-source/src/main/asciidoc/admin-guide/chap-sts.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1501,7 +1501,7 @@ Deploy the `.war` file as follows:
15011501
. OpenAM supports the following web containers for SOAP STS deployments:
15021502
+
15031503
1504-
* Apache Tomcat 6, 7, or 8
1504+
* Apache Tomcat 10.1.x or 11
15051505
15061506
* Jetty 7, 8, or 9
15071507
@@ -1609,13 +1609,13 @@ Then, you can make the following changes:
16091609
[#sts-soap-logger]
16101610
==== Configuring the SOAP STS Logger
16111611
1612-
OpenAM SOAP STS logs to the Simple Logging Facade for Java (SLF4J) API. Because the Apache CXF framework, by default, logs to the `java.util.logging` object, the OpenAM SOAP STS is built with a maven dependency upon `slf4j-jdk14`, which allows OpenAM SOAP STS log entries to be configured via `java.util.logging`. As a result, you can implement both OpenAM SOAP STS and Apache CXF logging to be configured via the `logging.properties` file in the Tomcat `conf` directory.
1612+
OpenAM SOAP STS logs to the Simple Logging Facade for Java (SLF4J) API. Because the Apache CXF framework, by default, logs to the `java.util.logging` object, the OpenAM SOAP STS is built with a maven dependency upon `slf4j`, which allows OpenAM SOAP STS log entries to be configured via `java.util.logging`. As a result, you can implement both OpenAM SOAP STS and Apache CXF logging to be configured via the `logging.properties` file in the Tomcat `conf` directory.
16131613
16141614
You can configure and customize Apache CXF-related logging according to directions given at the following web site: link:http://cxf.apache.org/docs/debugging-and-logging.html[http://cxf.apache.org/docs/debugging-and-logging.html, window=\_blank]
16151615
16161616
[NOTE]
16171617
====
1618-
Because the OpenAM SOAP STS code logs to the SLF4J API, the manner in which these logs are realized is a function of the jar file state bundled in the OpenAM SOAP STS server `.war` file. If you implement the OpenAM SOAP STS logs using a different framework, you can replace the `slf4j-jdk14` Maven dependency in the OpenAM SOAP STS server `pom.xml` file by the desired dependency and rebuild the `.war` file. Or you can change the generated OpenAM SOAP STS server `.war` file to include the desired `.jar` file, which will realize the SLF4J API with the desired logging framework.
1618+
Because the OpenAM SOAP STS code logs to the SLF4J API, the manner in which these logs are realized is a function of the jar file state bundled in the OpenAM SOAP STS server `.war` file. If you implement the OpenAM SOAP STS logs using a different framework, you can replace the `slf4j` Maven dependency in the OpenAM SOAP STS server `pom.xml` file by the desired dependency and rebuild the `.war` file. Or you can change the generated OpenAM SOAP STS server `.war` file to include the desired `.jar` file, which will realize the SLF4J API with the desired logging framework.
16191619
16201620
Also, note that the `debugfiles.properties` included in the OpenAM SOAP STS server `.war` file does not configure logging. It is present only because some OpenAM code leveraged by the SOAP STS continues to have dependencies upon the legacy, OpenAM debug logger. The presence of this file minimizes the number of harmless error logs generated by the initialization of this legacy debug logger. OpenAM SOAP STS does not utilize this logger.
16211621
====

openam-documentation/openam-doc-source/src/main/asciidoc/deployment-planning/chap-high-level-start.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,9 @@ The installation process requires that you implement your deployment plan.
329329
330330
* *Prepare the Operating System*. Prepare your operating system, depending on the OS: Linux, Solaris, Windows, Cloud (Amazon EC2, OpenStack, and so forth), Virtual Machines (VMWare, Xen, Hyper-V, and so forth)
331331
332-
* *Prepare the Java Environment*. Prepare your Java environment, depending on your vendor type: Oracle, IBM, OpenJDK.
332+
* *Prepare the Java Environment*. Prepare your Java environment, depending on your vendor type: Oracle, OpenJDK, Eclipse Temurin etc.
333333
334-
* *Prepare the App Server*. Prepare your application server, depending on type: Apache Tomcat, JBoss 4/5, WildFly, Jetty, Oracle WebLogic, IBM WebSphere. Also, prepare each app server for HTTPS.
334+
* *Prepare the App Server*. Prepare your application server, depending on type: Apache Tomcat, Jetty, Oracle WebLogic, IBM WebSphere. Also, prepare each app server for HTTPS.
335335
336336
* *Prepare the Directory Servers*. Prepare the configuration directory server, OpenDJ for the core token service (CTS), and the LDAP identity repository. For information on installing data repositories, see xref:../install-guide/chap-prepare-install.adoc#chap-prepare-install["Preparing For Installation"] in the __Installation Guide__.
337337

openam-documentation/openam-doc-source/src/main/asciidoc/deployment-planning/chap-hw-sw-requirements.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,8 @@ a|2008, 2008 R2, 2012, 2012 R2
182182
|===
183183
|Vendor |Version
184184
185-
a|Oracle JDK
186-
a|7, 8
187-
188-
a|IBM SDK, Java Technology Edition (Websphere only)
189-
a|7
185+
a|Any JDK vendor, i.e. Oracle JDK, Eclipse Temurin, Amazon Coretto
186+
a|11 LTS or later
190187
|===
191188
192189
@@ -201,7 +198,7 @@ a|7
201198
|Web Container |Version
202199
203200
a|Apache Tomcat
204-
a|7, 8
201+
a|10.1.X, 11
205202
206203
a|Oracle WebLogic Server
207204
a|12c
@@ -341,7 +338,7 @@ a|[none]
341338
a|[none]
342339
* 5, 6, 7
343340
a|[none]
344-
* Apache Tomcat 6, 7, 8
341+
* Apache Tomcat 10.1.X, 11
345342
* IBM Web Sphere Application Server 8, 8.5
346343
* JBoss Enterprise Application Platform 6
347344
* JBoss Application Server 7
@@ -353,23 +350,23 @@ a|[none]
353350
a|[none]
354351
* 2008, 2008 R2, 2012, 2012 R2
355352
a|[none]
356-
* Apache Tomcat 6, 7, 8
353+
* Apache Tomcat 10.1.X, 11
357354
358355
a|[none]
359356
* Oracle Solaris x64
360357
* Oracle Solaris SPARC
361358
a|[none]
362359
* 10, 11
363360
a|[none]
364-
* Apache Tomcat 6, 7, 8
361+
* Apache Tomcat 10.1.X, 11
365362
* Oracle WebLogic Server 11g, 12c
366363
367364
a|[none]
368365
* Ubuntu Linux
369366
a|[none]
370367
* 12.04 LTS, 14.04 LTS
371368
a|[none]
372-
* Apache Tomcat 6, 7, 8
369+
* Apache Tomcat 10.1.X, 11
373370
* IBM Web Sphere Application Server 8, 8.5
374371
* JBoss Enterprise Application Platform 6
375372
* JBoss Application Server 7

openam-documentation/openam-doc-source/src/main/asciidoc/deployment-planning/chap-intro.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,4 @@ In February 2010, a small group of former Sun employees founded ForgeRock to con
172172
173173
* 2016: OpenAM 14
174174
175-
* 2025: OpenAM 15
176-
177-
178-
175+
* 2025: OpenAM 15 and 16

openam-documentation/openam-doc-source/src/main/asciidoc/install-guide/chap-prepare-install.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Check the effective top-level domain list at link:https://publicsuffix.org/list/
5151
[#prepare-java]
5252
=== Preparing a Java Environment
5353
54-
OpenAM software depends on a Java runtime environment. Check the output of `java -version` to make sure your the version is supported. The current OpenAM release supports Java Development Kit 8, 11, 17 or 21 LTS version.
54+
OpenAM software depends on a Java runtime environment. Check the output of `java -version` to make sure your the version is supported. The current OpenAM release supports Java Development Kit 11, 17, 21 or 25 LTS version.
5555
5656
[#prepare-java-sun]
5757
==== Settings For Sun/Oracle Java Environments
@@ -1355,7 +1355,7 @@ You should also ensure `sslProtocol` is set to `TLS`, which disables the potenti
13551355
maxThreads="150" scheme="https" secure="true"
13561356
clientAuth="false" sslProtocol="TLS" URIEncoding="UTF-8" />
13571357
----
1358-
The following example script, `/etc/init.d/tomcat`, manages the service at system startup and shutdown. This script assumes you run OpenAM as the user `openam` and that you use Oracle JDK 8.
1358+
The following example script, `/etc/init.d/tomcat`, manages the service at system startup and shutdown. This script assumes you run OpenAM as the user `openam` and that you use JDK 11 LTS or later.
13591359
13601360
[source, shell]
13611361
----

0 commit comments

Comments
 (0)