Skip to content

Documentation for --server-output, plus fixes after testing #25807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 28, 2025
Merged

Documentation for --server-output, plus fixes after testing #25807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df90c6d
GFLauncher code cleanup
dmatej Nov 27, 2025
5a49bf6
Fixed links to the JPDA
dmatej Nov 28, 2025
97f2744
Added documentation for the new property --server-output
dmatej Nov 28, 2025
d1d2930
Fixed printing after domain restart
dmatej Nov 28, 2025
3e820e7
Fixed check for duplicated ports
dmatej Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions appserver/tests/appserv-tests/devtests/ejb/ports.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ private static String getFreePort(Set<String> excluded) throws IllegalStateExcep
while (true) {
counter++;
try (ServerSocket socket = new ServerSocket(0)) {
final int port = socket.getLocalPort();
final String port = Integer.toString(socket.getLocalPort());
socket.setSoTimeout(1);
if (excluded.contains(port) && counter >= 20) {
throw new IllegalStateException("Cannot open random port, tried 20 times. Port " + port
+ " is excluded and we were not able to find another.");
}
return Integer.toString(port);
return port;
} catch (IOException e) {
if (counter >= 20) {
throw new IllegalStateException("Cannot open random port, tried 20 times.", e);
Expand Down
6 changes: 4 additions & 2 deletions docs/reference-manual/src/main/asciidoc/copy-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,10 @@ asadmin-options::
requires superuser privileges.
`JAVA_DEBUGGER_PORT`;;
This property specifies the port number of the port that is used for
connections to the Java Platform Debugger Architecture (JPDA)
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
connections to the Specifies whether the domain is restarted with
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled.

Copy link
Contributor

@pzygielo pzygielo Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems that https://glassfish.org/docs/SNAPSHOT/reference-manual.html#copy-config is not updated with that (yet?) - so can't check how this is rendered - but I don't understand that part in bold already:

This property specifies the port number of the port that is used for
connections to the Specifies whether the domain is restarted with

For me, there is something not right with that sentence...

Copy link
Contributor Author

@dmatej dmatej Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is on my list as next item 🙂

debugger. Valid values are 1-65535. On UNIX, creating sockets that
listen on ports 1-1024 requires superuser privileges.
`JMS_PROVIDER_PORT`;;
Expand Down
4 changes: 1 addition & 3 deletions docs/reference-manual/src/main/asciidoc/create-cluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,7 @@ asadmin-options::
`JAVA_DEBUGGER_PORT`;;
This property specifies the port number of the port that is used for
connections to the
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugger. Valid values are 1-65535. On UNIX, creating sockets that
listen on ports 1-1024 requires superuser privileges.
`JMS_PROVIDER_PORT`;;
Expand Down
4 changes: 1 addition & 3 deletions docs/reference-manual/src/main/asciidoc/create-domain.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,7 @@ When the `--portbase` option is specified, the output of this
`java.debugger.port`;;
This property specifies the port number of the port that is used for
connections to the
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugger. Valid values are 1-65535. On UNIX, creating sockets that
listen on ports 1-1024 requires superuser privileges.
`jms.port`;;
Expand Down
3 changes: 1 addition & 2 deletions docs/reference-manual/src/main/asciidoc/create-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,7 @@ When the `--portbase` option is specified, the output of this
requires superuser privileges.
`JAVA_DEBUGGER_PORT`;;
This property specifies the port number of the port that is used for
connections to the Java Platform Debugger Architecture (JPDA)
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
connections to the https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugger. Valid values are 1-65535. On UNIX, creating sockets that
listen on ports 1-1024 requires superuser privileges.
`JMS_PROVIDER_PORT`;;
Expand Down
3 changes: 1 addition & 2 deletions docs/reference-manual/src/main/asciidoc/create-local-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,7 @@ When the `--portbase` option is specified, the output of this
requires superuser privileges.
`JAVA_DEBUGGER_PORT`;;
This property specifies the port number of the port that is used for
connections to the Java Platform Debugger Architecture (JPDA)
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
connections to the https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugger. Valid values are 1-65535. On UNIX, creating sockets that
listen on ports 1-1024 requires superuser privileges.
`JMS_PROVIDER_PORT`;;
Expand Down
16 changes: 13 additions & 3 deletions docs/reference-manual/src/main/asciidoc/restart-domain.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ asadmin restart-domain
[--force[=<force(default:true)>]]
[--help|-?]
[--kill[=<kill(default:false)>]]
[--server-output|-o=<server-output(default:false)>]]
[--timeout <timeout>]
[domain_name]
----
Expand Down Expand Up @@ -55,9 +56,7 @@ asadmin-options::
Displays the help text for the subcommand.
`--debug`::
Specifies whether the domain is restarted with
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled.
Possible values are as follows:

Expand Down Expand Up @@ -97,6 +96,17 @@ The default is the current setting of this option for the domain that
The domain is killed. The subcommand uses functionality of the
operating system to terminate the domain process.

`--server-output`::
`-o`::
Specifies if the command should or should not print the server output.
If not set, server prints the output just when the command failed.
Possible values are as follows:

`true`;;
The output of the server startup will be printed after the command finishes.
`false`;;
The output of the server startup will not be printed.

`--timeout`::
Specifies timeout in seconds to evaluate the expected result.
If the timeout is exceeded, the command fails - however it does
Expand Down
4 changes: 1 addition & 3 deletions docs/reference-manual/src/main/asciidoc/restart-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,7 @@ asadmin-options::
Displays the help text for the subcommand.
`--debug`::
Specifies whether the instance is restarted with
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture
(JPDA)](https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled. Possible values are as follows:

`true`;;
Expand Down
4 changes: 1 addition & 3 deletions docs/reference-manual/src/main/asciidoc/restart-local-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,7 @@ asadmin-options::
Displays the help text for the subcommand.
`--debug`::
Specifies whether the instance is restarted with
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled.
Possible values are as follows:

Expand Down
12 changes: 12 additions & 0 deletions docs/reference-manual/src/main/asciidoc/start-domain.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ asadmin start-domain
[--drop-interrupted-commands[=<drop-interrupted-commands(default:false)>]]
[--dry-run|-n[=<dry-run(default:false)>]]
[--help|-?]
[--server-output|-o=<server-output(default:false)>]]
[--suspend|-s[=<suspend(default:false)>]]
[--timeout <timeout>]
[--upgrade[=<upgrade(default:false)>]]
Expand Down Expand Up @@ -101,6 +102,17 @@ asadmin-options::
JVM options and when troubleshooting startup issues. +
The default value is `false`.

`--server-output`::
`-o`::
Specifies if the command should or should not print the server output.
If not set, server prints the output just when the command failed.
Possible values are as follows:

`true`;;
The output of the server startup will be printed after the command finishes.
`false`;;
The output of the server startup will not be printed.

`--suspend`::
`-s`::
Specifies whether the domain is started with
Expand Down
4 changes: 1 addition & 3 deletions docs/reference-manual/src/main/asciidoc/start-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@ asadmin-options::
Displays the help text for the subcommand.
`--debug`::
Specifies whether the instance is started with
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled. +
Possible values are as follows:

Expand Down
18 changes: 15 additions & 3 deletions docs/reference-manual/src/main/asciidoc/start-local-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ asadmin start-local-instance
[--help|-?]
[--node <node>]
[--nodedir <nodedir>]
[--server-output|-o=<server-output(default:false)>]]
[--sync <sync(default:normal)>]
[--timeout <timeout>]
[--verbose|-v[=<verbose(default:false)>]]
Expand Down Expand Up @@ -64,9 +65,7 @@ asadmin-options::
`--debug`::
`-d`::
Specifies whether the instance is started with
http://java.sun.com/javase/technologies/core/toolsapis/jpda/[Java
Platform Debugger Architecture (JPDA)]
(https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html)
https://docs.oracle.com/en/java/javase/17/docs/specs/jpda/jpda.html[Java Platform Debugger Architecture (JPDA)]
debugging enabled.
+
Possible values are as follows:
Expand All @@ -76,6 +75,7 @@ Possible values are as follows:
number for JPDA debugging is displayed.
`false`;;
The instance is started with JPDA debugging disabled (default).

`--dry-run`::
`-n`::
Suppresses actual starting of the instance. Instead,
Expand All @@ -92,6 +92,18 @@ Possible values are as follows:
Specifies the directory that contains the instance's node directory.
The instance's files are stored in the instance's node directory. The
default is as-install``/nodes``.

`--server-output`::
`-o`::
Specifies if the command should or should not print the server output.
If not set, server prints the output just when the command failed.
Possible values are as follows:

`true`;;
The output of the server startup will be printed after the command finishes.
`false`;;
The output of the server startup will not be printed.

`--sync`::
The type of synchronization between the DAS and the instance's files
when the instance is started. +
Expand Down
Loading