Issue #23739 Using safer syntax for headers
- previous was extremely sensitive to the length of the test above
- this change was done by a set of regular expressions, I hope I did not
miss something.
- I am committing also toc files as they are helpful to detect any broken
chapter header in diff
- plus: this syntax is colored by the Eclipse Editor
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/adding-configuration-data.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/adding-configuration-data.adoc
index 323362f..cd7f4fd 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/adding-configuration-data.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/adding-configuration-data.adoc
@@ -5,14 +5,12 @@
prev=adding-monitoring-capabilities.html
~~~~~~
-Adding Configuration Data for a Component
-=========================================
+= Adding Configuration Data for a Component
[[GSACG00006]][[gjlpe]]
[[adding-configuration-data-for-a-component]]
-Adding Configuration Data for a Component
------------------------------------------
+== Adding Configuration Data for a Component
The configuration data of a component determines the characteristics and
runtime behavior of a component. Eclipse GlassFish provides interfaces to
@@ -39,8 +37,7 @@
[[gjrdv]][[GSACG00121]][[how-glassfish-server-stores-configuration-data]]
-How GlassFish Server Stores Configuration Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== How GlassFish Server Stores Configuration Data
GlassFish Server stores the configuration data for a domain in a single
configuration file that is named `domain.xml`. This file is an
@@ -54,8 +51,7 @@
[[gjlop]][[GSACG00122]][[defining-an-element]]
-Defining an Element
-~~~~~~~~~~~~~~~~~~~
+=== Defining an Element
An element represents an item of configuration data. For example, to
represent the configuration data for a network listener, GlassFish
@@ -66,8 +62,7 @@
[[gjcnt]][[GSACG00074]][[to-define-an-element]]
-To Define an Element
-^^^^^^^^^^^^^^^^^^^^
+==== To Define an Element
1. Define a Java language interface to represent the element.
Define one interface for each element. Do not represent multiple
@@ -133,8 +128,7 @@
[[gjlpb]][[GSACG00123]][[defining-an-attribute-of-an-element]]
-Defining an Attribute of an Element
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Defining an Attribute of an Element
The attributes of an element describe the characteristics of the
element.
@@ -143,8 +137,7 @@
[[gjorj]][[GSACG00227]][[representing-an-attribute-of-an-element]]
-Representing an Attribute of an Element
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Representing an Attribute of an Element
Represent each attribute of an element as the property of a pair of
JavaBeans specification getter and setter methods of the interface that
@@ -154,8 +147,7 @@
[[gjopa]][[GSACG00228]][[specifying-the-data-type-of-an-attribute]]
-Specifying the Data Type of an Attribute
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Data Type of an Attribute
The data type of an attribute is the return type of the getter method
that is associated with the attribute. To enable the attribute take
@@ -164,8 +156,7 @@
[[gjopm]][[GSACG00229]][[identifying-an-attribute-of-an-element]]
-Identifying an Attribute of an Element
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Identifying an Attribute of an Element
To identify an attribute of an element, annotate the declaration of the
getter method that is associated with the attribute with the
@@ -176,8 +167,7 @@
[[gjopq]][[GSACG00230]][[specifying-the-name-of-an-attribute]]
-Specifying the Name of an Attribute
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Name of an Attribute
To specify the name of an attribute, set the `value` element of the
`@Attribute` annotation to a string that specifies the name. If you do
@@ -194,8 +184,7 @@
[[gjoqj]][[GSACG00231]][[specifying-the-default-value-of-an-attribute]]
-Specifying the Default Value of an Attribute
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Default Value of an Attribute
The default value of an attribute is the value that is applied if the
attribute is omitted when the element is written to the domain
@@ -208,8 +197,7 @@
[[gjoui]][[GSACG00232]][[specifying-whether-an-attribute-is-required-or-optional]]
-Specifying Whether an Attribute Is Required or Optional
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Whether an Attribute Is Required or Optional
Whether an attribute is required or optional determines how GlassFish
Server responds if the parameter is omitted when the element is written
@@ -228,8 +216,7 @@
[[gjrdz]][[GSACG00233]][[example-of-defining-an-attribute-of-an-element]]
-Example of Defining an Attribute of an Element
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Example of Defining an Attribute of an Element
[[sthref7]]
@@ -251,8 +238,7 @@
[[gjlov]][[GSACG00124]][[defining-a-subelement]]
-Defining a Subelement
-~~~~~~~~~~~~~~~~~~~~~
+=== Defining a Subelement
A subelement represents a containment or ownership relationship. For
example, GlassFish Server defines the `network-listeners` element to
@@ -263,8 +249,7 @@
[[gjzlb]][[GSACG00075]][[to-define-a-subelement]]
-To Define a Subelement
-^^^^^^^^^^^^^^^^^^^^^^
+==== To Define a Subelement
1. Define an interface to represent the subelement.
For more information, see link:#gjlop[Defining an Element].
@@ -320,8 +305,7 @@
[[gjlpu]][[GSACG00125]][[validating-configuration-data]]
-Validating Configuration Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Validating Configuration Data
Validating configuration data ensures that attribute values that are
being set or updated do not violate any constraints that you impose on
@@ -415,8 +399,7 @@
[[gjrdj]][[GSACG00126]][[initializing-a-components-configuration-data]]
-Initializing a Component's Configuration Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Initializing a Component's Configuration Data
To ensure that a component's configuration data is added to the
`domain.xml` file when the component is first instantiated, you must
@@ -431,8 +414,7 @@
[[gkbgi]][[GSACG00076]][[to-define-a-components-initial-configuration-data]]
-To Define a Component's Initial Configuration Data
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Define a Component's Initial Configuration Data
1. Create a plain-text file that contains an XML fragment to represent
the configuration data.
@@ -464,8 +446,7 @@
[[gjses]][[GSACG00077]][[to-write-a-components-initial-configuration-data-to-the-domain.xml-file]]
-To Write a Component's Initial Configuration Data to the `domain.xml` File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Write a Component's Initial Configuration Data to the `domain.xml` File
Add code to write the component's initial configuration data in the
class that represents your add-on component. If your add-on component is
@@ -581,8 +562,7 @@
[[gjrcz]][[GSACG00127]][[creating-a-transaction-to-update-configuration-data]]
-Creating a Transaction to Update Configuration Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating a Transaction to Update Configuration Data
Creating a transaction to update configuration data enables the data to
be updated without the need to specify a dotted name in the
@@ -599,8 +579,7 @@
[[gkakw]][[GSACG00078]][[to-create-a-transaction-to-update-configuration-data]]
-To Create a Transaction to Update Configuration Data
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Transaction to Update Configuration Data
Any transaction that you create to modify configuration data must use a
configuration change transaction to ensure that the change is atomic,
@@ -673,8 +652,7 @@
[[gjmkt]][[GSACG00128]][[dotted-names-and-rest-urls-of-configuration-attributes]]
-Dotted Names and REST URLs of Configuration Attributes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Dotted Names and REST URLs of Configuration Attributes
The GlassFish Server administrative subcommands link:../reference-manual/get.html#GSRFM00139[`get`],
link:../reference-manual/list.html#GSRFM00145[`list`], and olink:GSRFM00226[`set`] locate a
@@ -729,8 +707,7 @@
[[gkaal]][[GSACG00131]][[examples-of-adding-configuration-data-for-a-component]]
-Examples of Adding Configuration Data for a Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Examples of Adding Configuration Data for a Component
This example shows the interfaces that define the configuration data for
the Greeter Container component. The data is comprised of the following
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/adding-container-capabilities.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/adding-container-capabilities.adoc
index 97ab5a0..c4c3d5a 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/adding-container-capabilities.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/adding-container-capabilities.adoc
@@ -5,15 +5,13 @@
prev=adding-configuration-data.html
~~~~~~
-Adding Container Capabilities
-=============================
+= Adding Container Capabilities
[[GSACG00007]][[ghmon]]
[[adding-container-capabilities]]
-Adding Container Capabilities
------------------------------
+== Adding Container Capabilities
Applications run on Eclipse GlassFish Server in containers. GlassFish Server
enables you to create containers that extend or replace the existing
@@ -30,8 +28,7 @@
[[ghpjl]][[GSACG00132]][[creating-a-container-implementation]]
-Creating a `Container` Implementation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating a `Container` Implementation
To implement a container that extends or replaces a service in GlassFish
Server, you must create a Java programming language class that includes
@@ -50,8 +47,7 @@
[[ghogv]][[GSACG00234]][[marking-the-class-with-the-service-annotation]]
-Marking the Class With the `@Service` Annotation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Marking the Class With the `@Service` Annotation
Add a `com.jvnet.hk2.annotations.Service` annotation at the class
definition level to identify your class as a service implementation.
@@ -81,8 +77,7 @@
[[ghohg]][[GSACG00235]][[implementing-the-container-interface]]
-Implementing the `Container` Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Implementing the `Container` Interface
The `org.glassfish.api.container.Container` interface is the contract
that defines a container implementation. Classes that implement
@@ -188,8 +183,7 @@
[[ghozu]][[GSACG00133]][[adding-an-archive-type]]
-Adding an Archive Type
-~~~~~~~~~~~~~~~~~~~~~~
+=== Adding an Archive Type
An archive type is an abstraction of the archive file format. An archive
type can be implemented as a plain JAR file, as a directory layout, or a
@@ -250,8 +244,7 @@
[[ghoyp]][[GSACG00236]][[implementing-the-archivehandler-interface]]
-Implementing the `ArchiveHandler` Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Implementing the `ArchiveHandler` Interface
An archive handler is responsible for handling the particular layout of
an archive. Jakarta EE defines a set of archives (WAR, JAR, and RAR, for
@@ -293,8 +286,7 @@
[[ghphp]][[GSACG00134]][[creating-connector-modules]]
-Creating Connector Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating Connector Modules
Connector modules are small add-on modules that consist of application
"sniffers" that associate application types with containers that can run
@@ -314,8 +306,7 @@
[[ghozd]][[GSACG00237]][[associating-file-types-with-containers-by-using-the-sniffer-interface]]
-Associating File Types With Containers by Using the `Sniffer` Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Associating File Types With Containers by Using the `Sniffer` Interface
Containers do not necessarily need to be installed on the local machine
for GlassFish Server to recognize the container's application type.
@@ -396,8 +387,7 @@
[[ghpbx]][[GSACG00172]][[making-sniffer-implementations-available-to-the-glassfish-server]]
-Making `Sniffer` Implementations Available to the GlassFish Server
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Making `Sniffer` Implementations Available to the GlassFish Server
Package `Sniffer` implementation code into modules and install the
modules in the as-install`/modules` directory. GlassFish Server will
@@ -408,8 +398,7 @@
[[gkane]][[GSACG00135]][[example-of-adding-container-capabilities]]
-Example of Adding Container Capabilities
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Example of Adding Container Capabilities
This example shows a custom container and a web client of the container.
The example is comprised of the following code:
@@ -428,8 +417,7 @@
[[gkbah]][[GSACG00238]][[container-component-code]]
-Container Component Code
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Container Component Code
The container component code is comprised of the classes and interfaces
that are listed in the following table. The table also provides a
@@ -748,8 +736,7 @@
[[gkbcq]][[GSACG00239]][[web-client-code]]
-Web Client Code
-^^^^^^^^^^^^^^^
+==== Web Client Code
The web client code is comprised of the classes and resources that are
listed in the following table. The table also provides a cross-reference
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/adding-monitoring-capabilities.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/adding-monitoring-capabilities.adoc
index 47b5d0c..a0381c6 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/adding-monitoring-capabilities.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/adding-monitoring-capabilities.adoc
@@ -5,14 +5,12 @@
prev=extending-asadmin.html
~~~~~~
-Adding Monitoring Capabilities
-==============================
+= Adding Monitoring Capabilities
[[GSACG00005]][[ghmos]]
[[adding-monitoring-capabilities]]
-Adding Monitoring Capabilities
-------------------------------
+== Adding Monitoring Capabilities
Monitoring is the process of reviewing the statistics of a system to
improve performance or solve problems. By monitoring the state of
@@ -39,8 +37,7 @@
[[ghopc]][[GSACG00116]][[defining-statistics-that-are-to-be-monitored]]
-Defining Statistics That Are to Be Monitored
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Defining Statistics That Are to Be Monitored
At runtime, your add-on component might perform operations that affect
the behavior and performance of your system. For example, your component
@@ -75,8 +72,7 @@
[[gkadk]][[GSACG00220]][[defining-an-event-provider]]
-Defining an Event Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Defining an Event Provider
An event provider defines the types of events for the operations that
generate statistics for an add-on component.
@@ -93,8 +89,7 @@
[[ghovq]][[GSACG00164]][[defining-an-event-provider-by-writing-a-java-class]]
-Defining an Event Provider by Writing a Java Class
-++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Defining an Event Provider by Writing a Java Class
To define an event provider, write a Java language class that defines
the types of events for the component. Your class is not required to
@@ -214,8 +209,7 @@
[[gkaec]][[GSACG00165]][[defining-an-event-provider-by-writing-an-xml-fragment]]
-Defining an Event Provider by Writing an XML Fragment
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Defining an Event Provider by Writing an XML Fragment
To define an event provider, write an extensible markup language (XML)
fragment that contains a single `probe-provider` element.
@@ -314,8 +308,7 @@
[[gkaie]][[GSACG00166]][[packaging-a-components-event-providers]]
-Packaging a Component's Event Providers
-+++++++++++++++++++++++++++++++++++++++
+===== Packaging a Component's Event Providers
Packaging a component's event providers enables the monitoring
infrastructure of GlassFish Server to discover the event providers automatically.
@@ -360,8 +353,7 @@
[[ghprg]][[GSACG00221]][[sending-an-event]]
-Sending an Event
-^^^^^^^^^^^^^^^^
+==== Sending an Event
At runtime, your add-on component might perform an operation that
generates statistics. To provide statistics about the operation to
@@ -412,8 +404,7 @@
[[ghplw]][[GSACG00117]][[updating-the-monitorable-object-tree]]
-Updating the Monitorable Object Tree
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Updating the Monitorable Object Tree
A monitorable object is a component, subcomponent, or service that can
be monitored. GlassFish Server uses a tree structure to track
@@ -458,8 +449,7 @@
[[ghpni]][[GSACG00222]][[creating-event-listeners]]
-Creating Event Listeners
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Creating Event Listeners
An event listener gathers statistics from events that an event provider
sends. To enable an add-on component to gather statistics from events,
@@ -500,8 +490,7 @@
[[ghptp]][[GSACG00223]][[representing-a-components-statistics-in-an-event-listener-class]]
-Representing a Component's Statistics in an Event Listener Class
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Representing a Component's Statistics in an Event Listener Class
Represent each statistic as the property of a JavaBeans specification
getter method of your listener class. Methods in the listener class for
@@ -575,8 +564,7 @@
[[ghpml]][[GSACG00224]][[subscribing-to-events-from-event-provider-classes]]
-Subscribing to Events From Event Provider Classes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Subscribing to Events From Event Provider Classes
To receive events from event provider classes, a listener must subscribe
to the events. Subscribing to events also specifies the provider and the
@@ -659,8 +647,7 @@
[[ghpsp]][[GSACG00167]][[listening-for-changes-to-values-that-are-not-part-of-the-target-method-definition]]
-Listening for Changes to Values That are Not Part of the Target Method Definition
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Listening for Changes to Values That are Not Part of the Target Method Definition
Event listeners can express their interest in certain predefined values
that are not part of the target method definition. For example,
@@ -670,8 +657,7 @@
[[ghpsw]][[GSACG00168]][[getting-information-about-a-event-provider]]
-Getting Information About a Event Provider
-++++++++++++++++++++++++++++++++++++++++++
+===== Getting Information About a Event Provider
`ProbeProviderInfo` contains details about individual event types in an
event provider class.
@@ -697,8 +683,7 @@
[[ghpmt]][[GSACG00225]][[listening-for-events-from-classes-that-are-not-event-providers]]
-Listening for Events From Classes That Are Not Event Providers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Listening for Events From Classes That Are Not Event Providers
gfProbes infrastructure allows clients to monitor glassfish even in the
absence of provider classes. This is done by allowing clients to receive
@@ -722,8 +707,7 @@
[[ghpql]][[GSACG00169]][[monitoring-method-entry]]
-Monitoring Method Entry
-+++++++++++++++++++++++
+===== Monitoring Method Entry
The @MethodEntry annotation must be used by the client to receive
callback when the target method is entered. The client method argument
@@ -731,8 +715,7 @@
[[ghppg]][[GSACG00170]][[monitoring-method-exit]]
-Monitoring Method Exit
-++++++++++++++++++++++
+===== Monitoring Method Exit
The @MethodExit annotation must be used by the client to receive
callback when the target method is exited. The client method argument
@@ -742,8 +725,7 @@
[[ghplj]][[GSACG00171]][[monitoring-exceptions]]
-Monitoring Exceptions
-+++++++++++++++++++++
+===== Monitoring Exceptions
The @OnException annotation must be used by the client to receive
callback when the target method exits because of an exception. The
@@ -753,8 +735,7 @@
[[ghppo]][[GSACG00226]][[registering-an-event-listener]]
-Registering an Event Listener
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Registering an Event Listener
Registering an event listener enables the listener to receive callbacks
from the GlassFish Server event infrastructure. The listener can then
@@ -826,8 +807,7 @@
[[ghrma]][[GSACG00118]][[dotted-names-and-rest-urls-for-an-add-on-components-statistics]]
-Dotted Names and REST URLs for an Add-On Component's Statistics
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Dotted Names and REST URLs for an Add-On Component's Statistics
The GlassFish Server administrative subcommands link:../reference-manual/get.html#GSRFM00139[`get`],
link:../reference-manual/list.html#GSRFM00145[`list`], and olink:GSRFM00226[`set`] locate a statistic
@@ -896,8 +876,7 @@
[[ghmox]][[GSACG00119]][[adding-a-type-to-the-monitor-command]]
-Adding a Type to the `monitor` Command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding a Type to the `monitor` Command
To add a type to the `monitor` command, implement the `MonitorContract` interface.
@@ -906,8 +885,7 @@
[[ghptj]][[GSACG00120]][[example-of-adding-monitoring-capabilities]]
-Example of Adding Monitoring Capabilities
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Example of Adding Monitoring Capabilities
This example shows a component that monitors the number of requests that
a container receives. The following table provides a cross-reference to
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/extending-asadmin.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/extending-asadmin.adoc
index 95e0784..d98a21e 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/extending-asadmin.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/extending-asadmin.adoc
@@ -5,15 +5,13 @@
prev=extending-the-admin-console.html
~~~~~~
-Extending the asadmin Utility
-=============================
+= Extending the asadmin Utility
[[GSACG00004]][[ghmrd]]
[[extending-the-asadmin-utility]]
-Extending the `asadmin` Utility
--------------------------------
+== Extending the `asadmin` Utility
The `asadmin` utility is a command-line tool for configuring and
administering Eclipse GlassFish Server. Extending the `asadmin` utility enables
@@ -39,8 +37,7 @@
[[ghpuj]][[GSACG00105]][[about-the-administrative-command-infrastructure-of-glassfish-server]]
-About the Administrative Command Infrastructure of GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About the Administrative Command Infrastructure of GlassFish Server
To enable multiple containers to be independently packaged and loaded,
the administrative command infrastructure of GlassFish Server provides
@@ -58,8 +55,7 @@
[[ghpwe]][[GSACG00107]][[adding-an-asadmin-subcommand]]
-Adding an `asadmin` Subcommand
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding an `asadmin` Subcommand
An `asadmin` subcommand identifies the operation or task that a user is
to perform. Adding an `asadmin` subcommand enables the user to perform
@@ -75,8 +71,7 @@
[[ghrqj]][[GSACG00194]][[representing-an-asadmin-subcommand-as-a-java-class]]
-Representing an `asadmin` Subcommand as a Java Class
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Representing an `asadmin` Subcommand as a Java Class
Each `asadmin` subcommand that you are adding must be represented as a
Java class. To represent an `asadmin` subcommand as a Java class, write
@@ -99,8 +94,7 @@
[[ghrpm]][[GSACG00195]][[specifying-the-name-of-an-asadmin-subcommand]]
-Specifying the Name of an `asadmin` Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Name of an `asadmin` Subcommand
To specify the name of the subcommand, set the `name` element of the
`@Service` annotation to the name.
@@ -139,8 +133,7 @@
[[ghrng]][[GSACG00196]][[ensuring-that-an-admincommand-implementation-is-stateless]]
-Ensuring That an `AdminCommand` Implementation Is Stateless
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Ensuring That an `AdminCommand` Implementation Is Stateless
To enable multiple clients to run a subcommand simultaneously, ensure
that the implementation of the `AdminCommand` interface for the
@@ -154,8 +147,7 @@
[[ghrqx]][[GSACG00197]][[example-of-adding-an-asadmin-subcommand]]
-Example of Adding an `asadmin` Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Example of Adding an `asadmin` Subcommand
[[GSACG00034]][[ghrqq]]
Example 4-1 Adding an `asadmin` Subcommand
@@ -187,8 +179,7 @@
[[ghpwa]][[GSACG00108]][[adding-parameters-to-an-asadmin-subcommand]]
-Adding Parameters to an `asadmin` Subcommand
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding Parameters to an `asadmin` Subcommand
The parameters of an `asadmin` subcommand are the options and operands
of the subcommand.
@@ -213,8 +204,7 @@
[[ghpvh]][[GSACG00198]][[representing-a-parameter-of-an-asadmin-subcommand]]
-Representing a Parameter of an `asadmin` Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Representing a Parameter of an `asadmin` Subcommand
Represent each parameter of a subcommand in your implementation as a
field or as the property of a JavaBeans specification setter method. Use
@@ -225,8 +215,7 @@
[[ghptx]][[GSACG00199]][[identifying-a-parameter-of-an-asadmin-subcommand]]
-Identifying a Parameter of an `asadmin` Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Identifying a Parameter of an `asadmin` Subcommand
Identifying a parameter of an `asadmin` subcommand enables GlassFish
Server to perform the following operations at runtime on the parameter:
@@ -255,8 +244,7 @@
[[ghpxp]][[GSACG00200]][[specifying-whether-a-parameter-is-an-option-or-an-operand]]
-Specifying Whether a Parameter Is an Option or an Operand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Whether a Parameter Is an Option or an Operand
Whether a parameter is an option or an operand determines how a user
must specify the parameter when running the subcommand:
@@ -274,8 +262,7 @@
[[ghpxj]][[GSACG00201]][[specifying-the-name-of-an-option]]
-Specifying the Name of an Option
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Name of an Option
The name of an option is the name that a user must type on the command
line to specify the option when running the subcommand.
@@ -305,8 +292,7 @@
[[ghpvy]][[GSACG00163]][[specifying-the-long-form-of-an-option-name]]
-Specifying the Long Form of an Option Name
-++++++++++++++++++++++++++++++++++++++++++
+===== Specifying the Long Form of an Option Name
To specify the long form of an option name, set the `name` element of
the `@Param` annotation to a string that specifies the name. If you do
@@ -323,8 +309,7 @@
[[sthref5]][[specifying-the-short-form-of-an-option-name]]
-Specifying the Short Form of an Option Name
-+++++++++++++++++++++++++++++++++++++++++++
+===== Specifying the Short Form of an Option Name
[[ghpvi]]
@@ -336,8 +321,7 @@
[[ghpxl]][[GSACG00202]][[specifying-the-acceptable-values-of-a-parameter]]
-Specifying the Acceptable Values of a Parameter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Acceptable Values of a Parameter
When a user runs the subcommand, the GlassFish Server validates option
arguments and operands against the acceptable values that you specify in
@@ -350,8 +334,7 @@
[[ghrgt]][[GSACG00203]][[specifying-the-default-value-of-a-parameter]]
-Specifying the Default Value of a Parameter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Default Value of a Parameter
The default value of a parameter is the value that is applied if a user
omits the parameter when running the subcommand.
@@ -365,8 +348,7 @@
[[ghpuk]][[GSACG00204]][[specifying-whether-a-parameter-is-required-or-optional]]
-Specifying Whether a Parameter Is Required or Optional
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Whether a Parameter Is Required or Optional
Whether a parameter is required or optional determines how a subcommand
responds if a user omits the parameter when running the subcommand:
@@ -384,8 +366,7 @@
[[CDCFAJDG]][[specifying-whether-a-parameter-can-be-used-multiple-times-on-the-command-line]]
Specifying Whether a Parameter Can Be Used Multiple Times on the Command
-Line
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Line
By default, each parameter can be used once on the command line. To use
the parameter multiple times, set the `multiple` element of the `@Param`
@@ -394,8 +375,7 @@
[[ghpxd]][[GSACG00205]][[example-of-adding-parameters-to-an-asadmin-subcommand]]
-Example of Adding Parameters to an `asadmin` Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Example of Adding Parameters to an `asadmin` Subcommand
[[GSACG00035]][[ghpuh]]
Example 4-2 Adding Parameters to an `asadmin` Subcommand
@@ -445,8 +425,7 @@
[[gkygt]][[GSACG00109]][[making-asadmin-subcommands-cluster-aware]]
-Making `asadmin` Subcommands Cluster-Aware
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Making `asadmin` Subcommands Cluster-Aware
The GlassFish Server `asadmin` command framework provides support for
making `asadmin` subcommands work properly in a clustered environment or
@@ -478,8 +457,7 @@
[[gkyjk]][[GSACG00206]][[specifying-allowed-targets]]
-Specifying Allowed Targets
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Allowed Targets
When you define a `--target` option by using the `@Param` annotation in
the `org.glassfish.api` package, possible targets are as follows:
@@ -553,8 +531,7 @@
[[gkykm]][[GSACG00207]][[the-target-utility]]
-The `Target` Utility
-^^^^^^^^^^^^^^^^^^^^
+==== The `Target` Utility
The `Target` utility is a service, present in the `internal-api` module,
`org.glassfish.internal.api` package, which a command implementation can
@@ -582,8 +559,7 @@
[[gkyfv]][[GSACG00208]][[specifying-asadmin-subcommand-execution]]
-Specifying `asadmin` Subcommand Execution
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying `asadmin` Subcommand Execution
By default, all `asadmin` subcommands are automatically replicated and
run on the DAS and all GlassFish Server instances specified in the
@@ -642,8 +618,7 @@
[[gkyjs]][[GSACG00209]][[subcommand-preprocessing-and-postprocessing]]
-Subcommand Preprocessing and Postprocessing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Subcommand Preprocessing and Postprocessing
Some `asadmin` subcommands may require preprocessing or postprocessing.
For example, after an application is deployed to the DAS, references are
@@ -735,8 +710,7 @@
[[gkyit]][[GSACG00210]][[running-a-command-from-another-command]]
-Running a Command from Another Command
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Running a Command from Another Command
An `asadmin` subcommand or supplemental command might need to run
another subcommand. For example, a subcommand running on the DAS might
@@ -762,8 +736,7 @@
[[ghptw]][[GSACG00110]][[adding-message-text-strings-to-an-asadmin-subcommand]]
-Adding Message Text Strings to an `asadmin` Subcommand
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding Message Text Strings to an `asadmin` Subcommand
A message text string provides useful information to the user about an
`asadmin` subcommand or a parameter.
@@ -896,8 +869,7 @@
[[ghpvn]][[GSACG00111]][[enabling-an-asadmin-subcommand-to-run]]
-Enabling an `asadmin` Subcommand to Run
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Enabling an `asadmin` Subcommand to Run
To enable an `asadmin` subcommand to run, implement the `execute` method
in your implementation of the `AdminCommand` interface. The declaration
@@ -919,8 +891,7 @@
[[ghpvq]][[GSACG00112]][[setting-the-context-of-an-asadmin-subcommand]]
-Setting the Context of an `asadmin` Subcommand
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting the Context of an `asadmin` Subcommand
The `org.glassfish.api.admin.AdminCommandContext` class provides the
following services to an `asadmin` subcommand:
@@ -935,8 +906,7 @@
[[ghpwn]][[GSACG00113]][[changing-the-brand-in-the-glassfish-server-cli]]
-Changing the Brand in the GlassFish Server CLI
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Changing the Brand in the GlassFish Server CLI
The brand in the GlassFish Server command-line interface (CLI) consists
of the product name and release information that are displayed in the
@@ -1024,8 +994,7 @@
[[ghmza]][[GSACG00114]][[examples-of-extending-the-asadmin-utility]]
-Examples of Extending the `asadmin` Utility
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Examples of Extending the `asadmin` Utility
[[GSACG00038]][[ghrnt]]
Example 4-5 `asadmin` Subcommand With Empty `execute` Method
@@ -1260,8 +1229,7 @@
[[gkzlq]][[GSACG00115]][[implementing-create-delete-and-list-commands-using-annotations]]
-Implementing Create, Delete, and List Commands Using Annotations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Implementing Create, Delete, and List Commands Using Annotations
Many `asadmin` subcommands simply create, delete, or list objects in the
configuration. Such code is repetitive to write and error prone. To
@@ -1285,8 +1253,7 @@
[[gkzkc]][[GSACG00211]][[command-patterns]]
-Command Patterns
-^^^^^^^^^^^^^^^^
+==== Command Patterns
Create command pattern. The most basic create commands are implemented
in the following pattern:
@@ -1349,8 +1316,7 @@
[[gkzle]][[GSACG00212]][[resolvers]]
-Resolvers
-^^^^^^^^^
+==== Resolvers
A resolver retrieves a configuration object instance of a particular
type. For a create command, it retrieves the parent of the object to be
@@ -1404,8 +1370,7 @@
[[gkzoy]][[GSACG00213]][[the-create-annotation]]
-The `@Create` Annotation
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `@Create` Annotation
By placing the `org.glassfish.config.support.Create` annotation on a
method, you provide the following information:
@@ -1443,8 +1408,7 @@
[[gkzoo]][[GSACG00214]][[the-delete-annotation]]
-The `@Delete` Annotation
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `@Delete` Annotation
By placing the `org.glassfish.config.support.Delete` annotation on a
method, you provide the following information:
@@ -1482,8 +1446,7 @@
[[gkzpl]][[GSACG00215]][[the-listing-annotation]]
-The `@Listing` Annotation
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `@Listing` Annotation
By placing the `org.glassfish.config.support.Listing` annotation on a
method, you provide the following information:
@@ -1522,8 +1485,7 @@
[[gkznf]][[GSACG00216]][[create-command-decorators]]
-Create Command Decorators
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Create Command Decorators
Most create commands must do more than create a single configuration
object instance with default attribute values. For example, most create
@@ -1629,8 +1591,7 @@
[[gkznx]][[GSACG00217]][[delete-command-decorators]]
-Delete Command Decorators
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Delete Command Decorators
Some delete commands must do more than delete a single configuration
object instance. For example, the `delete-cluster` subcommand deletes
@@ -1715,8 +1676,7 @@
[[gkzmu]][[GSACG00218]][[specifying-command-execution]]
-Specifying Command Execution
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Command Execution
Commands specified with the `@Create`, `@Delete`, and `@Listing`
annotations can use the `@ExecuteOn` annotation. The `@ExecuteOn`
@@ -1736,8 +1696,7 @@
[[gkznd]][[GSACG00219]][[using-multiple-command-annotations]]
-Using Multiple Command Annotations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Multiple Command Annotations
You can specify multiple command annotations on the same method. The
following example combines create, delete, and list commands for
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/extending-the-admin-console.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/extending-the-admin-console.adoc
index 2ddde67..5094328 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/extending-the-admin-console.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/extending-the-admin-console.adoc
@@ -5,15 +5,13 @@
prev=writing-hk2-components.html
~~~~~~
-Extending the Administration Console
-====================================
+= Extending the Administration Console
[[GSACG00003]][[ghmrb]]
[[extending-the-administration-console]]
-Extending the Administration Console
-------------------------------------
+== Extending the Administration Console
The Administration Console is a browser-based tool for administering
Eclipse GlassFish Server. It features an easy-to-navigate interface and online
@@ -43,8 +41,7 @@
[[ghmof]][[GSACG00097]][[administration-console-architecture]]
-Administration Console Architecture
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administration Console Architecture
The Administration Console is a web application that is composed of OSGi
bundles. These bundles provide all the features of the Administration
@@ -86,8 +83,7 @@
[[ghnzl]][[GSACG00187]][[implementing-a-console-provider]]
-Implementing a Console Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Implementing a Console Provider
The `org.glassfish.api.admingui.ConsoleProvider` interface has one
required method, `getConfiguration`. The `getConfiguration` method
@@ -131,8 +127,7 @@
[[ghmom]][[GSACG00098]][[about-administration-console-templates]]
-About Administration Console Templates
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Administration Console Templates
GlassFish Server includes a set of templates that make it easier to
create Jakarta Server Faces pages for your add-on component. These templates
@@ -151,8 +146,7 @@
[[ghmqr]][[GSACG00099]][[about-integration-points]]
-About Integration Points
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Integration Points
The integration points for your add-on component are the individual
Administration Console user interface features that your add-on
@@ -180,8 +174,7 @@
[[ghmpg]][[GSACG00100]][[specifying-the-id-of-an-add-on-component]]
-Specifying the ID of an Add-On Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Specifying the ID of an Add-On Component
The `console-config.xml` file consists of a `console-config` element
that encloses a series of `integration-point` elements. The
@@ -217,8 +210,7 @@
[[ghmpk]][[GSACG00101]][[adding-functionality-to-the-administration-console]]
-Adding Functionality to the Administration Console
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding Functionality to the Administration Console
The `integration-point` elements in the `console-config.xml` file
specify attributes for the user interface features that you choose to
@@ -267,8 +259,7 @@
[[ghocf]][[GSACG00188]][[adding-a-node-to-the-navigation-tree]]
-Adding a Node to the Navigation Tree
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding a Node to the Navigation Tree
You can add a node to the navigation tree, either at the top level or
under another node. To add a node, use an integration point of type
@@ -337,8 +328,7 @@
[[ghoej]][[GSACG00158]][[creating-a-javaserver-faces-page-for-your-node]]
-Creating a Jakarta Server Faces Page for Your Node
-++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating a Jakarta Server Faces Page for Your Node
A Jakarta Server Faces page for a tree node uses the tag `sun:treeNode`.
This tag provides all the capabilities of the Project Woodstock tag
@@ -394,8 +384,7 @@
[[ghotv]][[GSACG00189]][[adding-tabs-to-a-page]]
-Adding Tabs to a Page
-^^^^^^^^^^^^^^^^^^^^^
+==== Adding Tabs to a Page
You can add a tab to an existing tab set, or you can create a tab set
for your own page. One way to add a tab or tab set is to use an
@@ -490,8 +479,7 @@
[[ghovg]][[GSACG00159]][[creating-javaserver-faces-pages-for-your-tabs]]
-Creating Jakarta Server Faces Pages for Your Tabs
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating Jakarta Server Faces Pages for Your Tabs
A Jakarta Server Faces page for a tab uses the tag `sun:tab`. This tag
provides all the capabilities of the Project Woodstock tag
@@ -553,8 +541,7 @@
[[ghmqw]][[GSACG00190]][[adding-a-task-to-the-common-tasks-page]]
-Adding a Task to the Common Tasks Page
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding a Task to the Common Tasks Page
You can add either a single task or a group of tasks to the Common Tasks
page of the Administration Console. To add a task or task group, use an
@@ -594,8 +581,7 @@
[[ghoeu]][[GSACG00160]][[creating-a-javaserver-faces-page-for-your-task]]
-Creating a Jakarta Server Faces Page for Your Task
-++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating a Jakarta Server Faces Page for Your Task
A Jakarta Server Faces page for a task uses the tag `sun:commonTask`.
This tag provides all the capabilities of the Project Woodstock tag `webuijsf:commonTask`.
@@ -637,8 +623,7 @@
[[ghozn]][[GSACG00191]][[adding-a-task-group-to-the-common-tasks-page]]
-Adding a Task Group to the Common Tasks Page
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding a Task Group to the Common Tasks Page
You can add a new group of tasks to the Common Tasks page to display the
most important tasks for your add-on component. To add a task group, use
@@ -676,8 +661,7 @@
[[ghoya]][[GSACG00161]][[creating-a-javaserver-faces-page-for-your-task-group]]
-Creating a Jakarta Server Faces Page for Your Task Group
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating a Jakarta Server Faces Page for Your Task Group
A Jakarta Server Faces page for a task group uses the tag
`sun:commonTasksGroup`. This tag provides all the capabilities of the
@@ -721,8 +705,7 @@
[[ghmrg]][[GSACG00192]][[adding-content-to-a-page]]
-Adding Content to a Page
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding Content to a Page
You can add content for your add-on component to an existing top-level
page, such as the Configuration page or the Resources page.
@@ -766,8 +749,7 @@
[[ghpao]][[GSACG00162]][[creating-a-javaserver-faces-page-for-your-page-content]]
-Creating a Jakarta Server Faces Page for Your Page Content
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating a Jakarta Server Faces Page for Your Page Content
A Jakarta Server Faces page for page content often uses the tag
`sun:property` to specify a property on a property sheet. This tag
@@ -817,8 +799,7 @@
[[ghmqe]][[GSACG00193]][[adding-a-page-to-the-administration-console]]
-Adding a Page to the Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding a Page to the Administration Console
Your add-on component may require new configuration tasks. In addition
to implementing commands that accomplish these tasks (see
@@ -866,8 +847,7 @@
[[ghmqi]][[GSACG00102]][[adding-internationalization-support]]
-Adding Internationalization Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding Internationalization Support
To add internationalization support for your add-on component to the
Administration Console, you can place an event and handler like the
@@ -885,8 +865,7 @@
[[ghmqg]][[GSACG00103]][[changing-the-theme-or-brand-of-the-administration-console]]
-Changing the Theme or Brand of the Administration Console
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Changing the Theme or Brand of the Administration Console
To change the theme or brand of the Administration Console for your
add-on component, use the integration point type
@@ -989,8 +968,7 @@
[[ghpkz]][[GSACG00104]][[creating-an-integration-point-type]]
-Creating an Integration Point Type
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating an Integration Point Type
If your add-on component provides new content that you would like other
people to extend, you may define your own integration point types. For
@@ -1002,8 +980,7 @@
[[sthref4]][[to-create-an-integration-point-type]]
-To Create an Integration Point Type
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Integration Point Type
1. Decide on the name of your integration point type.
+
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/integration-point-reference.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/integration-point-reference.adoc
index f3899b5..5edbea0 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/integration-point-reference.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/integration-point-reference.adoc
@@ -4,15 +4,13 @@
prev=packaging-integrating-delivering.html
~~~~~~
-Integration Point Reference
-===========================
+= Integration Point Reference
[[GSACG00010]][[ghmrp]]
[[a-integration-point-reference]]
-Integration Point Reference
----------------------------
+== Integration Point Reference
This appendix provides reference information about integration points,
which are described in
@@ -38,8 +36,7 @@
[[ghprc]][[GSACG00145]][[integration-point-attributes]]
-Integration Point Attributes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Integration Point Attributes
For each `integration-point` element, specify the following attributes.
Each attribute takes a string value.
@@ -66,8 +63,7 @@
[[ghmwa]][[GSACG00146]][[org.glassfish.adminguinavnode-integration-point]]
-`org.glassfish.admingui:navNode` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:navNode` Integration Point
Use an `org.glassfish.admingui:navNode` integration point to insert a
node in the Administration Console navigation tree. Specify the
@@ -117,8 +113,7 @@
[[gjkff]][[GSACG00147]][[org.glassfish.adminguirightpanel-integration-point]]
-`org.glassfish.admingui:rightPanel` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:rightPanel` Integration Point
Use an `org.glassfish.admingui:rightPanel` integration point to specify
content for the right frame of the Administration Console. Specify the
@@ -139,8 +134,7 @@
[[gjkfq]][[GSACG00148]][[org.glassfish.adminguirightpaneltitle-integration-point]]
-`org.glassfish.admingui:rightPanelTitle` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:rightPanelTitle` Integration Point
Use an `org.glassfish.admingui:rightPanel` integration point to specify
the title for the right frame of the Administration Console. Specify the
@@ -159,8 +153,7 @@
[[ghpkh]][[GSACG00149]][[org.glassfish.adminguiserverinsttab-integration-point]]
-`org.glassfish.admingui:serverInstTab` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:serverInstTab` Integration Point
Use an `org.glassfish.admingui:serverInstTab` integration point to place
an additional tab on the GlassFish Server page of the Administration
@@ -202,8 +195,7 @@
[[ghpit]][[GSACG00150]][[org.glassfish.adminguicommontask-integration-point]]
-`org.glassfish.admingui:commonTask` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:commonTask` Integration Point
Use an `org.glassfish.admingui:commonTask` integration point to place a
new task or task group on the Common Tasks page of the Administration
@@ -229,8 +221,7 @@
[[ghphz]][[GSACG00151]][[org.glassfish.adminguiconfiguration-integration-point]]
-`org.glassfish.admingui:configuration` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:configuration` Integration Point
Use an `org.glassfish.admingui:configuration` integration point to add a
component to the Configuration page of the Administration Console.
@@ -252,8 +243,7 @@
[[ghpfm]][[GSACG00152]][[org.glassfish.adminguiresources-integration-point]]
-`org.glassfish.admingui:resources` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:resources` Integration Point
Use an `org.glassfish.admingui:resources` integration point to add a
component to the Resources page of the Administration Console.
@@ -278,8 +268,7 @@
[[ghpiz]][[GSACG00153]][[org.glassfish.adminguicustomtheme-integration-point]]
-`org.glassfish.admingui:customtheme` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:customtheme` Integration Point
Use an `org.glassfish.admingui:customtheme` integration point to add
your own branding to the Administration Console. Specify the attributes
@@ -315,8 +304,7 @@
[[ghppm]][[GSACG00154]][[org.glassfish.adminguimasthead-integration-point]]
-`org.glassfish.admingui:masthead` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:masthead` Integration Point
Use an `org.glassfish.admingui:masthead` integration point to specify
the name and location of the include masthead file, which can be
@@ -340,8 +328,7 @@
[[ghppk]][[GSACG00155]][[org.glassfish.adminguiloginimage-integration-point]]
-`org.glassfish.admingui:loginimage` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:loginimage` Integration Point
Use an `org.glassfish.admingui:loginimage` integration point to specify
the name and location of the include file containing the branding login
@@ -367,8 +354,7 @@
[[ghprk]][[GSACG00156]][[org.glassfish.adminguiloginform-integration-point]]
-`org.glassfish.admingui:loginform` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:loginform` Integration Point
Use an `org.glassfish.admingui:loginform` integration point to specify
the name and location of the include file containing the customized
@@ -392,8 +378,7 @@
[[ghpse]][[GSACG00157]][[org.glassfish.adminguiversioninfo-integration-point]]
-`org.glassfish.admingui:versioninfo` Integration Point
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `org.glassfish.admingui:versioninfo` Integration Point
Use an `org.glassfish.admingui:versioninfo` integration point to specify
the name and location of the include file containing the branding image
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/introduction.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/introduction.adoc
index fb39b52..2d3d14e 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/introduction.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/introduction.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Introduction to the Development Environment for Eclipse GlassFish Add-On Components
-===================================================================================
+= Introduction to the Development Environment for Eclipse GlassFish Add-On Components
[[GSACG00001]][[ghmlv]]
[[introduction-to-the-development-environment-for-eclipse-glassfish-add-on-components]]
-Introduction to the Development Environment for Eclipse GlassFish Add-On Components
------------------------------------------------------------------------------------
+== Introduction to the Development Environment for Eclipse GlassFish Add-On Components
Eclipse GlassFish enables an external vendor such as
an independent software vendor (ISV), original equipment manufacturer
@@ -36,8 +34,7 @@
[[ghmje]][[GSACG00087]][[glassfish-server-modular-architecture-and-add-on-components]]
-GlassFish Server Modular Architecture and Add-On Components
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Modular Architecture and Add-On Components
GlassFish Server has a modular architecture in which the features of
GlassFish Server are provided by a consistent set of components that
@@ -72,8 +69,7 @@
[[ghmrf]][[GSACG00088]][[osgi-alliance-module-management-subsystem]]
-OSGi Alliance Module Management Subsystem
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== OSGi Alliance Module Management Subsystem
To enable components to be added when required, GlassFish Server
provides a lightweight and extensible kernel that uses the module
@@ -96,8 +92,7 @@
[[ghmnq]][[GSACG00089]][[hundred-kilobyte-kernel]]
-Hundred-Kilobyte Kernel
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Hundred-Kilobyte Kernel
The https://github.com/eclipse-ee4j/glassfish-hk2[Hundred-Kilobyte Kernel (HK2)]
(`https://github.com/eclipse-ee4j/glassfish-hk2`) is the lightweight and extensible kernel
@@ -118,8 +113,7 @@
[[ghmns]][[GSACG00090]][[overview-of-the-development-process-for-an-add-on-component]]
-Overview of the Development Process for an Add-On Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Overview of the Development Process for an Add-On Component
To ensure that an add-on component behaves identically to components
that are supplied in GlassFish Server distributions, the component must
@@ -148,8 +142,7 @@
[[ghpqc]][[GSACG00173]][[writing-hk2-components]]
-Writing HK2 Components
-^^^^^^^^^^^^^^^^^^^^^^
+==== Writing HK2 Components
The Hundred-Kilobyte Kernel (HK2) is the lightweight and extensible
kernel of GlassFish Server. To interact with GlassFish Server, add-on
@@ -164,8 +157,7 @@
[[ghokn]][[GSACG00174]][[extending-the-administration-console]]
-Extending the Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Extending the Administration Console
The Administration Console is a browser-based tool for administering
GlassFish Server. It features an easy-to-navigate interface and online
@@ -184,8 +176,7 @@
[[ghohx]][[GSACG00175]][[extending-the-asadmin-utility]]
-Extending the `asadmin` Utility
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Extending the `asadmin` Utility
The `asadmin` utility is a command-line tool for configuring and
administering GlassFish Server. Extending the `asadmin` utility enables
@@ -200,8 +191,7 @@
[[ghojs]][[GSACG00176]][[adding-monitoring-capabilities]]
-Adding Monitoring Capabilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding Monitoring Capabilities
Monitoring is the process of reviewing the statistics of a system to
improve performance or solve problems. By monitoring the state of
@@ -225,8 +215,7 @@
[[gkahs]][[GSACG00177]][[adding-configuration-data-for-a-component]]
-Adding Configuration Data for a Component
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding Configuration Data for a Component
The configuration data of a component determines the characteristics and
runtime behavior of a component. GlassFish Server provides interfaces to
@@ -246,8 +235,7 @@
[[ghojq]][[GSACG00178]][[adding-container-capabilities]]
-Adding Container Capabilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding Container Capabilities
Applications run on GlassFish Server in containers. GlassFish Server
enables you to create containers that extend or replace the existing
@@ -261,8 +249,7 @@
[[gktld]][[GSACG00179]][[creating-a-session-persistence-module]]
-Creating a Session Persistence Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Creating a Session Persistence Module
GlassFish Server enables you to create a session persistence module in
the web container for high availability-related functionality by
@@ -282,8 +269,7 @@
[[ghoiu]][[GSACG00180]][[packaging-and-delivering-an-add-on-component]]
-Packaging and Delivering an Add-On Component
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Packaging and Delivering an Add-On Component
Packaging an add-on component enables the component to interact with the
GlassFish Server kernel in the same way as other components. Integrating
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/loe.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/loe.adoc
index b77e2e4..6f1c544 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/loe.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:writing-hk2-components.html#ghoqv[2-1 Example Implementation of
PostContruct and PreDestroy]
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/lot.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/lot.adoc
index 2af91bf..8ef7790 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/lot.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:adding-configuration-data.html#gjrlg[6-1 Commonly Used Annotations
for Validating GlassFish Server Configuration Data]
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/packaging-integrating-delivering.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/packaging-integrating-delivering.adoc
index aab1a68..1addc6e 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/packaging-integrating-delivering.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/packaging-integrating-delivering.adoc
@@ -5,15 +5,13 @@
prev=session-persistence-modules.html
~~~~~~
-Packaging, Integrating, and Delivering an Add-On Component
-==========================================================
+= Packaging, Integrating, and Delivering an Add-On Component
[[GSACG00009]][[ghmxp]]
[[packaging-integrating-and-delivering-an-add-on-component]]
-Packaging, Integrating, and Delivering an Add-On Component
-----------------------------------------------------------
+== Packaging, Integrating, and Delivering an Add-On Component
Packaging an add-on component enables the component to interact with the
GlassFish Server kernel in the same way as other components. Integrating
@@ -30,8 +28,7 @@
[[ghpun]][[GSACG00142]][[packaging-an-add-on-component]]
-Packaging an Add-On Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Packaging an Add-On Component
To enable an add-on component to plug in to the GlassFish Server kernel
in the same way as other components, package the component as an OSGi
@@ -51,8 +48,7 @@
[[ghmne]][[GSACG00143]][[integrating-an-add-on-component-with-glassfish-server]]
-Integrating an Add-On Component With GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Integrating an Add-On Component With GlassFish Server
Integrating an add-on component with GlassFish Server enables GlassFish
Server to discover the component at runtime. To integrate an add-on
@@ -62,8 +58,7 @@
[[ghpuz]][[GSACG00144]][[delivering-an-add-on-component-through-update-tool]]
-Delivering an Add-On Component Through Update Tool
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Delivering an Add-On Component Through Update Tool
If an add-on component is an extension or update to existing
installations of GlassFish Server, deliver the component through Update
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/preface.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/preface.adoc
index 2e50a73..b19e002 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/preface.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[sthref2]]
[[preface]]
-Preface
--------
+== Preface
This document explains how to use published interfaces of
GlassFish Server Open Source Edition to develop add-on components
@@ -49,8 +47,7 @@
[[GSACG00079]][[ghpbz]]
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -155,8 +152,7 @@
[[GSACG00080]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -200,8 +196,7 @@
[[GSACG00081]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -241,8 +236,7 @@
[[GSACG00082]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -286,8 +280,7 @@
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/session-persistence-modules.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/session-persistence-modules.adoc
index 8db581c..93342a5 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/session-persistence-modules.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/session-persistence-modules.adoc
@@ -5,15 +5,13 @@
prev=adding-container-capabilities.html
~~~~~~
-Creating a Session Persistence Module
-=====================================
+= Creating a Session Persistence Module
[[GSACG00008]][[gkmhj]]
[[creating-a-session-persistence-module]]
-Creating a Session Persistence Module
--------------------------------------
+== Creating a Session Persistence Module
GlassFish Server enables you to create a session persistence module in
the web container for high availability-related functionality by
@@ -29,8 +27,7 @@
[[gkmhr]][[GSACG00141]][[implementing-the-persistencestrategybuilder-interface]]
-Implementing the `PersistenceStrategyBuilder` Interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Implementing the `PersistenceStrategyBuilder` Interface
You can implement the `PersistenceStrategyBuilder` interface by creating
a new web session manager type.
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/title.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/title.adoc
index 51e3bbe..c43b937 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/title.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/title.adoc
@@ -5,13 +5,11 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Add-On Component Development Guide, Release 7
-======================================================================
+= Eclipse GlassFish Server Add-On Component Development Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Add-On Component Development Guide
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/toc.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..6b874f2
--- /dev/null
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,164 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Add-On Component Development Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Add-On Component Development Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#GSACG00079[GlassFish Server Documentation Set]
+** link:preface.html#GSACG00080[Related Documentation]
+** link:preface.html#GSACG00081[Typographic Conventions]
+** link:preface.html#GSACG00082[Symbol Conventions]
+** link:preface.html#GSACG00083[Default Paths and File Names]
+* link:introduction.html#GSACG00001[Introduction to the Development Environment for Eclipse GlassFish Add-On Components]
+** link:introduction.html#GSACG00087[GlassFish Server Modular Architecture and Add-On Components]
+** link:introduction.html#GSACG00088[OSGi Alliance Module Management Subsystem]
+** link:introduction.html#GSACG00089[Hundred-Kilobyte Kernel]
+** link:introduction.html#GSACG00090[Overview of the Development Process for an Add-On Component]
+*** link:introduction.html#GSACG00173[Writing HK2 Components]
+*** link:introduction.html#GSACG00174[Extending the Administration Console]
+*** link:introduction.html#GSACG00175[Extending the `asadmin` Utility]
+*** link:introduction.html#GSACG00176[Adding Monitoring Capabilities]
+*** link:introduction.html#GSACG00177[Adding Configuration Data for a Component]
+*** link:introduction.html#GSACG00178[Adding Container Capabilities]
+*** link:introduction.html#GSACG00179[Creating a Session Persistence Module]
+*** link:introduction.html#GSACG00180[Packaging and Delivering an Add-On Component]
+* link:writing-hk2-components.html#GSACG00002[Writing HK2 Components]
+** link:writing-hk2-components.html#GSACG00091[HK2 Component Model]
+** link:writing-hk2-components.html#GSACG00092[Services in the HK2 Component Model]
+** link:writing-hk2-components.html#GSACG00093[HK2 Runtime]
+*** link:writing-hk2-components.html#GSACG00181[Scopes of Services]
+*** link:writing-hk2-components.html#GSACG00182[Instantiation of Components in HK2]
+*** link:writing-hk2-components.html#GSACG00183[HK2 Lifecycle Interfaces]
+** link:writing-hk2-components.html#GSACG00094[Inversion of Control]
+*** link:writing-hk2-components.html#GSACG00184[Injecting HK2 Components]
+*** link:writing-hk2-components.html#GSACG00186[Instantiation Cascading in HK2]
+** link:writing-hk2-components.html#GSACG00095[Identifying a Class as an Add-On Component]
+** link:writing-hk2-components.html#GSACG00096[Using the Apache Maven Build System to Develop HK2 Components]
+* link:extending-the-admin-console.html#GSACG00003[Extending the Administration Console]
+** link:extending-the-admin-console.html#GSACG00097[Administration Console Architecture]
+*** link:extending-the-admin-console.html#GSACG00187[Implementing a Console Provider]
+** link:extending-the-admin-console.html#GSACG00098[About Administration Console Templates]
+** link:extending-the-admin-console.html#GSACG00099[About Integration Points]
+** link:extending-the-admin-console.html#GSACG00100[Specifying the ID of an Add-On Component]
+** link:extending-the-admin-console.html#GSACG00101[Adding Functionality to the Administration Console]
+*** link:extending-the-admin-console.html#GSACG00188[Adding a Node to the Navigation Tree]
+*** link:extending-the-admin-console.html#GSACG00189[Adding Tabs to a Page]
+*** link:extending-the-admin-console.html#GSACG00190[Adding a Task to the Common Tasks Page]
+*** link:extending-the-admin-console.html#GSACG00191[Adding a Task Group to the Common Tasks Page]
+*** link:extending-the-admin-console.html#GSACG00192[Adding Content to a Page]
+*** link:extending-the-admin-console.html#GSACG00193[Adding a Page to the Administration Console]
+** link:extending-the-admin-console.html#GSACG00102[Adding Internationalization Support]
+** link:extending-the-admin-console.html#GSACG00103[Changing the Theme or Brand of the Administration Console]
+** link:extending-the-admin-console.html#GSACG00104[Creating an Integration Point Type]
+*** link:extending-the-admin-console.html#sthref4[To Create an Integration Point Type]
+* link:extending-asadmin.html#GSACG00004[Extending the `asadmin` Utility]
+** link:extending-asadmin.html#GSACG00105[About the Administrative Command Infrastructure of GlassFish Server]
+** link:extending-asadmin.html#GSACG00107[Adding an `asadmin` Subcommand]
+*** link:extending-asadmin.html#GSACG00194[Representing an `asadmin` Subcommand as a Java Class]
+*** link:extending-asadmin.html#GSACG00195[Specifying the Name of an `asadmin` Subcommand]
+*** link:extending-asadmin.html#GSACG00196[Ensuring That an `AdminCommand` Implementation Is Stateless]
+*** link:extending-asadmin.html#GSACG00197[Example of Adding an `asadmin` Subcommand]
+** link:extending-asadmin.html#GSACG00108[Adding Parameters to an `asadmin` Subcommand]
+*** link:extending-asadmin.html#GSACG00198[Representing a Parameter of an `asadmin` Subcommand]
+*** link:extending-asadmin.html#GSACG00199[Identifying a Parameter of an `asadmin` Subcommand]
+*** link:extending-asadmin.html#GSACG00200[Specifying Whether a Parameter Is an Option or an Operand]
+*** link:extending-asadmin.html#GSACG00201[Specifying the Name of an Option]
+*** link:extending-asadmin.html#GSACG00202[Specifying the Acceptable Values of a Parameter]
+*** link:extending-asadmin.html#GSACG00203[Specifying the Default Value of a Parameter]
+*** link:extending-asadmin.html#GSACG00204[Specifying Whether a Parameter Is Required or Optional]
+*** link:extending-asadmin.html#GSACG00205[Example of Adding Parameters to an `asadmin` Subcommand]
+** link:extending-asadmin.html#GSACG00109[Making `asadmin` Subcommands Cluster-Aware]
+*** link:extending-asadmin.html#GSACG00206[Specifying Allowed Targets]
+*** link:extending-asadmin.html#GSACG00207[The `Target` Utility]
+*** link:extending-asadmin.html#GSACG00208[Specifying `asadmin` Subcommand Execution]
+*** link:extending-asadmin.html#GSACG00209[Subcommand Preprocessing and Postprocessing]
+*** link:extending-asadmin.html#GSACG00210[Running a Command from Another Command]
+** link:extending-asadmin.html#GSACG00110[Adding Message Text Strings to an `asadmin` Subcommand]
+** link:extending-asadmin.html#GSACG00111[Enabling an `asadmin` Subcommand to Run]
+** link:extending-asadmin.html#GSACG00112[Setting the Context of an `asadmin` Subcommand]
+** link:extending-asadmin.html#GSACG00113[Changing the Brand in the GlassFish Server CLI]
+** link:extending-asadmin.html#GSACG00114[Examples of Extending the `asadmin` Utility]
+** link:extending-asadmin.html#GSACG00115[Implementing Create, Delete, and List Commands Using Annotations]
+*** link:extending-asadmin.html#GSACG00211[Command Patterns]
+*** link:extending-asadmin.html#GSACG00212[Resolvers]
+*** link:extending-asadmin.html#GSACG00213[The `@Create` Annotation]
+*** link:extending-asadmin.html#GSACG00214[The `@Delete` Annotation]
+*** link:extending-asadmin.html#GSACG00215[The `@Listing` Annotation]
+*** link:extending-asadmin.html#GSACG00216[Create Command Decorators]
+*** link:extending-asadmin.html#GSACG00217[Delete Command Decorators]
+*** link:extending-asadmin.html#GSACG00218[Specifying Command Execution]
+*** link:extending-asadmin.html#GSACG00219[Using Multiple Command Annotations]
+* link:adding-monitoring-capabilities.html#GSACG00005[Adding Monitoring Capabilities]
+** link:adding-monitoring-capabilities.html#GSACG00116[Defining Statistics That Are to Be Monitored]
+*** link:adding-monitoring-capabilities.html#GSACG00220[Defining an Event Provider]
+*** link:adding-monitoring-capabilities.html#GSACG00221[Sending an Event]
+** link:adding-monitoring-capabilities.html#GSACG00117[Updating the Monitorable Object Tree]
+*** link:adding-monitoring-capabilities.html#GSACG00222[Creating Event Listeners]
+*** link:adding-monitoring-capabilities.html#GSACG00223[Representing a Component's Statistics in an Event Listener Class]
+*** link:adding-monitoring-capabilities.html#GSACG00224[Subscribing to Events From Event Provider Classes]
+*** link:adding-monitoring-capabilities.html#GSACG00225[Listening for Events From Classes That Are Not Event Providers]
+*** link:adding-monitoring-capabilities.html#GSACG00226[Registering an Event Listener]
+** link:adding-monitoring-capabilities.html#GSACG00118[Dotted Names and REST URLs for an Add-On Component's Statistics]
+** link:adding-monitoring-capabilities.html#GSACG00119[Adding a Type to the `monitor` Command]
+** link:adding-monitoring-capabilities.html#GSACG00120[Example of Adding Monitoring Capabilities]
+* link:adding-configuration-data.html#GSACG00006[Adding Configuration Data for a Component]
+** link:adding-configuration-data.html#GSACG00121[How GlassFish Server Stores Configuration Data]
+** link:adding-configuration-data.html#GSACG00122[Defining an Element]
+*** link:adding-configuration-data.html#GSACG00074[To Define an Element]
+** link:adding-configuration-data.html#GSACG00123[Defining an Attribute of an Element]
+*** link:adding-configuration-data.html#GSACG00227[Representing an Attribute of an Element]
+*** link:adding-configuration-data.html#GSACG00228[Specifying the Data Type of an Attribute]
+*** link:adding-configuration-data.html#GSACG00229[Identifying an Attribute of an Element]
+*** link:adding-configuration-data.html#GSACG00230[Specifying the Name of an Attribute]
+*** link:adding-configuration-data.html#GSACG00231[Specifying the Default Value of an Attribute]
+*** link:adding-configuration-data.html#GSACG00232[Specifying Whether an Attribute Is Required or Optional]
+*** link:adding-configuration-data.html#GSACG00233[Example of Defining an Attribute of an Element]
+** link:adding-configuration-data.html#GSACG00124[Defining a Subelement]
+*** link:adding-configuration-data.html#GSACG00075[To Define a Subelement]
+** link:adding-configuration-data.html#GSACG00125[Validating Configuration Data]
+** link:adding-configuration-data.html#GSACG00126[Initializing a Component's Configuration Data]
+*** link:adding-configuration-data.html#GSACG00076[To Define a Component's Initial Configuration Data]
+*** link:adding-configuration-data.html#GSACG00077[To Write a Component's Initial Configuration Data to the `domain.xml` File]
+** link:adding-configuration-data.html#GSACG00127[Creating a Transaction to Update Configuration Data]
+*** link:adding-configuration-data.html#GSACG00078[To Create a Transaction to Update Configuration Data]
+** link:adding-configuration-data.html#GSACG00128[Dotted Names and REST URLs of Configuration Attributes]
+** link:adding-configuration-data.html#GSACG00131[Examples of Adding Configuration Data for a Component]
+* link:adding-container-capabilities.html#GSACG00007[Adding Container Capabilities]
+** link:adding-container-capabilities.html#GSACG00132[Creating a `Container` Implementation]
+*** link:adding-container-capabilities.html#GSACG00234[Marking the Class With the `@Service` Annotation]
+*** link:adding-container-capabilities.html#GSACG00235[Implementing the `Container` Interface]
+** link:adding-container-capabilities.html#GSACG00133[Adding an Archive Type]
+*** link:adding-container-capabilities.html#GSACG00236[Implementing the `ArchiveHandler` Interface]
+** link:adding-container-capabilities.html#GSACG00134[Creating Connector Modules]
+*** link:adding-container-capabilities.html#GSACG00237[Associating File Types With Containers by Using the `Sniffer` Interface]
+** link:adding-container-capabilities.html#GSACG00135[Example of Adding Container Capabilities]
+*** link:adding-container-capabilities.html#GSACG00238[Container Component Code]
+*** link:adding-container-capabilities.html#GSACG00239[Web Client Code]
+* link:session-persistence-modules.html#GSACG00008[Creating a Session Persistence Module]
+** link:session-persistence-modules.html#GSACG00141[Implementing the `PersistenceStrategyBuilder` Interface]
+* link:packaging-integrating-delivering.html#GSACG00009[Packaging, Integrating, and Delivering an Add-On Component]
+** link:packaging-integrating-delivering.html#GSACG00142[Packaging an Add-On Component]
+** link:packaging-integrating-delivering.html#GSACG00143[Integrating an Add-On Component With GlassFish Server]
+** link:packaging-integrating-delivering.html#GSACG00144[Delivering an Add-On Component Through Update Tool]
+* link:integration-point-reference.html#GSACG00010[Integration Point Reference]
+** link:integration-point-reference.html#GSACG00145[Integration Point Attributes]
+** link:integration-point-reference.html#GSACG00146[`org.glassfish.admingui:navNode` Integration Point]
+** link:integration-point-reference.html#GSACG00147[`org.glassfish.admingui:rightPanel` Integration Point]
+** link:integration-point-reference.html#GSACG00148[`org.glassfish.admingui:rightPanelTitle` Integration Point]
+** link:integration-point-reference.html#GSACG00149[`org.glassfish.admingui:serverInstTab` Integration Point]
+** link:integration-point-reference.html#GSACG00150[`org.glassfish.admingui:commonTask` Integration Point]
+** link:integration-point-reference.html#GSACG00151[`org.glassfish.admingui:configuration` Integration Point]
+** link:integration-point-reference.html#GSACG00152[`org.glassfish.admingui:resources` Integration Point]
+** link:integration-point-reference.html#GSACG00153[`org.glassfish.admingui:customtheme` Integration Point]
+** link:integration-point-reference.html#GSACG00154[`org.glassfish.admingui:masthead` Integration Point]
+** link:integration-point-reference.html#GSACG00155[`org.glassfish.admingui:loginimage` Integration Point]
+** link:integration-point-reference.html#GSACG00156[`org.glassfish.admingui:loginform` Integration Point]
+** link:integration-point-reference.html#GSACG00157[`org.glassfish.admingui:versioninfo` Integration Point]
diff --git a/docs/add-on-component-development-guide/src/main/jbake/content/writing-hk2-components.adoc b/docs/add-on-component-development-guide/src/main/jbake/content/writing-hk2-components.adoc
index eaf9416..f74b638 100644
--- a/docs/add-on-component-development-guide/src/main/jbake/content/writing-hk2-components.adoc
+++ b/docs/add-on-component-development-guide/src/main/jbake/content/writing-hk2-components.adoc
@@ -5,15 +5,13 @@
prev=introduction.html
~~~~~~
-Writing HK2 Components
-======================
+= Writing HK2 Components
[[GSACG00002]][[ghmna]]
[[writing-hk2-components]]
-Writing HK2 Components
-----------------------
+== Writing HK2 Components
The Hundred-Kilobyte Kernel (HK2) is the lightweight and extensible
kernel of GlassFish Server. To interact with GlassFish Server, add-on
@@ -34,8 +32,7 @@
[[ghokq]][[GSACG00091]][[hk2-component-model]]
-HK2 Component Model
-~~~~~~~~~~~~~~~~~~~
+=== HK2 Component Model
The Hundred-Kilobyte Kernel (HK2) provides a module system and component
model for building complex software systems. HK2 forms the core of
@@ -52,8 +49,7 @@
[[ghojt]][[GSACG00092]][[services-in-the-hk2-component-model]]
-Services in the HK2 Component Model
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Services in the HK2 Component Model
An HK2 service identifies the building blocks or the extension points of
an application. A service is a plain-old Java object (POJO) with the
@@ -99,8 +95,7 @@
[[ghokt]][[GSACG00093]][[hk2-runtime]]
-HK2 Runtime
-~~~~~~~~~~~
+=== HK2 Runtime
Once Services are defined, the HK2 runtime can be used to instantiate or
retrieve instances of services. Each service instance has a scope,
@@ -108,8 +103,7 @@
[[ghoib]][[GSACG00181]][[scopes-of-services]]
-Scopes of Services
-^^^^^^^^^^^^^^^^^^
+==== Scopes of Services
You can specify the scope of a service by adding an
`org.jvnet.hk2.annotations.Scoped` annotation to the class-level of your
@@ -151,8 +145,7 @@
[[ghoky]][[GSACG00182]][[instantiation-of-components-in-hk2]]
-Instantiation of Components in HK2
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Instantiation of Components in HK2
Do not call the `new` method to instantiate components. Instead,
retrieve components by using the `Habitat` instance. The simplest way to
@@ -170,8 +163,7 @@
[[ghois]][[GSACG00183]][[hk2-lifecycle-interfaces]]
-HK2 Lifecycle Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== HK2 Lifecycle Interfaces
Components can attach behaviors to their construction and destruction
events by implementing the
@@ -213,8 +205,7 @@
[[ghojb]][[GSACG00094]][[inversion-of-control]]
-Inversion of Control
-~~~~~~~~~~~~~~~~~~~~
+=== Inversion of Control
Inversion of control (IoC) refers to a style of software architecture
where the behavior of a system is determined by the runtime capabilities
@@ -228,8 +219,7 @@
[[ghoiz]][[GSACG00184]][[injecting-hk2-components]]
-Injecting HK2 Components
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Injecting HK2 Components
Services usually rely on other services to perform their tasks. The HK2
runtime identifies the `@Contract` implementations required by a service
@@ -269,8 +259,7 @@
[[ghoic]][[GSACG00186]][[instantiation-cascading-in-hk2]]
-Instantiation Cascading in HK2
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Instantiation Cascading in HK2
Injection of instances that have not been already instantiated triggers
more instantiation. You can see this as a component instantiation
@@ -307,8 +296,7 @@
[[ghmoe]][[GSACG00095]][[identifying-a-class-as-an-add-on-component]]
-Identifying a Class as an Add-On Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Identifying a Class as an Add-On Component
GlassFish Server discovers add-on components by identifying Java
programming language classes that are annotated with the
@@ -360,8 +348,7 @@
[[ghpvp]][[GSACG00096]][[using-the-apache-maven-build-system-to-develop-hk2-components]]
-Using the Apache Maven Build System to Develop HK2 Components
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the Apache Maven Build System to Develop HK2 Components
If you are using Maven 2 to build HK2 components, invoke the
`auto-depends` plug-in for Maven so that the `META-INF/services` files
diff --git a/docs/administration-guide/src/main/jbake/content/asadmin-subcommands.adoc b/docs/administration-guide/src/main/jbake/content/asadmin-subcommands.adoc
index cf615c4..9d76b07 100644
--- a/docs/administration-guide/src/main/jbake/content/asadmin-subcommands.adoc
+++ b/docs/administration-guide/src/main/jbake/content/asadmin-subcommands.adoc
@@ -4,15 +4,13 @@
prev=part-appendixes.html
~~~~~~
-Subcommands for the asadmin Utility
-===================================
+= Subcommands for the asadmin Utility
[[GSADG00023]][[gcode]]
[[a-subcommands-for-the-asadmin-utility]]
-A Subcommands for the `asadmin` Utility
----------------------------------------
+== A Subcommands for the `asadmin` Utility
This appendix lists the `asadmin` subcommands that are included with
this release of the GlassFish Server Open Source Edition 7 software.
@@ -52,8 +50,7 @@
[[ggltk]][[GSADG00610]][[general-administration-subcommands]]
-General Administration Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== General Administration Subcommands
link:../reference-manual/add-resources.html#GSRFM00001[`add-resources`]::
Creates the resources named in the specified XML file. Supported in
@@ -181,8 +178,7 @@
[[CHDJGEEG]][[GSADG1155]][[batch-jobs-subcommands]]
-Batch Jobs Subcommands
-~~~~~~~~~~~~~~~~~~~~~~
+=== Batch Jobs Subcommands
link:../reference-manual/list-batch-jobs.html#GSRFM861[`list-batch-jobs`]::
Lists batch jobs and job details. For procedural information in this
@@ -205,8 +201,7 @@
[[CHDECJFC]][[GSADG1156]][[concurrent-resources-subcommands]]
-Concurrent Resources Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Concurrent Resources Subcommands
link:../reference-manual/create-context-service.html#GSRFM838[`create-context-service`]::
Creates a context service resource. For procedural information in this
@@ -256,8 +251,7 @@
[[giowb]][[GSADG00611]][[connectivity-subcommands]]
-Connectivity Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Connectivity Subcommands
link:../reference-manual/create-admin-object.html#GSRFM00012[`create-admin-object`]::
Creates an administered object. For procedural information in this
@@ -377,8 +371,7 @@
[[gitwu]][[GSADG00612]][[domain-subcommands]]
-Domain Subcommands
-~~~~~~~~~~~~~~~~~~
+=== Domain Subcommands
link:../reference-manual/backup-domain.html#GSRFM00003[`backup-domain`]::
Describes how to back up a domain. Supported in local mode only. For
@@ -433,8 +426,7 @@
[[ggltm]][[GSADG00613]][[internet-connectivity-subcommands]]
-Internet Connectivity Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Internet Connectivity Subcommands
link:../reference-manual/create-http.html#GSRFM00025[`create-http`]::
Creates a set of HTTP parameters for a protocol, which in turn
@@ -517,8 +509,7 @@
[[ggltf]][[GSADG00614]][[javamail-subcommands]]
-JavaMail Subcommands
-~~~~~~~~~~~~~~~~~~~~
+=== JavaMail Subcommands
link:../reference-manual/create-javamail-resource.html#GSRFM00035[`create-javamail-resource`]::
Creates a JavaMail session resource. Supported in remote mode only.
@@ -535,8 +526,7 @@
[[gipen]][[GSADG00615]][[jms-subcommands]]
-JMS Subcommands
-~~~~~~~~~~~~~~~
+=== JMS Subcommands
link:../reference-manual/create-jmsdest.html#GSRFM00038[`create-jmsdest`]::
Creates a JMS physical destination. Along with the physical
@@ -591,8 +581,7 @@
[[gitws]][[GSADG00616]][[jndi-subcommands]]
-JNDI Subcommands
-~~~~~~~~~~~~~~~~
+=== JNDI Subcommands
link:../reference-manual/create-custom-resource.html#GSRFM00022[`create-custom-resource`]::
Creates a custom JNDI resource. Supported in remote mode only. For
@@ -625,8 +614,7 @@
[[gglsk]][[GSADG00617]][[jvm-subcommands]]
-JVM Subcommands
-~~~~~~~~~~~~~~~
+=== JVM Subcommands
link:../reference-manual/create-jvm-options.html#GSRFM00042[`create-jvm-options`]::
Creates a JVM option in the Java configuration or profiler elements of
@@ -658,8 +646,7 @@
[[giuzl]][[GSADG00618]][[life-cycle-module-subcommands]]
-Life Cycle Module Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Life Cycle Module Subcommands
link:../reference-manual/create-lifecycle-module.html#GSRFM00043[`create-lifecycle-module`]::
Creates a new life cycle module. Supported in remote mode only. For
@@ -676,8 +663,7 @@
[[gitxd]][[GSADG00619]][[logging-and-monitoring-subcommands]]
-Logging and Monitoring Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Logging and Monitoring Subcommands
link:../reference-manual/collect-log-files.html#GSRFM00007[`collect-log-files`]::
Collects all available log files and creates a ZIP archive. Supported
@@ -729,8 +715,7 @@
[[giusq]][[GSADG00620]][[orb-subcommands]]
-ORB Subcommands
-~~~~~~~~~~~~~~~
+=== ORB Subcommands
link:../reference-manual/create-iiop-listener.html#GSRFM00032[`create-iiop-listener`]::
Creates an IIOP listener. Supported in remote mode only. For
@@ -747,8 +732,7 @@
[[giuqr]][[GSADG00621]][[thread-pool-subcommands]]
-Thread Pool Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Thread Pool Subcommands
link:../reference-manual/create-threadpool.html#GSRFM00060[`create-threadpool`]::
Creates a new thread pool. Supported in remote mode only. For
@@ -765,8 +749,7 @@
[[gitxi]][[GSADG00622]][[transaction-service-subcommands]]
-Transaction Service Subcommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Transaction Service Subcommands
link:../reference-manual/freeze-transaction-service.html#GSRFM00137[`freeze-transaction-service`]::
Freezes the transaction subsystem during which time all the in-flight
diff --git a/docs/administration-guide/src/main/jbake/content/batch.adoc b/docs/administration-guide/src/main/jbake/content/batch.adoc
index 508b312..af3960f 100644
--- a/docs/administration-guide/src/main/jbake/content/batch.adoc
+++ b/docs/administration-guide/src/main/jbake/content/batch.adoc
@@ -5,15 +5,13 @@
prev=lifecycle-modules.html
~~~~~~
-Administering Batch Jobs
-========================
+= Administering Batch Jobs
[[GSADG1077]][[sthref66]]
[[administering-batch-jobs]]
-10 Administering Batch Jobs
----------------------------
+== 10 Administering Batch Jobs
This chapter provides procedures for administering batch jobs in the
GlassFish Server environment by using the `asadmin` command-line
@@ -30,8 +28,7 @@
[[BABCHGJJ]][[GSADG1078]][[about-batch-jobs]]
-About Batch Jobs
-~~~~~~~~~~~~~~~~
+=== About Batch Jobs
GlassFish Server provides a batch runtime for the scheduling and
execution of batch jobs. Batch jobs are typically long-running,
@@ -57,8 +54,7 @@
[[BABIHIGA]][[GSADG1079]][[viewing-batch-jobs]]
-Viewing Batch Jobs
-~~~~~~~~~~~~~~~~~~
+=== Viewing Batch Jobs
You can view detailed information about batch jobs, executions, and
steps. Users who log in to the `asadmin` utility or to the
@@ -74,8 +70,7 @@
[[BABIBFDJ]][[GSADG1080]][[to-list-batch-jobs]]
-To List Batch Jobs
-^^^^^^^^^^^^^^^^^^
+==== To List Batch Jobs
Use the `list-batch-jobs` subcommand in remote mode to list batch jobs
and job details.
@@ -108,8 +103,7 @@
[[BABFBGJB]][[GSADG1083]][[to-list-batch-job-executions]]
-To List Batch Job Executions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Batch Job Executions
When the batch runtime executes a job, the execution is given a unique
execution ID. An execution ID is similar to a process ID. A new
@@ -148,8 +142,7 @@
[[BABGJIDD]][[GSADG1086]][[to-list-batch-job-steps]]
-To List Batch Job Steps
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Batch Job Steps
A batch job consists of one or more steps. A step is an independent and
sequential phase of a batch job.
@@ -198,8 +191,7 @@
[[BABBFFIG]][[GSADG1089]][[configuring-the-batch-runtime]]
-Configuring the Batch Runtime
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring the Batch Runtime
The batch runtime uses a data source and a managed executor service to
execute batch jobs. The data source stores information about current and
@@ -228,8 +220,7 @@
[[BABBGHCJ]][[GSADG1090]][[to-list-the-batch-runtime-configuration]]
-To List the Batch Runtime Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List the Batch Runtime Configuration
Use the `list-batch-runtime-configuration` subcommand in remote mode to
display the configuration of the batch runtime.
@@ -274,8 +265,7 @@
[[BABFEJAD]][[GSADG1093]][[to-configure-the-batch-runtime]]
-To Configure the Batch Runtime
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure the Batch Runtime
Use the `set-batch-runtime-configuration` subcommand in remote mode to
configure the batch runtime.
diff --git a/docs/administration-guide/src/main/jbake/content/concurrent.adoc b/docs/administration-guide/src/main/jbake/content/concurrent.adoc
index 88a3579..8665eca 100644
--- a/docs/administration-guide/src/main/jbake/content/concurrent.adoc
+++ b/docs/administration-guide/src/main/jbake/content/concurrent.adoc
@@ -5,15 +5,13 @@
prev=http_https.html
~~~~~~
-Administering Concurrent Resources
-==================================
+= Administering Concurrent Resources
[[GSADG1108]][[sthref73]]
[[administering-concurrent-resources]]
-14 Administering Concurrent Resources
--------------------------------------
+== 14 Administering Concurrent Resources
This chapter provides procedures for administering concurrent resources
in the GlassFish Server environment by using the `asadmin` command-line
@@ -33,8 +31,7 @@
[[DAFGCCDI]][[GSADG1109]][[about-concurrent-resources]]
-About Concurrent Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Concurrent Resources
Concurrent resources are managed objects that provide concurrency
capabilities to Jakarta EE applications. In GlassFish Server, you configure
@@ -60,8 +57,7 @@
[[DAFFGDCD]][[GSADG1110]][[default-concurrent-resources]]
-Default Concurrent Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Concurrent Resources
When you create a concurrent resource, you specify a unique JNDI name
for the resource. Applications use this name to access the resource.
@@ -88,8 +84,7 @@
[[DAFFCEEA]][[GSADG1111]][[configuring-context-services]]
-Configuring Context Services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Context Services
Context services are used to create dynamic proxy objects that capture
the context of a container and enable applications to run within that
@@ -105,8 +100,7 @@
[[DAFJACDI]][[GSADG1112]][[to-create-a-context-service]]
-To Create a Context Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Context Service
Use the `create-context-service` subcommand in remote mode to create a
context service resource.
@@ -157,8 +151,7 @@
[[DAFDCFCB]][[GSADG1115]][[to-list-context-services]]
-To List Context Services
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Context Services
Use the `list-context-services` subcommand in remote mode to list the
existing context service resources.
@@ -191,8 +184,7 @@
[[DAFBFICB]][[GSADG1118]][[to-update-a-context-service]]
-To Update a Context Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Context Service
You can change all of the settings for an existing context service
resource except its JNDI name. Use the `get` and `set` subcommands to
@@ -227,8 +219,7 @@
[[DAFGGGEC]][[GSADG1119]][[to-delete-a-context-service]]
-To Delete a Context Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Context Service
Use the `delete-context-service` subcommand in remote mode to delete an
existing context service. Deleting a context service is a dynamic event
@@ -266,8 +257,7 @@
[[DAFBAAIJ]][[GSADG1122]][[configuring-managed-thread-factories]]
-Configuring Managed Thread Factories
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Managed Thread Factories
Managed thread factories are used by applications to create managed
threads on demand. The threads are started and managed by the container.
@@ -284,8 +274,7 @@
[[DAFGFAEI]][[GSADG1123]][[to-create-a-managed-thread-factory]]
-To Create a Managed Thread Factory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Managed Thread Factory
Use the `create-managed-thread-factory` subcommand in remote mode to
create a managed thread factory resource.
@@ -334,8 +323,7 @@
[[DAFDGEGE]][[GSADG1126]][[to-list-managed-thread-factories]]
-To List Managed Thread Factories
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Managed Thread Factories
Use the `list-managed-thread-factories` subcommand in remote mode to
list the existing managed thread factory resources.
@@ -368,8 +356,7 @@
[[DAFDIJIH]][[GSADG1129]][[to-update-a-managed-thread-factory]]
-To Update a Managed Thread Factory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Managed Thread Factory
You can change all of the settings for an existing managed thread
factory resource except its JNDI name. Use the `get` and `set`
@@ -405,8 +392,7 @@
[[DAFCEDEI]][[GSADG1130]][[to-delete-a-managed-thread-factory]]
-To Delete a Managed Thread Factory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Managed Thread Factory
Use the `delete-managed-thread-factory` subcommand in remote mode to
delete an existing managed thread factory. Deleting a managed thread
@@ -444,8 +430,7 @@
[[DAFBHEDI]][[GSADG1133]][[configuring-managed-executor-services]]
-Configuring Managed Executor Services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Managed Executor Services
Managed executor services are used by applications to execute submitted
tasks asynchronously. Tasks are executed on threads that are started and
@@ -462,8 +447,7 @@
[[DAFJIEGA]][[GSADG1134]][[to-create-a-managed-executor-service]]
-To Create a Managed Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Managed Executor Service
Use the `create-managed-executor-service` subcommand in remote mode to
create a managed executor service resource.
@@ -516,8 +500,7 @@
[[DAFIJDAE]][[GSADG1137]][[to-list-managed-executor-services]]
-To List Managed Executor Services
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Managed Executor Services
Use the `list-managed-executor-services` subcommand in remote mode to
list the existing managed executor service resources.
@@ -551,8 +534,7 @@
[[DAFICEJF]][[GSADG1140]][[to-update-a-managed-executor-service]]
-To Update a Managed Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Managed Executor Service
You can change all of the settings for an existing managed executor
service resource except its JNDI name. Use the `get` and `set`
@@ -588,8 +570,7 @@
[[DAFDAGAD]][[GSADG1141]][[to-delete-a-managed-executor-service]]
-To Delete a Managed Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Managed Executor Service
Use the `delete-managed-executor-service` subcommand in remote mode to
delete an existing managed executor service. Deleting a managed executor
@@ -628,8 +609,7 @@
[[DAFHJHCF]][[GSADG1144]][[configuring-managed-scheduled-executor-services]]
-Configuring Managed Scheduled Executor Services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Managed Scheduled Executor Services
Managed scheduled executor services are used by applications to execute
submitted tasks asynchronously at specific times. Tasks are executed on
@@ -646,8 +626,7 @@
[[DAFFGDGG]][[GSADG1145]][[to-create-a-managed-scheduled-executor-service]]
-To Create a Managed Scheduled Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Managed Scheduled Executor Service
Use the `create-managed-scheduled-executor-service` subcommand in remote
mode to create a managed scheduled executor service resource.
@@ -701,8 +680,7 @@
[[DAFJBADD]][[GSADG1148]][[to-list-managed-scheduled-executor-services]]
-To List Managed Scheduled Executor Services
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Managed Scheduled Executor Services
Use the `list-managed-scheduled-executor-services` subcommand in remote
mode to list the existing managed scheduled executor service resources.
@@ -736,8 +714,7 @@
[[DAFGEBEI]][[GSADG1151]][[to-update-a-managed-scheduled-executor-service]]
-To Update a Managed Scheduled Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Managed Scheduled Executor Service
You can change all of the settings for an existing managed scheduled
executor service resource except its JNDI name. Use the `get` and `set`
@@ -772,8 +749,7 @@
[[DAFEBEGC]][[GSADG1152]][[to-delete-a-managed-scheduled-executor-service]]
-To Delete a Managed Scheduled Executor Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Managed Scheduled Executor Service
Use the `delete-managed-scheduled-executor-service` subcommand in remote
mode to delete an existing managed scheduled executor service. Deleting
diff --git a/docs/administration-guide/src/main/jbake/content/connectors.adoc b/docs/administration-guide/src/main/jbake/content/connectors.adoc
index 417b286..e3363e4 100644
--- a/docs/administration-guide/src/main/jbake/content/connectors.adoc
+++ b/docs/administration-guide/src/main/jbake/content/connectors.adoc
@@ -5,15 +5,13 @@
prev=jdbc.html
~~~~~~
-Administering EIS Connectivity
-==============================
+= Administering EIS Connectivity
[[GSADG00016]][[abllp]]
[[administering-eis-connectivity]]
-12 Administering EIS Connectivity
----------------------------------
+== 12 Administering EIS Connectivity
This chapter provides information and procedures for administering
connections to enterprise information system (EIS) data in the Oracle
@@ -48,8 +46,7 @@
[[abllq]][[GSADG00580]][[about-eis-connectivity]]
-About EIS Connectivity
-~~~~~~~~~~~~~~~~~~~~~~
+=== About EIS Connectivity
Enterprise information system (EIS) refers to any system that holds the
data of an organization. It can be a mainframe, a messaging system, a
@@ -123,8 +120,7 @@
[[ablls]][[GSADG00581]][[administering-connector-connection-pools]]
-Administering Connector Connection Pools
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Connector Connection Pools
After a connector module has been deployed, you are ready to create a
connector connection pool for it.
@@ -140,8 +136,7 @@
[[gioce]][[GSADG00431]][[to-create-a-connector-connection-pool]]
-To Create a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Connector Connection Pool
Use the `create-connector-connection-pool` subcommand in remote mode to
create a connector connection pool for a deployed connector module. When
@@ -206,8 +201,7 @@
[[giocg]][[GSADG00432]][[to-list-connector-connection-pools]]
-To List Connector Connection Pools
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Connector Connection Pools
Use the `list-connector-connection-pools` subcommand in remote mode to
list the pools that have been created.
@@ -238,8 +232,7 @@
[[gjiqz]][[GSADG00433]][[to-connect-to-ping-or-reset-flush-a-connector-connection-pool]]
-To Connect to (Ping) or Reset (Flush) a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Connect to (Ping) or Reset (Flush) a Connector Connection Pool
Use the `ping-connection-pool` or `flush-connection-pool` subcommands in
remote mode to perform these tasks on a connection pools. See
@@ -254,8 +247,7 @@
[[gioti]][[GSADG00434]][[to-update-a-connector-connection-pool]]
-To Update a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Connector Connection Pool
Use the `get` and `set` subcommands to view and change the values of the
connector connection pool properties.
@@ -284,8 +276,7 @@
[[giocp]][[GSADG00435]][[to-delete-a-connector-connection-pool]]
-To Delete a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Connector Connection Pool
Use the `delete-connector-connection-pool` subcommand in remote mode to
remove a connector connection pool.
@@ -318,8 +309,7 @@
[[abllx]][[GSADG00582]][[administering-connector-resources]]
-Administering Connector Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Connector Resources
A connector resource provides an application or module with the means of
connecting to an EIS. Typically, you create a connector resource for
@@ -334,8 +324,7 @@
[[giogt]][[GSADG00436]][[to-create-a-connector-resource]]
-To Create a Connector Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Connector Resource
Use the `create-connector-resource` subcommand in remote mode to
register a new connector resource with its JNDI name.
@@ -388,8 +377,7 @@
[[giohs]][[GSADG00437]][[to-list-connector-resources]]
-To List Connector Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Connector Resources
Use the `list-connector-resources` subcommand in remote mode to list the
connector resources that have been created.
@@ -419,8 +407,7 @@
[[giosg]][[GSADG00438]][[to-update-a-connector-resource]]
-To Update a Connector Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Connector Resource
Use the `get` and `set` subcommands to view and change the values of the
connector resource properties.
@@ -449,8 +436,7 @@
[[giofs]][[GSADG00439]][[to-delete-a-connector-resource]]
-To Delete a Connector Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Connector Resource
Use the `delete-connector-resource` subcommand in remote mode to remove
a connector resource by specifying the JNDI name.
@@ -488,8 +474,7 @@
[[giope]][[GSADG00583]][[administering-the-resource-adapter-configuration]]
-Administering the Resource Adapter Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering the Resource Adapter Configuration
The following topics are addressed here:
@@ -501,8 +486,7 @@
[[gioqx]][[GSADG00440]][[to-create-configuration-information-for-a-resource-adapter]]
-To Create Configuration Information for a Resource Adapter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create Configuration Information for a Resource Adapter
Use the `create-resource-adapter-config` subcommand in remote mode to
create configuration information for a resource adapter, also known as a
@@ -541,8 +525,7 @@
[[giorn]][[GSADG00441]][[to-list-resource-adapter-configurations]]
-To List Resource Adapter Configurations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Resource Adapter Configurations
Use the `list-resource-adapter-configs` subcommand in remote mode to
list the configuration information contained in the domain configuration
@@ -575,8 +558,7 @@
[[gioum]][[GSADG00442]][[to-update-a-resource-adapter-configuration]]
-To Update a Resource Adapter Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Resource Adapter Configuration
Use the `get` and `set` subcommands to view and change the values of the
resource adapter configuration properties.
@@ -602,8 +584,7 @@
[[gionv]][[GSADG00443]][[to-delete-a-resource-adapter-configuration]]
-To Delete a Resource Adapter Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Resource Adapter Configuration
Use the `delete-resource-adapter-config` subcommand in remote mode to
delete the configuration information contained in the domain
@@ -637,8 +618,7 @@
[[gitxy]][[GSADG00584]][[administering-connector-security-maps]]
-Administering Connector Security Maps
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Connector Security Maps
The EIS is any system that holds the data of an organization. It can be
a mainframe, a messaging system, a database system, or an application.
@@ -658,8 +638,7 @@
[[gitzz]][[GSADG00444]][[to-create-a-connector-security-map]]
-To Create a Connector Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Connector Security Map
Use the `create-connector-security-map` subcommand in remote mode to
create a security map for the specified connector connection pool. If
@@ -708,8 +687,7 @@
[[gitwx]][[GSADG00445]][[to-list-connector-security-maps]]
-To List Connector Security Maps
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Connector Security Maps
Use the `list-connector-security-maps` subcommand in remote mode to list
the existing security maps belonging to the specified connector
@@ -769,8 +747,7 @@
[[gityj]][[GSADG00446]][[to-update-a-connector-security-map]]
-To Update a Connector Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Connector Security Map
Use the `update-connector-security-map` subcommand in remote mode to
create or modify a security map for the specified connector connection
@@ -802,8 +779,7 @@
[[gitvf]][[GSADG00447]][[to-delete-a-connector-security-map]]
-To Delete a Connector Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Connector Security Map
Use the `delete-connector-security-map` subcommand in remote mode to
delete a security map for the specified connector connection pool.
@@ -831,8 +807,7 @@
[[giohl]][[GSADG00585]][[administering-connector-work-security-maps]]
-Administering Connector Work Security Maps
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Connector Work Security Maps
The EIS is any system that holds the data of an organization. It can be
a mainframe, a messaging system, a database system, or an application.
@@ -852,8 +827,7 @@
[[giofz]][[GSADG00448]][[to-create-a-connector-work-security-map]]
-To Create a Connector Work Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Connector Work Security Map
Use the `create-connector-work-security-map` subcommand in remote mode
to map the caller identity of the work submitted by the connector module
@@ -913,8 +887,7 @@
[[gioir]][[GSADG00449]][[to-list-connector-work-security-maps]]
-To List Connector Work Security Maps
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Connector Work Security Maps
Use the `list-connector-work-security-maps` subcommand in remote mode to
list the work security maps that belong to a specific connector module.
@@ -947,8 +920,7 @@
[[giogm]][[GSADG00450]][[to-update-a-connector-work-security-map]]
-To Update a Connector Work Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Connector Work Security Map
Use the `update-connector-work-security-map` subcommand in remote to
modify a work security map that belongs to a specific resource adapter
@@ -984,8 +956,7 @@
[[gioin]][[GSADG00451]][[to-delete-a-connector-work-security-map]]
-To Delete a Connector Work Security Map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Connector Work Security Map
Use the `delete-connector-work-security-map` subcommand in remote mode
to delete a work security map that belongs to a specific connector
@@ -1019,8 +990,7 @@
[[ablmc]][[GSADG00586]][[administering-administered-objects]]
-Administering Administered Objects
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Administered Objects
Packaged within a connector module, an administered object provides
specialized functionality for an application. For example, an
@@ -1036,8 +1006,7 @@
[[giolr]][[GSADG00452]][[to-create-an-administered-object]]
-To Create an Administered Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Administered Object
Use the `create-admin-object` subcommand to create an administered
object resource. When creating an administered object resource,
@@ -1086,8 +1055,7 @@
[[giokm]][[GSADG00453]][[to-list-administered-objects]]
-To List Administered Objects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Administered Objects
Use the `list-admin-object` subcommand in remote mode to list the
existing administered objects.
@@ -1117,8 +1085,7 @@
[[giots]][[GSADG00454]][[to-update-an-administered-object]]
-To Update an Administered Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update an Administered Object
Use the `get` and `set` subcommands to view and change the values of the
administered objects properties.
@@ -1147,8 +1114,7 @@
[[gioma]][[GSADG00455]][[to-delete-an-administered-object]]
-To Delete an Administered Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an Administered Object
Use the `delete-admin-object` subcommand to delete an administered objects.
diff --git a/docs/administration-guide/src/main/jbake/content/domains.adoc b/docs/administration-guide/src/main/jbake/content/domains.adoc
index 0c2638c..adc7184 100644
--- a/docs/administration-guide/src/main/jbake/content/domains.adoc
+++ b/docs/administration-guide/src/main/jbake/content/domains.adoc
@@ -5,15 +5,13 @@
prev=general-administration.html
~~~~~~
-Administering Domains
-=====================
+= Administering Domains
[[GSADG00006]][[ggnop]]
[[administering-domains]]
-3 Administering Domains
------------------------
+== 3 Administering Domains
This chapter provides procedures for administering domains in the
GlassFish Server Open Source Edition environment by using the `asadmin`
@@ -35,8 +33,7 @@
[[ggoek]][[GSADG00535]][[about-administering-domains]]
-About Administering Domains
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Administering Domains
A domain contains a group of GlassFish Server instances that are
administered together. Each domain has a domain administration server
@@ -49,8 +46,7 @@
[[geolm]][[GSADG00715]][[glassfish-server-instances]]
-GlassFish Server Instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server Instances
A GlassFish Server instance is a single Virtual Machine for the Java
platform (Java Virtual Machine or JVM machine) on a single node in which
@@ -85,8 +81,7 @@
[[geojp]][[GSADG00716]][[domains-for-administering-glassfish-server]]
-Domains for Administering GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Domains for Administering GlassFish Server
A domain is an administrative boundary that contains a group of
GlassFish Server instances that are administered together. Each instance
@@ -113,8 +108,7 @@
[[geojl]][[GSADG00717]][[domain-administration-server-das]]
-Domain Administration Server (DAS)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Domain Administration Server (DAS)
The domain administration server (DAS) is a specially designated
GlassFish Server instance that hosts administrative applications. The
@@ -144,8 +138,7 @@
[[gitvz]][[GSADG00536]][[creating-logging-in-to-and-deleting-a-domain]]
-Creating, Logging In To, and Deleting a Domain
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Logging In To, and Deleting a Domain
The following topics are addressed here:
@@ -157,8 +150,7 @@
[[ggoei]][[GSADG00330]][[to-create-a-domain]]
-To Create a Domain
-^^^^^^^^^^^^^^^^^^
+==== To Create a Domain
After installing GlassFish Server and creating the default domain
(`domain1`), you can create additional domains by using the local
@@ -229,8 +221,7 @@
[[gldel]][[GSADG00331]][[to-create-a-domain-from-a-custom-template]]
-To Create a Domain From a Custom Template
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Domain From a Custom Template
A custom template enables you to customize the configuration of any
domain that you create from the template.
@@ -372,8 +363,7 @@
[[ggoco]][[GSADG00332]][[to-list-domains]]
-To List Domains
-^^^^^^^^^^^^^^^
+==== To List Domains
Use the `list-domains` subcommand to display a list of domains and their statuses.
If the domain directory is not specified, the contents of the
@@ -407,8 +397,7 @@
[[ghhjz]][[GSADG00333]][[to-log-in-to-a-domain]]
-To Log In to a Domain
-^^^^^^^^^^^^^^^^^^^^^
+==== To Log In to a Domain
All remote subcommands require that credentials be specified in terms of
an administration user name and its password. By default, the domain is
@@ -509,8 +498,7 @@
[[ggofa]][[GSADG00334]][[to-delete-a-domain]]
-To Delete a Domain
-^^^^^^^^^^^^^^^^^^
+==== To Delete a Domain
Use the `delete-domain` subcommand to delete an existing domain from a
server. Only the root user or the operating system user who is
@@ -549,8 +537,7 @@
[[gitwj]][[GSADG00537]][[starting-and-stopping-a-domain]]
-Starting and Stopping a Domain
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Starting and Stopping a Domain
The following topics are addressed here:
@@ -560,8 +547,7 @@
[[ggoda]][[GSADG00335]][[to-start-a-domain]]
-To Start a Domain
-^^^^^^^^^^^^^^^^^
+==== To Start a Domain
When you start a domain or server, the domain administration server
(DAS) is started. After startup, the DAS runs constantly, listening for
@@ -620,8 +606,7 @@
[[ggoch]][[GSADG00336]][[to-stop-a-domain]]
-To Stop a Domain
-^^^^^^^^^^^^^^^^
+==== To Stop a Domain
Stopping a domain or server shuts down its domain administration server
(DAS). When stopping a domain, the DAS stops accepting new connections
@@ -672,8 +657,7 @@
[[ginqj]][[GSADG00337]][[to-restart-a-domain]]
-To Restart a Domain
-^^^^^^^^^^^^^^^^^^^
+==== To Restart a Domain
Use the `restart-domain` subcommand in remote mode to restart the Domain
Administration Server (DAS) of the specified host. When restarting a
@@ -724,8 +708,7 @@
[[gglqp]][[GSADG00538]][[configuring-a-das-or-a-glassfish-server-instance-for-automatic-restart]]
-Configuring a DAS or a GlassFish Server Instance for Automatic Restart
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring a DAS or a GlassFish Server Instance for Automatic Restart
Use the `create-service` subcommand in local mode to configure your
system to automatically restart a domain administration server (DAS) or
@@ -749,8 +732,7 @@
[[gjzfg]][[GSADG00338]][[to-configure-a-das-or-an-instance-for-automatic-restart-on-windows]]
-To Configure a DAS or an Instance for Automatic Restart on Windows
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a DAS or an Instance for Automatic Restart on Windows
On Windows systems, the `create-service` subcommand creates a Windows
service to represent the DAS or instance. The service is created in the
@@ -833,8 +815,7 @@
[[giurs]][[GSADG00339]][[to-configure-a-das-or-an-instance-for-automatic-restart-on-linux]]
-To Configure a DAS or an Instance for Automatic Restart on Linux
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a DAS or an Instance for Automatic Restart on Linux
On Linux systems, the `create-service` subcommand creates a
System-V-style initialization script
@@ -889,8 +870,7 @@
[[giusi]][[GSADG00340]][[to-configure-a-das-or-an-instance-for-automatic-restart-on-oracle-solaris]]
To Configure a DAS or an Instance for Automatic Restart on Oracle
-Solaris
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Solaris
On Oracle Solaris systems, the `create-service` subcommand creates an
Oracle Solaris Service Management Facility (SMF) service that restarts a
@@ -995,8 +975,7 @@
[[giurf]][[GSADG00341]][[to-prevent-service-shutdown-when-a-user-logs-out-on-windows]]
-To Prevent Service Shutdown When a User Logs Out on Windows
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Prevent Service Shutdown When a User Logs Out on Windows
By default, the Java Virtual Machine (VM) receives signals from Windows
that indicate that Windows is shutting down, or that a user is logging
@@ -1036,8 +1015,7 @@
[[gityo]][[GSADG00541]][[backing-up-and-restoring-a-domain]]
-Backing Up and Restoring a Domain
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Backing Up and Restoring a Domain
The following topics are addressed here:
@@ -1047,8 +1025,7 @@
[[ggocq]][[GSADG00352]][[to-back-up-a-domain]]
-To Back Up a Domain
-^^^^^^^^^^^^^^^^^^^
+==== To Back Up a Domain
Use the `backup-domain` subcommand in local mode to make a backup of a
specified domain.
@@ -1097,8 +1074,7 @@
[[ggody]][[GSADG00353]][[to-restore-a-domain]]
-To Restore a Domain
-^^^^^^^^^^^^^^^^^^^
+==== To Restore a Domain
Use the `restore-domain` subcommand in local mode to use a backup file
to restore the files and subdirectories in a specified domain's
@@ -1150,8 +1126,7 @@
[[ghgod]][[GSADG00354]][[to-list-domain-backups]]
-To List Domain Backups
-^^^^^^^^^^^^^^^^^^^^^^
+==== To List Domain Backups
Use the `list-backups` subcommand in local mode to display information
about backups of a specified domain stored in a specified backup
@@ -1193,8 +1168,7 @@
[[gglri]][[GSADG00542]][[re-creating-the-domain-administration-server-das]]
-Re-Creating the Domain Administration Server (DAS)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Re-Creating the Domain Administration Server (DAS)
For mirroring purposes, and to provide a working copy of the DAS, you
must have:
@@ -1228,8 +1202,7 @@
[[gglnp]][[GSADG00355]][[to-migrate-the-das]]
-To Migrate the DAS
-^^^^^^^^^^^^^^^^^^
+==== To Migrate the DAS
The following steps are required to migrate the DAS from the first host
(olddashost) to the third host (newdashost).
@@ -1298,8 +1271,7 @@
[[gitvn]][[GSADG00543]][[additional-domain-tasks]]
-Additional Domain Tasks
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Additional Domain Tasks
The following topics are addressed here:
@@ -1309,8 +1281,7 @@
[[ghhnt]][[GSADG00356]][[to-display-domain-uptime]]
-To Display Domain Uptime
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Display Domain Uptime
Use the `uptime` subcommand in remote mode to display the length of time
that the domain administration server (DAS) has been running since it
@@ -1340,8 +1311,7 @@
[[ghmbn]][[GSADG00357]][[to-switch-a-domain-to-another-supported-java-version]]
-To Switch a Domain to Another Supported Java Version
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Switch a Domain to Another Supported Java Version
GlassFish Server 7 requires Java SE 8 as the underlying virtual
machine for the Java platform (Java Virtual Machine or JVM machine).
@@ -1383,8 +1353,7 @@
[[gkvkb]][[GSADG00358]][[to-change-the-administration-port-of-a-domain]]
-To Change the Administration Port of a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change the Administration Port of a Domain
Use the `set` subcommand in remote mode to change the administration
port of a domain.
diff --git a/docs/administration-guide/src/main/jbake/content/general-administration.adoc b/docs/administration-guide/src/main/jbake/content/general-administration.adoc
index 4eb51f6..0609d16 100644
--- a/docs/administration-guide/src/main/jbake/content/general-administration.adoc
+++ b/docs/administration-guide/src/main/jbake/content/general-administration.adoc
@@ -5,15 +5,13 @@
prev=part-runtime-admin.html
~~~~~~
-General Administration
-======================
+= General Administration
[[GSADG00005]][[gitya]]
[[general-administration]]
-2 General Administration
-------------------------
+== 2 General Administration
This chapter provides instructions for performing general administration
tasks in the GlassFish Server Open Source Edition 7 environment by
@@ -34,8 +32,7 @@
[[giobi]][[GSADG00530]][[using-the-asadmin-utility]]
-Using the `asadmin` Utility
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the `asadmin` Utility
Use the `asadmin` utility to perform administrative tasks for GlassFish
Server from the command line or from a script. You can use this utility
@@ -55,8 +52,7 @@
[[giwdb]][[GSADG00705]][[path-to-the-asadmin-utility]]
-Path to the `asadmin` Utility
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Path to the `asadmin` Utility
The `asadmin` utility is located in the as-install`/bin` directory. To
run the `asadmin` utility without specifying the path, ensure that this
@@ -64,8 +60,7 @@
[[givvn]][[GSADG00706]][[asadmin-utility-syntax]]
-`asadmin` Utility Syntax
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== `asadmin` Utility Syntax
The syntax for running the `asadmin` utility is as follows:
@@ -81,8 +76,7 @@
[[ghvzn]][[GSADG00631]][[subcommands-of-the-asadmin-utility]]
-Subcommands of the `asadmin` Utility
-++++++++++++++++++++++++++++++++++++
+===== Subcommands of the `asadmin` Utility
The subcommand identifies the operation or task that you are performing.
Subcommands are case-sensitive. Each subcommand is either a local
@@ -102,8 +96,7 @@
[[ghvyd]][[GSADG00632]][[asadmin-utility-options-and-subcommand-options]]
-`asadmin` Utility Options and Subcommand Options
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== `asadmin` Utility Options and Subcommand Options
Options control the behavior of the `asadmin` utility and its
subcommands. Options are case-sensitive.
@@ -156,8 +149,7 @@
[[ghvyj]][[GSADG00633]][[operands-of-asadmin-utility-subcommands]]
-Operands of `asadmin` Utility Subcommands
-+++++++++++++++++++++++++++++++++++++++++
+===== Operands of `asadmin` Utility Subcommands
Operands specify the items on which the subcommand is to act. Operands
must follow the argument values of subcommand options, and are set off
@@ -167,8 +159,7 @@
[[ghvzx]][[GSADG00304]][[to-run-an-asadmin-utility-subcommand-in-single-mode]]
-To Run an `asadmin` Utility Subcommand in Single Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Run an `asadmin` Utility Subcommand in Single Mode
In single mode, you must type a separate `asadmin` command for each
subcommand that you want to use. After the subcommand has run, you are
@@ -242,8 +233,7 @@
[[givlw]][[GSADG00305]][[to-display-help-information-for-the-asadmin-utility-or-a-subcommand]]
-To Display Help Information for the `asadmin` Utility or a Subcommand
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Display Help Information for the `asadmin` Utility or a Subcommand
GlassFish Server provides help information about the syntax, purpose,
and options of the `asadmin` utility and its subcommands. This help
@@ -294,8 +284,7 @@
[[giodz]][[GSADG00306]][[to-start-a-multimode-session]]
-To Start a Multimode Session
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start a Multimode Session
The `asadmin` utility can be used in multiple command mode, or
multimode. In multimode, you run the `asadmin` utility once to start a
@@ -379,8 +368,7 @@
[[givjn]][[GSADG00307]][[to-end-a-multimode-session]]
-To End a Multimode Session
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To End a Multimode Session
At the `asadmin>` prompt, type one of the following commands or key
combinations:
@@ -407,8 +395,7 @@
[[givjd]][[GSADG00308]][[to-run-a-set-of-asadmin-subcommands-from-a-file]]
-To Run a Set of `asadmin` Subcommands From a File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Run a Set of `asadmin` Subcommands From a File
Running a set of `asadmin` subcommands from a file enables you to
automate repetitive tasks.
@@ -476,8 +463,7 @@
[[CACDDHBA]][[GSADG1055]][[to-run-asadmin-subcommands-in---detach-mode]]
-To Run `asadmin` Subcommands in `--detach` Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Run `asadmin` Subcommands in `--detach` Mode
You can use the `--detach` option of the `asadmin` utility to detach
`asadmin` subcommands and run them in the background in detach mode. The
@@ -577,8 +563,7 @@
[[ghcjc]][[GSADG00531]][[administering-system-properties]]
-Administering System Properties
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering System Properties
Shared server instances will often need to override attributes defined
in their referenced configuration. Any configuration attribute can be
@@ -592,8 +577,7 @@
[[ggonc]][[GSADG00309]][[to-create-system-properties]]
-To Create System Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create System Properties
Use the `create-system-properties` subcommand in remote mode to create
or update one or more system properties of the domain or configuration.
@@ -628,8 +612,7 @@
[[ggodt]][[GSADG00310]][[to-list-system-properties]]
-To List System Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List System Properties
Use the `list-system-properties` subcommand in remote mode to list the
system properties that apply to a domain, cluster, or server instance or
@@ -663,8 +646,7 @@
[[ggomm]][[GSADG00311]][[to-delete-a-system-property]]
-To Delete a System Property
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a System Property
Use the `delete-system-property` subcommand in remote mode to delete
system properties.
@@ -698,8 +680,7 @@
[[CHDJBJDA]][[GSADG1096]][[using-configuration-modularity]]
-Using Configuration Modularity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Configuration Modularity
With configuration modularity in GlassFish Server Open Source Edition,
new modules can be added to GlassFish Server distributions without
@@ -717,8 +698,7 @@
[[CHDGCJCF]][[GSADG1097]][[to-add-the-default-configuration-of-a-module-to-domain.xml]]
-To Add the Default Configuration of a Module to `domain.xml`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Add the Default Configuration of a Module to `domain.xml`
Use the `create-module-config` subcommand to add the default
configuration of a module to `domain.xml`.
@@ -749,8 +729,7 @@
[[CHDJCJFA]][[GSADG1100]][[to-remove-the-configuration-of-a-module-from-domain.xml]]
-To Remove the Configuration of a Module From `domain.xml`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Remove the Configuration of a Module From `domain.xml`
Use the `delete-module-config` subcommand to remove the configuration of
a module from `domain.xml` and cause the module to use the default
@@ -781,8 +760,7 @@
[[CHDICIJE]][[GSADG1103]][[to-display-the-current-active-configuration-of-a-module]]
-To Display the Current Active Configuration of a Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Display the Current Active Configuration of a Module
Use the `get-active-module-config` subcommand to display the current
active configuration of a module.
@@ -816,8 +794,7 @@
[[gixps]][[GSADG00532]][[administering-resources]]
-Administering Resources
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Resources
This section contains instructions for integrating resources into the
GlassFish Server environment. Information about administering specific
@@ -825,8 +802,7 @@
[[ggoeh]][[GSADG00312]][[to-add-resources-from-an-xml-file]]
-To Add Resources From an XML File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Add Resources From an XML File
Use the `add-resources` subcommand in remote mode to create the
resources named in the specified XML file. The following resources are
@@ -871,8 +847,7 @@
[[ggocm]][[GSADG00533]][[listing-various-system-elements]]
-Listing Various System Elements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Listing Various System Elements
The following topics are addressed here:
@@ -886,8 +861,7 @@
[[ghhox]][[GSADG00316]][[to-display-the-glassfish-server-version]]
-To Display the GlassFish Server Version
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Display the GlassFish Server Version
Use the `version` subcommand in remote mode to display information about
the GlassFish Server version for a particular server. If the subcommand
@@ -920,8 +894,7 @@
[[ggocy]][[GSADG00317]][[to-list-applications]]
-To List Applications
-^^^^^^^^^^^^^^^^^^^^
+==== To List Applications
Use the `list-applications` subcommand in remote mode to list the
deployed Java applications. If the `--type` option is not specified, all
@@ -952,8 +925,7 @@
[[ggocv]][[GSADG00319]][[to-list-containers]]
-To List Containers
-^^^^^^^^^^^^^^^^^^
+==== To List Containers
Use the `list-containers` subcommand in remote mode to list application
containers.
@@ -993,8 +965,7 @@
[[ghlgf]][[GSADG00320]][[to-list-modules]]
-To List Modules
-^^^^^^^^^^^^^^^
+==== To List Modules
Use the `list-modules` subcommand in remote mode to list the modules
that are accessible to the GlassFish Server module subsystem. The status
@@ -1052,8 +1023,7 @@
[[ggoeg]][[GSADG00321]][[to-list-subcommands]]
-To List Subcommands
-^^^^^^^^^^^^^^^^^^^
+==== To List Subcommands
Use the `list-commands` subcommand in remote mode to list the deployed
`asadmin` subcommands. You can specify that only remote subcommands or
@@ -1095,8 +1065,7 @@
[[giojd]][[GSADG00322]][[to-list-timers]]
-To List Timers
-^^^^^^^^^^^^^^
+==== To List Timers
The timer service is a persistent and transactional notification service
that is provided by the enterprise bean container and is used to
@@ -1128,8 +1097,7 @@
[[giyjd]][[GSADG00323]][[to-show-component-status]]
-To Show Component Status
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Show Component Status
Use the `show-component-status` subcommand in remote mode to get the
status (either enabled or disabled) of the specified deployed component.
@@ -1152,8 +1120,7 @@
[[gjipx]][[GSADG00534]][[using-rest-interfaces-to-administer-glassfish-server]]
-Using REST Interfaces to Administer GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using REST Interfaces to Administer GlassFish Server
GlassFish Server provides representational state transfer (REST)
interfaces to enable you to access monitoring and configuration data for
@@ -1201,8 +1168,7 @@
[[gjipk]][[GSADG00707]][[using-rest-urls-to-administer-glassfish-server]]
-Using REST URLs to Administer GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using REST URLs to Administer GlassFish Server
Each object in the configuration and monitoring object trees is
represented as a REST resource that is accessible through an HTTP
@@ -1211,8 +1177,7 @@
[[gkwhy]][[GSADG00634]][[rest-urls-to-resources-for-configuration-and-monitoring-objects]]
-REST URLs to Resources for Configuration and Monitoring Objects
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== REST URLs to Resources for Configuration and Monitoring Objects
The formats of the URLs to resources that represent objects in the
configuration and monitoring object trees are as follows:
@@ -1272,8 +1237,7 @@
[[gkwib]][[GSADG00635]][[rest-urls-for-accessing-the-log-file]]
-REST URLs for Accessing the Log File
-++++++++++++++++++++++++++++++++++++
+===== REST URLs for Accessing the Log File
The `server.log` file of the DAS is represented as a child that is named
`view-log` of the resource for managing the domain. A child of the
@@ -1310,8 +1274,7 @@
[[gjijx]][[GSADG00708]][[using-rest-resource-methods-to-administer-glassfish-server]]
-Using REST Resource Methods to Administer GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using REST Resource Methods to Administer GlassFish Server
The GlassFish Server REST interfaces support methods for accessing
objects in the monitoring and configuration object trees.
@@ -1360,8 +1323,7 @@
[[gjjei]][[GSADG00324]][[to-determine-the-methods-and-method-parameters-that-an-object-in-the-tree-supports]]
-To Determine the Methods and Method Parameters That an Object in the Tree Supports
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Determine the Methods and Method Parameters That an Object in the Tree Supports
The methods and method parameters that an object in the tree supports
depend on the REST resource that represents the object:
@@ -1464,8 +1426,7 @@
[[gjjel]][[GSADG00325]][[to-retrieve-data-for-an-object-in-the-tree]]
-To Retrieve Data for an Object in the Tree
-++++++++++++++++++++++++++++++++++++++++++
+===== To Retrieve Data for an Object in the Tree
Retrieving data for an object in the tree obtains the following
information about the REST resource that represents the object:
@@ -1546,8 +1507,7 @@
[[gjjdv]][[GSADG00326]][[to-add-an-object-to-the-tree]]
-To Add an Object to the Tree
-++++++++++++++++++++++++++++
+===== To Add an Object to the Tree
1. Ensure that the server is running.
+
@@ -1663,8 +1623,7 @@
[[gjjgj]][[GSADG00327]][[to-update-an-object-in-the-tree]]
-To Update an Object in the Tree
-+++++++++++++++++++++++++++++++
+===== To Update an Object in the Tree
1. Ensure that the server is running.
Operations on REST resources for GlassFish Server data require a running server.
@@ -1784,8 +1743,7 @@
[[gjjgm]][[GSADG00328]][[to-delete-an-object-from-the-tree]]
-To Delete an Object From the Tree
-+++++++++++++++++++++++++++++++++
+===== To Delete an Object From the Tree
1. Ensure that the server is running.
+
@@ -1893,8 +1851,7 @@
[[gjjdg]][[GSADG00709]][[resources-for-asadmin-subcommands-that-perform-non-crud-operations]]
-Resources for `asadmin` Subcommands That Perform Non-CRUD Operations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Resources for `asadmin` Subcommands That Perform Non-CRUD Operations
The GlassFish Server REST interfaces also support operations other than
create, read, update, and delete (CRUD) operations, for example:
@@ -1918,8 +1875,7 @@
[[gjiut]][[GSADG00710]][[securing-glassfish-server-rest-interfaces]]
-Securing GlassFish Server REST Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Securing GlassFish Server REST Interfaces
The GlassFish Server REST interfaces support the following
authentication schemes for securing the REST interfaces:
@@ -1934,8 +1890,7 @@
[[setting-up-basic-authentication-over-a-secure-connection]]
-Setting Up Basic Authentication Over a Secure Connection
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Setting Up Basic Authentication Over a Secure Connection
Setting up basic authentication over a secure connection to secure
GlassFish Server REST interfaces involves the following sequence of
@@ -1962,8 +1917,7 @@
[[gkvtj]][[GSADG00329]][[to-secure-rest-interfaces-by-using-session-tokens]]
-To Secure REST Interfaces by Using Session Tokens
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Secure REST Interfaces by Using Session Tokens
Basic authentication requires a REST client to cache a user's
credentials to enable the client to pass the credentials with each
@@ -1992,8 +1946,7 @@
[[gjijz]][[GSADG00711]][[formats-for-resource-representation-of-configuration-objects]]
-Formats for Resource Representation of Configuration Objects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Formats for Resource Representation of Configuration Objects
The GlassFish Server REST interfaces represent resources for
configuration objects in the following formats:
@@ -2026,8 +1979,7 @@
[[gjiji]][[GSADG00636]][[json-resource-representation-for-configuration-objects]]
-JSON Resource Representation for Configuration Objects
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== JSON Resource Representation for Configuration Objects
The general format for the JSON representation of a resource for a
configuration object is as follows:
@@ -2236,8 +2188,7 @@
[[gkvzs]][[GSADG00637]][[xml-resource-representation-for-configuration-objects]]
-XML Resource Representation for Configuration Objects
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== XML Resource Representation for Configuration Objects
The general format for the XML representation of a resource for a
configuration object is as follows:
@@ -2539,8 +2490,7 @@
[[gjipm]][[GSADG00638]][[html-resource-representation-for-configuration-objects]]
-HTML Resource Representation for Configuration Objects
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== HTML Resource Representation for Configuration Objects
The format for the HTML representation of a resource for a configuration
object is a web page that provides the following information about the
@@ -2561,8 +2511,7 @@
[[gkwdd]][[GSADG00712]][[formats-for-resource-representation-of-monitoring-objects]]
-Formats for Resource Representation of Monitoring Objects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Formats for Resource Representation of Monitoring Objects
The GlassFish Server REST interfaces represent resources for monitoring
data in the following formats:
@@ -2573,8 +2522,7 @@
[[gkwgi]][[GSADG00639]][[json-resource-representation-for-monitoring-objects]]
-JSON Resource Representation for Monitoring Objects
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== JSON Resource Representation for Monitoring Objects
The general format for the JSON representation of a resource for a
monitoring object is as follows:
@@ -2758,8 +2706,7 @@
[[gkwew]][[GSADG00640]][[xml-resource-representation-for-monitoring-objects]]
-XML Resource Representation for Monitoring Objects
-++++++++++++++++++++++++++++++++++++++++++++++++++
+===== XML Resource Representation for Monitoring Objects
The general format for the XML representation of a resource for a
monitoring object is as follows:
@@ -3001,8 +2948,7 @@
[[gkwij]][[GSADG00641]][[html-resource-representation-for-monitoring-objects]]
-HTML Resource Representation for Monitoring Objects
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== HTML Resource Representation for Monitoring Objects
The format for the HTML representation of a resource for a monitoring
object is a web page that provides the following information about the
@@ -3026,8 +2972,7 @@
[[gkwid]][[GSADG00713]][[formats-for-resource-representation-of-log-file-details]]
-Formats for Resource Representation of Log File Details
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Formats for Resource Representation of Log File Details
The GlassFish Server REST interfaces represent resources for log file
details in the following formats:
@@ -3037,8 +2982,7 @@
[[gkwnp]][[GSADG00642]][[json-resource-representation-for-log-file-details]]
-JSON Resource Representation for Log File Details
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== JSON Resource Representation for Log File Details
The general format for the JSON representation of a resource for log
file details is as follows:
@@ -3161,8 +3105,7 @@
[[gkwmi]][[GSADG00643]][[xml-resource-representation-for-log-file-details]]
-XML Resource Representation for Log File Details
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== XML Resource Representation for Log File Details
The general format for the XML representation of a resource for log file
details is as follows:
@@ -3255,8 +3198,7 @@
[[gkwsq]][[GSADG00714]][[supported-content-types-in-requests-to-rest-resources]]
-Supported Content Types in Requests to REST Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Supported Content Types in Requests to REST Resources
The GlassFish Server REST interfaces support the following types in the
content-type header of a client request:
diff --git a/docs/administration-guide/src/main/jbake/content/http_https.adoc b/docs/administration-guide/src/main/jbake/content/http_https.adoc
index fab96ed..866e5fd 100644
--- a/docs/administration-guide/src/main/jbake/content/http_https.adoc
+++ b/docs/administration-guide/src/main/jbake/content/http_https.adoc
@@ -5,15 +5,13 @@
prev=connectors.html
~~~~~~
-Administering Internet Connectivity
-===================================
+= Administering Internet Connectivity
[[GSADG00017]][[ablsw]]
[[administering-internet-connectivity]]
-13 Administering Internet Connectivity
---------------------------------------
+== 13 Administering Internet Connectivity
This chapter provides procedures for performing internet connectivity
tasks in the GlassFish Server Open Source Edition 7 environment by
@@ -31,8 +29,7 @@
[[giusf]][[GSADG00587]][[about-internet-connectivity]]
-About Internet Connectivity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Internet Connectivity
The HTTP service provides functionality for deploying web applications
and for making deployed web applications accessible by Internet clients,
@@ -50,8 +47,7 @@
[[giuri]][[GSADG00766]][[about-http-network-listeners]]
-About HTTP Network Listeners
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== About HTTP Network Listeners
An HTTP listener, also known as a network listener, is a listen socket
that has an Internet Protocol (IP) address, a port number, a server
@@ -89,8 +85,7 @@
[[giupz]][[GSADG00767]][[about-virtual-servers]]
-About Virtual Servers
-^^^^^^^^^^^^^^^^^^^^^
+==== About Virtual Servers
A virtual server, sometimes called a virtual host, is an object that
allows the same physical server to host multiple Internet domain names.
@@ -132,8 +127,7 @@
[[ggnfu]][[GSADG00588]][[administering-http-network-listeners]]
-Administering HTTP Network Listeners
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering HTTP Network Listeners
By default, when GlassFish Server starts, the following HTTP listeners
are started automatically:
@@ -180,8 +174,7 @@
[[ggnfh]][[GSADG00456]][[to-create-an-internet-connection]]
-To Create an Internet Connection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Internet Connection
Use the subcommands in this procedure to create an internet connection
with the full range of listener options. A network listener is created
@@ -219,8 +212,7 @@
[[gjkuy]][[GSADG00768]][[administering-http-protocols]]
-Administering HTTP Protocols
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering HTTP Protocols
Each HTTP listener has an HTTP protocol, which is created either by
using the `create-protocol` subcommand or by using the built-in
@@ -235,8 +227,7 @@
[[gjhot]][[GSADG00457]][[to-create-a-protocol]]
-To Create a Protocol
-++++++++++++++++++++
+===== To Create a Protocol
Use the `create-protocol` subcommand in remote mode to create a
protocol.
@@ -267,8 +258,7 @@
[[gjhna]][[GSADG00458]][[to-list-protocols]]
-To List Protocols
-+++++++++++++++++
+===== To List Protocols
Use the `list-protocols` subcommand in remote mode to list the existing
HTTP protocols.
@@ -301,8 +291,7 @@
[[gjhnx]][[GSADG00459]][[to-delete-a-protocol]]
-To Delete a Protocol
-++++++++++++++++++++
+===== To Delete a Protocol
Use the `delete-protocol` subcommand in remote mode to remove a
protocol.
@@ -331,8 +320,7 @@
[[gjkzi]][[GSADG00769]][[administering-http-configurations]]
-Administering HTTP Configurations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering HTTP Configurations
Each HTTP listener has an HTTP configuration, which is created either by
using the `create-http` subcommand or by using the built-in
@@ -346,8 +334,7 @@
[[gjhqc]][[GSADG00460]][[to-create-an-http-configuration]]
-To Create an HTTP Configuration
-+++++++++++++++++++++++++++++++
+===== To Create an HTTP Configuration
Use the `create-http` subcommand in remote mode to create a set of HTTP
parameters for a protocol. This set of parameters configures one or more
@@ -380,8 +367,7 @@
[[gjhqa]][[GSADG00461]][[to-delete-an-http-configuration]]
-To Delete an HTTP Configuration
-+++++++++++++++++++++++++++++++
+===== To Delete an HTTP Configuration
Use the `delete-http` subcommand in remote mode to remove HTTP
parameters from a protocol.
@@ -410,8 +396,7 @@
[[gjkym]][[GSADG00770]][[administering-http-transports]]
-Administering HTTP Transports
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering HTTP Transports
Each HTTP listener has an HTTP transport, which is created either by
using the `create-transport` subcommand or by using the built-in
@@ -426,8 +411,7 @@
[[gjhps]][[GSADG00462]][[to-create-a-transport]]
-To Create a Transport
-+++++++++++++++++++++
+===== To Create a Transport
Use the `create-transport` subcommand in remote mode to create a
transport for a network listener,
@@ -458,8 +442,7 @@
[[gjhmx]][[GSADG00463]][[to-list-transports]]
-To List Transports
-++++++++++++++++++
+===== To List Transports
Use the `list-transports` subcommand in remote mode to list the existing
HTTP transports.
@@ -490,8 +473,7 @@
[[gjhqp]][[GSADG00464]][[to-delete-a-transport]]
-To Delete a Transport
-+++++++++++++++++++++
+===== To Delete a Transport
Use the `delete-transport` subcommand in remote mode to remove a
transport.
@@ -520,8 +502,7 @@
[[gjkwt]][[GSADG00771]][[administering-http-network-listeners-1]]
-Administering HTTP Network Listeners
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering HTTP Network Listeners
The following topics are addressed here:
@@ -537,8 +518,7 @@
[[gjimx]][[GSADG00465]][[to-create-an-http-network-listener]]
-To Create an HTTP Network Listener
-++++++++++++++++++++++++++++++++++
+===== To Create an HTTP Network Listener
Use the `create-http-listener` subcommand or the
`create-network-listener` subcommand in remote mode to create a
@@ -600,8 +580,7 @@
[[ggnbv]][[GSADG00466]][[to-list-http-network-listeners]]
-To List HTTP Network Listeners
-++++++++++++++++++++++++++++++
+===== To List HTTP Network Listeners
Use the `list-http-listeners` subcommand or the `list-network-listeners`
subcommand in remote mode to list the existing HTTP listeners.
@@ -636,8 +615,7 @@
[[giwls]][[GSADG00467]][[to-update-an-http-network-listener]]
-To Update an HTTP Network Listener
-++++++++++++++++++++++++++++++++++
+===== To Update an HTTP Network Listener
1. List HTTP listeners by using the
link:../reference-manual/list-http-listeners.html#GSRFM00168[`list-http-listeners`] or
@@ -660,8 +638,7 @@
[[ggndu]][[GSADG00468]][[to-delete-an-http-network-listener]]
-To Delete an HTTP Network Listener
-++++++++++++++++++++++++++++++++++
+===== To Delete an HTTP Network Listener
Use the `delete-http-listener` subcommand or the
`delete-network-listener` subcommand in remote mode to delete an
@@ -699,8 +676,7 @@
[[ggnbj]][[GSADG00469]][[to-configure-an-http-listener-for-ssl]]
-To Configure an HTTP Listener for SSL
-+++++++++++++++++++++++++++++++++++++
+===== To Configure an HTTP Listener for SSL
Use the `create-ssl` subcommand in remote mode to create and configure
an SSL element in the specified listener. This enables secure
@@ -733,8 +709,7 @@
[[CHDEDCEA]][[GSADG1106]][[to-configure-optional-client-authentication-for-ssl]]
-To Configure Optional Client Authentication for SSL
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Configure Optional Client Authentication for SSL
In GlassFish Server, you can configure the SSL protocol of an HTTP
listener such that it requests a certificate before permitting a client
@@ -750,8 +725,7 @@
[[CHDHEFHG]][[GSADG1107]][[to-configure-a-custom-ssl-implementation]]
-To Configure a Custom SSL Implementation
-++++++++++++++++++++++++++++++++++++++++
+===== To Configure a Custom SSL Implementation
In GlassFish Server, you can configure the SSL protocol an HTTP listener
such that it uses a custom implementation of SSL. To enable this
@@ -770,8 +744,7 @@
[[ggncl]][[GSADG00470]][[to-delete-ssl-from-an-http-listener]]
-To Delete SSL From an HTTP Listener
-+++++++++++++++++++++++++++++++++++
+===== To Delete SSL From an HTTP Listener
Use the `delete-ssl` subcommand in remote mode to delete the SSL element
in the specified listener. This disables secure communications for the
@@ -804,8 +777,7 @@
[[gixjb]][[GSADG00471]][[to-assign-a-default-virtual-server-to-an-http-listener]]
-To Assign a Default Virtual Server to an HTTP Listener
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Assign a Default Virtual Server to an HTTP Listener
1. In the Administration Console, open the HTTP Service component under
the relevant configuration.
@@ -825,8 +797,7 @@
[[ggncs]][[GSADG00589]][[administering-virtual-servers]]
-Administering Virtual Servers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Virtual Servers
A virtual server is a virtual web server that serves content targeted
for a specific URL. Multiple virtual servers can serve content using the
@@ -873,8 +844,7 @@
[[ggnfr]][[GSADG00472]][[to-create-a-virtual-server]]
-To Create a Virtual Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Virtual Server
By default, when GlassFish Server starts, the following virtual servers
are started automatically:
@@ -937,8 +907,7 @@
[[ggndw]][[GSADG00473]][[to-list-virtual-servers]]
-To List Virtual Servers
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Virtual Servers
Use the `list-virtual-servers` subcommand in remote mode to list the
existing virtual servers.
@@ -971,8 +940,7 @@
[[giwkp]][[GSADG00474]][[to-update-a-virtual-server]]
-To Update a Virtual Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Virtual Server
1. List virtual servers by using the
link:../reference-manual/list-virtual-servers.html#GSRFM00207[`list-virtual-servers`] subcommand.
@@ -983,8 +951,7 @@
[[ggnen]][[GSADG00475]][[to-delete-a-virtual-server]]
-To Delete a Virtual Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Virtual Server
Use the `delete-virtual-server` subcommand in remote mode to delete an
existing virtual server.
@@ -1020,8 +987,7 @@
[[beaga]][[GSADG00772]][[to-assign-a-default-web-module-to-a-virtual-server]]
-To Assign a Default Web Module to a Virtual Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Assign a Default Web Module to a Virtual Server
A default web module can be assigned to the default virtual server and
to each new virtual server. To access the default web module for a
@@ -1048,8 +1014,7 @@
[[gixku]][[GSADG00476]][[to-assign-a-virtual-server-to-an-application-or-module]]
-To Assign a Virtual Server to an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Assign a Virtual Server to an Application or Module
You can assign a virtual server to a deployed application or web module.
@@ -1074,8 +1039,7 @@
[[glavy]][[GSADG00477]][[to-set-jsessionidsso-cookie-attributes]]
-To Set `JSESSIONIDSSO` Cookie Attributes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set `JSESSIONIDSSO` Cookie Attributes
Use the `sso-cookie-http-only` and `sso-cookie-secure` virtual server
attributes to set the `HttpOnly` and `Secure` attributes of any
diff --git a/docs/administration-guide/src/main/jbake/content/javamail.adoc b/docs/administration-guide/src/main/jbake/content/javamail.adoc
index ab39139..17236bc 100644
--- a/docs/administration-guide/src/main/jbake/content/javamail.adoc
+++ b/docs/administration-guide/src/main/jbake/content/javamail.adoc
@@ -5,15 +5,13 @@
prev=orb.html
~~~~~~
-Administering the JavaMail Service
-==================================
+= Administering the JavaMail Service
[[GSADG00019]][[ablkr]]
[[administering-the-javamail-service]]
-16 Administering the JavaMail Service
--------------------------------------
+== 16 Administering the JavaMail Service
GlassFish Server includes the JavaMail API along with JavaMail service
providers that allow an application component to send email
@@ -31,8 +29,7 @@
[[ggjsf]][[GSADG00593]][[about-javamail]]
-About JavaMail
-~~~~~~~~~~~~~~
+=== About JavaMail
The JavaMail API is a set of abstract APIs that model a mail system. The
JavaMail API provides a platform-independent and protocol-independent
@@ -53,8 +50,7 @@
[[giowr]][[GSADG00594]][[administering-javamail-resources]]
-Administering JavaMail Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JavaMail Resources
When you create a mail session, the server-side components and
applications are enabled to access JavaMail services with JNDI, using
@@ -93,8 +89,7 @@
[[giowd]][[GSADG00482]][[to-create-a-javamail-resource]]
-To Create a JavaMail Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a JavaMail Resource
Use the `create-javamail-resource` subcommand in remote mode to create a
JavaMail session resource. The JNDI name for a JavaMail session resource
@@ -134,8 +129,7 @@
[[giowq]][[GSADG00483]][[to-list-javamail-resources]]
-To List JavaMail Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List JavaMail Resources
Use the `list-javamail-resources` subcommand in remote mode to list the
existing JavaMail session resources.
@@ -165,8 +159,7 @@
[[giwjw]][[GSADG00484]][[to-update-a-javamail-resource]]
-To Update a JavaMail Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a JavaMail Resource
1. List the JavaMail resources by using the
link:../reference-manual/list-javamail-resources.html#GSRFM00172[`list-javamail-resources`] subcommand.
@@ -190,8 +183,7 @@
[[gioxj]][[GSADG00485]][[to-delete-a-javamail-resource]]
-To Delete a JavaMail Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a JavaMail Resource
Use the `delete-javamail-resource` subcommands in remote mode to delete
a JavaMail session resource.
diff --git a/docs/administration-guide/src/main/jbake/content/jdbc.adoc b/docs/administration-guide/src/main/jbake/content/jdbc.adoc
index b1b2abc..cf3e60c 100644
--- a/docs/administration-guide/src/main/jbake/content/jdbc.adoc
+++ b/docs/administration-guide/src/main/jbake/content/jdbc.adoc
@@ -5,15 +5,13 @@
prev=part-res-and-svcs-admin.html
~~~~~~
-Administering Database Connectivity
-===================================
+= Administering Database Connectivity
[[GSADG00015]][[ablih]]
[[administering-database-connectivity]]
-11 Administering Database Connectivity
---------------------------------------
+== 11 Administering Database Connectivity
This chapter provides procedures for performing database connectivity
tasks in the GlassFish Server Open Source Edition 7 environment by
@@ -31,8 +29,7 @@
[[gipbp]][[GSADG00576]][[about-database-connectivity]]
-About Database Connectivity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Database Connectivity
A database management system (DBMS) provides facilities for storing,
organizing, and retrieving data. The information in databases is often
@@ -90,8 +87,7 @@
[[ggkon]][[GSADG00577]][[setting-up-the-database]]
-Setting Up the Database
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up the Database
Most applications use relational databases to store, organize, and
retrieve data. Applications access relational databases through the Java
@@ -106,8 +102,7 @@
[[gharl]][[GSADG00416]][[to-install-the-database-and-database-driver]]
-To Install the Database and Database Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Install the Database and Database Driver
1. Install a supported database product.
+
@@ -142,8 +137,7 @@
[[ggndz]][[GSADG00417]][[to-start-the-database]]
-To Start the Database
-^^^^^^^^^^^^^^^^^^^^^
+==== To Start the Database
GlassFish Server includes an implementation of the Apache Derby
database, however, you can use any JDBC-compliant database. The database
@@ -183,8 +177,7 @@
[[ggnbw]][[GSADG00418]][[to-stop-the-database]]
-To Stop the Database
-^^^^^^^^^^^^^^^^^^^^
+==== To Stop the Database
Use the local `stop-database` subcommand to stop the Apache Derby
database on a specified port. A single host can have multiple database
@@ -232,8 +225,7 @@
[[ghmbq]][[GSADG00744]][[apache-derby-database-utility-scripts]]
-Apache Derby Database Utility Scripts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Apache Derby Database Utility Scripts
The Apache Derby database configuration that is available for use with
GlassFish Server includes scripts that can help you use the Apache Derby
@@ -256,8 +248,7 @@
[[ghmbj]][[GSADG00419]][[to-configure-your-environment-to-run-the-apache-derby-database-utility-scripts]]
-To Configure Your Environment to Run the Apache Derby Database Utility Scripts
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Configure Your Environment to Run the Apache Derby Database Utility Scripts
1. Ensure that the `JAVA_HOME` environment variable specifies the
directory where the JDK is installed.
@@ -278,8 +269,7 @@
[[ggndx]][[GSADG00578]][[configuring-access-to-the-database]]
-Configuring Access to the Database
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Access to the Database
After establishing the database, you are ready to set up access for
GlassFish Server applications. The high-level steps include creating a
@@ -297,8 +287,7 @@
[[gharo]][[GSADG00745]][[administering-jdbc-connection-pools]]
-Administering JDBC Connection Pools
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering JDBC Connection Pools
A JDBC connection pool is a group of reusable connections for a
particular database. Because creating each new physical connection is
@@ -330,8 +319,7 @@
[[ggnfv]][[GSADG00420]][[to-create-a-jdbc-connection-pool]]
-To Create a JDBC Connection Pool
-++++++++++++++++++++++++++++++++
+===== To Create a JDBC Connection Pool
Use the `create-jdbc-connection-pool` subcommand in remote mode to
register a new JDBC connection pool with the specified JDBC connection
@@ -401,8 +389,7 @@
[[ggnby]][[GSADG00421]][[to-list-jdbc-connection-pools]]
-To List JDBC Connection Pools
-+++++++++++++++++++++++++++++
+===== To List JDBC Connection Pools
Use the `list-jdbc-connection-pools` subcommand in remote mode to list
all existing JDBC connection pools.
@@ -436,8 +423,7 @@
[[ggnwn]][[GSADG00422]][[to-contact-ping-a-connection-pool]]
-To Contact (Ping) a Connection Pool
-+++++++++++++++++++++++++++++++++++
+===== To Contact (Ping) a Connection Pool
Use the `ping-connection-pool` subcommand in remote mode to test if a
connection pool is usable. For example, if you create a new JDBC
@@ -482,8 +468,7 @@
[[gjiqp]][[GSADG00423]][[to-reset-flush-a-connection-pool]]
-To Reset (Flush) a Connection Pool
-++++++++++++++++++++++++++++++++++
+===== To Reset (Flush) a Connection Pool
Use the `flush-connection-pool` in remote mode to reinitialize all
connections established in the specified connection pool without the
@@ -520,8 +505,7 @@
[[giosk]][[GSADG00424]][[to-update-a-jdbc-connection-pool]]
-To Update a JDBC Connection Pool
-++++++++++++++++++++++++++++++++
+===== To Update a JDBC Connection Pool
You can change all of the settings for an existing pool except its name.
Use the `get` and `set` subcommands to view and change the values of the
@@ -562,8 +546,7 @@
[[ggngb]][[GSADG00425]][[to-delete-a-jdbc-connection-pool]]
-To Delete a JDBC Connection Pool
-++++++++++++++++++++++++++++++++
+===== To Delete a JDBC Connection Pool
Use the `delete-jdbc-connection-pool` subcommand in remote mode to
delete an existing JDBC connection pool. Deleting a JDBC connection pool
@@ -604,8 +587,7 @@
[[gktdi]][[GSADG00670]][[configuring-specific-jdbc-connection-pool-features]]
-Configuring Specific JDBC Connection Pool Features
-++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuring Specific JDBC Connection Pool Features
In GlassFish Server, JDBC Connection Pools support a variety of features
to simplify administration, monitoring and performance tuning. The
@@ -865,8 +847,7 @@
[[ggndp]][[GSADG00746]][[administering-jdbc-resources]]
-Administering JDBC Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering JDBC Resources
A JDBC resource, also known as a data source, provides an application
with a means of connecting to a database. Typically, you create a JDBC
@@ -902,8 +883,7 @@
[[ggnda]][[GSADG00426]][[to-create-a-jdbc-resource]]
-To Create a JDBC Resource
-+++++++++++++++++++++++++
+===== To Create a JDBC Resource
Use the `create-jdbc-resource` subcommand in remote mode to create a
JDBC resource. Creating a JDBC resource is a dynamic event and does not
@@ -950,8 +930,7 @@
[[ggnhl]][[GSADG00427]][[to-list-jdbc-resources]]
-To List JDBC Resources
-++++++++++++++++++++++
+===== To List JDBC Resources
Use the `list-jdbc-resources` subcommand in remote mode to list the
existing JDBC resources.
@@ -984,8 +963,7 @@
[[giwjv]][[GSADG00428]][[to-update-a-jdbc-resource]]
-To Update a JDBC Resource
-+++++++++++++++++++++++++
+===== To Update a JDBC Resource
You can enable or disable a JDBC resource by using the `set` subcommand.
The JDBC resource is identified by its dotted name.
@@ -1009,8 +987,7 @@
[[ggnhz]][[GSADG00429]][[to-delete-a-jdbc-resource]]
-To Delete a JDBC Resource
-+++++++++++++++++++++++++
+===== To Delete a JDBC Resource
Use the `delete-jdbc-resource` subcommand in remote mode to delete an
existing JDBC resource. Deleting a JDBC resource is a dynamic event and
@@ -1050,8 +1027,7 @@
[[gkudf]][[GSADG00747]][[enabling-the-jdbc__default-resource-in-a-clustered-environment]]
-Enabling the `jdbc/__default` Resource in a Clustered Environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enabling the `jdbc/__default` Resource in a Clustered Environment
GlassFish Server 7 includes a preconfigured JDBC resource with the
JNDI name `jdbc/__default`. This `jdbc/__default` resource is not
@@ -1060,8 +1036,7 @@
[[gkubj]][[GSADG00430]][[to-enable-the-jdbc__default-resource-for-a-clustered-environment]]
-To Enable the `jdbc/__default` Resource for a Clustered Environment
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Enable the `jdbc/__default` Resource for a Clustered Environment
Instructions for creating JDBC resources in general are provided in
link:#ggnda[To Create a JDBC Resource]. Use the following procedure to
@@ -1093,8 +1068,7 @@
[[ghatb]][[GSADG00748]][[integrating-the-jdbc-driver]]
-Integrating the JDBC Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Integrating the JDBC Driver
To use JDBC features, you must choose a JDBC driver to work with the
GlassFish Server, then you must set up the driver. This section covers
@@ -1106,8 +1080,7 @@
[[gkpdj]][[GSADG00671]][[supported-database-drivers]]
-Supported Database Drivers
-++++++++++++++++++++++++++
+===== Supported Database Drivers
Supported JDBC drivers are those that have been fully tested by Oracle.
For a list of the JDBC drivers currently supported by the GlassFish
@@ -1127,8 +1100,7 @@
[[gkpci]][[GSADG00672]][[making-the-jdbc-driver-jar-files-accessible]]
-Making the JDBC Driver JAR Files Accessible
-+++++++++++++++++++++++++++++++++++++++++++
+===== Making the JDBC Driver JAR Files Accessible
To integrate the JDBC driver into a GlassFish Server domain, copy the
JAR files into the domain-dir`/lib` directory, then restart the server.
@@ -1145,8 +1117,7 @@
[[gkpfj]][[GSADG00673]][[automatic-detection-of-installed-drivers]]
-Automatic Detection of Installed Drivers
-++++++++++++++++++++++++++++++++++++++++
+===== Automatic Detection of Installed Drivers
The Administration Console detects installed JDBC Drivers automatically
when you create a JDBC connection pool. To create a JDBC connection pool
@@ -1164,8 +1135,7 @@
[[beamw]][[GSADG00579]][[configuration-specifics-for-jdbc-drivers]]
-Configuration Specifics for JDBC Drivers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuration Specifics for JDBC Drivers
GlassFish Server is designed to support connectivity to any database
management system by using a corresponding JDBC driver. Configuration
@@ -1192,8 +1162,7 @@
[[beanc]][[GSADG00749]][[ibm-db2-database-type-2-driver]]
-IBM DB2 Database Type 2 Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== IBM DB2 Database Type 2 Driver
The JAR files for the DB2 driver are `db2jcc.jar`,
`db2jcc_license_cu.jar`, and `db2java.zip`. Set your environment
@@ -1229,8 +1198,7 @@
[[glhim]][[GSADG00750]][[ibm-db2-database-type-4-driver]]
-IBM DB2 Database Type 4 Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== IBM DB2 Database Type 4 Driver
The JAR file for the DB2 driver is `db2jcc.jar`. Configure the
connection pool using the following settings:
@@ -1251,8 +1219,7 @@
[[beamx]][[GSADG00751]][[apache-derby-dbderby-type-4-driver]]
-Apache Derby DB/Derby Type 4 Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Apache Derby DB/Derby Type 4 Driver
The Apache Derby DB/Derby JDBC driver is included with GlassFish Server
by default, so you do not need to integrate this JDBC driver with
@@ -1295,8 +1262,7 @@
[[gbsor]][[GSADG00752]][[mysql-server-database-type-4-driver]]
-MySQL Server Database Type 4 Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== MySQL Server Database Type 4 Driver
The JAR file for the MySQL driver is
`mysql-connector-java-5.1.14-bin.jar`. Configure the connection pool
@@ -1327,8 +1293,7 @@
[[beani]][[GSADG00753]][[oracle-10-database-driver]]
-Oracle 10 Database Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Oracle 10 Database Driver
The JAR file for the Oracle 10 database driver is `ojdbc14.jar`. Make
sure that the shared library is available through `LD_LIBRARY_PATH` and
@@ -1362,8 +1327,7 @@
[[beanh]][[GSADG00754]][[oracle-11-database-driver]]
-Oracle 11 Database Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Oracle 11 Database Driver
The JAR file for the Oracle 11 database driver is `ojdbc6.jar`.
@@ -1417,8 +1381,7 @@
[[gjksj]][[GSADG00755]][[postgresql-type-4-driver]]
-PostgreSQL Type 4 Driver
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== PostgreSQL Type 4 Driver
The JAR file for the PostgreSQL driver is
`postgresql-9.0-801.jdbc4.jar`. Configure the connection pool using the
@@ -1443,8 +1406,7 @@
[[beamy]][[GSADG00756]][[datadirect-type-4-driver-for-ibm-db2-database]]
-DataDirect Type 4 Driver for IBM DB2 Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for IBM DB2 Database
The JAR file for DataDirect driver is `db2.jar`. Configure the
connection pool using the following settings:
@@ -1468,8 +1430,7 @@
[[beanj]][[GSADG00757]][[datadirect-type-4-driver-for-ibm-informix]]
-DataDirect Type 4 Driver for IBM Informix
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for IBM Informix
Configure the connection pool using the following settings:
@@ -1502,8 +1463,7 @@
[[beana]][[GSADG00758]][[datadirect-type-4-driver-for-microsoft-sql-server-database]]
-DataDirect Type 4 Driver for Microsoft SQL Server Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for Microsoft SQL Server Database
The JAR file for the DataDirect driver is `sqlserver.jar`. Configure the
connection pool using the following settings:
@@ -1527,8 +1487,7 @@
[[gjksd]][[GSADG00759]][[datadirect-type-4-driver-for-mysql-server-database]]
-DataDirect Type 4 Driver for MySQL Server Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for MySQL Server Database
The JAR file for the DataDirect driver is `mysql.jar`. Configure the
connection pool using the following settings:
@@ -1552,8 +1511,7 @@
[[beamz]][[GSADG00760]][[datadirect-type-4-driver-for-oracle-11-database]]
-DataDirect Type 4 Driver for Oracle 11 Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for Oracle 11 Database
The JAR file for the DataDirect driver is `oracle.jar`.
@@ -1584,8 +1542,7 @@
[[beanb]][[GSADG00761]][[datadirect-type-4-driver-for-sybase-database]]
-DataDirect Type 4 Driver for Sybase Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== DataDirect Type 4 Driver for Sybase Database
The JAR file for the DataDirect driver is `sybase.jar`. Configure the
connection pool using the following settings:
@@ -1619,8 +1576,7 @@
[[beane]][[GSADG00762]][[inet-oraxo-driver-for-oracle-database]]
-Inet Oraxo Driver for Oracle Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Inet Oraxo Driver for Oracle Database
The JAR file for the Inet Oracle driver is `Oranxo.jar`. Configure the
connection pool using the following settings:
@@ -1662,8 +1618,7 @@
[[beanf]][[GSADG00763]][[inet-merlia-driver-for-microsoft-sql-server-database]]
-Inet Merlia Driver for Microsoft SQL Server Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Inet Merlia Driver for Microsoft SQL Server Database
The JAR file for the Inet Microsoft SQL Server driver is `Merlia.jar`.
Configure the connection pool using the following settings:
@@ -1685,8 +1640,7 @@
[[beang]][[GSADG00764]][[inet-sybelux-driver-for-sybase-database]]
-Inet Sybelux Driver for Sybase Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Inet Sybelux Driver for Sybase Database
The JAR file for the Inet Sybase driver is `Sybelux.jar`. Configure the
connection pool using the following settings:
@@ -1711,8 +1665,7 @@
[[beand]][[GSADG00765]][[jconnect-type-4-driver-for-sybase-ase-12.5-database]]
-JConnect Type 4 Driver for Sybase ASE 12.5 Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== JConnect Type 4 Driver for Sybase ASE 12.5 Database
The JAR file for the Sybase driver is `jconn4.jar`. Configure the
connection pool using the following settings:
diff --git a/docs/administration-guide/src/main/jbake/content/jms.adoc b/docs/administration-guide/src/main/jbake/content/jms.adoc
index 21471bc..6ee1397 100644
--- a/docs/administration-guide/src/main/jbake/content/jms.adoc
+++ b/docs/administration-guide/src/main/jbake/content/jms.adoc
@@ -5,15 +5,13 @@
prev=javamail.html
~~~~~~
-Administering the Java Message Service (JMS)
-============================================
+= Administering the Java Message Service (JMS)
[[GSADG00020]][[abljw]]
[[administering-the-java-message-service-jms]]
-17 Administering the Java Message Service (JMS)
------------------------------------------------
+== 17 Administering the Java Message Service (JMS)
The Java Message Service (JMS) API is a messaging standard that allows
Jakarta EE applications and components, including message-driven beans
@@ -56,8 +54,7 @@
[[gipit]][[GSADG00595]][[about-the-jms-service]]
-About the JMS Service
-~~~~~~~~~~~~~~~~~~~~~
+=== About the JMS Service
To support JMS messaging, the JMS Service provides the following
administrative objects:
@@ -104,8 +101,7 @@
[[gavqn]][[GSADG00773]][[jms-service-high-availability]]
-JMS Service High Availability
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== JMS Service High Availability
Just as GlassFish Server supports clusters of instances to provide high
availability, Message Queue supports clusters of brokers to provide
@@ -126,8 +122,7 @@
[[beaof]][[GSADG00596]][[updating-the-jms-service-configuration]]
-Updating the JMS Service Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Updating the JMS Service Configuration
Because the JMS service configuration is part of the overall
configuration for a standalone instance or cluster, it is created when
@@ -207,8 +202,7 @@
[[gkxgf]][[GSADG00774]][[setting-message-queue-broker-properties-in-the-jms-service-configuration]]
-Setting Message Queue Broker Properties in the JMS Service Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting Message Queue Broker Properties in the JMS Service Configuration
You can specify any Message Queue broker property in the JMS service
configuration by adding it by name to the Additional Properties table on
@@ -236,8 +230,7 @@
[[gipbg]][[GSADG00597]][[administering-jms-hosts]]
-Administering JMS Hosts
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JMS Hosts
A JMS host represents a Message Queue broker. JMS contains a JMS hosts
list (the `AddressList` property) that contains all the JMS hosts that
@@ -263,8 +256,7 @@
[[giplw]][[GSADG00775]][[about-jms-host-types]]
-About JMS Host Types
-^^^^^^^^^^^^^^^^^^^^
+==== About JMS Host Types
The JMS service uses Message Queue (MQ) brokers as JMS hosts,
integrating them in three ways:
@@ -308,8 +300,7 @@
[[gktfb]][[GSADG00776]][[configuring-embedded-and-local-jms-hosts]]
-Configuring Embedded and Local JMS Hosts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Embedded and Local JMS Hosts
Because the JMS service, not Message Queue, manages Embedded and Local
JMS hosts automatically, you should avoid using Message Queue utilities
@@ -355,8 +346,7 @@
[[gipbh]][[GSADG00486]][[to-create-a-jms-host]]
-To Create a JMS Host
-^^^^^^^^^^^^^^^^^^^^
+==== To Create a JMS Host
The default JMS service configuration includes a JMS host,
`default_JMS_host`. For most situations, this host is sufficient, so
@@ -436,8 +426,7 @@
[[gipbz]][[GSADG00487]][[to-list-jms-hosts]]
-To List JMS Hosts
-^^^^^^^^^^^^^^^^^
+==== To List JMS Hosts
Use the `list-jms-hosts` subcommand in remote `asadmin` mode to list the
existing JMS hosts.
@@ -463,8 +452,7 @@
[[givno]][[GSADG00488]][[to-update-a-jms-host]]
-To Update a JMS Host
-^^^^^^^^^^^^^^^^^^^^
+==== To Update a JMS Host
Use the `set` subcommand in remote `asadmin` mode to update an existing
JMS host.
@@ -529,8 +517,7 @@
[[gipbv]][[GSADG00489]][[to-delete-a-jms-host]]
-To Delete a JMS Host
-^^^^^^^^^^^^^^^^^^^^
+==== To Delete a JMS Host
Use the `delete-jms-host` subcommand in remote `asadmin` mode to delete
a JMS host from the JMS service. If you delete the only JMS host, the
@@ -564,8 +551,7 @@
[[ablkb]][[GSADG00598]][[administering-jms-connection-factories-and-destinations]]
-Administering JMS Connection Factories and Destinations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JMS Connection Factories and Destinations
The JMS API uses two kinds of administered objects. Connection factory
objects allow an application to create other JMS objects
@@ -625,8 +611,7 @@
[[giotd]][[GSADG00490]][[to-create-a-connection-factory-or-destination-resource]]
-To Create a Connection Factory or Destination Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Connection Factory or Destination Resource
For each JMS connection factory that you create, GlassFish Server
creates a connector connection pool and connector resource. For each JMS
@@ -712,8 +697,7 @@
[[giosx]][[GSADG00491]][[to-list-jms-resources]]
-To List JMS Resources
-^^^^^^^^^^^^^^^^^^^^^
+==== To List JMS Resources
Use the `list-jms-resources` subcommand in remote `asadmin` mode to list
the existing connection factory and destination resources.
@@ -762,8 +746,7 @@
[[giouw]][[GSADG00492]][[to-delete-a-connection-factory-or-destination-resource]]
-To Delete a Connection Factory or Destination Resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Connection Factory or Destination Resource
Use the `delete-jms-resource` subcommand in remote `asadmin` mode to
remove the specified connection factory or destination resource.
@@ -803,8 +786,7 @@
[[ablkj]][[GSADG00599]][[administering-jms-physical-destinations]]
-Administering JMS Physical Destinations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JMS Physical Destinations
Messages are delivered for routing and delivery to consumers by using
physical destinations in the JMS provider. A physical destination is
@@ -836,8 +818,7 @@
[[gioue]][[GSADG00493]][[to-create-a-jms-physical-destination]]
-To Create a JMS Physical Destination
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a JMS Physical Destination
For production purposes, always create physical destinations. During the
development and testing phase, however, this step is not required. Use
@@ -885,8 +866,7 @@
[[gioyp]][[GSADG00494]][[to-list-jms-physical-destinations]]
-To List JMS Physical Destinations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List JMS Physical Destinations
Use the `list-jmsdest` subcommand in remote `asadmin` mode to list the
existing JMS physical destinations.
@@ -920,8 +900,7 @@
[[giowx]][[GSADG00495]][[to-purge-messages-from-a-physical-destination]]
-To Purge Messages From a Physical Destination
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Purge Messages From a Physical Destination
Use the `flush-jmsdest` subcommand in remote `asadmin` mode to purge the
messages from a physical destination in the specified target's JMS
@@ -959,8 +938,7 @@
[[giouv]][[GSADG00496]][[to-delete-a-jms-physical-destination]]
-To Delete a JMS Physical Destination
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a JMS Physical Destination
Use the `delete-jmsdest` subcommand in remote `asadmin` mode to remove
the specified JMS physical destination.
@@ -993,8 +971,7 @@
[[gkxgk]][[GSADG00600]][[special-situations-when-using-the-jms-service]]
-Special Situations When Using the JMS Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Special Situations When Using the JMS Service
As mentioned earlier, Message Queue, through the built-in `jmsra`
resource adapter, is tightly integrated with GlassFish Server to provide
@@ -1043,8 +1020,7 @@
[[gipnh]][[GSADG00601]][[troubleshooting-the-jms-service]]
-Troubleshooting the JMS Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Troubleshooting the JMS Service
If you encounter problems, consider the following:
@@ -1078,8 +1054,7 @@
[[gbtvg]][[GSADG00602]][[using-the-generic-resource-adapter-for-jms-to-integrate-supported-external-jms-providers]]
-Using the Generic Resource Adapter for JMS to Integrate Supported External JMS Providers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the Generic Resource Adapter for JMS to Integrate Supported External JMS Providers
GlassFish Server supports the integration and use of Oracle WebLogic JMS
and IBM WebSphere MQ JMS providers through the use of the Generic
@@ -1098,8 +1073,7 @@
[[gkkvc]][[GSADG00777]][[configuring-genericjmsra-for-supported-external-jms-providers]]
-Configuring GenericJMSRA for Supported External JMS Providers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring GenericJMSRA for Supported External JMS Providers
GenericJMSRA has three main properties that need to be configured:
`SupportXA`, `DeliveryType`, and `ProviderIntegrationMode`. The values
@@ -1127,8 +1101,7 @@
[[giosy]][[GSADG00497]][[to-deploy-and-configure-genericjmsra]]
-To Deploy and Configure GenericJMSRA
-++++++++++++++++++++++++++++++++++++
+===== To Deploy and Configure GenericJMSRA
Before deploying GenericJMSRA, JMS client libraries must be made
available to GlassFish Server. For some JMS providers, client libraries
@@ -1156,8 +1129,7 @@
[[gbtvu]][[GSADG00674]][[genericjmsra-configuration-properties]]
-GenericJMSRA Configuration Properties
-+++++++++++++++++++++++++++++++++++++
+===== GenericJMSRA Configuration Properties
The following table describes the properties that can be set to when
configuring the resource adapter.
@@ -1257,8 +1229,7 @@
[[gbtwu]][[GSADG00675]][[connection-factory-properties]]
-Connection Factory Properties
-+++++++++++++++++++++++++++++
+===== Connection Factory Properties
`ManagedConnectionFactory` properties are specified when a
`connector-connection-pool` is created. All the properties specified
@@ -1287,8 +1258,7 @@
[[gbtxa]][[GSADG00676]][[destination-properties]]
-Destination Properties
-++++++++++++++++++++++
+===== Destination Properties
Properties in this section are specified when a destination (queue or
topic) is created. All the resource adapter properties can be overridden
@@ -1312,8 +1282,7 @@
[[gbtvf]][[GSADG00677]][[activation-spec-properties]]
-Activation Spec Properties
-++++++++++++++++++++++++++
+===== Activation Spec Properties
Properties in this section are specified in the GlassFish Server
`glassfish-ejb-jar.xml` deployment descriptor of an MDB as
@@ -1404,8 +1373,7 @@
[[gkkuy]][[GSADG00778]][[using-genericjmsra-with-weblogic-jms]]
-Using GenericJMSRA with WebLogic JMS
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using GenericJMSRA with WebLogic JMS
You can configure GenericJMSRA to enable applications running in
GlassFish Server to send messages to, and receive messages from, Oracle
@@ -1434,8 +1402,7 @@
[[gkmeb]][[GSADG00678]][[deploy-the-weblogic-thin-t3-client-jar-in-glassfish-server]]
-Deploy the WebLogic Thin T3 Client JAR in GlassFish Server
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Deploy the WebLogic Thin T3 Client JAR in GlassFish Server
WebLogic Server provides several different clients for use by standalone
applications that run outside of WebLogic Server. These client are
@@ -1462,8 +1429,7 @@
[[gkmek]][[GSADG00679]][[configure-weblogic-jms-resources-for-integration]]
-Configure WebLogic JMS Resources for Integration
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configure WebLogic JMS Resources for Integration
If you need to configure the necessary WebLogic JMS resources on the
WebLogic Server from which you want to access messages using GlassFish
@@ -1489,8 +1455,7 @@
[[gkmee]][[GSADG00680]][[create-a-resource-adapter-configuration-for-genericjmsra-to-work-with-weblogic-jms]]
-Create a Resource Adapter Configuration for GenericJMSRA to Work With WebLogic JMS
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Create a Resource Adapter Configuration for GenericJMSRA to Work With WebLogic JMS
When you deploy GenericJMSRA, you also need to create a resource adapter
configuration in GlassFish Server. You can do this using either the
@@ -1558,8 +1523,7 @@
[[gkkxz]][[GSADG00498]][[deploy-the-genericjmsra-resource-archive]]
-Deploy the GenericJMSRA Resource Archive
-++++++++++++++++++++++++++++++++++++++++
+===== Deploy the GenericJMSRA Resource Archive
1. Download the GenericJMSRA resource archive (genericra.rar).
2. Deploy the resource adapter. You can do this using either the
@@ -1578,8 +1542,7 @@
[[gkkwq]][[GSADG00499]][[configuring-an-mdb-to-receive-messages-from-weblogic-jms]]
-Configuring an MDB to Receive Messages from WebLogic JMS
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuring an MDB to Receive Messages from WebLogic JMS
In this example, all configuration information is defined in two
deployment descriptor files: `ejb-jar.xml` and the GlassFish Server
@@ -1687,8 +1650,7 @@
[[gknjj]][[GSADG00500]][[accessing-connections-and-destinations-directly]]
-Accessing Connections and Destinations Directly
-+++++++++++++++++++++++++++++++++++++++++++++++
+===== Accessing Connections and Destinations Directly
When configuring a MDB to consume messages from WebLogic JMS your code
does not need to access the WebLogic JMS connection factory and
@@ -1833,8 +1795,7 @@
[[gkkvz]][[GSADG00681]][[limitations-when-using-genericjmsra-with-weblogic-jms]]
-Limitations When Using GenericJMSRA with WebLogic JMS
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Limitations When Using GenericJMSRA with WebLogic JMS
Due to the nature of the WebLogic T3 Thin Client there are a number of
limitations in the way in which it can be used with GenericJMSRA.
@@ -1960,8 +1921,7 @@
[[gktfi]][[GSADG00682]][[configuration-reference-of-genericjmsra-properties-for-weblogic-jms]]
-Configuration Reference of GenericJMSRA Properties for WebLogic JMS
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuration Reference of GenericJMSRA Properties for WebLogic JMS
The tables in this section list the properties that need to be set to
configure the resource adapter and any activation specs, managed
@@ -2128,8 +2088,7 @@
[[gkslb]][[GSADG00779]][[using-genericjmsra-with-ibm-websphere-mq]]
-Using GenericJMSRA with IBM WebSphere MQ
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using GenericJMSRA with IBM WebSphere MQ
You can configure GenericJMSRA to enable applications running in
GlassFish Server to send messages to, and receive messages from, IBM
@@ -2156,8 +2115,7 @@
[[gksiw]][[GSADG00683]][[preliminary-setup-procedures-for-websphere-mq-integration]]
-Preliminary Setup Procedures for WebSphere MQ Integration
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Preliminary Setup Procedures for WebSphere MQ Integration
Before you can configure WebSphere MQ to exchange messages with
GlassFish Server, you must complete the following tasks:
@@ -2238,8 +2196,7 @@
[[gksli]][[GSADG00501]][[configure-the-websphere-mq-administered-objects]]
-Configure the WebSphere MQ Administered Objects
-+++++++++++++++++++++++++++++++++++++++++++++++
+===== Configure the WebSphere MQ Administered Objects
This section provides an example of how you could configure the
necessary administered objects, such as destinations and connection
@@ -2366,8 +2323,7 @@
[[gksni]][[GSADG00684]][[create-a-resource-adapter-configuration-for-genericjmsra-to-work-with-websphere-mq]]
-Create a Resource Adapter Configuration for GenericJMSRA to Work With WebSphere MQ
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Create a Resource Adapter Configuration for GenericJMSRA to Work With WebSphere MQ
Before deploying GenericJMSRA, you need to create a resource adapter
configuration in GlassFish Server. You can do this using either the
@@ -2496,16 +2452,14 @@
[[gksnh]][[GSADG00685]][[deploy-the-genericjmsra-archive]]
-Deploy the GenericJMSRA Archive
-+++++++++++++++++++++++++++++++
+===== Deploy the GenericJMSRA Archive
For instructions on downloading and deploying GenericJMSRA, see
link:#gkkxz[Deploy the GenericJMSRA Resource Archive].
[[gkson]][[GSADG00686]][[create-the-connection-factories-and-administered-objects-in-glassfish-server]]
-Create the Connection Factories and Administered Objects in GlassFish Server
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Create the Connection Factories and Administered Objects in GlassFish Server
In order to configure a JMS Connection Factory using GenericJMSRA, a
Connector Connection Pool and resource needs to be created in GlassFish
@@ -2607,8 +2561,7 @@
[[gktmn]][[GSADG00687]][[configuring-an-mdb-to-receive-messages-from-websphere-mq]]
-Configuring an MDB to Receive Messages from WebSphere MQ
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuring an MDB to Receive Messages from WebSphere MQ
The administered object names in the sample deployment descriptor below
map to the example WebSphere MQ configuration in link:#gksli[Configure
diff --git a/docs/administration-guide/src/main/jbake/content/jndi.adoc b/docs/administration-guide/src/main/jbake/content/jndi.adoc
index cd5c09b..523a156 100644
--- a/docs/administration-guide/src/main/jbake/content/jndi.adoc
+++ b/docs/administration-guide/src/main/jbake/content/jndi.adoc
@@ -5,15 +5,13 @@
prev=jms.html
~~~~~~
-Administering the Java Naming and Directory Interface (JNDI) Service
-====================================================================
+= Administering the Java Naming and Directory Interface (JNDI) Service
[[GSADG00021]][[ablky]]
[[administering-the-java-naming-and-directory-interface-jndi-service]]
-18 Administering the Java Naming and Directory Interface (JNDI) Service
------------------------------------------------------------------------
+== 18 Administering the Java Naming and Directory Interface (JNDI) Service
The Java Naming and Directory Interface (JNDI) API is used for accessing
different kinds of naming and directory services. Jakarta EE components
@@ -30,8 +28,7 @@
[[ggjue]][[GSADG00603]][[about-jndi]]
-About JNDI
-~~~~~~~~~~
+=== About JNDI
By making calls to the JNDI API, applications locate resources and other
program objects. A resource is a program object that provides
@@ -54,8 +51,7 @@
[[abllb]][[GSADG00780]][[java-ee-naming-environment]]
-Jakarta EE Naming Environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Jakarta EE Naming Environment
JNDI names are bound to their objects by the naming and directory
service that is provided by a Jakarta EE server. Because Jakarta EE components
@@ -78,8 +74,7 @@
[[gglpg]][[GSADG00781]][[how-the-naming-environment-and-the-container-work-together]]
-How the Naming Environment and the Container Work Together
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How the Naming Environment and the Container Work Together
The application component's environment is used as follows:
@@ -107,8 +102,7 @@
[[abllc]][[GSADG00782]][[naming-references-and-binding-information]]
-Naming References and Binding Information
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Naming References and Binding Information
A resource reference is an element in a deployment descriptor that
identifies the component's coded name for the resource. For example,
@@ -155,8 +149,7 @@
[[gglpq]][[GSADG00604]][[administering-jndi-resources]]
-Administering JNDI Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JNDI Resources
Within GlassFish Server, you can configure your environment for custom
and external JNDI resources. A custom resource accesses a local JNDI
@@ -169,8 +162,7 @@
[[ablle]][[GSADG00783]][[administering-custom-jndi-resources]]
-Administering Custom JNDI Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering Custom JNDI Resources
A custom resource specifies a custom server-wide resource object factory
that implements the `javax.naming.spi.ObjectFactory` interface.
@@ -184,8 +176,7 @@
[[giowe]][[GSADG00503]][[to-create-a-custom-jndi-resource]]
-To Create a Custom JNDI Resource
-++++++++++++++++++++++++++++++++
+===== To Create a Custom JNDI Resource
Use the `create-custom-resource` subcommand in remote mode to create a
custom resource.
@@ -221,8 +212,7 @@
[[gioxb]][[GSADG00504]][[to-list-custom-jndi-resources]]
-To List Custom JNDI Resources
-+++++++++++++++++++++++++++++
+===== To List Custom JNDI Resources
Use the `list-custom-resources` subcommand in remote mode to list the
existing custom resources.
@@ -253,8 +243,7 @@
[[giwlk]][[GSADG00505]][[to-update-a-custom-jndi-resource]]
-To Update a Custom JNDI Resource
-++++++++++++++++++++++++++++++++
+===== To Update a Custom JNDI Resource
1. List the custom resources by using the
link:../reference-manual/list-custom-resources.html#GSRFM00162[`list-custom-resources`] subcommand.
@@ -275,8 +264,7 @@
[[gioxl]][[GSADG00506]][[to-delete-a-custom-jndi-resource]]
-To Delete a Custom JNDI Resource
-++++++++++++++++++++++++++++++++
+===== To Delete a Custom JNDI Resource
Use the `delete-custom-resource` subcommand in remote mode to delete a
custom resource.
@@ -307,8 +295,7 @@
[[gitxz]][[GSADG00784]][[administering-external-jndi-resources]]
-Administering External JNDI Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering External JNDI Resources
Applications running on GlassFish Server often require access to
resources stored in an external JNDI repository. For example, generic
@@ -328,8 +315,7 @@
[[gitxn]][[GSADG00507]][[to-register-an-external-jndi-resource]]
-To Register an External JNDI Resource
-+++++++++++++++++++++++++++++++++++++
+===== To Register an External JNDI Resource
Use the `create-jndi-resource` subcommand in remote mode to register an
external JNDI resource.
@@ -373,8 +359,7 @@
[[gitvj]][[GSADG00508]][[to-list-external-jndi-resources]]
-To List External JNDI Resources
-+++++++++++++++++++++++++++++++
+===== To List External JNDI Resources
Use the `list-jndi-resources` subcommand in remote mode to list all
existing JNDI resources.
@@ -406,8 +391,7 @@
[[gitwc]][[GSADG00509]][[to-list-external-jndi-entries]]
-To List External JNDI Entries
-+++++++++++++++++++++++++++++
+===== To List External JNDI Entries
Use the `list-jndi-entries` subcommand in remote mode to browse and list
the entries in the JNDI tree. You can either list all entries, or you
@@ -440,8 +424,7 @@
[[giwnr]][[GSADG00510]][[to-update-an-external-jndi-resource]]
-To Update an External JNDI Resource
-+++++++++++++++++++++++++++++++++++
+===== To Update an External JNDI Resource
1. List the existing JNDI resources by using
theolink:GSRFM00179[`list-jndi-resources`] subcommand.
@@ -461,8 +444,7 @@
[[gitvt]][[GSADG00511]][[to-delete-an-external-jndi-resource]]
-To Delete an External JNDI Resource
-+++++++++++++++++++++++++++++++++++
+===== To Delete an External JNDI Resource
Use the `delete-jndi-resource` subcommand in remote mode to remove a
JNDI resource.
@@ -491,8 +473,7 @@
[[abllk]][[GSADG00688]][[example-of-using-an-external-jndi-resource]]
-Example of Using an External JNDI Resource
-++++++++++++++++++++++++++++++++++++++++++
+===== Example of Using an External JNDI Resource
[source,xml]
----
@@ -520,8 +501,7 @@
[[gknaf]][[GSADG00512]][[to-disable-glassfish-server-v2-vendor-specific-jndi-names]]
-To Disable GlassFish Server v2 Vendor-Specific JNDI Names
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Disable GlassFish Server v2 Vendor-Specific JNDI Names
The EJB 3.1 specification supported by GlassFish Server 7 defines
portable EJB JNDI names. Because of this, there is less need to continue
diff --git a/docs/administration-guide/src/main/jbake/content/jvm.adoc b/docs/administration-guide/src/main/jbake/content/jvm.adoc
index dfa67d7..c582709 100644
--- a/docs/administration-guide/src/main/jbake/content/jvm.adoc
+++ b/docs/administration-guide/src/main/jbake/content/jvm.adoc
@@ -5,15 +5,13 @@
prev=domains.html
~~~~~~
-Administering the Virtual Machine for the Java Platform
-=======================================================
+= Administering the Virtual Machine for the Java Platform
[[GSADG00007]][[ablwj]]
[[administering-the-virtual-machine-for-the-java-platform]]
-4 Administering the Virtual Machine for the Java Platform
----------------------------------------------------------
+== 4 Administering the Virtual Machine for the Java Platform
This chapter provides procedures for administering the Virtual Machine
for the Java platform (Java Virtual Machine) or JVM machine) in the
@@ -30,8 +28,7 @@
[[gepzd]][[GSADG00544]][[administering-jvm-options]]
-Administering JVM Options
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JVM Options
The Java Virtual Machine is an interpretive computing engine responsible
for running the byte codes in a compiled Java program. The virtual
@@ -49,8 +46,7 @@
[[ggnes]][[GSADG00359]][[to-create-jvm-options]]
-To Create JVM Options
-^^^^^^^^^^^^^^^^^^^^^
+==== To Create JVM Options
Use the `create-jvm-options` subcommand in remote mode to create JVM
options in the Java configuration or the profiler elements of the
@@ -94,8 +90,7 @@
[[ggnce]][[GSADG00360]][[to-list-jvm-options]]
-To List JVM Options
-^^^^^^^^^^^^^^^^^^^
+==== To List JVM Options
Use the `list-jvm-options` subcommand in remote mode to list the
existing JVM options.
@@ -140,8 +135,7 @@
[[ggnfi]][[GSADG00361]][[to-delete-jvm-options]]
-To Delete JVM Options
-^^^^^^^^^^^^^^^^^^^^^
+==== To Delete JVM Options
Use the `delete-jvm-options` subcommand in remote mode to delete JVM
options from the Java configuration or profiler elements of the
@@ -194,8 +188,7 @@
[[ggnbu]][[GSADG00362]][[to-generate-a-jvm-report]]
-To Generate a JVM Report
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Generate a JVM Report
Use the `generate-jvm-report` subcommand in remote mode to generate a
JVM report showing the threads (dump of a stack trace), classes, memory,
@@ -245,8 +238,7 @@
[[ggnde]][[GSADG00545]][[administering-the-profiler]]
-Administering the Profiler
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering the Profiler
A profiler generates information used to analyze server performance.
@@ -257,8 +249,7 @@
[[ggneb]][[GSADG00363]][[to-create-a-profiler]]
-To Create a Profiler
-^^^^^^^^^^^^^^^^^^^^
+==== To Create a Profiler
A server instance is tied to a particular profiler by the profiler
element in the Java configuration. If JVM options are created for a
@@ -301,8 +292,7 @@
[[ggnem]][[GSADG00365]][[to-delete-a-profiler]]
-To Delete a Profiler
-^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Profiler
Use the `delete-profiler` subcommand in remote mode to delete the
profiler element from the Java configuration. You can then create a new
diff --git a/docs/administration-guide/src/main/jbake/content/lifecycle-modules.adoc b/docs/administration-guide/src/main/jbake/content/lifecycle-modules.adoc
index be20763..c01dbc2 100644
--- a/docs/administration-guide/src/main/jbake/content/lifecycle-modules.adoc
+++ b/docs/administration-guide/src/main/jbake/content/lifecycle-modules.adoc
@@ -5,15 +5,13 @@
prev=monitoring.html
~~~~~~
-Administering Life Cycle Modules
-================================
+= Administering Life Cycle Modules
[[GSADG00013]][[giury]]
[[administering-life-cycle-modules]]
-9 Administering Life Cycle Modules
-----------------------------------
+== 9 Administering Life Cycle Modules
This chapter provides procedures for administering life cycle modules in
the GlassFish Server Open Source Edition 7 environment.
@@ -29,8 +27,7 @@
[[giuxo]][[GSADG00566]][[about-life-cycle-modules]]
-About Life Cycle Modules
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Life Cycle Modules
Life cycle modules, also known as initialization services, provide a
means of running short or long duration Java-based tasks within the
@@ -70,8 +67,7 @@
[[giuue]][[GSADG00567]][[configuring-life-cycle-modules]]
-Configuring Life Cycle Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Life Cycle Modules
The following topics are addressed here:
@@ -82,8 +78,7 @@
[[giuus]][[GSADG00399]][[to-create-a-life-cycle-module]]
-To Create a Life Cycle Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Life Cycle Module
Use the `create-lifecycle-module` subcommand in remote mode to create a
life cycle module.
@@ -121,8 +116,7 @@
[[giuvh]][[GSADG00400]][[to-list-life-cycle-modules]]
-To List Life Cycle Modules
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Life Cycle Modules
Use the `list-lifecycle-modules` subcommand in remote mode to list the
existing life cycle modules.
@@ -152,8 +146,7 @@
[[giuyh]][[GSADG00401]][[to-update-a-life-cycle-module]]
-To Update a Life Cycle Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Life Cycle Module
Use the `set` subcommand to update an existing life cycle module.
@@ -203,8 +196,7 @@
[[giuux]][[GSADG00402]][[to-delete-a-life-cycle-module]]
-To Delete a Life Cycle Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Life Cycle Module
Use the `delete-lifecycle-module` subcommand in remote mode to delete a
life cycle module.
diff --git a/docs/administration-guide/src/main/jbake/content/loe.adoc b/docs/administration-guide/src/main/jbake/content/loe.adoc
index c3bc89f..d53fcec 100644
--- a/docs/administration-guide/src/main/jbake/content/loe.adoc
+++ b/docs/administration-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:overview.html#gkvay[1-1 Determining if the DAS Requires Restart]
* link:overview.html#gkvba[1-2 Determining if an Instance Requires
diff --git a/docs/administration-guide/src/main/jbake/content/lof.adoc b/docs/administration-guide/src/main/jbake/content/lof.adoc
index 240a5f7..7d69f97 100644
--- a/docs/administration-guide/src/main/jbake/content/lof.adoc
+++ b/docs/administration-guide/src/main/jbake/content/lof.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Figures
-===============
+= List of Figures
[[list-of-figures]]
-List of Figures
----------------
+== List of Figures
* link:general-administration.html#gjjce[2-1 Web Page for the REST
Resource for Managing a Domain]
diff --git a/docs/administration-guide/src/main/jbake/content/logging.adoc b/docs/administration-guide/src/main/jbake/content/logging.adoc
index 65b3dc9..43f7764 100644
--- a/docs/administration-guide/src/main/jbake/content/logging.adoc
+++ b/docs/administration-guide/src/main/jbake/content/logging.adoc
@@ -5,15 +5,13 @@
prev=webapps.html
~~~~~~
-Administering the Logging Service
-=================================
+= Administering the Logging Service
[[GSADG00010]][[abluj]]
[[administering-the-logging-service]]
-7 Administering the Logging Service
------------------------------------
+== 7 Administering the Logging Service
This chapter provides instructions on how to configure logging and how
to view log information in the GlassFish Server Open Source Edition 7 environment.
@@ -31,8 +29,7 @@
[[abluk]][[GSADG00554]][[about-logging]]
-About Logging
-~~~~~~~~~~~~~
+=== About Logging
Logging is the process by which GlassFish Server Open Source Edition
captures information about events that occur, such as configuration
@@ -56,8 +53,7 @@
[[ablul]][[GSADG00719]][[log-files]]
-Log Files
-^^^^^^^^^
+==== Log Files
GlassFish Server Open Source Edition log records are captured in the
server log file, which captures information about the operation of a server instance
@@ -73,8 +69,7 @@
[[gkmep]][[GSADG00644]][[log-file-names-and-locations]]
-Log File Names and Locations
-++++++++++++++++++++++++++++
+===== Log File Names and Locations
In an GlassFish Server Open Source Edition domain, log files have the
following name and location by default:
@@ -122,8 +117,7 @@
[[gkmex]][[GSADG00645]][[log-records]]
-Log Records
-+++++++++++
+===== Log Records
GlassFish Server Open Source Edition writes log records in either the
Oracle Diagnostics Logging (ODL) format or the Uniform Log Formatter
@@ -216,8 +210,7 @@
[[gkmdz]][[GSADG00646]][[log-rotation]]
-Log Rotation
-++++++++++++
+===== Log Rotation
By default, when a log file grows to 2 MB, GlassFish Server Open Source
Edition renames (rotates) the file to incorporate a timestamp and
@@ -230,8 +223,7 @@
[[gkres]][[GSADG00720]][[logger-namespaces]]
-Logger Namespaces
-^^^^^^^^^^^^^^^^^
+==== Logger Namespaces
GlassFish Server Open Source Edition provides a logger for each of its
modules. The following list is an example of the logger namespaces in a
@@ -290,8 +282,7 @@
[[gkjft]][[GSADG00721]][[logging-targets]]
-Logging Targets
-^^^^^^^^^^^^^^^
+==== Logging Targets
Each instance in an GlassFish Server Open Source Edition domain has a
dedicated log file, and each instance and cluster has its own logging
@@ -338,8 +329,7 @@
[[gkkit]][[GSADG00722]][[logging-properties]]
-Logging Properties
-^^^^^^^^^^^^^^^^^^
+==== Logging Properties
The DAS as well as each configuration, instance, and cluster has its own
set of logging properties that are maintained in individual
@@ -378,8 +368,7 @@
[[gklmn]][[GSADG00555]][[configuring-the-logging-service]]
-Configuring the Logging Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring the Logging Service
This section contains the following topics:
@@ -391,8 +380,7 @@
[[gklmx]][[GSADG00723]][[changing-the-name-and-location-of-logging-service-files]]
-Changing the Name and Location of Logging Service Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Changing the Name and Location of Logging Service Files
This section explains how to change the name and location of the
following logging service files:
@@ -402,8 +390,7 @@
[[gkmak]][[GSADG00375]][[to-change-the-name-and-location-of-the-log-file]]
-To Change the Name and Location of the Log File
-+++++++++++++++++++++++++++++++++++++++++++++++
+===== To Change the Name and Location of the Log File
To change the name and location of the log file, first use the
`list-log-attributes` subcommand to obtain the current log attribute
@@ -481,8 +468,7 @@
[[gkmcz]][[GSADG00376]][[to-change-the-name-and-location-of-the-logging-properties-file]]
-To Change the Name and Location of the Logging Properties File
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Change the Name and Location of the Logging Properties File
You can set the name and location of the logging properties file by
setting the `java.util.logging.config.file` system property. By setting
@@ -520,8 +506,7 @@
[[gklml]][[GSADG00724]][[setting-log-levels]]
-Setting Log Levels
-^^^^^^^^^^^^^^^^^^
+==== Setting Log Levels
The log level determines the granularity of the message that is logged,
from error only (`EMERGENCY`) to detailed debug (`FINEST`). The
@@ -559,8 +544,7 @@
[[gjirr]][[GSADG00377]][[to-list-log-levels]]
-To List Log Levels
-++++++++++++++++++
+===== To List Log Levels
GlassFish Server Open Source Edition provides the means to list all
loggers and their log levels. Listing the loggers provides a convenient
@@ -632,8 +616,7 @@
[[ghmep]][[GSADG00378]][[to-set-the-global-log-level]]
-To Set the Global Log Level
-+++++++++++++++++++++++++++
+===== To Set the Global Log Level
The global log level specifies the events that are logged across all
loggers. The default level for messages output to the console is `INFO`
@@ -687,8 +670,7 @@
[[ghmdu]][[GSADG00379]][[to-set-module-log-levels]]
-To Set Module Log Levels
-++++++++++++++++++++++++
+===== To Set Module Log Levels
A module log level specifies the events that are logged for a particular
logger. The default level for messages output to the console is `INFO`
@@ -767,8 +749,7 @@
[[CEGDJEBG]][[GSADG1062]][[setting-the-log-file-format]]
-Setting the Log File Format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting the Log File Format
You can set the format for log records in log files. The following
topics are addressed here:
@@ -779,8 +760,7 @@
[[CEGFFJDG]][[GSADG1063]][[to-set-the-log-file-format]]
-To Set the Log File Format
-++++++++++++++++++++++++++
+===== To Set the Log File Format
Use the `set-log-file-format` subcommand in remote mode to set the
formatter used by GlassFish Server Open Source Edition to format log
@@ -841,8 +821,7 @@
[[CEGGBJCC]][[GSADG1067]][[to-exclude-fields-in-log-records]]
-To Exclude Fields in Log Records
-++++++++++++++++++++++++++++++++
+===== To Exclude Fields in Log Records
Use the `set-log-attributes` subcommand in remote mode to exclude
specific name-value fields from log records. If the `excludeFields`
@@ -894,8 +873,7 @@
[[CEGBBEAH]][[GSADG1070]][[to-set-multiline-mode]]
-To Set Multiline Mode
-+++++++++++++++++++++
+===== To Set Multiline Mode
Use the `set-log-attributes` command in remote mode to set multiline
mode. When multiline mode is enabled (the default), the body of a log
@@ -939,8 +917,7 @@
[[gklni]][[GSADG00725]][[setting-log-file-rotation]]
-Setting Log File Rotation
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting Log File Rotation
As explained in link:#ablul[Log Files], GlassFish Server Open Source
Edition by default rotates log files when they reach 2 MB in size.
@@ -970,8 +947,7 @@
[[gkmbh]][[GSADG00380]][[to-change-the-rotation-file-size]]
-To Change the Rotation File Size
-++++++++++++++++++++++++++++++++
+===== To Change the Rotation File Size
Use the `set-log-attributes` subcommand in remote mode to change the log
rotation file size. The default target of this subcommand is the DAS.
@@ -1021,8 +997,7 @@
[[gkman]][[GSADG00381]][[to-change-the-file-rotation-interval]]
-To Change the File Rotation Interval
-++++++++++++++++++++++++++++++++++++
+===== To Change the File Rotation Interval
Use the `set-log-attributes` subcommand in remote mode to change the log
file rotation time limit interval. The default target of this subcommand
@@ -1078,8 +1053,7 @@
[[gkmai]][[GSADG00382]][[to-change-the-limit-number-of-retained-files]]
-To Change the Limit Number of Retained Files
-++++++++++++++++++++++++++++++++++++++++++++
+===== To Change the Limit Number of Retained Files
Use the `set-log-attributes` subcommand in remote mode to change the
limit on the number of log files that the server creates to store old
@@ -1135,8 +1109,7 @@
[[gkmau]][[GSADG00383]][[to-rotate-log-files-manually]]
-To Rotate Log Files Manually
-++++++++++++++++++++++++++++
+===== To Rotate Log Files Manually
You can rotate log files manually by using the `rotate-log` subcommand
in remote mode. The default target of this subcommand is the DAS.
@@ -1175,8 +1148,7 @@
[[gklnk]][[GSADG00726]][[adding-a-custom-logging-handler]]
-Adding a Custom Logging Handler
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding a Custom Logging Handler
By default, GlassFish Server Open Source Edition log records are
captured in a server log file using the format described in
@@ -1189,8 +1161,7 @@
[[ghmen]][[GSADG00384]][[to-add-a-custom-log-handler]]
-To Add a Custom Log Handler
-+++++++++++++++++++++++++++
+===== To Add a Custom Log Handler
A comma-separated list of log handlers is installed during startup of
the Java Virtual Machine (JVM) host. The default log handler that is
@@ -1266,8 +1237,7 @@
[[gkobx]][[GSADG00556]][[viewing-log-records]]
-Viewing Log Records
-~~~~~~~~~~~~~~~~~~~
+=== Viewing Log Records
The recommended means for general viewing of logging information is to
use the Log Viewer in the Administration Console. The Log Viewer
@@ -1283,8 +1253,7 @@
[[gklbi]][[GSADG00385]][[to-collect-log-files-into-a-zip-archive]]
-To Collect Log Files into a ZIP Archive
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Collect Log Files into a ZIP Archive
Use the `collect-log-files` subcommand in remote mode to collect log
files into a ZIP archive. The default target of this subcommand is the
@@ -1349,16 +1318,14 @@
[[CEGGHGIJ]][[GSADG1073]][[listing-loggers]]
-Listing Loggers
-~~~~~~~~~~~~~~~
+=== Listing Loggers
You can list and view information about all public loggers in your
distribution of GlassFish Server Open Source Edition.
[[CEGGICGF]][[GSADG1074]][[to-list-loggers]]
-To List Loggers
-^^^^^^^^^^^^^^^
+==== To List Loggers
Use the `list-loggers` subcommand in remote mode to list the logger
name, subsystem, and description of loggers in your distribution of
diff --git a/docs/administration-guide/src/main/jbake/content/lot.adoc b/docs/administration-guide/src/main/jbake/content/lot.adoc
index 61577c7..75ac2c6 100644
--- a/docs/administration-guide/src/main/jbake/content/lot.adoc
+++ b/docs/administration-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=lof.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:overview.html#giuad[1-1 Default Administration Values]
* link:overview.html#gjhfv[1-2 Default Locations]
diff --git a/docs/administration-guide/src/main/jbake/content/monitoring.adoc b/docs/administration-guide/src/main/jbake/content/monitoring.adoc
index 6ec424c..03cf4df 100644
--- a/docs/administration-guide/src/main/jbake/content/monitoring.adoc
+++ b/docs/administration-guide/src/main/jbake/content/monitoring.adoc
@@ -5,15 +5,13 @@
prev=logging.html
~~~~~~
-Administering the Monitoring Service
-====================================
+= Administering the Monitoring Service
[[GSADG00011]][[ablur]]
[[administering-the-monitoring-service]]
-8 Administering the Monitoring Service
---------------------------------------
+== 8 Administering the Monitoring Service
This chapter explains how to monitor the GlassFish Server Open Source
Edition 7 components and services by using the `asadmin` command-line
@@ -38,8 +36,7 @@
[[ablus]][[GSADG00557]][[about-monitoring]]
-About Monitoring
-~~~~~~~~~~~~~~~~
+=== About Monitoring
Monitoring is the process of reviewing the statistics of a system to
improve performance or solve problems. The monitoring service can track
@@ -64,8 +61,7 @@
[[ghbaz]][[GSADG00727]][[how-the-monitoring-tree-structure-works]]
-How the Monitoring Tree Structure Works
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How the Monitoring Tree Structure Works
A monitorable object is a component, subcomponent, or service that can
be monitored. GlassFish Server uses a tree structure to track
@@ -116,8 +112,7 @@
[[abluv]][[GSADG00647]][[tree-structure-of-monitorable-objects]]
-Tree Structure of Monitorable Objects
-+++++++++++++++++++++++++++++++++++++
+===== Tree Structure of Monitorable Objects
Each monitorable object has a hierarchical tree structure. In the tree,
a replaceable such as *statistics represents the name of the attribute
@@ -448,8 +443,7 @@
[[gitkq]][[GSADG00728]][[about-monitoring-for-add-on-components]]
-About Monitoring for Add-on Components
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== About Monitoring for Add-on Components
An add-on component typically generates statistics that GlassFish Server
can gather at runtime. Adding monitoring capabilities enables an add-on
@@ -461,8 +455,7 @@
[[ghbfq]][[GSADG00729]][[tools-for-monitoring-glassfish-server]]
-Tools for Monitoring GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tools for Monitoring GlassFish Server
The following `asadmin` subcommands are provided for monitoring the
services and components of GlassFish Server:
@@ -486,8 +479,7 @@
[[ablvp]][[GSADG00558]][[configuring-monitoring]]
-Configuring Monitoring
-~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Monitoring
By default, the monitoring service is enabled for GlassFish Server, but
monitoring for the individual modules is not. To enable monitoring for a
@@ -507,8 +499,7 @@
[[ablvr]][[GSADG00386]][[to-enable-monitoring]]
-To Enable Monitoring
-^^^^^^^^^^^^^^^^^^^^
+==== To Enable Monitoring
Use the `enable-monitoring` subcommand to enable the monitoring service
itself, or to enable monitoring for individual modules. Monitoring is
@@ -586,8 +577,7 @@
[[gglcu]][[GSADG00387]][[to-disable-monitoring]]
-To Disable Monitoring
-^^^^^^^^^^^^^^^^^^^^^
+==== To Disable Monitoring
Use the `disable-monitoring` subcommand to disable the monitoring
service itself, or to disable monitoring for individual modules.
@@ -664,8 +654,7 @@
[[ablvs]][[GSADG00559]][[viewing-common-monitoring-data]]
-Viewing Common Monitoring Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Viewing Common Monitoring Data
Use the `monitor` subcommand to display basic data on commonly-monitored
objects.
@@ -675,8 +664,7 @@
[[gelol]][[GSADG00388]][[to-view-common-monitoring-data]]
-To View Common Monitoring Data
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To View Common Monitoring Data
Use the `--type` option of the `monitor` subcommand to specify the
object for which you want to display data, such as `httplistener`,
@@ -725,8 +713,7 @@
[[ghmdc]][[GSADG00730]][[common-monitoring-statistics]]
-Common Monitoring Statistics
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Common Monitoring Statistics
Common monitoring statistics are described in the following sections:
@@ -736,8 +723,7 @@
[[ghltk]][[GSADG00648]][[http-listener-common-statistics]]
-HTTP Listener Common Statistics
-+++++++++++++++++++++++++++++++
+===== HTTP Listener Common Statistics
The statistics available for the `httplistener` type are shown in the
following table.
@@ -766,8 +752,7 @@
[[ghlvm]][[GSADG00649]][[jvm-common-statistics]]
-JVM Common Statistics
-+++++++++++++++++++++
+===== JVM Common Statistics
The statistics available for the `jvm` type are shown in the following
table.
@@ -800,8 +785,7 @@
[[ghljx]][[GSADG00650]][[web-module-common-statistics]]
-Web Module Common Statistics
-++++++++++++++++++++++++++++
+===== Web Module Common Statistics
The statistics available for the `webmodule` type are shown in the
following table.
@@ -839,8 +823,7 @@
[[ghmct]][[GSADG00560]][[viewing-comprehensive-monitoring-data]]
-Viewing Comprehensive Monitoring Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Viewing Comprehensive Monitoring Data
By applying the `list` and `get` subcommands against the tree structure
using dotted names, you can display more comprehensive monitoring data,
@@ -856,8 +839,7 @@
[[ablwh]][[GSADG00731]][[guidelines-for-using-the-list-and-get-subcommands-for-monitoring]]
-Guidelines for Using the `list` and `get` Subcommands for Monitoring
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Guidelines for Using the `list` and `get` Subcommands for Monitoring
The underlying assumptions for using the `list` and `get` subcommands
with dotted names are:
@@ -915,8 +897,7 @@
[[ablvv]][[GSADG00389]][[to-view-comprehensive-monitoring-data]]
-To View Comprehensive Monitoring Data
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To View Comprehensive Monitoring Data
Although the `monitor` subcommand is useful in many situations, it does
not offer the complete list of all monitorable objects. To work with
@@ -1054,8 +1035,7 @@
[[ghmcn]][[GSADG00732]][[comprehensive-monitoring-statistics]]
-Comprehensive Monitoring Statistics
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Comprehensive Monitoring Statistics
You can get comprehensive monitoring statistics by forming a dotted name
that specifies the statistic you are looking for. For example, the
@@ -1082,8 +1062,7 @@
[[gjkbi]][[GSADG00651]][[ejb-statistics]]
-EJB Statistics
-++++++++++++++
+===== EJB Statistics
EJBs fit into the tree of objects as shown in link:#abluw[Applications
Tree Hierarchy]. Use the following dotted name pattern to get EJB
@@ -1317,8 +1296,7 @@
[[ablvg]][[GSADG00652]][[http-service-statistics]]
-HTTP Service Statistics
-+++++++++++++++++++++++
+===== HTTP Service Statistics
The HTTP service fits into the tree of objects as shown in
link:#ghlin[HTTP Service Tree Hierarchy].
@@ -1408,8 +1386,7 @@
[[gjjyb]][[GSADG00653]][[jersey-statistics]]
-Jersey Statistics
-+++++++++++++++++
+===== Jersey Statistics
Jersey fits into the tree of objects as shown in
link:#abluw[Applications Tree Hierarchy].
@@ -1441,8 +1418,7 @@
[[ablvi]][[GSADG00654]][[jmsconnector-service-statistics]]
-JMS/Connector Service Statistics
-++++++++++++++++++++++++++++++++
+===== JMS/Connector Service Statistics
The JMS/Connector Service fits into the tree of objects as shown in
link:#ablva[JMS/Container Service Tree Hierarchy].
@@ -1568,8 +1544,7 @@
[[ablvm]][[GSADG00655]][[jvm-statistics]]
-JVM Statistics
-++++++++++++++
+===== JVM Statistics
The JVM fits into the tree of objects as show in link:#ghlic[JVM Tree
Hierarchy].
@@ -1865,8 +1840,7 @@
[[gjipy]][[GSADG00656]][[network-statistics]]
-Network Statistics
-++++++++++++++++++
+===== Network Statistics
Network fits into the tree of objects as shown in link:#giznj[Network
Tree Hierarchy].
@@ -2073,8 +2047,7 @@
[[ablvj]][[GSADG00657]][[orb-statistics-connection-manager]]
-ORB Statistics (Connection Manager)
-+++++++++++++++++++++++++++++++++++
+===== ORB Statistics (Connection Manager)
The ORB fits into the tree of objects as shown in link:#ablvb[ORB Tree
Hierarchy].
@@ -2111,8 +2084,7 @@
[[gipzv]][[GSADG00658]][[resource-statistics-connection-pool]]
-Resource Statistics (Connection Pool)
-+++++++++++++++++++++++++++++++++++++
+===== Resource Statistics (Connection Pool)
By monitoring connection pool resources you can measure performance and
capture resource usage at runtime. Connections are expensive and
@@ -2254,8 +2226,7 @@
[[gjiov]][[GSADG00659]][[security-statistics]]
-Security Statistics
-+++++++++++++++++++
+===== Security Statistics
Security fits into the tree of objects as shown in link:#gjios[Security
Tree Hierarchy].
@@ -2352,8 +2323,7 @@
[[ablvk]][[GSADG00660]][[thread-pool-statistics]]
-Thread Pool Statistics
-++++++++++++++++++++++
+===== Thread Pool Statistics
The thread pool fits into the tree of objects as shown in
link:#ablvc[Thread Pool Tree Hierarchy].
@@ -2458,8 +2428,7 @@
[[ablvl]][[GSADG00661]][[transaction-service-statistics]]
-Transaction Service Statistics
-++++++++++++++++++++++++++++++
+===== Transaction Service Statistics
The transaction service allows the client to freeze the transaction
subsystem in order to roll back transactions and determine which
@@ -2505,8 +2474,7 @@
[[ablvf]][[GSADG00662]][[web-statistics]]
-Web Statistics
-++++++++++++++
+===== Web Statistics
The web module fits into the tree of objects as shown in link:#ghlff[Web
Tree Hierarchy].
@@ -2713,8 +2681,7 @@
[[giwqm]][[GSADG00561]][[configuring-jconsole-to-view-glassfish-server-monitoring-data]]
-Configuring JConsole to View GlassFish Server Monitoring Data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring JConsole to View GlassFish Server Monitoring Data
Java SE provides tools to connect to an MBean Server and view the MBeans
registered with the server. JConsole is one such popular JMX Connector
@@ -2725,8 +2692,7 @@
[[ggpfh]][[GSADG00390]][[to-connect-jconsole-to-glassfish-server]]
-To Connect JConsole to GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Connect JConsole to GlassFish Server
Java SE 6 enhances management and monitoring of the virtual machine by
including a Platform MBean Server and by including managed beans
diff --git a/docs/administration-guide/src/main/jbake/content/orb.adoc b/docs/administration-guide/src/main/jbake/content/orb.adoc
index 5c1b42e..fe8b2ad 100644
--- a/docs/administration-guide/src/main/jbake/content/orb.adoc
+++ b/docs/administration-guide/src/main/jbake/content/orb.adoc
@@ -5,15 +5,13 @@
prev=concurrent.html
~~~~~~
-Administering the Object Request Broker (ORB)
-=============================================
+= Administering the Object Request Broker (ORB)
[[GSADG00018]][[abltr]]
[[administering-the-object-request-broker-orb]]
-15 Administering the Object Request Broker (ORB)
-------------------------------------------------
+== 15 Administering the Object Request Broker (ORB)
GlassFish Server supports a standard set of protocols and formats that
ensure interoperability. Among these protocols are those defined by
@@ -35,8 +33,7 @@
[[ablts]][[GSADG00590]][[about-the-orb]]
-About the ORB
-~~~~~~~~~~~~~
+=== About the ORB
The Common Object Request Broker Architecture (CORBA) model is based on
clients requesting services from distributed objects or servers through
@@ -51,8 +48,7 @@
[[abltw]][[GSADG00591]][[configuring-the-orb]]
-Configuring the ORB
-~~~~~~~~~~~~~~~~~~~
+=== Configuring the ORB
A CORBA object never talks directly with another. Instead, the object
makes requests through a remote stub to the Internet Inter-Orb Protocol
@@ -66,8 +62,7 @@
[[ablty]][[GSADG00592]][[administering-iiop-listeners]]
-Administering IIOP Listeners
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering IIOP Listeners
An IIOP listener is a listen socket that accepts incoming connections
from the remote clients of enterprise beans and from other CORBA-based
@@ -86,8 +81,7 @@
[[gioyo]][[GSADG00478]][[to-create-an-iiop-listener]]
-To Create an IIOP Listener
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an IIOP Listener
Use the `create-iiop-listener` subcommand in remote mode to create an
IIOP listener.
@@ -123,8 +117,7 @@
[[giowc]][[GSADG00479]][[to-list-iiop-listeners]]
-To List IIOP Listeners
-^^^^^^^^^^^^^^^^^^^^^^
+==== To List IIOP Listeners
Use the `list-iiop-listeners` subcommand in remote mode to list the
existing IIOP listeners.
@@ -157,8 +150,7 @@
[[giwlq]][[GSADG00480]][[to-update-an-iiop-listener]]
-To Update an IIOP Listener
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update an IIOP Listener
1. List the IIOP listeners by using the
link:../reference-manual/list-iiop-listeners.html#GSRFM00169[`list-iiop-listeners`] subcommand.
@@ -181,8 +173,7 @@
[[giowj]][[GSADG00481]][[to-delete-an-iiop-listener]]
-To Delete an IIOP Listener
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an IIOP Listener
Use the `delete-iiop-listener` subcommand in remote mode to delete an
IIOP listener.
diff --git a/docs/administration-guide/src/main/jbake/content/overview.adoc b/docs/administration-guide/src/main/jbake/content/overview.adoc
index 16d05dd..f658159 100644
--- a/docs/administration-guide/src/main/jbake/content/overview.adoc
+++ b/docs/administration-guide/src/main/jbake/content/overview.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Overview of GlassFish Server Administration
-===========================================
+= Overview of GlassFish Server Administration
[[GSADG00004]][[ablaq]]
[[overview-of-glassfish-server-administration]]
-1 Overview of GlassFish Server Administration
----------------------------------------------
+== 1 Overview of GlassFish Server Administration
GlassFish Server Open Source Edition provides a server for developing
and deploying Java Platform Enterprise Edition (Jakarta EE) applications
@@ -36,8 +34,7 @@
[[giubb]][[GSADG00526]][[default-settings-and-locations]]
-Default Settings and Locations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Settings and Locations
After installation, you might need to perform some immediate
configuration tasks to make your installation function as intended. If
@@ -101,8 +98,7 @@
[[ghrcy]][[GSADG00527]][[configuration-tasks]]
-Configuration Tasks
-~~~~~~~~~~~~~~~~~~~
+=== Configuration Tasks
Some configuration tasks must be performed directly after installation
for your GlassFish Server environment to work as intended. For example,
@@ -124,8 +120,7 @@
[[gitwr]][[GSADG00694]][[initial-configuration-tasks]]
-Initial Configuration Tasks
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Initial Configuration Tasks
This section maps the common configuration tasks to the command-line
procedures in this guide. In some situations, the resource or service is
@@ -219,8 +214,7 @@
[[giusb]][[GSADG00695]][[how-dotted-names-work-for-configuration]]
-How Dotted Names Work for Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Dotted Names Work for Configuration
After the initial configuration is working, you will continue to manage
ongoing configuration for the life of your GlassFish Server
@@ -310,8 +304,7 @@
[[gjjrl]][[GSADG00696]][[configuration-files]]
-Configuration Files
-^^^^^^^^^^^^^^^^^^^
+==== Configuration Files
The bulk of the configuration information about GlassFish Server
resources, applications, and instances is stored in the `domain.xml`
@@ -349,8 +342,7 @@
[[gitzw]][[GSADG00697]][[impact-of-configuration-changes]]
-Impact of Configuration Changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Impact of Configuration Changes
Some configuration changes require that you restart the DAS or GlassFish
Server instances for the changes to take effect. Other changes are
@@ -373,8 +365,7 @@
[[gkvaj]][[GSADG00300]][[to-determine-whether-the-das-or-an-instance-requires-restart]]
-To Determine Whether the DAS or an Instance Requires Restart
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Determine Whether the DAS or an Instance Requires Restart
1. Ensure that the DAS is running.
To obtain information about the DAS or an instance, a running server is required.
@@ -448,8 +439,7 @@
[[ghciy]][[GSADG00628]][[configuration-changes-that-require-restart]]
-Configuration Changes That Require Restart
-++++++++++++++++++++++++++++++++++++++++++
+===== Configuration Changes That Require Restart
The following configuration changes require restart for the changes to
take effect:
@@ -473,8 +463,7 @@
[[ghclm]][[GSADG00629]][[dynamic-configuration-changes]]
-Dynamic Configuration Changes
-+++++++++++++++++++++++++++++
+===== Dynamic Configuration Changes
With dynamic configuration, changes take effect while the DAS or
instance is running. The following configuration changes do not require
@@ -494,8 +483,7 @@
[[gkvas]][[GSADG00630]][[changes-that-affect-applications]]
-Changes That Affect Applications
-++++++++++++++++++++++++++++++++
+===== Changes That Affect Applications
Some changes to resources or connection pools affect the applications
that use the resources or connection pools. These changes do not require
@@ -548,8 +536,7 @@
[[ggjxp]][[GSADG00528]][[administration-tools]]
-Administration Tools
-~~~~~~~~~~~~~~~~~~~~
+=== Administration Tools
For the most part, you can perform the same tasks by using either the
graphical Administration Console or the `asadmin` command-line utility,
@@ -566,8 +553,7 @@
[[ablav]][[GSADG00698]][[administration-console]]
-Administration Console
-^^^^^^^^^^^^^^^^^^^^^^
+==== Administration Console
The Administration Console is a browser-based utility that features an
easy-to-navigate graphical interface that includes extensive online help
@@ -638,8 +624,7 @@
[[gcocs]][[GSADG00699]][[asadmin-utility]]
-`asadmin` Utility
-^^^^^^^^^^^^^^^^^
+==== `asadmin` Utility
The `asadmin` utility is a command-line tool that runs subcommands for
identifying the operation or task that you want to perform. You can run
@@ -690,8 +675,7 @@
[[gjjok]][[GSADG00700]][[rest-interfaces]]
-REST Interfaces
-^^^^^^^^^^^^^^^
+==== REST Interfaces
GlassFish Server provides representational state transfer (REST)
interfaces to enable you to access monitoring and configuration data for
@@ -702,8 +686,7 @@
[[gjjxt]][[GSADG00702]][[osgi-module-management-subsystem]]
-OSGi Module Management Subsystem
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== OSGi Module Management Subsystem
The OSGi module management subsystem that is provided with GlassFish
Server is the http://felix.apache.org/[Apache Felix OSGi framework] . To
@@ -732,8 +715,7 @@
[[glhdz]][[GSADG00302]][[to-enable-the-apache-felix-gogo-remote-shell]]
-To Enable the Apache Felix Gogo Remote Shell
-++++++++++++++++++++++++++++++++++++++++++++
+===== To Enable the Apache Felix Gogo Remote Shell
By default, the Apache Felix Gogo remote shell in GlassFish Server is
disabled. Before using the shell to administer OSGi bundles in GlassFish
@@ -774,8 +756,7 @@
[[CJAGIGII]][[GSADG1050]][[to-run-apache-felix-gogo-remote-shell-commands]]
-To Run Apache Felix Gogo Remote Shell Commands
-++++++++++++++++++++++++++++++++++++++++++++++
+===== To Run Apache Felix Gogo Remote Shell Commands
The Apache Felix Gogo remote shell is integrated with the GlassFish
Server `asadmin` command line utility. You can use the `asadmin`
@@ -878,8 +859,7 @@
[source]
----
asadmin> osgi inspect service capability 251
-GlassFish EJB Container for OSGi Enabled EJB Applications (251) provides services:
----------------------------------------------------------------------------
+== GlassFish EJB Container for OSGi Enabled EJB Applications (251) provides services:
objectClass = org.glassfish.osgijavaeebase.Extender
service.id = 68
-----
@@ -891,8 +871,7 @@
asadmin> osgi -shell
Use "exit" to exit and "help" for online help.
gogo$ inspect service capability 251
-GlassFish EJB Container for OSGi Enabled EJB Applications (251) provides services:
----------------------------------------------------------------------------
+== GlassFish EJB Container for OSGi Enabled EJB Applications (251) provides services:
objectClass = org.glassfish.osgijavaeebase.Extender
service.id = 68
...
@@ -901,8 +880,7 @@
[[gkwvx]][[GSADG00303]][[to-download-and-install-the-glassfish-osgi-web-console]]
-To Download and Install the GlassFish OSGi Web Console
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Download and Install the GlassFish OSGi Web Console
The GlassFish OSGi Web Console is distributed as follows:
@@ -945,8 +923,7 @@
[[BABIDJHF]][[GSADG798]][[to-access-the-glassfish-osgi-web-console-through-the-glassfish-server-administration-console]]
-To Access the GlassFish OSGi Web Console Through the GlassFish Server Administration Console
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Access the GlassFish OSGi Web Console Through the GlassFish Server Administration Console
A tab for the GlassFish OSGi Web Console is provided for the DAS and for
every GlassFish Server instance in a domain.
@@ -983,8 +960,7 @@
[[BABDJHAF]][[GSADG799]][[to-access-the-glassfish-osgi-web-console-as-a-standalone-web-application]]
-To Access the GlassFish OSGi Web Console as a Standalone Web Application
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Access the GlassFish OSGi Web Console as a Standalone Web Application
1. Ensure that the DAS or the instance for which you want to access the
GlassFish OSGi Web Console is running.
@@ -1017,8 +993,7 @@
[[ghcjl]][[GSADG00703]][[keytool-utility]]
-`keytool` Utility
-^^^^^^^^^^^^^^^^^
+==== `keytool` Utility
The `keytool` utility is used to set up and work with Java Security
Socket Extension (JSSE) digital certificates. See
@@ -1027,8 +1002,7 @@
[[ghrfm]][[GSADG00704]][[java-monitoring-and-management-console-jconsole]]
-Java Monitoring and Management Console (JConsole)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Java Monitoring and Management Console (JConsole)
Java SE provides tools to connect to an MBean server and view the MBeans
that are registered with the server. JConsole is one such popular JMX
@@ -1039,8 +1013,7 @@
[[giudo]][[GSADG00529]][[instructions-for-administering-glassfish-server]]
-Instructions for Administering GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Instructions for Administering GlassFish Server
Information and instructions on performing most of the administration
tasks from the command line are provided in this document and in the
diff --git a/docs/administration-guide/src/main/jbake/content/part-appendixes.adoc b/docs/administration-guide/src/main/jbake/content/part-appendixes.adoc
index 3cde958..7d1cdc7 100644
--- a/docs/administration-guide/src/main/jbake/content/part-appendixes.adoc
+++ b/docs/administration-guide/src/main/jbake/content/part-appendixes.adoc
@@ -5,15 +5,12 @@
prev=transactions.html
~~~~~~
-Appendixes
-==========
+= Appendixes
[[gitym]][[GSADG00299]][[part-iii]]
-Part III
---------
+== Part III
[[appendixes]]
-Appendixes
-----------
+== Appendixes
diff --git a/docs/administration-guide/src/main/jbake/content/part-res-and-svcs-admin.adoc b/docs/administration-guide/src/main/jbake/content/part-res-and-svcs-admin.adoc
index 133b9e7..5ba4b28 100644
--- a/docs/administration-guide/src/main/jbake/content/part-res-and-svcs-admin.adoc
+++ b/docs/administration-guide/src/main/jbake/content/part-res-and-svcs-admin.adoc
@@ -5,15 +5,12 @@
prev=batch.html
~~~~~~
-Resources and Services Administration
-=====================================
+= Resources and Services Administration
[[gitxw]][[GSADG00298]][[part-ii]]
-Part II
--------
+== Part II
[[resources-and-services-administration]]
-Resources and Services Administration
--------------------------------------
+== Resources and Services Administration
diff --git a/docs/administration-guide/src/main/jbake/content/part-runtime-admin.adoc b/docs/administration-guide/src/main/jbake/content/part-runtime-admin.adoc
index c0c946d..283d747 100644
--- a/docs/administration-guide/src/main/jbake/content/part-runtime-admin.adoc
+++ b/docs/administration-guide/src/main/jbake/content/part-runtime-admin.adoc
@@ -5,15 +5,12 @@
prev=overview.html
~~~~~~
-Runtime Administration
-======================
+= Runtime Administration
[[gitzg]][[GSADG00297]][[part-i]]
-Part I
-------
+== Part I
[[runtime-administration]]
-Runtime Administration
-----------------------
+== Runtime Administration
diff --git a/docs/administration-guide/src/main/jbake/content/preface.adoc b/docs/administration-guide/src/main/jbake/content/preface.adoc
index ccfab24..918e9a1 100644
--- a/docs/administration-guide/src/main/jbake/content/preface.adoc
+++ b/docs/administration-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSADG00003]][[gkamj]]
[[preface]]
-Preface
--------
+== Preface
The GlassFish Server Open Source Edition Administration Guide provides
instructions for configuring and administering
@@ -40,8 +38,7 @@
[[GSADG00518]][[ghpbz]]
[[glassfish-server-documentation-set]]
-Eclipse GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Eclipse GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -146,8 +143,7 @@
[[GSADG00519]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -191,8 +187,7 @@
[[GSADG00520]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -232,8 +227,7 @@
[[GSADG00521]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -276,8 +270,7 @@
[[GSADG00522]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/administration-guide/src/main/jbake/content/threadpools.adoc b/docs/administration-guide/src/main/jbake/content/threadpools.adoc
index 120d883..fe748e6 100644
--- a/docs/administration-guide/src/main/jbake/content/threadpools.adoc
+++ b/docs/administration-guide/src/main/jbake/content/threadpools.adoc
@@ -5,15 +5,13 @@
prev=jvm.html
~~~~~~
-Administering Thread Pools
-==========================
+= Administering Thread Pools
[[GSADG00008]][[abluc]]
[[administering-thread-pools]]
-5 Administering Thread Pools
-----------------------------
+== 5 Administering Thread Pools
This chapter provides procedures for administering thread pools in the
GlassFish Server Open Source Edition 7 environment by using the
@@ -29,8 +27,7 @@
[[ggjyv]][[GSADG00546]][[about-thread-pools]]
-About Thread Pools
-~~~~~~~~~~~~~~~~~~
+=== About Thread Pools
The Virtual Machine for the Java platform (Java Virtual Machine) or JVM
machine) can support many threads of execution simultaneously. To help
@@ -48,8 +45,7 @@
[[ablud]][[GSADG00547]][[configuring-thread-pools]]
-Configuring Thread Pools
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Thread Pools
You can specify the minimum and maximum number of threads that are
reserved for requests from applications. The thread pool is dynamically
@@ -64,8 +60,7 @@
[[ggkwj]][[GSADG00366]][[to-create-a-thread-pool]]
-To Create a Thread Pool
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Thread Pool
Use the `create-threadpool` subcommand in remote mode to create a thread
pool.
@@ -119,8 +114,7 @@
[[giuff]][[GSADG00367]][[to-list-thread-pools]]
-To List Thread Pools
-^^^^^^^^^^^^^^^^^^^^
+==== To List Thread Pools
Use the `list-threadpools` subcommand in remote mode to list the
existing thread pools.
@@ -150,8 +144,7 @@
[[ggkyc]][[GSADG00368]][[to-update-a-thread-pool]]
-To Update a Thread Pool
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Thread Pool
Use the `set` subcommand to update the values for a specified thread
pool.
@@ -192,8 +185,7 @@
[[ggkwy]][[GSADG00369]][[to-delete-a-thread-pool]]
-To Delete a Thread Pool
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Thread Pool
Use the `delete-threadpool` subcommand in remote mode to delete an
existing thread pool. Deleting a thread pool will fail if that pool is
diff --git a/docs/administration-guide/src/main/jbake/content/title.adoc b/docs/administration-guide/src/main/jbake/content/title.adoc
index 02b3f78..f94ef8e 100644
--- a/docs/administration-guide/src/main/jbake/content/title.adoc
+++ b/docs/administration-guide/src/main/jbake/content/title.adoc
@@ -10,8 +10,7 @@
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Administration Guide
diff --git a/docs/administration-guide/src/main/jbake/content/toc.adoc b/docs/administration-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..49a5352
--- /dev/null
+++ b/docs/administration-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,438 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Administration Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Administration Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSADG00003[Preface]
+
+** link:preface.html#GSADG00518[Eclipse GlassFish Server Documentation Set]
+** link:preface.html#GSADG00519[Related Documentation]
+** link:preface.html#GSADG00520[Typographic Conventions]
+** link:preface.html#GSADG00521[Symbol Conventions]
+** link:preface.html#GSADG00522[Default Paths and File Names]
+
+[[overview-of-glassfish-server-administration]]
+=== link:overview.html#GSADG00004[1 Overview of GlassFish Server Administration]
+
+** link:overview.html#GSADG00526[Default Settings and Locations]
+** link:overview.html#GSADG00527[Configuration Tasks]
+*** link:overview.html#GSADG00694[Initial Configuration Tasks]
+*** link:overview.html#GSADG00695[How Dotted Names Work for Configuration]
+*** link:overview.html#GSADG00696[Configuration Files]
+*** link:overview.html#GSADG00697[Impact of Configuration Changes]
+** link:overview.html#GSADG00528[Administration Tools]
+*** link:overview.html#GSADG00698[Administration Console]
+*** link:overview.html#GSADG00699[`asadmin` Utility]
+*** link:overview.html#GSADG00700[REST Interfaces]
+*** link:overview.html#GSADG00702[OSGi Module Management Subsystem]
+*** link:overview.html#GSADG00703[`keytool` Utility]
+*** link:overview.html#GSADG00704[Java Monitoring and Management Console (JConsole)]
+** link:overview.html#GSADG00529[Instructions for Administering GlassFish Server]
+
+[[part-i]]
+=== link:part-runtime-admin.html#GSADG00297[Part I]
+
+* link:part-runtime-admin.html#runtime-administration[Runtime Administration]
+
+[[general-administration]]
+=== link:general-administration.html#GSADG00005[2 General Administration]
+
+** link:general-administration.html#GSADG00530[Using the `asadmin` Utility]
+*** link:general-administration.html#GSADG00705[Path to the `asadmin` Utility]
+*** link:general-administration.html#GSADG00706[`asadmin` Utility Syntax]
+*** link:general-administration.html#GSADG00304[To Run an `asadmin` Utility Subcommand in Single Mode]
+*** link:general-administration.html#GSADG00305[To Display Help Information for the `asadmin` Utility or a Subcommand]
+*** link:general-administration.html#GSADG00306[To Start a Multimode Session]
+*** link:general-administration.html#GSADG00307[To End a Multimode Session]
+*** link:general-administration.html#GSADG00308[To Run a Set of `asadmin` Subcommands From a File]
+*** link:general-administration.html#GSADG1055[To Run `asadmin` Subcommands in `--detach` Mode]
+** link:general-administration.html#GSADG00531[Administering System Properties]
+*** link:general-administration.html#GSADG00309[To Create System Properties]
+*** link:general-administration.html#GSADG00310[To List System Properties]
+*** link:general-administration.html#GSADG00311[To Delete a System Property]
+** link:general-administration.html#GSADG1096[Using Configuration Modularity]
+*** link:general-administration.html#GSADG1097[To Add the Default Configuration of a Module to `domain.xml`]
+*** link:general-administration.html#GSADG1100[To Remove the Configuration of a Module From `domain.xml`]
+*** link:general-administration.html#GSADG1103[To Display the Current Active Configuration of a Module]
+** link:general-administration.html#GSADG00532[Administering Resources]
+*** link:general-administration.html#GSADG00312[To Add Resources From an XML File]
+** link:general-administration.html#GSADG00533[Listing Various System Elements]
+*** link:general-administration.html#GSADG00316[To Display the GlassFish Server Version]
+*** link:general-administration.html#GSADG00317[To List Applications]
+*** link:general-administration.html#GSADG00319[To List Containers]
+*** link:general-administration.html#GSADG00320[To List Modules]
+*** link:general-administration.html#GSADG00321[To List Subcommands]
+*** link:general-administration.html#GSADG00322[To List Timers]
+*** link:general-administration.html#GSADG00323[To Show Component Status]
+** link:general-administration.html#GSADG00534[Using REST Interfaces to Administer GlassFish Server]
+*** link:general-administration.html#GSADG00707[Using REST URLs to Administer GlassFish Server]
+*** link:general-administration.html#GSADG00708[Using REST Resource Methods to Administer GlassFish Server]
+*** link:general-administration.html#GSADG00709[Resources for `asadmin` Subcommands That Perform Non-CRUD Operations]
+*** link:general-administration.html#GSADG00710[Securing GlassFish Server REST Interfaces]
+*** link:general-administration.html#GSADG00711[Formats for Resource Representation of Configuration Objects]
+*** link:general-administration.html#GSADG00712[Formats for Resource Representation of Monitoring Objects]
+*** link:general-administration.html#GSADG00713[Formats for Resource Representation of Log File Details]
+*** link:general-administration.html#GSADG00714[Supported Content Types in Requests to REST Resources]
+
+[[administering-domains]]
+=== link:domains.html#GSADG00006[3 Administering Domains]
+
+** link:domains.html#GSADG00535[About Administering Domains]
+*** link:domains.html#GSADG00715[GlassFish Server Instances]
+*** link:domains.html#GSADG00716[Domains for Administering GlassFish Server]
+*** link:domains.html#GSADG00717[Domain Administration Server (DAS)]
+** link:domains.html#GSADG00536[Creating, Logging In To, and Deleting a Domain]
+*** link:domains.html#GSADG00330[To Create a Domain]
+*** link:domains.html#GSADG00331[To Create a Domain From a Custom Template]
+*** link:domains.html#GSADG00332[To List Domains]
+*** link:domains.html#GSADG00333[To Log In to a Domain]
+*** link:domains.html#GSADG00334[To Delete a Domain]
+** link:domains.html#GSADG00537[Starting and Stopping a Domain]
+*** link:domains.html#GSADG00335[To Start a Domain]
+*** link:domains.html#GSADG00336[To Stop a Domain]
+*** link:domains.html#GSADG00337[To Restart a Domain]
+** link:domains.html#GSADG00538[Configuring a DAS or a GlassFish Server Instance for Automatic Restart]
+*** link:domains.html#GSADG00338[To Configure a DAS or an Instance for Automatic Restart on Windows]
+*** link:domains.html#GSADG00339[To Configure a DAS or an Instance for Automatic Restart on Linux]
+*** link:domains.html#GSADG00341[To Prevent Service Shutdown When a User Logs Out on Windows]
+** link:domains.html#GSADG00541[Backing Up and Restoring a Domain]
+*** link:domains.html#GSADG00352[To Back Up a Domain]
+*** link:domains.html#GSADG00353[To Restore a Domain]
+*** link:domains.html#GSADG00354[To List Domain Backups]
+** link:domains.html#GSADG00542[Re-Creating the Domain Administration Server (DAS)]
+*** link:domains.html#GSADG00355[To Migrate the DAS]
+** link:domains.html#GSADG00543[Additional Domain Tasks]
+*** link:domains.html#GSADG00356[To Display Domain Uptime]
+*** link:domains.html#GSADG00357[To Switch a Domain to Another Supported Java Version]
+*** link:domains.html#GSADG00358[To Change the Administration Port of a Domain]
+
+[[administering-the-virtual-machine-for-the-java-platform]]
+=== link:jvm.html#GSADG00007[4 Administering the Virtual Machine for the Java Platform]
+
+** link:jvm.html#GSADG00544[Administering JVM Options]
+*** link:jvm.html#GSADG00359[To Create JVM Options]
+*** link:jvm.html#GSADG00360[To List JVM Options]
+*** link:jvm.html#GSADG00361[To Delete JVM Options]
+*** link:jvm.html#GSADG00362[To Generate a JVM Report]
+** link:jvm.html#GSADG00545[Administering the Profiler]
+*** link:jvm.html#GSADG00363[To Create a Profiler]
+*** link:jvm.html#GSADG00365[To Delete a Profiler]
+
+[[administering-thread-pools]]
+=== link:threadpools.html#GSADG00008[5 Administering Thread Pools]
+
+** link:threadpools.html#GSADG00546[About Thread Pools]
+** link:threadpools.html#GSADG00547[Configuring Thread Pools]
+*** link:threadpools.html#GSADG00366[To Create a Thread Pool]
+*** link:threadpools.html#GSADG00367[To List Thread Pools]
+*** link:threadpools.html#GSADG00368[To Update a Thread Pool]
+*** link:threadpools.html#GSADG00369[To Delete a Thread Pool]
+
+[[administering-web-applications]]
+=== link:webapps.html#GSADG00009[6 Administering Web Applications]
+
+** link:webapps.html#GSADG00548[Invoking a Servlet by Alternate Means]
+** link:webapps.html#GSADG00549[Changing Log Output for a Servlet]
+** link:webapps.html#GSADG00550[Defining Global Features for Web Applications]
+*** link:webapps.html#GSADG00370[To Use the `default-web.xml` File]
+** link:webapps.html#GSADG00551[Redirecting a URL]
+** link:webapps.html#GSADG00552[Administering `mod_jk`]
+*** link:webapps.html#GSADG00371[To Enable `mod_jk`]
+*** link:webapps.html#GSADG00372[To Load Balance Using `mod_jk` and GlassFish Server]
+*** link:webapps.html#GSADG00373[To Enable SSL Between the `mod_jk` Load Balancer and the Browser]
+*** link:webapps.html#GSADG00374[To Enable SSL Between the `mod_jk` Load Balancer and GlassFish Server]
+** link:webapps.html#GSADG861[Administering `mod_proxy_ajp`]
+*** link:webapps.html#GSADG862[To Enable `mod_proxy_ajp`]
+*** link:webapps.html#GSADG1049[To Load Balance Using `mod_proxy_ajp` and GlassFish Server]
+
+[[administering-the-logging-service]]
+=== link:logging.html#GSADG00010[7 Administering the Logging Service]
+
+** link:logging.html#GSADG00554[About Logging]
+*** link:logging.html#GSADG00719[Log Files]
+*** link:logging.html#GSADG00720[Logger Namespaces]
+*** link:logging.html#GSADG00721[Logging Targets]
+*** link:logging.html#GSADG00722[Logging Properties]
+** link:logging.html#GSADG00555[Configuring the Logging Service]
+*** link:logging.html#GSADG00723[Changing the Name and Location of Logging Service Files]
+*** link:logging.html#GSADG00724[Setting Log Levels]
+*** link:logging.html#GSADG1062[Setting the Log File Format]
+*** link:logging.html#GSADG00725[Setting Log File Rotation]
+*** link:logging.html#GSADG00726[Adding a Custom Logging Handler]
+** link:logging.html#GSADG00556[Viewing Log Records]
+*** link:logging.html#GSADG00385[To Collect Log Files into a ZIP Archive]
+** link:logging.html#GSADG1073[Listing Loggers]
+*** link:logging.html#GSADG1074[To List Loggers]
+
+[[administering-the-monitoring-service]]
+=== link:monitoring.html#GSADG00011[8 Administering the Monitoring Service]
+
+** link:monitoring.html#GSADG00557[About Monitoring]
+*** link:monitoring.html#GSADG00727[How the Monitoring Tree Structure Works]
+*** link:monitoring.html#GSADG00728[About Monitoring for Add-on Components]
+*** link:monitoring.html#GSADG00729[Tools for Monitoring GlassFish Server]
+** link:monitoring.html#GSADG00558[Configuring Monitoring]
+*** link:monitoring.html#GSADG00386[To Enable Monitoring]
+*** link:monitoring.html#GSADG00387[To Disable Monitoring]
+** link:monitoring.html#GSADG00559[Viewing Common Monitoring Data]
+*** link:monitoring.html#GSADG00388[To View Common Monitoring Data]
+*** link:monitoring.html#GSADG00730[Common Monitoring Statistics]
+** link:monitoring.html#GSADG00560[Viewing Comprehensive Monitoring Data]
+*** link:monitoring.html#GSADG00731[Guidelines for Using the `list` and `get` Subcommands for Monitoring]
+*** link:monitoring.html#GSADG00389[To View Comprehensive Monitoring Data]
+*** link:monitoring.html#GSADG00732[Comprehensive Monitoring Statistics]
+** link:monitoring.html#GSADG00561[Configuring JConsole to View GlassFish Server Monitoring Data]
+*** link:monitoring.html#GSADG00390[To Connect JConsole to GlassFish Server]
+
+[[administering-life-cycle-modules]]
+=== link:lifecycle-modules.html#GSADG00013[9 Administering Life Cycle Modules]
+
+** link:lifecycle-modules.html#GSADG00566[About Life Cycle Modules]
+** link:lifecycle-modules.html#GSADG00567[Configuring Life Cycle Modules]
+*** link:lifecycle-modules.html#GSADG00399[To Create a Life Cycle Module]
+*** link:lifecycle-modules.html#GSADG00400[To List Life Cycle Modules]
+*** link:lifecycle-modules.html#GSADG00401[To Update a Life Cycle Module]
+*** link:lifecycle-modules.html#GSADG00402[To Delete a Life Cycle Module]
+
+[[administering-batch-jobs]]
+=== link:batch.html#GSADG1077[10 Administering Batch Jobs]
+
+** link:batch.html#GSADG1078[About Batch Jobs]
+** link:batch.html#GSADG1079[Viewing Batch Jobs]
+*** link:batch.html#GSADG1080[To List Batch Jobs]
+*** link:batch.html#GSADG1083[To List Batch Job Executions]
+*** link:batch.html#GSADG1086[To List Batch Job Steps]
+** link:batch.html#GSADG1089[Configuring the Batch Runtime]
+*** link:batch.html#GSADG1090[To List the Batch Runtime Configuration]
+*** link:batch.html#GSADG1093[To Configure the Batch Runtime]
+
+[[part-ii]]
+=== link:part-res-and-svcs-admin.html#GSADG00298[Part II]
+
+* link:part-res-and-svcs-admin.html#resources-and-services-administration[Resources and Services Administration]
+
+[[administering-database-connectivity]]
+=== link:jdbc.html#GSADG00015[11 Administering Database Connectivity]
+
+** link:jdbc.html#GSADG00576[About Database Connectivity]
+** link:jdbc.html#GSADG00577[Setting Up the Database]
+*** link:jdbc.html#GSADG00416[To Install the Database and Database Driver]
+*** link:jdbc.html#GSADG00417[To Start the Database]
+*** link:jdbc.html#GSADG00418[To Stop the Database]
+*** link:jdbc.html#GSADG00744[Apache Derby Database Utility Scripts]
+** link:jdbc.html#GSADG00578[Configuring Access to the Database]
+*** link:jdbc.html#GSADG00745[Administering JDBC Connection Pools]
+*** link:jdbc.html#GSADG00746[Administering JDBC Resources]
+*** link:jdbc.html#GSADG00747[Enabling the `jdbc/__default` Resource in a Clustered Environment]
+*** link:jdbc.html#GSADG00748[Integrating the JDBC Driver]
+** link:jdbc.html#GSADG00579[Configuration Specifics for JDBC Drivers]
+*** link:jdbc.html#GSADG00749[IBM DB2 Database Type 2 Driver]
+*** link:jdbc.html#GSADG00750[IBM DB2 Database Type 4 Driver]
+*** link:jdbc.html#GSADG00751[Apache Derby DB/Derby Type 4 Driver]
+*** link:jdbc.html#GSADG00752[MySQL Server Database Type 4 Driver]
+*** link:jdbc.html#GSADG00753[Oracle 10 Database Driver]
+*** link:jdbc.html#GSADG00754[Oracle 11 Database Driver]
+*** link:jdbc.html#GSADG00755[PostgreSQL Type 4 Driver]
+*** link:jdbc.html#GSADG00756[DataDirect Type 4 Driver for IBM DB2 Database]
+*** link:jdbc.html#GSADG00757[DataDirect Type 4 Driver for IBM Informix]
+*** link:jdbc.html#GSADG00758[DataDirect Type 4 Driver for Microsoft SQL Server Database]
+*** link:jdbc.html#GSADG00759[DataDirect Type 4 Driver for MySQL Server Database]
+*** link:jdbc.html#GSADG00760[DataDirect Type 4 Driver for Oracle 11 Database]
+*** link:jdbc.html#GSADG00761[DataDirect Type 4 Driver for Sybase Database]
+*** link:jdbc.html#GSADG00762[Inet Oraxo Driver for Oracle Database]
+*** link:jdbc.html#GSADG00763[Inet Merlia Driver for Microsoft SQL Server Database]
+*** link:jdbc.html#GSADG00764[Inet Sybelux Driver for Sybase Database]
+*** link:jdbc.html#GSADG00765[JConnect Type 4 Driver for Sybase ASE 12.5 Database]
+
+[[administering-eis-connectivity]]
+=== link:connectors.html#GSADG00016[12 Administering EIS Connectivity]
+
+** link:connectors.html#GSADG00580[About EIS Connectivity]
+** link:connectors.html#GSADG00581[Administering Connector Connection Pools]
+*** link:connectors.html#GSADG00431[To Create a Connector Connection Pool]
+*** link:connectors.html#GSADG00432[To List Connector Connection Pools]
+*** link:connectors.html#GSADG00433[To Connect to (Ping) or Reset (Flush) a Connector Connection Pool]
+*** link:connectors.html#GSADG00434[To Update a Connector Connection Pool]
+*** link:connectors.html#GSADG00435[To Delete a Connector Connection Pool]
+** link:connectors.html#GSADG00582[Administering Connector Resources]
+*** link:connectors.html#GSADG00436[To Create a Connector Resource]
+*** link:connectors.html#GSADG00437[To List Connector Resources]
+*** link:connectors.html#GSADG00438[To Update a Connector Resource]
+*** link:connectors.html#GSADG00439[To Delete a Connector Resource]
+** link:connectors.html#GSADG00583[Administering the Resource Adapter Configuration]
+*** link:connectors.html#GSADG00440[To Create Configuration Information for a Resource Adapter]
+*** link:connectors.html#GSADG00441[To List Resource Adapter Configurations]
+*** link:connectors.html#GSADG00442[To Update a Resource Adapter Configuration]
+*** link:connectors.html#GSADG00443[To Delete a Resource Adapter Configuration]
+** link:connectors.html#GSADG00584[Administering Connector Security Maps]
+*** link:connectors.html#GSADG00444[To Create a Connector Security Map]
+*** link:connectors.html#GSADG00445[To List Connector Security Maps]
+*** link:connectors.html#GSADG00446[To Update a Connector Security Map]
+*** link:connectors.html#GSADG00447[To Delete a Connector Security Map]
+** link:connectors.html#GSADG00585[Administering Connector Work Security Maps]
+*** link:connectors.html#GSADG00448[To Create a Connector Work Security Map]
+*** link:connectors.html#GSADG00449[To List Connector Work Security Maps]
+*** link:connectors.html#GSADG00450[To Update a Connector Work Security Map]
+*** link:connectors.html#GSADG00451[To Delete a Connector Work Security Map]
+** link:connectors.html#GSADG00586[Administering Administered Objects]
+*** link:connectors.html#GSADG00452[To Create an Administered Object]
+*** link:connectors.html#GSADG00453[To List Administered Objects]
+*** link:connectors.html#GSADG00454[To Update an Administered Object]
+*** link:connectors.html#GSADG00455[To Delete an Administered Object]
+
+[[administering-internet-connectivity]]
+=== link:http_https.html#GSADG00017[13 Administering Internet Connectivity]
+
+** link:http_https.html#GSADG00587[About Internet Connectivity]
+*** link:http_https.html#GSADG00766[About HTTP Network Listeners]
+*** link:http_https.html#GSADG00767[About Virtual Servers]
+** link:http_https.html#GSADG00588[Administering HTTP Network Listeners]
+*** link:http_https.html#GSADG00456[To Create an Internet Connection]
+*** link:http_https.html#GSADG00768[Administering HTTP Protocols]
+*** link:http_https.html#GSADG00769[Administering HTTP Configurations]
+*** link:http_https.html#GSADG00770[Administering HTTP Transports]
+*** link:http_https.html#GSADG00771[Administering HTTP Network Listeners]
+** link:http_https.html#GSADG00589[Administering Virtual Servers]
+*** link:http_https.html#GSADG00472[To Create a Virtual Server]
+*** link:http_https.html#GSADG00473[To List Virtual Servers]
+*** link:http_https.html#GSADG00474[To Update a Virtual Server]
+*** link:http_https.html#GSADG00475[To Delete a Virtual Server]
+*** link:http_https.html#GSADG00772[To Assign a Default Web Module to a Virtual Server]
+*** link:http_https.html#GSADG00476[To Assign a Virtual Server to an Application or Module]
+*** link:http_https.html#GSADG00477[To Set `JSESSIONIDSSO` Cookie Attributes]
+
+[[administering-concurrent-resources]]
+=== link:concurrent.html#GSADG1108[14 Administering Concurrent Resources]
+
+** link:concurrent.html#GSADG1109[About Concurrent Resources]
+** link:concurrent.html#GSADG1110[Default Concurrent Resources]
+** link:concurrent.html#GSADG1111[Configuring Context Services]
+*** link:concurrent.html#GSADG1112[To Create a Context Service]
+*** link:concurrent.html#GSADG1115[To List Context Services]
+*** link:concurrent.html#GSADG1118[To Update a Context Service]
+*** link:concurrent.html#GSADG1119[To Delete a Context Service]
+** link:concurrent.html#GSADG1122[Configuring Managed Thread Factories]
+*** link:concurrent.html#GSADG1123[To Create a Managed Thread Factory]
+*** link:concurrent.html#GSADG1126[To List Managed Thread Factories]
+*** link:concurrent.html#GSADG1129[To Update a Managed Thread Factory]
+*** link:concurrent.html#GSADG1130[To Delete a Managed Thread Factory]
+** link:concurrent.html#GSADG1133[Configuring Managed Executor Services]
+*** link:concurrent.html#GSADG1134[To Create a Managed Executor Service]
+*** link:concurrent.html#GSADG1137[To List Managed Executor Services]
+*** link:concurrent.html#GSADG1140[To Update a Managed Executor Service]
+*** link:concurrent.html#GSADG1141[To Delete a Managed Executor Service]
+** link:concurrent.html#GSADG1144[Configuring Managed Scheduled Executor Services]
+*** link:concurrent.html#GSADG1145[To Create a Managed Scheduled Executor Service]
+*** link:concurrent.html#GSADG1148[To List Managed Scheduled Executor Services]
+*** link:concurrent.html#GSADG1151[To Update a Managed Scheduled Executor Service]
+*** link:concurrent.html#GSADG1152[To Delete a Managed Scheduled Executor Service]
+
+[[administering-the-object-request-broker-orb]]
+=== link:orb.html#GSADG00018[15 Administering the Object Request Broker (ORB)]
+
+** link:orb.html#GSADG00590[About the ORB]
+** link:orb.html#GSADG00591[Configuring the ORB]
+** link:orb.html#GSADG00592[Administering IIOP Listeners]
+*** link:orb.html#GSADG00478[To Create an IIOP Listener]
+*** link:orb.html#GSADG00479[To List IIOP Listeners]
+*** link:orb.html#GSADG00480[To Update an IIOP Listener]
+*** link:orb.html#GSADG00481[To Delete an IIOP Listener]
+
+[[administering-the-javamail-service]]
+=== link:javamail.html#GSADG00019[16 Administering the JavaMail Service]
+
+** link:javamail.html#GSADG00593[About JavaMail]
+** link:javamail.html#GSADG00594[Administering JavaMail Resources]
+*** link:javamail.html#GSADG00482[To Create a JavaMail Resource]
+*** link:javamail.html#GSADG00483[To List JavaMail Resources]
+*** link:javamail.html#GSADG00484[To Update a JavaMail Resource]
+*** link:javamail.html#GSADG00485[To Delete a JavaMail Resource]
+
+[[administering-the-java-message-service-jms]]
+=== link:jms.html#GSADG00020[17 Administering the Java Message Service (JMS)]
+
+** link:jms.html#GSADG00595[About the JMS Service]
+*** link:jms.html#GSADG00773[JMS Service High Availability]
+** link:jms.html#GSADG00596[Updating the JMS Service Configuration]
+*** link:jms.html#GSADG00774[Setting Message Queue Broker Properties in the JMS Service Configuration]
+** link:jms.html#GSADG00597[Administering JMS Hosts]
+*** link:jms.html#GSADG00775[About JMS Host Types]
+*** link:jms.html#GSADG00776[Configuring Embedded and Local JMS Hosts]
+*** link:jms.html#GSADG00486[To Create a JMS Host]
+*** link:jms.html#GSADG00487[To List JMS Hosts]
+*** link:jms.html#GSADG00488[To Update a JMS Host]
+*** link:jms.html#GSADG00489[To Delete a JMS Host]
+** link:jms.html#GSADG00598[Administering JMS Connection Factories and Destinations]
+*** link:jms.html#GSADG00490[To Create a Connection Factory or Destination Resource]
+*** link:jms.html#GSADG00491[To List JMS Resources]
+*** link:jms.html#GSADG00492[To Delete a Connection Factory or Destination Resource]
+** link:jms.html#GSADG00599[Administering JMS Physical Destinations]
+*** link:jms.html#GSADG00493[To Create a JMS Physical Destination]
+*** link:jms.html#GSADG00494[To List JMS Physical Destinations]
+*** link:jms.html#GSADG00495[To Purge Messages From a Physical Destination]
+*** link:jms.html#GSADG00496[To Delete a JMS Physical Destination]
+** link:jms.html#GSADG00600[Special Situations When Using the JMS Service]
+** link:jms.html#GSADG00601[Troubleshooting the JMS Service]
+** link:jms.html#GSADG00602[Using the Generic Resource Adapter for JMS to Integrate Supported External JMS Providers]
+*** link:jms.html#GSADG00777[Configuring GenericJMSRA for Supported External JMS Providers]
+*** link:jms.html#GSADG00778[Using GenericJMSRA with WebLogic JMS]
+*** link:jms.html#GSADG00779[Using GenericJMSRA with IBM WebSphere MQ]
+
+[[administering-the-java-naming-and-directory-interface-jndi-service]]
+=== link:jndi.html#GSADG00021[18 Administering the Java Naming and Directory Interface (JNDI) Service]
+
+** link:jndi.html#GSADG00603[About JNDI]
+*** link:jndi.html#GSADG00780[Jakarta EE Naming Environment]
+*** link:jndi.html#GSADG00781[How the Naming Environment and the Container Work Together]
+*** link:jndi.html#GSADG00782[Naming References and Binding Information]
+** link:jndi.html#GSADG00604[Administering JNDI Resources]
+*** link:jndi.html#GSADG00783[Administering Custom JNDI Resources]
+*** link:jndi.html#GSADG00784[Administering External JNDI Resources]
+
+[[administering-transactions]]
+=== link:transactions.html#GSADG00022[19 Administering Transactions]
+
+** link:transactions.html#GSADG00605[About Transactions]
+*** link:transactions.html#GSADG00785[Transaction Resource Managers]
+*** link:transactions.html#GSADG00786[Transaction Scope]
+** link:transactions.html#GSADG00606[Configuring the Transaction Service]
+** link:transactions.html#GSADG00607[Managing the Transaction Service for Rollbacks]
+*** link:transactions.html#GSADG00513[To Stop the Transaction Service]
+*** link:transactions.html#GSADG00514[To Roll Back a Transaction]
+*** link:transactions.html#GSADG00515[To Restart the Transaction Service]
+*** link:transactions.html#GSADG00787[Determining Local Transaction Completion at Shutdown]
+** link:transactions.html#GSADG00608[Recovering Transactions]
+*** link:transactions.html#GSADG00788[Automatic Transaction Recovery]
+*** link:transactions.html#GSADG00516[To Manually Recover Transactions]
+*** link:transactions.html#GSADG00789[Distributed Transaction Recovery]
+*** link:transactions.html#GSADG00790[Recovery Workarounds and Limitations]
+** link:transactions.html#GSADG00609[Transaction Logging]
+*** link:transactions.html#GSADG00517[To Store Transaction Logs in a Database]
+
+[[part-iii]]
+=== link:part-appendixes.html#GSADG00299[Part III]
+
+* link:part-appendixes.html#appendixes[Appendixes]
+* link:asadmin-subcommands.html#GSADG00023[A Subcommands for the `asadmin` Utility]
+** link:asadmin-subcommands.html#GSADG00610[General Administration Subcommands]
+** link:asadmin-subcommands.html#GSADG1155[Batch Jobs Subcommands]
+** link:asadmin-subcommands.html#GSADG1156[Concurrent Resources Subcommands]
+** link:asadmin-subcommands.html#GSADG00611[Connectivity Subcommands]
+** link:asadmin-subcommands.html#GSADG00612[Domain Subcommands]
+** link:asadmin-subcommands.html#GSADG00613[Internet Connectivity Subcommands]
+** link:asadmin-subcommands.html#GSADG00614[JavaMail Subcommands]
+** link:asadmin-subcommands.html#GSADG00615[JMS Subcommands]
+** link:asadmin-subcommands.html#GSADG00616[JNDI Subcommands]
+** link:asadmin-subcommands.html#GSADG00617[JVM Subcommands]
+** link:asadmin-subcommands.html#GSADG00618[Life Cycle Module Subcommands]
+** link:asadmin-subcommands.html#GSADG00619[Logging and Monitoring Subcommands]
+** link:asadmin-subcommands.html#GSADG00620[ORB Subcommands]
+** link:asadmin-subcommands.html#GSADG00621[Thread Pool Subcommands]
+** link:asadmin-subcommands.html#GSADG00622[Transaction Service Subcommands]
diff --git a/docs/administration-guide/src/main/jbake/content/transactions.adoc b/docs/administration-guide/src/main/jbake/content/transactions.adoc
index 4ab4643..c2615d9 100644
--- a/docs/administration-guide/src/main/jbake/content/transactions.adoc
+++ b/docs/administration-guide/src/main/jbake/content/transactions.adoc
@@ -5,15 +5,13 @@
prev=jndi.html
~~~~~~
-Administering Transactions
-==========================
+= Administering Transactions
[[GSADG00022]][[ablsn]]
[[administering-transactions]]
-19 Administering Transactions
------------------------------
+== 19 Administering Transactions
This chapter discusses how to manage the transaction service for the
GlassFish Server Open Source Edition environment by using the `asadmin`
@@ -43,8 +41,7 @@
[[ablso]][[GSADG00605]][[about-transactions]]
-About Transactions
-~~~~~~~~~~~~~~~~~~
+=== About Transactions
A transaction is a series of discreet actions in an application that
must all complete successfully. By enclosing one or more actions in an
@@ -111,8 +108,7 @@
[[beann]][[GSADG00785]][[transaction-resource-managers]]
-Transaction Resource Managers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Transaction Resource Managers
There are three types of transaction resource managers:
@@ -139,8 +135,7 @@
[[beano]][[GSADG00786]][[transaction-scope]]
-Transaction Scope
-^^^^^^^^^^^^^^^^^
+==== Transaction Scope
A local transaction involves only one non-XA resource and requires that
all participating application components execute within one process.
@@ -186,8 +181,7 @@
[[beanp]][[GSADG00606]][[configuring-the-transaction-service]]
-Configuring the Transaction Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring the Transaction Service
You can configure the transaction service in the GlassFish Server in the
following ways:
@@ -277,8 +271,7 @@
[[giubd]][[GSADG00607]][[managing-the-transaction-service-for-rollbacks]]
-Managing the Transaction Service for Rollbacks
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Managing the Transaction Service for Rollbacks
You can roll back a single transaction by using the `asadmin`
subcommands described in this section. To do so, the transaction service
@@ -295,8 +288,7 @@
[[giufn]][[GSADG00513]][[to-stop-the-transaction-service]]
-To Stop the Transaction Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop the Transaction Service
Use the `freeze-transaction-service` subcommand in remote mode to stop
the transaction service. When the transaction service is stopped, all
@@ -331,8 +323,7 @@
[[giugk]][[GSADG00514]][[to-roll-back-a-transaction]]
-To Roll Back a Transaction
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Roll Back a Transaction
In some situations, you might want to roll back a particular
transaction. Before you can roll back a transaction, you must first stop
@@ -388,8 +379,7 @@
[[giuet]][[GSADG00515]][[to-restart-the-transaction-service]]
-To Restart the Transaction Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Restart the Transaction Service
Use the `unfreeze-transaction-service` subcommand in remote mote to
resume all the suspended in-flight transactions. Run this subcommand to
@@ -419,8 +409,7 @@
[[gkrbo]][[GSADG00787]][[determining-local-transaction-completion-at-shutdown]]
-Determining Local Transaction Completion at Shutdown
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Determining Local Transaction Completion at Shutdown
When you shut down a GlassFish Server instance, all database connections
are closed. When an Oracle JDBC driver-based database connection is
@@ -443,8 +432,7 @@
[[gjjpy]][[GSADG00608]][[recovering-transactions]]
-Recovering Transactions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Recovering Transactions
There are some situations where the commit or rollback operations might
be interrupted, typically because the server crashed or a resource
@@ -465,8 +453,7 @@
[[gkoen]][[GSADG00788]][[automatic-transaction-recovery]]
-Automatic Transaction Recovery
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Automatic Transaction Recovery
GlassFish Server can perform automatic recovery in these ways:
@@ -483,8 +470,7 @@
[[giuhe]][[GSADG00516]][[to-manually-recover-transactions]]
-To Manually Recover Transactions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Manually Recover Transactions
Use the `recover-transactions` subcommand in remote mode to manually
recover transactions that were pending when a resource or a server
@@ -555,8 +541,7 @@
[[gaxim]][[GSADG00789]][[distributed-transaction-recovery]]
-Distributed Transaction Recovery
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Distributed Transaction Recovery
To enable cluster-wide automatic recovery, you must first facilitate
storing of transaction logs in a shared file system. See
@@ -569,8 +554,7 @@
[[gaxig]][[GSADG00790]][[recovery-workarounds-and-limitations]]
-Recovery Workarounds and Limitations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Recovery Workarounds and Limitations
The GlassFish Server provides workarounds for some known issues with
transaction recovery implementations.
@@ -584,8 +568,7 @@
[[gknau]][[GSADG00689]][[general-recovery-limitations]]
-General Recovery Limitations
-++++++++++++++++++++++++++++
+===== General Recovery Limitations
The following general limitations apply to transaction recovery:
@@ -610,8 +593,7 @@
[[gknee]][[GSADG00690]][[oracle-setup-for-transaction-recovery]]
-Oracle Setup for Transaction Recovery
-+++++++++++++++++++++++++++++++++++++
+===== Oracle Setup for Transaction Recovery
You must configure the following `grant` statements in your Oracle
database to set up transaction recovery:
@@ -631,8 +613,7 @@
[[gjiep]][[GSADG00691]][[oracle-thin-driver]]
-Oracle Thin Driver
-++++++++++++++++++
+===== Oracle Thin Driver
In the Oracle thin driver, the `XAResource.recover` method repeatedly
returns the same set of in-doubt Xids regardless of the input flag.
@@ -649,8 +630,7 @@
[[gkneq]][[GSADG00692]][[delegated-recovery-after-server-crash-doesnt-work-on-mysql]]
-Delegated Recovery After Server Crash Doesn't Work on MySQL
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Delegated Recovery After Server Crash Doesn't Work on MySQL
The MySQL database supports XA transaction recovery only when the
database crashes. When a GlassFish Server instance crashes, MySQL rolls
@@ -658,8 +638,7 @@
[[glclh]][[GSADG00693]][[call-to-xateminator.recover-during-resourceadapter.start-hangs-if-automatic-recovery-is-enabled]]
-Call to `XATeminator.recover()` During `ResourceAdapter.start()` Hangs If Automatic Recovery Is Enabled
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Call to `XATeminator.recover()` During `ResourceAdapter.start()` Hangs If Automatic Recovery Is Enabled
Calls to `XATerminator.recover()` from the `ResourceAdapter.start()`
method never return because GlassFish Server deadlocks. This only occurs
@@ -672,8 +651,7 @@
[[beanq]][[GSADG00609]][[transaction-logging]]
-Transaction Logging
-~~~~~~~~~~~~~~~~~~~
+=== Transaction Logging
The transaction service writes transactional activity into transaction
logs so that transactions can be recovered. You can control transaction
@@ -716,8 +694,7 @@
[[gcmam]][[GSADG00517]][[to-store-transaction-logs-in-a-database]]
-To Store Transaction Logs in a Database
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Store Transaction Logs in a Database
For multi-core machines, logging transactions to a database may be more
efficient. Transaction logging is designed to work with any
diff --git a/docs/administration-guide/src/main/jbake/content/webapps.adoc b/docs/administration-guide/src/main/jbake/content/webapps.adoc
index 2be6ecf..fac1a3a 100644
--- a/docs/administration-guide/src/main/jbake/content/webapps.adoc
+++ b/docs/administration-guide/src/main/jbake/content/webapps.adoc
@@ -5,15 +5,13 @@
prev=threadpools.html
~~~~~~
-Administering Web Applications
-==============================
+= Administering Web Applications
[[GSADG00009]][[gbbjk]]
[[administering-web-applications]]
-6 Administering Web Applications
---------------------------------
+== 6 Administering Web Applications
This chapter explains how to administer web applications in the
GlassFish Server Open Source Edition 7 environment.
@@ -33,8 +31,7 @@
[[beagk]][[GSADG00548]][[invoking-a-servlet-by-alternate-means]]
-Invoking a Servlet by Alternate Means
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Invoking a Servlet by Alternate Means
You can call a servlet deployed to GlassFish Server by using a URL in a
browser or embedded as a link in an HTML or JSP file. The format of a
@@ -102,8 +99,7 @@
[[gixud]][[GSADG00549]][[changing-log-output-for-a-servlet]]
-Changing Log Output for a Servlet
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Changing Log Output for a Servlet
`ServletContext.log` messages are sent to the server log. By default,
the `System.out` and `System.err` output of servlets are sent to the
@@ -118,8 +114,7 @@
[[beagc]][[GSADG00550]][[defining-global-features-for-web-applications]]
-Defining Global Features for Web Applications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Defining Global Features for Web Applications
You can use the `default-web.xml` file to define features such as
filters and security constraints that apply to all web applications.
@@ -161,8 +156,7 @@
[[fvymc]][[GSADG00370]][[to-use-the-default-web.xml-file]]
-To Use the `default-web.xml` File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Use the `default-web.xml` File
1. Place the JAR file for the filter, security constraint, or other
feature in the domain-dir`/lib` directory.
@@ -174,8 +168,7 @@
[[gixrb]][[GSADG00551]][[redirecting-a-url]]
-Redirecting a URL
-~~~~~~~~~~~~~~~~~
+=== Redirecting a URL
You can specify that a request for an old URL be treated as a request
for a new URL. This is called redirecting a URL.
@@ -205,8 +198,7 @@
[[gfaad]][[GSADG00552]][[administering-mod_jk]]
-Administering `mod_jk`
-~~~~~~~~~~~~~~~~~~~~~~
+=== Administering `mod_jk`
The Apache Tomcat Connector `mod_jk` can be used to connect the web
container with web servers such as Apache HTTP Server. By using
@@ -230,8 +222,7 @@
[[gixqw]][[GSADG00371]][[to-enable-mod_jk]]
-To Enable `mod_jk`
-^^^^^^^^^^^^^^^^^^
+==== To Enable `mod_jk`
You can front GlassFish Server with Apache HTTP Server by enabling the
`mod_jk` protocol for one of GlassFish Server's network listeners, as
@@ -348,8 +339,7 @@
[[gixpx]][[GSADG00372]][[to-load-balance-using-mod_jk-and-glassfish-server]]
-To Load Balance Using `mod_jk` and GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Load Balance Using `mod_jk` and GlassFish Server
Load balancing is the process of dividing the amount of work that a
computer has to do between two or more computers so that more work gets
@@ -437,8 +427,7 @@
[[gjpat]][[GSADG00373]][[to-enable-ssl-between-the-mod_jk-load-balancer-and-the-browser]]
-To Enable SSL Between the `mod_jk` Load Balancer and the Browser
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable SSL Between the `mod_jk` Load Balancer and the Browser
To activate security for `mod_jk` on GlassFish Server, you must first
generate a Secure Socket Layer (SSL) self-signed certificate on the
@@ -513,8 +502,7 @@
[[gjpan]][[GSADG00374]][[to-enable-ssl-between-the-mod_jk-load-balancer-and-glassfish-server]]
-To Enable SSL Between the `mod_jk` Load Balancer and GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable SSL Between the `mod_jk` Load Balancer and GlassFish Server
This procedure does not enable SSL transfer between `mod_jk` and
GlassFish Server. It enables `mod_jk` to forward SSL-encrypted
@@ -563,8 +551,7 @@
[[CIHJDAJD]][[GSADG861]][[administering-mod_proxy_ajp]]
-Administering `mod_proxy_ajp`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering `mod_proxy_ajp`
The Apache Connector `mod_proxy_ajp` can be used to connect the web
container with Apache HTTP Server. By using `mod_proxy_ajp`, you can
@@ -574,8 +561,7 @@
[[to-enable-mod_proxy_ajp]]
-To Enable `mod_proxy_ajp`
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable `mod_proxy_ajp`
You can front GlassFish Server with Apache HTTP Server and its
`mod_proxy_ajp` connector by enabling the AJP protocol for one of
@@ -654,8 +640,7 @@
[[to-load-balance-using-mod_proxy_ajp-and-glassfish-server]]
-To Load Balance Using `mod_proxy_ajp` and GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Load Balance Using `mod_proxy_ajp` and GlassFish Server
Load balancing is the process of dividing the amount of work that a
computer has to do between two or more computers so that more work gets
diff --git a/docs/application-deployment-guide/src/main/jbake/content/asadmin-deployment-subcommands.adoc b/docs/application-deployment-guide/src/main/jbake/content/asadmin-deployment-subcommands.adoc
index c291fb8..2585914 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/asadmin-deployment-subcommands.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/asadmin-deployment-subcommands.adoc
@@ -5,15 +5,13 @@
prev=deploying-applications.html
~~~~~~
-The asadmin Deployment Subcommands
-==================================
+= The asadmin Deployment Subcommands
[[GSDPG00005]][[gihzw]]
[[a-the-asadmin-deployment-subcommands]]
-A The `asadmin` Deployment Subcommands
---------------------------------------
+== A The `asadmin` Deployment Subcommands
This appendix lists the `asadmin` deployment subcommands that are
included with this release of the GlassFish Server Open Source
diff --git a/docs/application-deployment-guide/src/main/jbake/content/dd-elements.adoc b/docs/application-deployment-guide/src/main/jbake/content/dd-elements.adoc
index e095990..b271791 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/dd-elements.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/dd-elements.adoc
@@ -4,23 +4,20 @@
prev=dd-files.html
~~~~~~
-Elements of the GlassFish Server Deployment Descriptors
-=======================================================
+= Elements of the GlassFish Server Deployment Descriptors
[[GSDPG00007]][[beaqi]]
[[c-elements-of-the-glassfish-server-deployment-descriptors]]
-C Elements of the GlassFish Server Deployment Descriptors
----------------------------------------------------------
+== C Elements of the GlassFish Server Deployment Descriptors
This appendix describes the elements of the GlassFish Server Open Source
Editiondeployment descriptors.
[[beaqs]][[GSDPG00085]][[activation-config]]
-`activation-config`
-~~~~~~~~~~~~~~~~~~~
+=== `activation-config`
Specifies an activation configuration, which includes the runtime
configuration properties of the message-driven bean in its operational
@@ -30,15 +27,13 @@
[[fvyoe]][[GSDPG00335]][[superelements]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaus[`mdb-resource-adapter`] (`glassfish-ejb-jar.xml`)
[[fvynj]][[GSDPG00336]][[subelements]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `activation-config`
element.
@@ -68,22 +63,19 @@
[[beaqt]][[GSDPG00086]][[activation-config-property]]
-`activation-config-property`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `activation-config-property`
Specifies the name and value of an activation configuration property.
[[fvyne]][[GSDPG00337]][[superelements-1]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaqs[`activation-config`] (`glassfish-ejb-jar.xml`)
[[fvyns]][[GSDPG00338]][[subelements-1]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`activation-config-property` element.
@@ -111,50 +103,43 @@
[[beaqu]][[GSDPG00087]][[activation-config-property-name]]
-`activation-config-property-name`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `activation-config-property-name`
Specifies the name of an activation configuration property.
[[fvynm]][[GSDPG00339]][[superelements-2]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaqt[`activation-config-property`] (`glassfish-ejb-jar.xml`)
[[fvyok]][[GSDPG00340]][[subelements-2]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaqv]][[GSDPG00088]][[activation-config-property-value]]
-`activation-config-property-value`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `activation-config-property-value`
Specifies the value of an activation configuration property.
[[fvyou]][[GSDPG00341]][[superelements-3]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaqt[`activation-config-property`] (`glassfish-ejb-jar.xml`)
[[fvyoz]][[GSDPG00342]][[subelements-3]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giyhw]][[GSDPG00089]][[admin-object-resource]]
-`admin-object-resource`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `admin-object-resource`
Defines an administered object for an inbound resource adapter.
@@ -162,8 +147,7 @@
[[superelements-4]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -171,8 +155,7 @@
[[subelements-4]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`admin-object-resource` element.
@@ -199,8 +182,7 @@
[[attributes]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `admin-object-resource`
element.
@@ -239,8 +221,7 @@
[[properties]]
-Properties
-^^^^^^^^^^
+==== Properties
Properties of the `admin-object-resource` element are the names of
setter methods of the class referenced by the `adminobject-class` of the
@@ -249,22 +230,19 @@
[[beaqw]][[GSDPG00090]][[as-context]]
-`as-context`
-~~~~~~~~~~~~
+=== `as-context`
Specifies the authentication mechanism used to authenticate the client.
[[fvyos]][[GSDPG00343]][[superelements-5]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beato[`ior-security-config`] (`glassfish-ejb-jar.xml`)
[[fvyom]][[GSDPG00344]][[subelements-5]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `as-context` element.
@@ -300,8 +278,7 @@
[[gjizj]][[GSDPG00091]][[archive-name]]
-`archive-name`
-~~~~~~~~~~~~~~
+=== `archive-name`
Specifies the name of the archive file. The value of the `archive-name`
element is used to derive the default application name when
@@ -312,22 +289,19 @@
[[gjizb]][[GSDPG00345]][[superelements-6]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`)
[[gjizg]][[GSDPG00346]][[subelements-6]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaqx]][[GSDPG00092]][[auth-method]]
-`auth-method`
-~~~~~~~~~~~~~
+=== `auth-method`
Specifies the authentication method.
@@ -341,23 +315,20 @@
[[fvyow]][[GSDPG00347]][[superelements-7]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauk[`login-config`] (`glassfish-web.xml`),
link:#beaqw[`as-context`] (`glassfish-ejb-jar.xml`)
[[fvyop]][[GSDPG00348]][[subelements-7]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaqy]][[GSDPG00093]][[auth-realm]]
-`auth-realm`
-~~~~~~~~~~~~
+=== `auth-realm`
JAAS is available on the ACC. Defines the optional configuration for a
JAAS authentication realm. Authentication realms require
@@ -368,15 +339,13 @@
[[fvyot]][[GSDPG00349]][[superelements-8]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearr[`client-container`] (`sun-acc.xml`)
[[fvyor]][[GSDPG00350]][[subelements-8]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `auth-realm` element.
@@ -398,8 +367,7 @@
[[fvyoy]][[GSDPG00351]][[attributes-1]]
-`Attributes`
-^^^^^^^^^^^^
+==== `Attributes`
The following table describes attributes for the `auth-realm` element.
@@ -418,8 +386,7 @@
[[fvyox]][[GSDPG00352]][[example]]
-Example
-^^^^^^^
+==== Example
Here is an example of the default file realm:
@@ -440,8 +407,7 @@
[[giyjv]][[GSDPG00094]][[backend-principal]]
-`backend-principal`
-~~~~~~~~~~~~~~~~~~~
+=== `backend-principal`
Specifies the user name and password required by the Enterprise
Information System (EIS).
@@ -450,8 +416,7 @@
[[superelements-9]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyhy[`security-map`] (`glassfish-resources.xml`)
@@ -459,8 +424,7 @@
[[subelements-9]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
@@ -468,8 +432,7 @@
[[attributes-2]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `backend-principal`
element.
@@ -491,23 +454,20 @@
[[beara]][[GSDPG00095]][[bean-cache]]
-`bean-cache`
-~~~~~~~~~~~~
+=== `bean-cache`
Specifies the entity bean cache properties. Used for entity beans and
stateful session beans.
[[fvyoq]][[GSDPG00353]][[superelements-10]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyon]][[GSDPG00354]][[subelements-10]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `bean-cache` element.
@@ -566,8 +526,7 @@
[[fvyoo]][[GSDPG00355]][[example-1]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -583,23 +542,20 @@
[[bearb]][[GSDPG00096]][[bean-pool]]
-`bean-pool`
-~~~~~~~~~~~
+=== `bean-pool`
Specifies the pool properties of stateless session beans, entity beans,
and message-driven bean.
[[fvypc]][[GSDPG00356]][[superelements-11]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvypd]][[GSDPG00357]][[subelements-11]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `bean-pool` element.
@@ -651,8 +607,7 @@
[[fvypf]][[GSDPG00358]][[example-2]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -666,22 +621,19 @@
[[beard]][[GSDPG00097]][[cache]]
-`cache`
-~~~~~~~
+=== `cache`
Configures caching for web application components.
[[fvype]][[GSDPG00359]][[superelements-12]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvypl]][[GSDPG00360]][[subelements-12]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cache` element.
@@ -725,8 +677,7 @@
[[fvypj]][[GSDPG00361]][[attributes-3]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `cache` element.
@@ -753,8 +704,7 @@
[[fvypx]][[GSDPG00362]][[properties-1]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `cache` element.
@@ -784,8 +734,7 @@
[[fvyrn]][[GSDPG00363]][[cache-class-names]]
-Cache Class Names
-^^^^^^^^^^^^^^^^^
+==== Cache Class Names
The following table lists possible values of the `cacheClassName`
property.
@@ -815,23 +764,20 @@
[[beare]][[GSDPG00098]][[cache-helper]]
-`cache-helper`
-~~~~~~~~~~~~~~
+=== `cache-helper`
Specifies a class that implements the
com.sun.appserv.web.cache.CacheHelper interface.
[[fvyqy]][[GSDPG00364]][[superelements-13]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beard[`cache`] (`glassfish-web.xml`)
[[fvyru]][[GSDPG00365]][[subelements-13]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cache-helper`
element.
@@ -854,8 +800,7 @@
[[fvyqu]][[GSDPG00366]][[attributes-4]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `cache-helper` element.
@@ -878,30 +823,26 @@
[[bearf]][[GSDPG00099]][[cache-helper-ref]]
-`cache-helper-ref`
-~~~~~~~~~~~~~~~~~~
+=== `cache-helper-ref`
Specifies the `name` of the link:#beare[`cache-helper`] used by the
parent link:#bearh[`cache-mapping`] element.
[[fvypq]][[GSDPG00367]][[superelements-14]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvyqs]][[GSDPG00368]][[subelements-14]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[bearg]][[GSDPG00100]][[cache-idle-timeout-in-seconds]]
-`cache-idle-timeout-in-seconds`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `cache-idle-timeout-in-seconds`
Specifies the maximum time that a bean can remain idle in the cache.
After this amount of time, the container can passivate this bean. A
@@ -912,36 +853,31 @@
[[fvyqc]][[GSDPG00369]][[superelements-15]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`] (`glassfish-ejb-jar.xml`)
[[fvyqo]][[GSDPG00370]][[subelements-15]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[bearh]][[GSDPG00101]][[cache-mapping]]
-`cache-mapping`
-~~~~~~~~~~~~~~~
+=== `cache-mapping`
Maps a URL pattern or a servlet name to its cacheability constraints.
[[fvyqi]][[GSDPG00371]][[superelements-16]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beard[`cache`] (`glassfish-web.xml`)
[[fvyqn]][[GSDPG00372]][[subelements-16]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cache-mapping`
element.
@@ -1026,8 +962,7 @@
[[beari]][[GSDPG00102]][[call-property]]
-`call-property`
-~~~~~~~~~~~~~~~
+=== `call-property`
Specifies JAX-RPC property values that can be set on a
`javax.xml.rpc.Call` object before it is returned to the web service
@@ -1036,8 +971,7 @@
[[fvyri]][[GSDPG00373]][[superelements-17]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavt[`port-info`], link:#beaxk[`service-ref`]
(`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
@@ -1045,8 +979,7 @@
[[fvyqp]][[GSDPG00374]][[subelements-17]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `call-property`
element.
@@ -1074,52 +1007,45 @@
[[bearj]][[GSDPG00103]][[caller-propagation]]
-`caller-propagation`
-~~~~~~~~~~~~~~~~~~~~
+=== `caller-propagation`
Specifies whether the target accepts propagated caller identities. The
values are `NONE`, `SUPPORTED`, or `REQUIRED`.
[[fvyqj]][[GSDPG00375]][[superelements-18]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxb[`sas-context`] (`glassfish-ejb-jar.xml`)
[[fvyrb]][[GSDPG00376]][[subelements-18]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beark]][[GSDPG00104]][[cert-db]]
-`cert-db`
-~~~~~~~~~
+=== `cert-db`
Not implemented. Included for backward compatibility only. Attribute
values are ignored.
[[fvyqa]][[GSDPG00377]][[superelements-19]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxf[`security`] (`sun-acc.xml`)
[[fvyre]][[GSDPG00378]][[subelements-19]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvyrr]][[GSDPG00379]][[attributes-5]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `cert-db` element.
@@ -1140,44 +1066,38 @@
[[bearl]][[GSDPG00105]][[check-all-at-commit]]
-`check-all-at-commit`
-~~~~~~~~~~~~~~~~~~~~~
+=== `check-all-at-commit`
This element is not implemented. Do not use.
[[fvyrj]][[GSDPG00380]][[superelements-20]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`] (`sun-cmp-mappings.xml`)
[[bearm]][[GSDPG00106]][[check-modified-at-commit]]
-`check-modified-at-commit`
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `check-modified-at-commit`
Checks concurrent modification of fields in modified beans at commit
time.
[[fvyqf]][[GSDPG00381]][[superelements-21]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`] (`sun-cmp-mappings.xml`)
[[fvyqz]][[GSDPG00382]][[subelements-20]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - element is present or absent
[[bearn]][[GSDPG00107]][[check-version-of-accessed-instances]]
-`check-version-of-accessed-instances`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `check-version-of-accessed-instances`
Checks the version column of the modified beans.
@@ -1192,15 +1112,13 @@
[[fvyqt]][[GSDPG00383]][[superelements-22]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`] (`sun-cmp-mappings.xml`)
[[fvypp]][[GSDPG00384]][[subelements-21]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`check-version-of-accessed-instances` element.
@@ -1223,8 +1141,7 @@
[[bearo]][[GSDPG00108]][[checkpoint-at-end-of-method]]
-`checkpoint-at-end-of-method`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `checkpoint-at-end-of-method`
Specifies that the stateful session bean state is checkpointed, or
persisted, after the specified methods are executed. The
@@ -1233,15 +1150,13 @@
[[fvypr]][[GSDPG00385]][[superelements-23]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyqe]][[GSDPG00386]][[subelements-22]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`checkpoint-at-end-of-method` element.
@@ -1264,37 +1179,32 @@
[[bearp]][[GSDPG00109]][[checkpointed-methods]]
-`checkpointed-methods`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `checkpointed-methods`
Deprecated. Supported for backward compatibility. Use
link:#bearo[`checkpoint-at-end-of-method`] instead.
[[fvyrk]][[GSDPG00387]][[superelements-24]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[bearq]][[GSDPG00110]][[class-loader]]
-`class-loader`
-~~~~~~~~~~~~~~
+=== `class-loader`
Configures the class loader for the web module.
[[fvyrv]][[GSDPG00388]][[superelements-25]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvyrh]][[GSDPG00389]][[subelements-23]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `class-loader`
element.
@@ -1317,8 +1227,7 @@
[[fvyrl]][[GSDPG00390]][[attributes-6]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `class-loader` element.
@@ -1381,8 +1290,7 @@
[[gcfko]][[GSDPG00391]][[properties-2]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `class-loader` element.
@@ -1402,8 +1310,7 @@
[[bearr]][[GSDPG00111]][[client-container]]
-`client-container`
-~~~~~~~~~~~~~~~~~~
+=== `client-container`
Defines the GlassFish Server specific configuration for the application
client container. This is the root element; there can only be one
@@ -1412,15 +1319,13 @@
[[fvypv]][[GSDPG00392]][[superelements-26]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvypk]][[GSDPG00393]][[subelements-24]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `client-container`
element.
@@ -1486,8 +1391,7 @@
[[fvyqq]][[GSDPG00394]][[attributes-7]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `client-container`
element.
@@ -1509,8 +1413,7 @@
[[fvyrm]][[GSDPG00395]][[properties-3]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `client-container`
element.
@@ -1533,8 +1436,7 @@
[[bears]][[GSDPG00112]][[client-credential]]
-`client-credential`
-~~~~~~~~~~~~~~~~~~~
+=== `client-credential`
Default client credentials that are sent to the server. If this element
is present, the credentials are automatically sent to the server,
@@ -1543,15 +1445,13 @@
[[fvyqk]][[GSDPG00396]][[superelements-27]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearr[`client-container`] (`sun-acc.xml`)
[[fvyqd]][[GSDPG00397]][[subelements-25]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `client-credential`
element.
@@ -1574,8 +1474,7 @@
[[fvyqv]][[GSDPG00398]][[attributes-8]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `client-credential`
element.
@@ -1609,15 +1508,13 @@
[[fvyrg]][[GSDPG00399]][[superelements-28]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyqw]][[GSDPG00400]][[subelements-26]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cmp` element.
@@ -1658,8 +1555,7 @@
[[bearu]][[GSDPG00114]][[cmp-field-mapping]]
-`cmp-field-mapping`
-~~~~~~~~~~~~~~~~~~~
+=== `cmp-field-mapping`
The `cmp-field-mapping` element associates a field with one or more
columns to which it maps. The column can be from a bean's primary table
@@ -1671,15 +1567,13 @@
[[fvypy]][[GSDPG00401]][[superelements-29]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasy[`entity-mapping`] (`sun-cmp-mappings.xml`)
[[fvyra]][[GSDPG00402]][[subelements-27]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cmp-field-mapping`
element.
@@ -1724,8 +1618,7 @@
[[bearv]][[GSDPG00115]][[cmp-resource]]
-`cmp-resource`
-~~~~~~~~~~~~~~
+=== `cmp-resource`
Specifies the database to be used for storing CMP beans. For more
information about this element, see "link:../application-development-guide/container_managed-persistence.html#GSDVG00154[Configuring the
@@ -1734,15 +1627,13 @@
[[fvypz]][[GSDPG00403]][[superelements-30]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`)
[[fvyrf]][[GSDPG00404]][[subelements-28]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cmp-resource`
element.
@@ -1808,8 +1699,7 @@
[[bearw]][[GSDPG00116]][[cmr-field-mapping]]
-`cmr-field-mapping`
-~~~~~~~~~~~~~~~~~~~
+=== `cmr-field-mapping`
A container-managed relationship field has a name and one or more column
pairs that define the relationship. There is one `cmr-field-mapping`
@@ -1818,15 +1708,13 @@
[[fvyrc]][[GSDPG00405]][[superelements-31]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasy[`entity-mapping`] (`sun-cmp-mappings.xml`)
[[fvypu]][[GSDPG00406]][[subelements-29]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cmr-field-mapping`
element.
@@ -1865,8 +1753,7 @@
[[bearx]][[GSDPG00117]][[cmr-field-name]]
-`cmr-field-name`
-~~~~~~~~~~~~~~~~
+=== `cmr-field-name`
Specifies the Java identifier of a field. Must match the value of the
`cmr-field-name` subelement of the `cmr-field` element in the
@@ -1874,22 +1761,19 @@
[[fvyrx]][[GSDPG00407]][[superelements-32]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearw[`cmr-field-mapping`] (`sun-cmp-mappings.xml`)
[[fvyry]][[GSDPG00408]][[subelements-30]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beary]][[GSDPG00118]][[cmt-timeout-in-seconds]]
-`cmt-timeout-in-seconds`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `cmt-timeout-in-seconds`
Overrides the Transaction Timeout setting of the Transaction Service for
an individual bean. The default value, `0`, specifies that the default
@@ -1899,30 +1783,26 @@
[[fvysf]][[GSDPG00409]][[superelements-33]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvysc]][[GSDPG00410]][[subelements-31]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[bearz]][[GSDPG00119]][[column-name]]
-`column-name`
-~~~~~~~~~~~~~
+=== `column-name`
Specifies the name of a column from the primary table, or the qualified
table name (TABLE.COLUMN) of a column from a secondary or related table.
[[fvyse]][[GSDPG00411]][[superelements-34]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearn[`check-version-of-accessed-instances`],
link:#bearu[`cmp-field-mapping`], link:#beasa[`column-pair`]
@@ -1930,15 +1810,13 @@
[[fvysb]][[GSDPG00412]][[subelements-32]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasa]][[GSDPG00120]][[column-pair]]
-`column-pair`
-~~~~~~~~~~~~~
+=== `column-pair`
Specifies the pair of columns that determine the relationship between
two database tables. Each `column-pair` must contain exactly two
@@ -1948,16 +1826,14 @@
[[fvysa]][[GSDPG00413]][[superelements-35]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearw[`cmr-field-mapping`], link:#beaxe[`secondary-table`]
(`sun-cmp-mappings.xml`)
[[fvysg]][[GSDPG00414]][[subelements-33]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `column-pair` element.
@@ -1981,8 +1857,7 @@
[[beasb]][[GSDPG00121]][[commit-option]]
-`commit-option`
-~~~~~~~~~~~~~~~
+=== `commit-option`
Specifies the commit option used on transaction completion. Valid values
for GlassFish Server are `B` or `C`. Default value is `B`. Applies to
@@ -1997,22 +1872,19 @@
[[fvyrz]][[GSDPG00415]][[superelements-36]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvysd]][[GSDPG00416]][[subelements-34]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gjjak]][[GSDPG00122]][[compatibility]]
-`compatibility`
-~~~~~~~~~~~~~~~
+=== `compatibility`
Specifies the GlassFish Server release with which to be backward
compatible in terms of JAR visibility requirements for applications. The
@@ -2025,45 +1897,39 @@
[[gjjaf]][[GSDPG00417]][[superelements-37]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beaya[`glassfish-ejb-jar`] (`glassfish-ejb-jar.xml`)
[[gjjag]][[GSDPG00418]][[subelements-35]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasc]][[GSDPG00123]][[confidentiality]]
-`confidentiality`
-~~~~~~~~~~~~~~~~~
+=== `confidentiality`
Specifies if the target supports privacy-protected messages. The values
are `NONE`, `SUPPORTED`, or `REQUIRED`.
[[fvysi]][[GSDPG00419]][[superelements-38]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayh[`transport-config`] (`glassfish-ejb-jar.xml`)
[[fvysk]][[GSDPG00420]][[subelements-36]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giygu]][[GSDPG00124]][[connector-connection-pool]]
-`connector-connection-pool`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `connector-connection-pool`
Defines a connector connection pool.
@@ -2071,8 +1937,7 @@
[[superelements-39]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -2080,8 +1945,7 @@
[[subelements-37]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`connector-connection-pool` element.
@@ -2119,8 +1983,7 @@
[[attributes-9]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`connector-connection-pool` element. Changing the following attributes
@@ -2267,8 +2130,7 @@
[[properties-4]]
-Properties
-^^^^^^^^^^
+==== Properties
Most properties of the `connector-connection-pool` element are the names
of setter methods of the `managedconnectionfactory-class` element in the
@@ -2361,8 +2223,7 @@
[[giyhv]][[GSDPG00125]][[connector-resource]]
-`connector-resource`
-~~~~~~~~~~~~~~~~~~~~
+=== `connector-resource`
Defines the connection factory object of a specific connection
definition in a connector (resource adapter).
@@ -2371,8 +2232,7 @@
[[superelements-40]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -2380,8 +2240,7 @@
[[subelements-38]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `connector-resource`
element.
@@ -2411,8 +2270,7 @@
[[attributes-10]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `connector-resource`
element.
@@ -2447,23 +2305,20 @@
[[beasd]][[GSDPG00126]][[consistency]]
-`consistency`
-~~~~~~~~~~~~~
+=== `consistency`
Specifies container behavior in guaranteeing transactional consistency
of the data in the bean.
[[fvysj]][[GSDPG00421]][[superelements-41]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasy[`entity-mapping`] (`sun-cmp-mappings.xml`)
[[fvysl]][[GSDPG00422]][[subelements-39]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `consistency` element.
@@ -2518,8 +2373,7 @@
[[bease]][[GSDPG00127]][[constraint-field]]
-`constraint-field`
-~~~~~~~~~~~~~~~~~~
+=== `constraint-field`
Specifies a cacheability constraint for the given
link:#beayl[`url-pattern`] or link:#beaxo[`servlet-name`].
@@ -2530,15 +2384,13 @@
[[fvysm]][[GSDPG00423]][[superelements-42]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvyso]][[GSDPG00424]][[subelements-40]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `constraint-field`
element.
@@ -2562,8 +2414,7 @@
[[fvysq]][[GSDPG00425]][[attributes-11]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `constraint-field`
element.
@@ -2595,8 +2446,7 @@
[[beasf]][[GSDPG00128]][[constraint-field-value]]
-`constraint-field-value`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `constraint-field-value`
Specifies a value to be matched to the input parameter value. The
matching is case sensitive. For example:
@@ -2608,22 +2458,19 @@
[[fvyss]][[GSDPG00426]][[superelements-43]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bease[`constraint-field`] (`glassfish-web.xml`)
[[fvyst]][[GSDPG00427]][[subelements-41]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvysu]][[GSDPG00428]][[attributes-12]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`constraint-field-value` element.
@@ -2655,8 +2502,7 @@
[[beasg]][[GSDPG00129]][[context-root]]
-`context-root`
-~~~~~~~~~~~~~~
+=== `context-root`
Contains the web context root for the application or web application
that was packaged as a WAR file. Overrides the corresponding element in
@@ -2674,8 +2520,7 @@
[[fvysx]][[GSDPG00429]][[superelements-44]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayr[`web`] (`glassfish-application.xml`),
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
@@ -2684,15 +2529,13 @@
[[fvysw]][[GSDPG00430]][[subelements-42]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beash]][[GSDPG00130]][[cookie-properties]]
-`cookie-properties`
-~~~~~~~~~~~~~~~~~~~
+=== `cookie-properties`
Specifies session cookie properties.
@@ -2709,15 +2552,13 @@
[[fvysy]][[GSDPG00431]][[superelements-45]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxp[`session-config`] (`glassfish-web.xml`)
[[fvysz]][[GSDPG00432]][[subelements-43]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `cookie-properties`
element.
@@ -2740,8 +2581,7 @@
[[fvyta]][[GSDPG00433]][[properties-5]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `cookie-properties`
element.
@@ -2793,8 +2633,7 @@
[[beasi]][[GSDPG00131]][[create-tables-at-deploy]]
-`create-tables-at-deploy`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `create-tables-at-deploy`
Specifies whether database tables are created for beans that are
automatically mapped by the EJB container. If `true`, creates tables in
@@ -2807,22 +2646,19 @@
[[fvytc]][[GSDPG00434]][[superelements-46]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearv[`cmp-resource`] (`glassfish-ejb-jar.xml`)
[[fvytd]][[GSDPG00435]][[subelements-44]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giyhr]][[GSDPG00132]][[custom-resource]]
-`custom-resource`
-~~~~~~~~~~~~~~~~~
+=== `custom-resource`
Defines a custom resource, which specifies a custom server-wide resource
object factory. Such object factories implement the
@@ -2832,8 +2668,7 @@
[[superelements-47]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -2841,8 +2676,7 @@
[[subelements-45]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `custom-resource`
element.
@@ -2872,8 +2706,7 @@
[[attributes-13]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `custom-resource`
element.
@@ -2911,8 +2744,7 @@
[[beask]][[GSDPG00133]][[database-vendor-name]]
-`database-vendor-name`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `database-vendor-name`
Specifies the name of the database vendor for which tables can be
created. Allowed values are `javadb`, `db2`, `mssql`, `mysql`, `oracle`,
@@ -2931,45 +2763,39 @@
[[fvytf]][[GSDPG00436]][[superelements-48]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearv[`cmp-resource`] (`glassfish-ejb-jar.xml`)
[[fvyti]][[GSDPG00437]][[subelements-46]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gaubj]][[GSDPG00134]][[debugging-enabled]]
-`debugging-enabled`
-~~~~~~~~~~~~~~~~~~~
+=== `debugging-enabled`
Specifies whether the debugging servlet is enabled for this web service
endpoint. Allowed values are `true` (the default) and `false`.
[[gaubf]][[GSDPG00438]][[superelements-49]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[gaube]][[GSDPG00439]][[subelements-47]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasl]][[GSDPG00135]][[default]]
-`default`
-~~~~~~~~~
+=== `default`
Specifies that a field belongs to the default hierarchical fetch group,
and enables prefetching for a CMR field. To disable prefetching for
@@ -2978,37 +2804,32 @@
[[fvytg]][[GSDPG00440]][[superelements-50]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beatc[`fetched-with`] (`sun-cmp-mappings.xml`)
[[fvyth]][[GSDPG00441]][[subelements-48]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - element is present or absent
[[beasm]][[GSDPG00136]][[default-helper]]
-`default-helper`
-~~~~~~~~~~~~~~~~
+=== `default-helper`
Passes property values to the built-in `default`
link:#beare[`cache-helper`] class.
[[fvytj]][[GSDPG00442]][[superelements-51]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beard[`cache`] (`glassfish-web.xml`)
[[fvytk]][[GSDPG00443]][[subelements-49]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `default-helper`
element.
@@ -3031,8 +2852,7 @@
[[fvytp]][[GSDPG00444]][[properties-6]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `default-helper`
element.
@@ -3059,8 +2879,7 @@
[[beasn]][[GSDPG00137]][[default-resource-principal]]
-`default-resource-principal`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `default-resource-principal`
Specifies the default principal (user) for the resource.
@@ -3072,8 +2891,7 @@
[[fvytl]][[GSDPG00445]][[superelements-52]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaww[`resource-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`);
@@ -3082,8 +2900,7 @@
[[fvytn]][[GSDPG00446]][[subelements-50]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`default-resource-principal` element.
@@ -3113,15 +2930,13 @@
[[beaso]][[GSDPG00138]][[description]]
-`description`
-~~~~~~~~~~~~~
+=== `description`
Specifies a text description of the containing element.
[[fvytq]][[GSDPG00447]][[superelements-53]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavx[`property` (with attributes)], link:#gikqk[`valve`]
(`glassfish-web.xml`); link:#beaqs[`activation-config`],
@@ -3137,15 +2952,13 @@
[[fvyts]][[GSDPG00448]][[subelements-51]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gkhtw]][[GSDPG00139]][[disable-nonportable-jndi-names]]
-`disable-nonportable-jndi-names`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `disable-nonportable-jndi-names`
Because the EJB 3.1 specification defines portable EJB JNDI names, there
is less need for GlassFish Server specific JNDI names. By default,
@@ -3156,22 +2969,19 @@
[[gkhum]][[GSDPG00449]][[superelements-54]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaya[`glassfish-ejb-jar`] (`glassfish-ejb-jar.xml`)
[[gkhug]][[GSDPG00450]][[subelements-52]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasp]][[GSDPG00140]][[dispatcher]]
-`dispatcher`
-~~~~~~~~~~~~
+=== `dispatcher`
Specifies a comma-separated list of `RequestDispatcher` methods for
which caching is enabled on the target resource. Valid values are
@@ -3181,22 +2991,19 @@
[[fvytt]][[GSDPG00451]][[superelements-55]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvytv]][[GSDPG00452]][[subelements-53]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasq]][[GSDPG00141]][[drop-tables-at-undeploy]]
-`drop-tables-at-undeploy`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `drop-tables-at-undeploy`
Specifies whether database tables that were automatically created when
the bean(s) were last deployed are dropped when the bean(s) are
@@ -3209,15 +3016,13 @@
[[fvytu]][[GSDPG00453]][[superelements-56]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearv[`cmp-resource`] (`glassfish-ejb-jar.xml`)
[[fvytx]][[GSDPG00454]][[subelements-54]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
@@ -3246,15 +3051,13 @@
[[fvyty]][[GSDPG00455]][[superelements-57]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`)
[[fvytw]][[GSDPG00456]][[subelements-55]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `ejb` element.
@@ -3461,8 +3264,7 @@
[[fvyuf]][[GSDPG00457]][[attributes-14]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `ejb` element.
@@ -3482,8 +3284,7 @@
[[fvytz]][[GSDPG00458]][[example-3]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -3513,8 +3314,7 @@
[[beast]][[GSDPG00143]][[ejb-name]]
-`ejb-name`
-~~~~~~~~~~
+=== `ejb-name`
In the `glassfish-ejb-jar.xml` file, matches the `ejb-name` in the
corresponding `ejb-jar.xml` file. The name must be unique among the
@@ -3530,23 +3330,20 @@
[[fvyug]][[GSDPG00459]][[superelements-58]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`], link:#beauz[`method`] (`glassfish-ejb-jar.xml`);
link:#beasy[`entity-mapping`] (`sun-cmp-mappings.xml`)
[[fvyue]][[GSDPG00460]][[subelements-56]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasu]][[GSDPG00144]][[ejb-ref]]
-`ejb-ref`
-~~~~~~~~~
+=== `ejb-ref`
Maps the `ejb-ref-name` in the corresponding Jakarta EE deployment
descriptor file `ejb-ref` entry to the absolute `jndi-name` of a
@@ -3557,8 +3354,7 @@
[[fvyub]][[GSDPG00461]][[superelements-59]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`),
@@ -3567,8 +3363,7 @@
[[fvyua]][[GSDPG00462]][[subelements-57]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `ejb-ref` element.
@@ -3597,54 +3392,47 @@
[[beasv]][[GSDPG00145]][[ejb-ref-name]]
-`ejb-ref-name`
-~~~~~~~~~~~~~~
+=== `ejb-ref-name`
Specifies the `ejb-ref-name` in the corresponding Jakarta EE deployment
descriptor file `ejb-ref` entry.
[[fvyuh]][[GSDPG00463]][[superelements-60]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasu[`ejb-ref`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvyuj]][[GSDPG00464]][[subelements-58]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gaubh]][[GSDPG00146]][[eligible]]
-`eligible`
-~~~~~~~~~~
+=== `eligible`
Specifies whether the application client module is eligible to be Java
Web Start enabled. Allowed values are `true` (the default) and `false`.
[[gaubg]][[GSDPG00465]][[superelements-61]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#gauax[`java-web-start-access`]
(`glassfish-application-client.xml`)
[[gauaz]][[GSDPG00466]][[subelements-59]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beasw]][[GSDPG00147]][[endpoint-address-uri]]
-`endpoint-address-uri`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `endpoint-address-uri`
Specifies the relative path combined with the web server root to form
the fully qualified endpoint address for a web service endpoint. This is
@@ -3665,23 +3453,20 @@
[[fvyul]][[GSDPG00467]][[superelements-62]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvyum]][[GSDPG00468]][[subelements-60]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvyuk]][[GSDPG00469]][[example-4]]
-Example
-^^^^^^^
+==== Example
If the web server is listening at `http://localhost:8080`, the following
`endpoint-address-uri`:
@@ -3700,23 +3485,20 @@
[[beasx]][[GSDPG00148]][[enterprise-beans]]
-`enterprise-beans`
-~~~~~~~~~~~~~~~~~~
+=== `enterprise-beans`
Specifies all the runtime properties for an EJB JAR file in the
application.
[[fvyun]][[GSDPG00470]][[superelements-63]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaya[`glassfish-ejb-jar`] (`glassfish-ejb-jar.xml`)
[[fvyuo]][[GSDPG00471]][[subelements-61]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `enterprise-beans`
element.
@@ -3786,8 +3568,7 @@
[[fvyux]][[GSDPG00472]][[example-5]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -3819,22 +3600,19 @@
[[beasy]][[GSDPG00149]][[entity-mapping]]
-`entity-mapping`
-~~~~~~~~~~~~~~~~
+=== `entity-mapping`
Specifies the mapping a bean to database columns.
[[fvyus]][[GSDPG00473]][[superelements-64]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxy[`sun-cmp-mapping`] (`sun-cmp-mappings.xml`)
[[fvyur]][[GSDPG00474]][[subelements-62]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `entity-mapping`
element.
@@ -3893,52 +3671,45 @@
[[beasz]][[GSDPG00150]][[establish-trust-in-client]]
-`establish-trust-in-client`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `establish-trust-in-client`
Specifies if the target is capable of authenticating a client. The
values are `NONE`, `SUPPORTED`, or `REQUIRED`.
[[fvyuq]][[GSDPG00475]][[superelements-65]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayh[`transport-config`] (`glassfish-ejb-jar.xml`)
[[fvyuy]][[GSDPG00476]][[subelements-63]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beata]][[GSDPG00151]][[establish-trust-in-target]]
-`establish-trust-in-target`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `establish-trust-in-target`
Specifies if the target is capable of authenticating to a client. The
values are `NONE`, `SUPPORTED`, or `REQUIRED`.
[[fvyuu]][[GSDPG00477]][[superelements-66]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayh[`transport-config`] (`glassfish-ejb-jar.xml`)
[[fvyuv]][[GSDPG00478]][[subelements-64]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giyin]][[GSDPG00152]][[external-jndi-resource]]
-`external-jndi-resource`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `external-jndi-resource`
Defines a resource that resides in an external JNDI repository. For
example, a generic Java object could be stored in an LDAP server. An
@@ -3949,8 +3720,7 @@
[[superelements-67]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -3958,8 +3728,7 @@
[[subelements-65]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`external-jndi-resource` element.
@@ -3989,8 +3758,7 @@
[[attributes-15]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`external-jndi-resource` element.
@@ -4034,8 +3802,7 @@
[[beatc]][[GSDPG00153]][[fetched-with]]
-`fetched-with`
-~~~~~~~~~~~~~~
+=== `fetched-with`
Specifies the fetch group configuration for fields and relationships.
The `fetched-with` element has different allowed and default subelements
@@ -4076,16 +3843,14 @@
[[fvyuw]][[GSDPG00479]][[superelements-68]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearu[`cmp-field-mapping`], link:#bearw[`cmr-field-mapping`]
(`sun-cmp-mappings.xml`)
[[fvyup]][[GSDPG00480]][[subelements-66]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `fetched-with`
element.
@@ -4134,8 +3899,7 @@
[[beatd]][[GSDPG00154]][[field-name]]
-`field-name`
-~~~~~~~~~~~~
+=== `field-name`
Specifies the Java identifier of a field. This identifier must match the
value of the `field-name` subelement of the `cmp-field` element in the
@@ -4143,36 +3907,31 @@
[[fvzcm]][[GSDPG00481]][[superelements-69]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearu[`cmp-field-mapping`] (`sun-cmp-mappings.xml`)
[[fvyxs]][[GSDPG00482]][[subelements-67]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beate]][[GSDPG00155]][[finder]]
-`finder`
-~~~~~~~~
+=== `finder`
Describes the finders for CMP 1.1 with a method name and query.
[[fvzao]][[GSDPG00483]][[superelements-70]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavk[`one-one-finders`] (`glassfish-ejb-jar.xml`)
[[fvzdc]][[GSDPG00484]][[subelements-68]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `finder` element.
@@ -4219,23 +3978,20 @@
[[beatf]][[GSDPG00156]][[flush-at-end-of-method]]
-`flush-at-end-of-method`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `flush-at-end-of-method`
Specifies the methods that force a database flush after execution.
Applicable to entity beans.
[[fvzcw]][[GSDPG00485]][[superelements-71]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyza]][[GSDPG00486]][[subelements-69]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`flush-at-end-of-method` element.
@@ -4258,8 +4014,7 @@
[[beath]][[GSDPG00157]][[gen-classes]]
-`gen-classes`
-~~~~~~~~~~~~~
+=== `gen-classes`
Specifies all the generated class names for a bean.
@@ -4273,15 +4028,13 @@
[[fvyyh]][[GSDPG00487]][[superelements-72]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvzee]][[GSDPG00488]][[subelements-70]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `gen-classes` element.
@@ -4325,8 +4078,7 @@
[[beaxw]][[GSDPG00158]][[glassfish-application]]
-`glassfish-application`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `glassfish-application`
Defines the GlassFish Server specific configuration for an application.
This is the root element; there can only be one `glassfish-application`
@@ -4335,15 +4087,13 @@
[[fvzhn]][[GSDPG00489]][[superelements-73]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvzgn]][[GSDPG00490]][[subelements-71]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`glassfish-application` element.
@@ -4458,8 +4208,7 @@
[[beaxx]][[GSDPG00159]][[glassfish-application-client]]
-`glassfish-application-client`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `glassfish-application-client`
Defines the GlassFish Server specific configuration for an application
client. This is the root element; there can only be one
@@ -4469,15 +4218,13 @@
[[fvzgq]][[GSDPG00491]][[superelements-74]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvzja]][[GSDPG00492]][[subelements-72]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`glassfish-application-client` element.
@@ -4545,8 +4292,7 @@
[[beaya]][[GSDPG00160]][[glassfish-ejb-jar]]
-`glassfish-ejb-jar`
-~~~~~~~~~~~~~~~~~~~
+=== `glassfish-ejb-jar`
Defines the GlassFish Server specific configuration for an EJB JAR file.
This is the root element; there can only be one `glassfish-ejb-jar`
@@ -4555,15 +4301,13 @@
[[fvzhw]][[GSDPG00493]][[superelements-75]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvzfv]][[GSDPG00494]][[subelements-73]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `glassfish-ejb-jar`
element.
@@ -4621,8 +4365,7 @@
[[beayb]][[GSDPG00161]][[glassfish-web-app]]
-`glassfish-web-app`
-~~~~~~~~~~~~~~~~~~~
+=== `glassfish-web-app`
Defines GlassFish Server specific configuration for a web module. This
is the root element; there can only be one `glassfish-web-app` element
@@ -4631,15 +4374,13 @@
[[fvzgj]][[GSDPG00495]][[superelements-76]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvzhr]][[GSDPG00496]][[subelements-74]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `glassfish-web-app`
element.
@@ -4792,8 +4533,7 @@
[[fvzia]][[GSDPG00497]][[attributes-16]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `glassfish-web-app`
element.
@@ -4816,8 +4556,7 @@
[[fvzgt]][[GSDPG00498]][[properties-7]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `glassfish-web-app`
element.
@@ -4962,8 +4701,7 @@
[[giygy]][[GSDPG00162]][[group-map]]
-`group-map`
-~~~~~~~~~~~
+=== `group-map`
Maps an EIS group to a group defined in the GlassFish Server domain.
@@ -4971,15 +4709,13 @@
[[superelements-77]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyht[`work-security-map`] (`glassfish-resources.xml`)
[[giyid]][[GSDPG00499]][[subelements-75]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
@@ -4987,8 +4723,7 @@
[[attributes-17]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `group-map` element.
@@ -5009,73 +4744,63 @@
[[beati]][[GSDPG00163]][[group-name]]
-`group-name`
-~~~~~~~~~~~~
+=== `group-name`
Specifies a group name in the current realm.
[[fvzak]][[GSDPG00500]][[superelements-78]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxg[`security-role-mapping`] (`glassfish-application.xml`,
`glassfish-web.xml`, `glassfish-ejb-jar.xml`)
[[fvywm]][[GSDPG00501]][[subelements-76]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatk]][[GSDPG00502]][[http-method]]
-`http-method`
-^^^^^^^^^^^^^
+==== `http-method`
Specifies an HTTP method that is eligible for caching. The default is
`GET`.
[[fvzbq]][[GSDPG00317]][[superelements-79]]
-Superelements
-+++++++++++++
+===== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvyyj]][[GSDPG00318]][[subelements-77]]
-Subelements
-+++++++++++
+===== Subelements
none - contains data
[[beatm]][[GSDPG00164]][[idempotent-url-pattern]]
-`idempotent-url-pattern`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `idempotent-url-pattern`
Specifies a URL pattern for idempotent requests.
[[fvzaj]][[GSDPG00503]][[superelements-80]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvzea]][[GSDPG00504]][[subelements-78]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvyxx]][[GSDPG00505]][[attributes-18]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`idempotent-url-pattern` element.
@@ -5102,8 +4827,7 @@
[[fvyxy]][[GSDPG00506]][[example-6]]
-Example
-^^^^^^^
+==== Example
The following example specifies that all requests for the URI
`sun-java/*` are idempotent.
@@ -5115,45 +4839,39 @@
[[beatn]][[GSDPG00165]][[integrity]]
-`integrity`
-~~~~~~~~~~~
+=== `integrity`
Specifies if the target supports integrity-protected messages. The
values are `NONE`, `SUPPORTED`, or `REQUIRED`.
[[fvzdj]][[GSDPG00507]][[superelements-81]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayh[`transport-config`] (`glassfish-ejb-jar.xml`)
[[fvzdv]][[GSDPG00508]][[subelements-79]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beato]][[GSDPG00166]][[ior-security-config]]
-`ior-security-config`
-~~~~~~~~~~~~~~~~~~~~~
+=== `ior-security-config`
Specifies the security information for the interoperable object
reference (IOR).
[[fvzbe]][[GSDPG00509]][[superelements-82]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvzbv]][[GSDPG00510]][[subelements-80]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `ior-security-config`
element.
@@ -5189,73 +4907,63 @@
[[beatp]][[GSDPG00167]][[is-cache-overflow-allowed]]
-`is-cache-overflow-allowed`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `is-cache-overflow-allowed`
This element is deprecated. Do not use.
[[fvzcu]][[GSDPG00511]][[superelements-83]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`] (`glassfish-ejb-jar.xml`)
[[beatq]][[GSDPG00168]][[is-one-one-cmp]]
-`is-one-one-cmp`
-~~~~~~~~~~~~~~~~
+=== `is-one-one-cmp`
This element is not used.
[[fvyww]][[GSDPG00512]][[superelements-84]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beart[`cmp`] (`glassfish-ejb-jar.xml`)
[[beatr]][[GSDPG00169]][[is-read-only-bean]]
-`is-read-only-bean`
-~~~~~~~~~~~~~~~~~~~
+=== `is-read-only-bean`
Specifies that this entity bean is a read-only bean if `true`. If this
element is absent, the default value of `false` is used.
[[fvzan]][[GSDPG00513]][[superelements-85]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyvx]][[GSDPG00514]][[subelements-81]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatt]][[GSDPG00170]][[java-method]]
-`java-method`
-~~~~~~~~~~~~~
+=== `java-method`
Specifies a method.
[[fvyyw]][[GSDPG00515]][[superelements-86]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaut[`message`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvyvo]][[GSDPG00516]][[subelements-82]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `java-method` element.
@@ -5284,24 +4992,21 @@
[[gauax]][[GSDPG00171]][[java-web-start-access]]
-`java-web-start-access`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `java-web-start-access`
Specifies changes to default Java Web Start parameters for an embedded
or stand-alone application client module.
[[gauba]][[GSDPG00517]][[superelements-87]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxx[`glassfish-application-client`]
(`glassfish-application-client.xml`)
[[gauav]][[GSDPG00518]][[subelements-83]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`java-web-start-access` element.
@@ -5368,8 +5073,7 @@
[[giyil]][[GSDPG00172]][[jdbc-connection-pool]]
-`jdbc-connection-pool`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `jdbc-connection-pool`
Defines the attributes and properties that are required for creating a
JDBC connection pool.
@@ -5378,8 +5082,7 @@
[[superelements-88]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -5387,8 +5090,7 @@
[[subelements-84]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `jdbc-connection-pool`
element.
@@ -5418,8 +5120,7 @@
[[attributes-19]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `jdbc-connection-pool`
element. Changing the following attributes requires a server restart or
@@ -5721,8 +5422,7 @@
[[glassfish-server-properties]]
-GlassFish Server Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server Properties
The following table describes properties for the `jdbc-connection-pool`
element that are specific to GlassFish Server.
@@ -5767,8 +5467,7 @@
[[database-properties]]
-Database Properties
-^^^^^^^^^^^^^^^^^^^
+==== Database Properties
Most JDBC drivers allow use of standard property lists to specify the
user, password, and other resource configuration information. Although
@@ -5825,8 +5524,7 @@
[[giyhm]][[GSDPG00173]][[jdbc-resource]]
-`jdbc-resource`
-~~~~~~~~~~~~~~~
+=== `jdbc-resource`
Defines a JDBC (javax.sql.DataSource) resource.
@@ -5834,8 +5532,7 @@
[[superelements-89]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -5843,8 +5540,7 @@
[[subelements-85]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `jdbc-resource`
element.
@@ -5874,8 +5570,7 @@
[[attributes-20]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `jdbc-resource`
element.
@@ -5913,8 +5608,7 @@
[[beatu]][[GSDPG00174]][[jms-durable-subscription-name]]
-`jms-durable-subscription-name`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `jms-durable-subscription-name`
Specifies the durable subscription associated with a message-driven bean
class. Only applies to the Java Message Service Topic Destination type,
@@ -5923,22 +5617,19 @@
[[fvzdb]][[GSDPG00519]][[superelements-90]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvzdp]][[GSDPG00520]][[subelements-86]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatv]][[GSDPG00175]][[jms-max-messages-load]]
-`jms-max-messages-load`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `jms-max-messages-load`
Specifies the maximum number of messages to load into a Java Message
Service session at one time for a message-driven bean to serve. The
@@ -5946,22 +5637,19 @@
[[fvyzx]][[GSDPG00521]][[superelements-91]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyxq]][[GSDPG00522]][[subelements-87]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatw]][[GSDPG00176]][[jndi-name]]
-`jndi-name`
-~~~~~~~~~~~
+=== `jndi-name`
Specifies the absolute `jndi-name` of a URL resource or a resource.
@@ -5979,8 +5667,7 @@
[[fvyyy]][[GSDPG00523]][[superelements-92]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasu[`ejb-ref`], link:#beauu[`message-destination`],
link:#beawu[`resource-env-ref`], link:#beaww[`resource-ref`]
@@ -5991,15 +5678,13 @@
[[fvywz]][[GSDPG00524]][[subelements-88]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gkhun]][[GSDPG00177]][[jnlp-doc]]
-`jnlp-doc`
-~~~~~~~~~~
+=== `jnlp-doc`
Contains the name of a custom JNLP file, which modifies the behavior of
a Java Web Start enabled application client module. If none is
@@ -6042,37 +5727,32 @@
[[gkhuj]][[GSDPG00525]][[superelements-93]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#gauax[`java-web-start-access`]
(`glassfish-application-client.xml`)
[[gkhtm]][[GSDPG00526]][[subelements-89]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatx]][[GSDPG00178]][[jsp-config]]
-`jsp-config`
-~~~~~~~~~~~~
+=== `jsp-config`
Specifies JSP configuration information.
[[fvywi]][[GSDPG00527]][[superelements-94]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvzcs]][[GSDPG00528]][[subelements-90]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `jsp-config` element.
@@ -6094,8 +5774,7 @@
[[fvyzf]][[GSDPG00529]][[properties-8]]
-Properties
-^^^^^^^^^^
+==== Properties
The default property values are tuned for development of JSP files at
the cost of performance. To maximize performance, set `jsp-config`
@@ -6256,8 +5935,7 @@
[[gkhtr]][[GSDPG00179]][[keep-state]]
-`keep-state`
-~~~~~~~~~~~~
+=== `keep-state`
If set to `true`, retains web sessions, stateful session bean instances,
and persistently created EJB timers across redeployments. The
@@ -6288,8 +5966,7 @@
[[gkhto]][[GSDPG00530]][[superelements-95]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beayb[`glassfish-web-app`] (`glassfish-web-app.xml`),
@@ -6297,15 +5974,13 @@
[[gkhuk]][[GSDPG00531]][[subelements-91]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beatz]][[GSDPG00180]][[key-field]]
-`key-field`
-~~~~~~~~~~~
+=== `key-field`
Specifies a component of the key used to look up and extract cache
entries. The web container looks for the named parameter, or field, in
@@ -6318,22 +5993,19 @@
[[fvyvb]][[GSDPG00532]][[superelements-96]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvzal]][[GSDPG00533]][[subelements-92]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvzdn]][[GSDPG00534]][[attributes-21]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `key-field` element.
@@ -6356,8 +6028,7 @@
[[beaub]][[GSDPG00181]][[level]]
-`level`
-~~~~~~~
+=== `level`
Specifies the name of a hierarchical fetch group. The name must be an
integer. Fields and relationships that belong to a hierarchical fetch
@@ -6366,22 +6037,19 @@
[[fvyvf]][[GSDPG00535]][[superelements-97]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beatc[`fetched-with`] (`sun-cmp-mappings.xml`)
[[fvywq]][[GSDPG00536]][[subelements-93]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beauc]][[GSDPG00182]][[local-home-impl]]
-`local-home-impl`
-~~~~~~~~~~~~~~~~~
+=== `local-home-impl`
Specifies the fully-qualified class name of the generated `EJBLocalHome`
`impl` class.
@@ -6396,22 +6064,19 @@
[[fvyzo]][[GSDPG00537]][[superelements-98]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beath[`gen-classes`] (`glassfish-ejb-jar.xml`)
[[fvzah]][[GSDPG00538]][[subelements-94]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaud]][[GSDPG00183]][[local-impl]]
-`local-impl`
-~~~~~~~~~~~~
+=== `local-impl`
Specifies the fully-qualified class name of the generated
`EJBLocalObject` `impl` class.
@@ -6426,22 +6091,19 @@
[[fvzcr]][[GSDPG00539]][[superelements-99]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beath[`gen-classes`] (`glassfish-ejb-jar.xml`)
[[fvzai]][[GSDPG00540]][[subelements-95]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaue]][[GSDPG00184]][[locale-charset-info]]
-`locale-charset-info`
-~~~~~~~~~~~~~~~~~~~~~
+=== `locale-charset-info`
Deprecated. For backward compatibility only. Use the
link:#beavn[`parameter-encoding`] subelement of
@@ -6450,15 +6112,13 @@
[[fvyvm]][[GSDPG00541]][[superelements-100]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvzbi]][[GSDPG00542]][[subelements-96]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `locale-charset-info`
element.
@@ -6491,8 +6151,7 @@
[[fvywh]][[GSDPG00543]][[attributes-22]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `locale-charset-info`
element.
@@ -6513,8 +6172,7 @@
[[beauf]][[GSDPG00185]][[locale-charset-map]]
-`locale-charset-map`
-~~~~~~~~~~~~~~~~~~~~
+=== `locale-charset-map`
Maps locales and agents to character encodings. Provided for backward
compatibility. Used only for request processing. Used only if the
@@ -6525,15 +6183,13 @@
[[fvzbg]][[GSDPG00544]][[superelements-101]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaue[`locale-charset-info`] (`glassfish-web.xml`)
[[fvywg]][[GSDPG00545]][[subelements-97]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `locale-charset-map`
element.
@@ -6556,8 +6212,7 @@
[[fvyzn]][[GSDPG00546]][[attributes-23]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `locale-charset-map`
element.
@@ -6585,8 +6240,7 @@
[[fvzct]][[GSDPG00547]][[example-agents]]
-Example Agents
-^^^^^^^^^^^^^^
+==== Example Agents
The following table specifies example `agent` attribute values.
@@ -6610,15 +6264,13 @@
[[beaug]][[GSDPG00186]][[localpart]]
-`localpart`
-~~~~~~~~~~~
+=== `localpart`
Specifies the local part of a QNAME.
[[fvzad]][[GSDPG00548]][[superelements-102]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxj[`service-qname`], link:#beayx[`wsdl-port`]
(`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
@@ -6626,15 +6278,13 @@
[[fvyzb]][[GSDPG00549]][[subelements-98]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beauh]][[GSDPG00187]][[lock-when-loaded]]
-`lock-when-loaded`
-~~~~~~~~~~~~~~~~~~
+=== `lock-when-loaded`
Places a database update lock on the rows corresponding to the bean
whenever the bean is loaded. How the lock is placed is
@@ -6644,50 +6294,43 @@
[[fvyze]][[GSDPG00550]][[superelements-103]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`] (`sun-cmp-mappings.xml`)
[[fvyyl]][[GSDPG00551]][[subelements-99]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - element is present or absent
[[beaui]][[GSDPG00188]][[lock-when-modified]]
-`lock-when-modified`
-~~~~~~~~~~~~~~~~~~~~
+=== `lock-when-modified`
This element is not implemented. Do not use.
[[fvyyc]][[GSDPG00552]][[superelements-104]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`] (`sun-cmp-mappings.xml`)
[[beauj]][[GSDPG00189]][[log-service]]
-`log-service`
-~~~~~~~~~~~~~
+=== `log-service`
Specifies configuration settings for the log file.
[[fvyyv]][[GSDPG00553]][[superelements-105]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearr[`client-container`] (`sun-acc.xml`)
[[fvywo]][[GSDPG00554]][[subelements-100]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `log-service` element.
@@ -6709,8 +6352,7 @@
[[fvyzl]][[GSDPG00555]][[attributes-24]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `log-service` element.
@@ -6733,8 +6375,7 @@
[[beauk]][[GSDPG00190]][[login-config]]
-`login-config`
-~~~~~~~~~~~~~~
+=== `login-config`
Specifies the authentication configuration for an EJB web service
endpoint. Not needed for servlet web service endpoints. A servlet's
@@ -6742,16 +6383,14 @@
[[fvywb]][[GSDPG00556]][[superelements-106]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvyxg]][[GSDPG00557]][[subelements-101]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `login-config`
element.
@@ -6781,8 +6420,7 @@
[[giyik]][[GSDPG00191]][[mail-resource]]
-`mail-resource`
-~~~~~~~~~~~~~~~
+=== `mail-resource`
Defines a Jakarta Mail (`jakarta.mail.Session`) resource.
@@ -6790,8 +6428,7 @@
[[superelements-107]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -6799,8 +6436,7 @@
[[subelements-102]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `mail-resource`
element.
@@ -6830,8 +6466,7 @@
[[attributes-25]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `mail-resource`
element.
@@ -6904,8 +6539,7 @@
[[properties-9]]
-Properties
-^^^^^^^^^^
+==== Properties
You can set properties for the `mail-resource` element and then get
these properties in a Jakarta Mail `Session` object later. Every property
@@ -6941,22 +6575,19 @@
[[beaum]][[GSDPG00192]][[manager-properties]]
-`manager-properties`
-~~~~~~~~~~~~~~~~~~~~
+=== `manager-properties`
Specifies session manager properties.
[[fvyyu]][[GSDPG00558]][[superelements-108]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxq[`session-manager`] (`glassfish-web.xml`)
[[fvzcq]][[GSDPG00559]][[subelements-103]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `manager-properties`
element.
@@ -6979,8 +6610,7 @@
[[fvzdg]][[GSDPG00560]][[properties-10]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `manager-properties`
element.
@@ -7058,22 +6688,19 @@
[[beaun]][[GSDPG00193]][[mapping-properties]]
-`mapping-properties`
-~~~~~~~~~~~~~~~~~~~~
+=== `mapping-properties`
This element is not implemented.
[[fvywv]][[GSDPG00561]][[superelements-109]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beart[`cmp`] (`glassfish-ejb-jar.xml`)
[[beauo]][[GSDPG00194]][[max-cache-size]]
-`max-cache-size`
-~~~~~~~~~~~~~~~~
+=== `max-cache-size`
Specifies the maximum number of beans allowable in cache. A value of
zero indicates an unbounded cache. In reality, there is no hard limit.
@@ -7084,22 +6711,19 @@
[[fvyyo]][[GSDPG00562]][[superelements-110]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`] (`glassfish-ejb-jar.xml`)
[[fvzbx]][[GSDPG00563]][[subelements-104]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaup]][[GSDPG00195]][[max-pool-size]]
-`max-pool-size`
-~~~~~~~~~~~~~~~
+=== `max-pool-size`
Specifies the maximum number of bean instances in the pool. Values are
from 0 (1 for message-driven bean) to MAX_INTEGER. A value of 0 means
@@ -7109,36 +6733,31 @@
[[fvzdw]][[GSDPG00564]][[superelements-111]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearb[`bean-pool`] (`glassfish-ejb-jar.xml`)
[[fvyxa]][[GSDPG00565]][[subelements-105]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beauq]][[GSDPG00196]][[max-wait-time-in-millis]]
-`max-wait-time-in-millis`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `max-wait-time-in-millis`
This element is deprecated. Do not use.
[[fvyzg]][[GSDPG00566]][[superelements-112]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearb[`bean-pool`] (`glassfish-ejb-jar.xml`)
[[beaur]][[GSDPG00197]][[mdb-connection-factory]]
-`mdb-connection-factory`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `mdb-connection-factory`
Specifies the connection factory associated with a message-driven bean.
Queue or Topic type must be consistent with the Java Message Service
@@ -7146,15 +6765,13 @@
[[fvyzj]][[GSDPG00567]][[superelements-113]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyxt]][[GSDPG00568]][[subelements-106]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`mdb-connection-factory` element.
@@ -7184,22 +6801,19 @@
[[beaus]][[GSDPG00198]][[mdb-resource-adapter]]
-`mdb-resource-adapter`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `mdb-resource-adapter`
Specifies runtime configuration information for a message-driven bean.
[[fvzdd]][[GSDPG00569]][[superelements-114]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyyx]][[GSDPG00570]][[subelements-107]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `mdb-resource-adapter`
element.
@@ -7227,24 +6841,21 @@
[[beaut]][[GSDPG00199]][[message]]
-`message`
-~~~~~~~~~
+=== `message`
Specifies the methods or operations to which message security
requirements apply.
[[fvzci]][[GSDPG00571]][[superelements-115]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauw[`message-security`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyxc]][[GSDPG00572]][[subelements-108]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `message` element.
@@ -7273,8 +6884,7 @@
[[beauu]][[GSDPG00200]][[message-destination]]
-`message-destination`
-~~~~~~~~~~~~~~~~~~~~~
+=== `message-destination`
Specifies the name of a logical `message-destination` defined within an
application. The `message-destination-name` matches the corresponding
@@ -7285,8 +6895,7 @@
[[fvzaz]][[GSDPG00573]][[superelements-116]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`),
@@ -7295,8 +6904,7 @@
[[fvyxn]][[GSDPG00574]][[subelements-109]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `message-destination`
element.
@@ -7326,31 +6934,27 @@
[[beauv]][[GSDPG00201]][[message-destination-name]]
-`message-destination-name`
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `message-destination-name`
Specifies the name of a logical message destination defined within the
corresponding Jakarta EE deployment descriptor file.
[[fvzcj]][[GSDPG00575]][[superelements-117]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauu[`message-destination`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvzbo]][[GSDPG00576]][[subelements-110]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gauao]][[GSDPG00202]][[message-destination-ref]]
-`message-destination-ref`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `message-destination-ref`
Directly binds a message destination reference to the JNDI name of a
`Queue`, `Topic`, or other physical destination. Use only when the
@@ -7360,8 +6964,7 @@
[[gauam]][[GSDPG00577]][[superelements-118]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`),
@@ -7370,8 +6973,7 @@
[[gaual]][[GSDPG00578]][[subelements-111]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`message-destination-ref` element.
@@ -7401,31 +7003,27 @@
[[gauat]][[GSDPG00203]][[message-destination-ref-name]]
-`message-destination-ref-name`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `message-destination-ref-name`
Specifies the name of a physical message destination defined within the
corresponding Jakarta EE deployment descriptor file.
[[gauaj]][[GSDPG00579]][[superelements-119]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#gauao[`message-destination-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[gauas]][[GSDPG00580]][[subelements-112]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beauw]][[GSDPG00204]][[message-security]]
-`message-security`
-~~~~~~~~~~~~~~~~~~
+=== `message-security`
Specifies message security requirements.
@@ -7437,16 +7035,14 @@
[[fvzac]][[GSDPG00581]][[superelements-120]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaux[`message-security-binding`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyve]][[GSDPG00582]][[subelements-113]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `message-security`
element.
@@ -7484,8 +7080,7 @@
[[beaux]][[GSDPG00205]][[message-security-binding]]
-`message-security-binding`
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `message-security-binding`
Specifies a custom authentication provider binding for a parent
link:#beayv[`webservice-endpoint`] or link:#beavt[`port-info`] element
@@ -7497,8 +7092,7 @@
[[fvzbc]][[GSDPG00583]][[superelements-121]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`], link:#beavt[`port-info`]
(`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
@@ -7506,8 +7100,7 @@
[[fvyxv]][[GSDPG00584]][[subelements-114]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`message-security-binding` element.
@@ -7530,8 +7123,7 @@
[[fvzbj]][[GSDPG00585]][[attributes-26]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`message-security-binding` element.
@@ -7562,22 +7154,19 @@
[[beauy]][[GSDPG00206]][[message-security-config]]
-`message-security-config`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `message-security-config`
Specifies configurations for message security providers.
[[fvyya]][[GSDPG00586]][[superelements-122]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearr[`client-container`] (`sun-acc.xml`)
[[fvzck]][[GSDPG00587]][[subelements-115]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`message-security-config` element.
@@ -7601,8 +7190,7 @@
[[fvyvw]][[GSDPG00588]][[attributes-27]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`message-security-config` element.
@@ -7629,23 +7217,20 @@
[[beauz]][[GSDPG00207]][[method]]
-`method`
-~~~~~~~~
+=== `method`
Specifies a bean method.
[[fvzae]][[GSDPG00589]][[superelements-123]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearo[`checkpoint-at-end-of-method`],
link:#beatf[`flush-at-end-of-method`] (`glassfish-ejb-jar.xml`)
[[fvzay]][[GSDPG00590]][[subelements-116]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `method` element.
@@ -7694,8 +7279,7 @@
[[beava]][[GSDPG00208]][[method-intf]]
-`method-intf`
-~~~~~~~~~~~~~
+=== `method-intf`
Specifies the method interface to distinguish between methods with the
same name in different interfaces. Allowed values are `Home`, `Remote`,
@@ -7703,30 +7287,26 @@
[[fvywj]][[GSDPG00591]][[superelements-124]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauz[`method`] (`glassfish-ejb-jar.xml`)
[[fvyyz]][[GSDPG00592]][[subelements-117]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavb]][[GSDPG00209]][[method-name]]
-`method-name`
-~~~~~~~~~~~~~
+=== `method-name`
Specifies a method name or `*` (an asterisk) for all methods. If a
method is overloaded, specifies all methods with the same name.
[[fvyvp]][[GSDPG00593]][[superelements-125]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beatt[`java-method`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`);
@@ -7735,15 +7315,13 @@
[[fvzcp]][[GSDPG00594]][[subelements-118]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzdr]][[GSDPG00595]][[examples]]
-Examples
-^^^^^^^^
+==== Examples
`<method-name>findTeammates</method-name>`
@@ -7751,37 +7329,32 @@
[[beavc]][[GSDPG00210]][[method-param]]
-`method-param`
-~~~~~~~~~~~~~~
+=== `method-param`
Specifies the fully qualified Java type name of a method parameter.
[[fvzdl]][[GSDPG00596]][[superelements-126]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavd[`method-params`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyvj]][[GSDPG00597]][[subelements-119]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavd]][[GSDPG00211]][[method-params]]
-`method-params`
-~~~~~~~~~~~~~~~
+=== `method-params`
Specifies fully qualified Java type names of method parameters.
[[fvzdt]][[GSDPG00598]][[superelements-127]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beatt[`java-method`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`);
@@ -7790,8 +7363,7 @@
[[fvyzw]][[GSDPG00599]][[subelements-120]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `method-params`
element.
@@ -7822,8 +7394,7 @@
[[fvyyf]][[GSDPG00600]][[superelements-128]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beari[`call-property`], link:#beasn[`default-resource-principal`],
link:#beaxv[`stub-property`] (`glassfish-web.xml`,
@@ -7833,15 +7404,13 @@
[[fvyxe]][[GSDPG00601]][[subelements-121]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavg]][[GSDPG00213]][[named-group]]
-`named-group`
-~~~~~~~~~~~~~
+=== `named-group`
Specifies the name of one independent fetch group. All the fields and
relationships that are part of a named group are fetched at the same
@@ -7850,29 +7419,25 @@
[[fvzds]][[GSDPG00602]][[superelements-129]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beatc[`fetched-with`] (`sun-cmp-mappings.xml`)
[[fvyxr]][[GSDPG00603]][[subelements-122]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavh]][[GSDPG00214]][[namespaceuri]]
-`namespaceURI`
-~~~~~~~~~~~~~~
+=== `namespaceURI`
Specifies the namespace URI.
[[fvywa]][[GSDPG00604]][[superelements-130]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxj[`service-qname`], link:#beayx[`wsdl-port`]
(`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
@@ -7880,8 +7445,7 @@
[[fvyzc]][[GSDPG00605]][[subelements-123]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
@@ -7895,37 +7459,32 @@
[[fvyvv]][[GSDPG00606]][[superelements-131]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasd[`consistency`], link:#beatc[`fetched-with`]
(`sun-cmp-mappings.xml`)
[[fvzaw]][[GSDPG00607]][[subelements-124]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - element is present or absent
[[beavk]][[GSDPG00216]][[one-one-finders]]
-`one-one-finders`
-~~~~~~~~~~~~~~~~~
+=== `one-one-finders`
Describes the finders for CMP 1.1 beans.
[[fvyvg]][[GSDPG00608]][[superelements-132]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beart[`cmp`] (`glassfish-ejb-jar.xml`)
[[fvywp]][[GSDPG00609]][[subelements-125]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `one-one-finders`
element.
@@ -7949,30 +7508,26 @@
[[beavl]][[GSDPG00217]][[operation-name]]
-`operation-name`
-~~~~~~~~~~~~~~~~
+=== `operation-name`
Specifies the WSDL name of an operation of a web service.
[[fvzas]][[GSDPG00610]][[superelements-133]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaut[`message`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvyvt]][[GSDPG00611]][[subelements-126]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavn]][[GSDPG00218]][[parameter-encoding]]
-`parameter-encoding`
-~~~~~~~~~~~~~~~~~~~~
+=== `parameter-encoding`
Specifies the default request character encoding and how the web
container decodes parameters from forms according to a hidden field
@@ -7986,23 +7541,20 @@
[[fvyzr]][[GSDPG00612]][[superelements-134]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaue[`locale-charset-info`], link:#beayb[`glassfish-web-app`]
(`glassfish-web.xml`)
[[fvzbf]][[GSDPG00613]][[subelements-127]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvyxk]][[GSDPG00614]][[attributes-28]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `parameter-encoding`
element.
@@ -8027,8 +7579,7 @@
[[beavo]][[GSDPG00219]][[pass-by-reference]]
-`pass-by-reference`
-~~~~~~~~~~~~~~~~~~~
+=== `pass-by-reference`
Specifies the passing method used by a servlet or enterprise bean
calling a remote interface method in another bean that is colocated
@@ -8079,45 +7630,39 @@
[[fvzec]][[GSDPG00615]][[superelements-135]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvywx]][[GSDPG00616]][[subelements-128]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavp]][[GSDPG00220]][[password]]
-`password`
-~~~~~~~~~~
+=== `password`
Specifies the password for the principal.
[[fvyvn]][[GSDPG00617]][[superelements-136]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasn[`default-resource-principal`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyvs]][[GSDPG00618]][[subelements-129]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gkkia]][[GSDPG00221]][[per-request-load-balancing]]
-`per-request-load-balancing`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `per-request-load-balancing`
Specifies the per-request load balancing behavior of EJB 2.x and 3.x
remote client invocations on a stateless session bean. If set to `true`,
@@ -8127,36 +7672,31 @@
[[gkklx]][[GSDPG00619]][[superelements-137]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[gkkmq]][[GSDPG00620]][[subelements-130]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavq]][[GSDPG00222]][[pm-descriptors]]
-`pm-descriptors`
-~~~~~~~~~~~~~~~~
+=== `pm-descriptors`
This element and its subelements are deprecated. Do not use.
[[fvzbh]][[GSDPG00621]][[superelements-138]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`)
[[beavr]][[GSDPG00223]][[pool-idle-timeout-in-seconds]]
-`pool-idle-timeout-in-seconds`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `pool-idle-timeout-in-seconds`
Specifies the maximum time, in seconds, that a bean instance is allowed
to remain idle in the pool. When this timeout expires, the bean instance
@@ -8177,44 +7717,38 @@
[[fvzbm]][[GSDPG00622]][[superelements-139]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearb[`bean-pool`] (`glassfish-ejb-jar.xml`)
[[fvzbs]][[GSDPG00623]][[subelements-131]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavs]][[GSDPG00224]][[port-component-name]]
-`port-component-name`
-~~~~~~~~~~~~~~~~~~~~~
+=== `port-component-name`
Specifies a unique name for a port component within a web or EJB module.
[[fvzbl]][[GSDPG00624]][[superelements-140]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvyys]][[GSDPG00625]][[subelements-132]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beavt]][[GSDPG00225]][[port-info]]
-`port-info`
-~~~~~~~~~~~
+=== `port-info`
Specifies information for a port within a web service reference.
@@ -8231,16 +7765,14 @@
[[fvzdh]][[GSDPG00626]][[superelements-141]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxk[`service-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyva]][[GSDPG00627]][[subelements-133]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `port-info` element.
@@ -8291,8 +7823,7 @@
[[beavu]][[GSDPG00226]][[prefetch-disabled]]
-`prefetch-disabled`
-~~~~~~~~~~~~~~~~~~~
+=== `prefetch-disabled`
Disables prefetching of entity bean states for the specified query
methods. Container-managed relationship fields are prefetched if their
@@ -8300,15 +7831,13 @@
[[fvyxl]][[GSDPG00628]][[superelements-142]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beart[`cmp`] (`glassfish-ejb-jar.xml`)
[[fvyyb]][[GSDPG00629]][[subelements-134]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `prefetch-disabled`
element.
@@ -8331,23 +7860,20 @@
[[beavv]][[GSDPG00227]][[principal]]
-`principal`
-~~~~~~~~~~~
+=== `principal`
Defines a user name on the platform.
[[fvyvy]][[GSDPG00630]][[superelements-143]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`);
link:#giyhy[`security-map`] (`glassfish-resources.xml`)
[[fvzbt]][[GSDPG00631]][[subelements-135]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `principal` element.
@@ -8369,8 +7895,7 @@
[[giyif]][[GSDPG00228]][[principal-map]]
-`principal-map`
-~~~~~~~~~~~~~~~
+=== `principal-map`
Maps an EIS principal to a principal defined in the GlassFish Server
domain.
@@ -8379,15 +7904,13 @@
[[superelements-144]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyht[`work-security-map`] (`glassfish-resources.xml`)
[[giyjg]][[GSDPG00632]][[subelements-136]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
@@ -8395,8 +7918,7 @@
[[attributes-29]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `principal-map`
element.
@@ -8418,8 +7940,7 @@
[[beavw]][[GSDPG00229]][[principal-name]]
-`principal-name`
-~~~~~~~~~~~~~~~~
+=== `principal-name`
Contains the principal (user) name.
@@ -8428,8 +7949,7 @@
[[fvyws]][[GSDPG00633]][[superelements-145]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxg[`security-role-mapping`] (`glassfish-application.xml`,
`glassfish-web.xml`, `glassfish-ejb-jar.xml`), link:#beaxm[`servlet`]
@@ -8437,15 +7957,13 @@
[[fvyxp]][[GSDPG00634]][[subelements-137]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gatzl]][[GSDPG00635]][[attributes-30]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `principal-name`
element.
@@ -8466,8 +7984,7 @@
[[beavx]][[GSDPG00230]][[property-with-attributes]]
-`property` (with attributes)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `property` (with attributes)
Specifies the name and value of a property. A property adds
configuration information to its parent element that is one or both of
@@ -8479,8 +7996,7 @@
[[fvzeb]][[GSDPG00636]][[superelements-146]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beard[`cache`], link:#beare[`cache-helper`],
link:#bearq[`class-loader`], link:#beash[`cookie-properties`],
@@ -8501,8 +8017,7 @@
[[fvyzv]][[GSDPG00637]][[subelements-138]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `property` element.
@@ -8531,8 +8046,7 @@
[[fvyvi]][[GSDPG00638]][[attributes-31]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `property` element.
@@ -8551,8 +8065,7 @@
[[fvzab]][[GSDPG00639]][[example-7]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -8561,8 +8074,7 @@
[[beavy]][[GSDPG00231]][[property-with-subelements]]
-`property` (with subelements)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `property` (with subelements)
Specifies the name and value of a property. A property adds
configuration information to its parent element that is one or both of
@@ -8574,8 +8086,7 @@
[[fvzcl]][[GSDPG00640]][[superelements-147]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasx[`enterprise-beans`], link:#bearv[`cmp-resource`],
link:#beaxd[`schema-generator-properties`],
@@ -8583,8 +8094,7 @@
[[fvzaf]][[GSDPG00641]][[subelements-139]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `property` element.
@@ -8611,8 +8121,7 @@
[[fvyxz]][[GSDPG00642]][[example-8]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -8624,8 +8133,7 @@
[[beavz]][[GSDPG00232]][[provider-config]]
-`provider-config`
-~~~~~~~~~~~~~~~~~
+=== `provider-config`
Specifies a configuration for one message security provider.
@@ -8639,15 +8147,13 @@
[[fvzcy]][[GSDPG00643]][[superelements-148]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauy[`message-security-config`] (`sun-acc.xml`)
[[fvyzt]][[GSDPG00644]][[subelements-140]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `provider-config`
element.
@@ -8684,8 +8190,7 @@
[[fvywu]][[GSDPG00645]][[attributes-32]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `provider-config`
element.
@@ -8714,43 +8219,37 @@
[[beawb]][[GSDPG00233]][[query-filter]]
-`query-filter`
-~~~~~~~~~~~~~~
+=== `query-filter`
Specifies the query filter for the CMP 1.1 finder.
[[fvzdm]][[GSDPG00646]][[superelements-149]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beate[`finder`] (`glassfish-ejb-jar.xml`)
[[fvzco]][[GSDPG00647]][[subelements-141]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawc]][[GSDPG00234]][[query-method]]
-`query-method`
-~~~~~~~~~~~~~~
+=== `query-method`
Specifies a query method.
[[fvyxo]][[GSDPG00648]][[superelements-150]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavu[`prefetch-disabled`] (`glassfish-ejb-jar.xml`)
[[fvyzm]][[GSDPG00649]][[subelements-142]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `query-method`
element.
@@ -8780,93 +8279,80 @@
[[beawd]][[GSDPG00235]][[query-ordering]]
-`query-ordering`
-~~~~~~~~~~~~~~~~
+=== `query-ordering`
Specifies the query ordering for the CMP 1.1 finder.
[[fvzef]][[GSDPG00650]][[superelements-151]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beate[`finder`] (`glassfish-ejb-jar.xml`)
[[fvywd]][[GSDPG00651]][[subelements-143]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawe]][[GSDPG00236]][[query-params]]
-`query-params`
-~~~~~~~~~~~~~~
+=== `query-params`
Specifies the query parameters for the CMP 1.1 finder.
[[fvyvu]][[GSDPG00652]][[superelements-152]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beate[`finder`] (`glassfish-ejb-jar.xml`)
[[fvzax]][[GSDPG00653]][[subelements-144]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawf]][[GSDPG00237]][[query-variables]]
-`query-variables`
-~~~~~~~~~~~~~~~~~
+=== `query-variables`
Specifies variables in the query expression for the CMP 1.1 finder.
[[fvyyg]][[GSDPG00654]][[superelements-153]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beate[`finder`] (`glassfish-ejb-jar.xml`)
[[fvzce]][[GSDPG00655]][[subelements-145]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawh]][[GSDPG00238]][[read-only]]
-`read-only`
-~~~~~~~~~~~
+=== `read-only`
Specifies that a field is read-only if `true`. If this element is
absent, the default value is `false` .
[[fvyzs]][[GSDPG00656]][[superelements-154]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearu[`cmp-field-mapping`] (`sun-cmp-mappings.xml`)
[[fvzav]][[GSDPG00657]][[subelements-146]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawi]][[GSDPG00239]][[realm]]
-`realm`
-~~~~~~~
+=== `realm`
Specifies the name of the realm used to process all authentication
requests associated with this application. If this element is not
@@ -8877,8 +8363,7 @@
[[fvzaa]][[GSDPG00658]][[superelements-155]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beaqw[`as-context`], link:#beauk[`login-config`]
@@ -8886,37 +8371,32 @@
[[fvzdq]][[GSDPG00659]][[subelements-147]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawj]][[GSDPG00240]][[refresh-field]]
-`refresh-field`
-~~~~~~~~~~~~~~~
+=== `refresh-field`
Specifies a field that gives the application component a programmatic
way to refresh a cached entry.
[[fvywt]][[GSDPG00660]][[superelements-156]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvzbw]][[GSDPG00661]][[subelements-148]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvzbp]][[GSDPG00662]][[attributes-33]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `refresh-field`
element.
@@ -8940,8 +8420,7 @@
[[beawk]][[GSDPG00241]][[refresh-period-in-seconds]]
-`refresh-period-in-seconds`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `refresh-period-in-seconds`
Specifies the rate at which a read-only-bean must be refreshed from the
data source. If the value is less than or equal to zero, the bean is
@@ -8951,22 +8430,19 @@
[[fvzcn]][[GSDPG00663]][[superelements-157]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvyxh]][[GSDPG00664]][[subelements-149]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawl]][[GSDPG00242]][[removal-timeout-in-seconds]]
-`removal-timeout-in-seconds`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `removal-timeout-in-seconds`
Specifies the amount of time a bean instance can remain idle in the
container before it is removed (timeout). A value of 0 specifies that
@@ -8984,22 +8460,19 @@
[[fvzat]][[GSDPG00665]][[superelements-158]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`] (`glassfish-ejb-jar.xml`)
[[fvzeg]][[GSDPG00666]][[subelements-150]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawm]][[GSDPG00243]][[remote-home-impl]]
-`remote-home-impl`
-~~~~~~~~~~~~~~~~~~
+=== `remote-home-impl`
Specifies the fully-qualified class name of the generated `EJBHome`
`impl` class.
@@ -9014,22 +8487,19 @@
[[fvywr]][[GSDPG00667]][[superelements-159]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beath[`gen-classes`] (`glassfish-ejb-jar.xml`)
[[fvyyt]][[GSDPG00668]][[subelements-151]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawn]][[GSDPG00244]][[remote-impl]]
-`remote-impl`
-~~~~~~~~~~~~~
+=== `remote-impl`
Specifies the fully-qualified class name of the generated `EJBObject`
`impl` class.
@@ -9044,44 +8514,38 @@
[[fvyzi]][[GSDPG00669]][[superelements-160]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beath[`gen-classes`] (`glassfish-ejb-jar.xml`)
[[fvzag]][[GSDPG00670]][[subelements-152]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawo]][[GSDPG00245]][[request-policy]]
-`request-policy`
-~~~~~~~~~~~~~~~~
+=== `request-policy`
Defines the authentication policy requirements of the authentication
provider's request processing.
[[fvyxw]][[GSDPG00671]][[superelements-161]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavz[`provider-config`] (`sun-acc.xml`)
[[fvzdz]][[GSDPG00672]][[subelements-153]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvyvq]][[GSDPG00673]][[attributes-34]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `request-policy`
element.
@@ -9106,31 +8570,27 @@
[[beawp]][[GSDPG00246]][[request-protection]]
-`request-protection`
-~~~~~~~~~~~~~~~~~~~~
+=== `request-protection`
Defines the authentication policy requirements of the application's
request processing.
[[fvzcv]][[GSDPG00674]][[superelements-162]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauw[`message-security`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvzby]][[GSDPG00675]][[subelements-154]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvzar]][[GSDPG00676]][[attributes-35]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `request-protection`
element.
@@ -9155,8 +8615,7 @@
[[beawq]][[GSDPG00247]][[required]]
-`required`
-~~~~~~~~~~
+=== `required`
Specifies whether the authentication method specified in the
link:#beaqx[`auth-method`] element must be used for client
@@ -9164,22 +8623,19 @@
[[fvyvc]][[GSDPG00677]][[superelements-163]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaqw[`as-context`] (`glassfish-ejb-jar.xml`)
[[fvywc]][[GSDPG00678]][[subelements-155]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawr]][[GSDPG00248]][[res-ref-name]]
-`res-ref-name`
-~~~~~~~~~~~~~~
+=== `res-ref-name`
Specifies the `res-ref-name` in the corresponding Jakarta EE deployment
descriptor file `resource-ref` entry. The `res-ref-name` element
@@ -9188,23 +8644,20 @@
[[fvyvk]][[GSDPG00679]][[superelements-164]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaww[`resource-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyyp]][[GSDPG00680]][[subelements-156]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaws]][[GSDPG00249]][[resize-quantity]]
-`resize-quantity`
-~~~~~~~~~~~~~~~~~
+=== `resize-quantity`
Specifies the number of bean instances to be:
@@ -9243,23 +8696,20 @@
[[fvyxb]][[GSDPG00681]][[superelements-165]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`], link:#bearb[`bean-pool`]
(`glassfish-ejb-jar.xml`)
[[fvzcf]][[GSDPG00682]][[subelements-157]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giyit]][[GSDPG00250]][[resource-adapter-config]]
-`resource-adapter-config`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `resource-adapter-config`
Defines a connector (resource adapter) configuration. Stores
configuration information for the resource adapter JavaBean in
@@ -9269,8 +8719,7 @@
[[superelements-166]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
@@ -9278,8 +8727,7 @@
[[subelements-158]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`resource-adapter-config` element.
@@ -9304,8 +8752,7 @@
[[attributes-36]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the
`resource-adapter-config` element.
@@ -9343,8 +8790,7 @@
[[properties-11]]
-Properties
-^^^^^^^^^^
+==== Properties
Properties of the `resource-adapter-config` element are the names of
setter methods of the `resourceadapter-class` element in the `ra.xml`
@@ -9353,30 +8799,26 @@
[[beawt]][[GSDPG00251]][[resource-adapter-mid]]
-`resource-adapter-mid`
-~~~~~~~~~~~~~~~~~~~~~~
+=== `resource-adapter-mid`
Specifies the module ID of the resource adapter that is responsible for
delivering messages to the message-driven bean.
[[fvyvd]][[GSDPG00683]][[superelements-167]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaus[`mdb-resource-adapter`] (`glassfish-ejb-jar.xml`)
[[fvzed]][[GSDPG00684]][[subelements-159]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beawu]][[GSDPG00252]][[resource-env-ref]]
-`resource-env-ref`
-~~~~~~~~~~~~~~~~~~
+=== `resource-env-ref`
Maps the `res-ref-name` in the corresponding Jakarta EE deployment
descriptor file `resource-env-ref` entry to the absolute `jndi-name` of
@@ -9384,8 +8826,7 @@
[[fvyvr]][[GSDPG00685]][[superelements-168]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`),
@@ -9394,8 +8835,7 @@
[[fvywe]][[GSDPG00686]][[subelements-160]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `resource-env-ref`
element.
@@ -9425,8 +8865,7 @@
[[fvzdf]][[GSDPG00687]][[example-9]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -9438,31 +8877,27 @@
[[beawv]][[GSDPG00253]][[resource-env-ref-name]]
-`resource-env-ref-name`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `resource-env-ref-name`
Specifies the `res-ref-name` in the corresponding Jakarta EE deployment
descriptor file `resource-env-ref` entry.
[[fvzau]][[GSDPG00688]][[superelements-169]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beawu[`resource-env-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyxj]][[GSDPG00689]][[subelements-161]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaww]][[GSDPG00254]][[resource-ref]]
-`resource-ref`
-~~~~~~~~~~~~~~
+=== `resource-ref`
Maps the `res-ref-name` in the corresponding Jakarta EE deployment
descriptor file `resource-ref` entry to the absolute `jndi-name` of a
@@ -9487,8 +8922,7 @@
[[fvywf]][[GSDPG00690]][[superelements-170]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`),
@@ -9497,8 +8931,7 @@
[[fvyzz]][[GSDPG00691]][[subelements-162]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `resource-ref`
element.
@@ -9534,8 +8967,7 @@
[[fvyzk]][[GSDPG00692]][[example-10]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -9547,8 +8979,7 @@
[[giyiy]][[GSDPG00255]][[resources]]
-`resources`
-~~~~~~~~~~~
+=== `resources`
Defines application-scoped resources for an enterprise application, web
module, EJB module, connector module, or application client module. This
@@ -9570,8 +9001,7 @@
[[superelements-171]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
@@ -9579,8 +9009,7 @@
[[subelements-163]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `resources` element.
@@ -9667,30 +9096,26 @@
[[beawx]][[GSDPG00256]][[response-policy]]
-`response-policy`
-~~~~~~~~~~~~~~~~~
+=== `response-policy`
Defines the authentication policy requirements of the authentication
provider's response processing.
[[fvzcg]][[GSDPG00693]][[superelements-172]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavz[`provider-config`] (`sun-acc.xml`)
[[fvyxm]][[GSDPG00694]][[subelements-164]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvyxf]][[GSDPG00695]][[attributes-37]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `response-policy`
element.
@@ -9715,31 +9140,27 @@
[[beawy]][[GSDPG00257]][[response-protection]]
-`response-protection`
-~~~~~~~~~~~~~~~~~~~~~
+=== `response-protection`
Defines the authentication policy requirements of the application's
response processing.
[[fvzdk]][[GSDPG00696]][[superelements-173]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beauw[`message-security`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvyxd]][[GSDPG00697]][[subelements-165]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvzeh]][[GSDPG00698]][[attributes-38]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `response-protection`
element.
@@ -9764,45 +9185,39 @@
[[beawz]][[GSDPG00258]][[role-name]]
-`role-name`
-~~~~~~~~~~~
+=== `role-name`
Contains the `role-name` in the `security-role` element of the
corresponding Jakarta EE deployment descriptor file.
[[fvzek]][[GSDPG00699]][[superelements-174]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxg[`security-role-mapping`] (`glassfish-application.xml`,
`glassfish-web.xml`, `glassfish-ejb-jar.xml`)
[[fvzei]][[GSDPG00700]][[subelements-166]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxb]][[GSDPG00259]][[sas-context]]
-`sas-context`
-~~~~~~~~~~~~~
+=== `sas-context`
Describes the sas-context fields.
[[fvzel]][[GSDPG00701]][[superelements-175]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beato[`ior-security-config`] (`glassfish-ejb-jar.xml`)
[[fvzfb]][[GSDPG00702]][[subelements-167]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `sas-context` element.
@@ -9825,8 +9240,7 @@
[[beaxc]][[GSDPG00260]][[schema]]
-`schema`
-~~~~~~~~
+=== `schema`
Specifies the file that contains a description of the database schema to
which the beans in this `sun-cmp-mappings.xml` file are mapped. If this
@@ -9839,22 +9253,19 @@
[[fvzfa]][[GSDPG00703]][[superelements-176]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxy[`sun-cmp-mapping`] (`sun-cmp-mappings.xml`)
[[fvzeq]][[GSDPG00704]][[subelements-168]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzer]][[GSDPG00705]][[examples-1]]
-Examples
-^^^^^^^^
+==== Examples
[source,xml]
----
@@ -9865,22 +9276,19 @@
[[beaxd]][[GSDPG00261]][[schema-generator-properties]]
-`schema-generator-properties`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `schema-generator-properties`
Specifies field-specific column attributes in `property` subelements.
[[fvzen]][[GSDPG00706]][[superelements-177]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearv[`cmp-resource`] (`glassfish-ejb-jar.xml`)
[[fvzez]][[GSDPG00707]][[subelements-169]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`schema-generator-properties` element.
@@ -9903,8 +9311,7 @@
[[fvzew]][[GSDPG00708]][[properties-12]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the
`schema-generator-properties` element.
@@ -9967,8 +9374,7 @@
[[fvzem]][[GSDPG00709]][[example-11]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -9990,22 +9396,19 @@
[[beaxe]][[GSDPG00262]][[secondary-table]]
-`secondary-table`
-~~~~~~~~~~~~~~~~~
+=== `secondary-table`
Specifies a bean's secondary table(s).
[[fvzep]][[GSDPG00710]][[superelements-178]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasy[`entity-mapping`] (`sun-cmp-mappings.xml`)
[[fvzeo]][[GSDPG00711]][[subelements-170]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `secondary-table`
element.
@@ -10035,23 +9438,20 @@
[[beaxf]][[GSDPG00263]][[security]]
-`security`
-~~~~~~~~~~
+=== `security`
Defines the SSL security configuration for IIOP/SSL communication with
the target server.
[[fvzes]][[GSDPG00712]][[superelements-179]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaye[`target-server`] (`sun-acc.xml`)
[[fvzeu]][[GSDPG00713]][[subelements-171]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `security` element.
@@ -10078,8 +9478,7 @@
[[giyhy]][[GSDPG00264]][[security-map]]
-`security-map`
-~~~~~~~~~~~~~~
+=== `security-map`
Maps the principal received during servlet or EJB authentication to the
credentials accepted by the EIS. This mapping is optional. It is
@@ -10094,8 +9493,7 @@
[[superelements-180]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giygu[`connector-connection-pool`] (`glassfish-resources.xml`)
@@ -10103,8 +9501,7 @@
[[subelements-172]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `security-map`
element.
@@ -10139,8 +9536,7 @@
[[attributes-39]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `security-map` element.
@@ -10158,8 +9554,7 @@
[[beaxg]][[GSDPG00265]][[security-role-mapping]]
-`security-role-mapping`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `security-role-mapping`
Maps roles to users or groups in the currently active realm. See
"link:../application-development-guide/securing-apps.html#GSDVG00118[Realm Configuration]" in GlassFish Server Open Source
@@ -10175,8 +9570,7 @@
[[fvzfc]][[GSDPG00714]][[superelements-181]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
@@ -10184,8 +9578,7 @@
[[fvzfd]][[GSDPG00715]][[subelements-173]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`security-role-mapping` element.
@@ -10224,59 +9617,51 @@
[[beaxh]][[GSDPG00266]][[service-endpoint-interface]]
-`service-endpoint-interface`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `service-endpoint-interface`
Specifies the web service reference name relative to `java:comp/env`.
[[fvzfm]][[GSDPG00716]][[superelements-182]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavt[`port-info`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvzfl]][[GSDPG00717]][[subelements-174]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxi]][[GSDPG00267]][[service-impl-class]]
-`service-impl-class`
-~~~~~~~~~~~~~~~~~~~~
+=== `service-impl-class`
Specifies the name of the generated service implementation class.
[[fvzfg]][[GSDPG00718]][[superelements-183]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxk[`service-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvzfk]][[GSDPG00719]][[subelements-175]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxj]][[GSDPG00268]][[service-qname]]
-`service-qname`
-~~~~~~~~~~~~~~~
+=== `service-qname`
Specifies the WSDL service element that is being referred to.
[[fvzfn]][[GSDPG00720]][[superelements-184]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxk[`service-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`);
@@ -10285,8 +9670,7 @@
[[fvzff]][[GSDPG00721]][[subelements-176]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `service-qname`
element.
@@ -10314,8 +9698,7 @@
[[beaxk]][[GSDPG00269]][[service-ref]]
-`service-ref`
-~~~~~~~~~~~~~
+=== `service-ref`
Specifies runtime settings for a web service reference. Runtime
information is only needed in the following cases:
@@ -10328,8 +9711,7 @@
[[fvzfh]][[GSDPG00722]][[superelements-185]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`),
@@ -10338,8 +9720,7 @@
[[fvzhf]][[GSDPG00723]][[subelements-177]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `service-ref` element.
@@ -10397,45 +9778,39 @@
[[beaxl]][[GSDPG00270]][[service-ref-name]]
-`service-ref-name`
-~~~~~~~~~~~~~~~~~~
+=== `service-ref-name`
Specifies the web service reference name relative to `java:comp/env`.
[[fvzfx]][[GSDPG00724]][[superelements-186]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxk[`service-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvzga]][[GSDPG00725]][[subelements-178]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxm]][[GSDPG00271]][[servlet]]
-`servlet`
-~~~~~~~~~
+=== `servlet`
Specifies a principal name for a servlet. Used for the `run-as` role
defined in `web.xml`.
[[fvzgd]][[GSDPG00726]][[superelements-187]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvzhs]][[GSDPG00727]][[subelements-179]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `servlet` element.
@@ -10470,69 +9845,60 @@
[[beaxn]][[GSDPG00272]][[servlet-impl-class]]
-`servlet-impl-class`
-~~~~~~~~~~~~~~~~~~~~
+=== `servlet-impl-class`
Specifies the automatically generated name of the servlet implementation
class.
[[fvzhx]][[GSDPG00728]][[superelements-188]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvzfs]][[GSDPG00729]][[subelements-180]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxo]][[GSDPG00273]][[servlet-name]]
-`servlet-name`
-~~~~~~~~~~~~~~
+=== `servlet-name`
Specifies the name of a servlet, which is matched to a `servlet-name` in
`web.xml`. This name must be present in `web.xml`.
[[fvzhj]][[GSDPG00730]][[superelements-189]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`], link:#beaxm[`servlet`]
(`glassfish-web.xml`)
[[fvzir]][[GSDPG00731]][[subelements-181]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxp]][[GSDPG00274]][[session-config]]
-`session-config`
-~~~~~~~~~~~~~~~~
+=== `session-config`
Specifies session configuration information. Overrides the web container
settings for an individual web module.
[[fvzic]][[GSDPG00732]][[superelements-190]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[fvzfy]][[GSDPG00733]][[subelements-182]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `session-config`
element.
@@ -10565,22 +9931,19 @@
[[beaxq]][[GSDPG00275]][[session-manager]]
-`session-manager`
-~~~~~~~~~~~~~~~~~
+=== `session-manager`
Specifies session manager information.
[[fvzgx]][[GSDPG00734]][[superelements-191]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxp[`session-config`] (`glassfish-web.xml`)
[[fvzit]][[GSDPG00735]][[subelements-183]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `session-manager`
element.
@@ -10608,8 +9971,7 @@
[[fvzgm]][[GSDPG00736]][[attributes-40]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `session-manager`
element.
@@ -10636,22 +9998,19 @@
[[beaxr]][[GSDPG00276]][[session-properties]]
-`session-properties`
-~~~~~~~~~~~~~~~~~~~~
+=== `session-properties`
Specifies session properties.
[[fvzha]][[GSDPG00737]][[superelements-192]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxp[`session-config`] (`glassfish-web.xml`)
[[fvzgk]][[GSDPG00738]][[subelements-184]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `session-properties`
element.
@@ -10674,8 +10033,7 @@
[[fvzht]][[GSDPG00739]][[properties-13]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `session-properties`
element.
@@ -10720,22 +10078,19 @@
[[fvzft]][[GSDPG00740]][[superelements-193]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxf[`security`] (`sun-acc.xml`)
[[fvzgh]][[GSDPG00741]][[subelements-185]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none
[[fvzip]][[GSDPG00742]][[attributes-41]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `SSL` element.
@@ -10784,8 +10139,7 @@
[[beaxt]][[GSDPG00278]][[steady-pool-size]]
-`steady-pool-size`
-~~~~~~~~~~~~~~~~~~
+=== `steady-pool-size`
Specifies the initial and minimum number of bean instances that are
maintained in the pool. Default is 32. Applies to stateless session
@@ -10793,36 +10147,31 @@
[[fvziq]][[GSDPG00743]][[superelements-194]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearb[`bean-pool`] (`glassfish-ejb-jar.xml`)
[[fvziy]][[GSDPG00744]][[subelements-186]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaxu]][[GSDPG00279]][[store-properties]]
-`store-properties`
-~~~~~~~~~~~~~~~~~~
+=== `store-properties`
Specifies session persistence (storage) properties.
[[fvzie]][[GSDPG00745]][[superelements-195]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxq[`session-manager`] (`glassfish-web.xml`)
[[fvzid]][[GSDPG00746]][[subelements-187]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `store-properties`
element.
@@ -10845,8 +10194,7 @@
[[fvzho]][[GSDPG00747]][[properties-14]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `store-properties`
element.
@@ -10904,8 +10252,7 @@
[[beaxv]][[GSDPG00280]][[stub-property]]
-`stub-property`
-~~~~~~~~~~~~~~~
+=== `stub-property`
Specifies JAX-RPC property values that are set on a `javax.xml.rpc.Stub`
object before it is returned to the web service client. The property
@@ -10914,16 +10261,14 @@
[[fvzgu]][[GSDPG00748]][[superelements-196]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavt[`port-info`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvzij]][[GSDPG00749]][[subelements-188]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `stub-property`
element.
@@ -10951,8 +10296,7 @@
[[gawoa]][[GSDPG00750]][[properties-15]]
-Properties
-^^^^^^^^^^
+==== Properties
The following table describes properties for the `stub-property`
element.
@@ -10972,8 +10316,7 @@
[[fvzji]][[GSDPG00751]][[example-12]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -10995,8 +10338,7 @@
[[beaxy]][[GSDPG00281]][[sun-cmp-mapping]]
-`sun-cmp-mapping`
-~~~~~~~~~~~~~~~~~
+=== `sun-cmp-mapping`
Specifies beans mapped to a particular database schema.
@@ -11010,15 +10352,13 @@
[[fvzhh]][[GSDPG00752]][[superelements-197]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxz[`sun-cmp-mappings`] (`sun-cmp-mappings.xml`)
[[fvzjg]][[GSDPG00753]][[subelements-189]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `sun-cmp-mapping`
element.
@@ -11048,8 +10388,7 @@
[[beaxz]][[GSDPG00282]][[sun-cmp-mappings]]
-`sun-cmp-mappings`
-~~~~~~~~~~~~~~~~~~
+=== `sun-cmp-mappings`
Defines the GlassFish Server specific CMP mapping configuration for an
EJB JAR file. This is the root element; there can only be one
@@ -11058,15 +10397,13 @@
[[fvzix]][[GSDPG00754]][[superelements-198]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
none
[[fvzjj]][[GSDPG00755]][[subelements-190]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `sun-cmp-mappings`
element.
@@ -11089,8 +10426,7 @@
[[beayd]][[GSDPG00283]][[table-name]]
-`table-name`
-~~~~~~~~~~~~
+=== `table-name`
Specifies the name of a database table. The table must be present in the
database schema file. See "link:../application-development-guide/container_managed-persistence.html#GSDVG00439[Automatic Database Schema
@@ -11099,23 +10435,20 @@
[[fvzis]][[GSDPG00756]][[superelements-199]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beasy[`entity-mapping`], link:#beaxe[`secondary-table`]
(`sun-cmp-mappings.xml`)
[[fvzjk]][[GSDPG00757]][[subelements-191]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaye]][[GSDPG00284]][[target-server]]
-`target-server`
-~~~~~~~~~~~~~~~
+=== `target-server`
Specifies the IIOP listener for the target server. Also specifies IIOP
endpoints used for load balancing. If the GlassFish Server instance on
@@ -11133,15 +10466,13 @@
[[fvzgy]][[GSDPG00758]][[superelements-200]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearr[`client-container`] (`sun-acc.xml`)
[[fvzhi]][[GSDPG00759]][[subelements-192]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `target-server`
element.
@@ -11171,8 +10502,7 @@
[[fvzfp]][[GSDPG00760]][[attributes-42]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `target-server`
element.
@@ -11204,31 +10534,27 @@
[[beayf]][[GSDPG00285]][[tie-class]]
-`tie-class`
-~~~~~~~~~~~
+=== `tie-class`
Specifies the automatically generated name of a tie implementation class
for a port component.
[[fvzgz]][[GSDPG00761]][[superelements-201]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvzfq]][[GSDPG00762]][[subelements-193]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayg]][[GSDPG00286]][[timeout]]
-`timeout`
-~~~~~~~~~
+=== `timeout`
Specifies the link:#bearh[`cache-mapping`] specific maximum amount of
time in seconds that an entry can remain in the cache after it is
@@ -11237,22 +10563,19 @@
[[fvzhc]][[GSDPG00763]][[superelements-202]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvziv]][[GSDPG00764]][[subelements-194]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzhd]][[GSDPG00765]][[attributes-43]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `timeout` element.
@@ -11277,22 +10600,19 @@
[[beayh]][[GSDPG00287]][[transport-config]]
-`transport-config`
-~~~~~~~~~~~~~~~~~~
+=== `transport-config`
Specifies the security transport information.
[[fvzfo]][[GSDPG00766]][[superelements-203]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beato[`ior-security-config`] (`glassfish-ejb-jar.xml`)
[[fvzhv]][[GSDPG00767]][[subelements-195]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `transport-config`
element.
@@ -11337,8 +10657,7 @@
[[beayi]][[GSDPG00288]][[transport-guarantee]]
-`transport-guarantee`
-~~~~~~~~~~~~~~~~~~~~~
+=== `transport-guarantee`
Specifies that the communication between client and server is `NONE`,
`INTEGRAL`, or `CONFIDENTIAL`.
@@ -11357,23 +10676,20 @@
[[fvzhb]][[GSDPG00768]][[superelements-204]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayv[`webservice-endpoint`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvzgl]][[GSDPG00769]][[subelements-196]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayk]][[GSDPG00289]][[unique-id]]
-`unique-id`
-~~~~~~~~~~~
+=== `unique-id`
Contains the unique ID for the application. This value is automatically
updated each time the application is deployed or redeployed. Do not edit
@@ -11381,45 +10697,39 @@
[[fvzig]][[GSDPG00770]][[superelements-205]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`)
[[fvzjc]][[GSDPG00771]][[subelements-197]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayl]][[GSDPG00290]][[url-pattern]]
-`url-pattern`
-~~~~~~~~~~~~~
+=== `url-pattern`
Specifies a servlet URL pattern for which caching is enabled. See the
Servlet 2.4 specification section SRV. 11.2 for applicable patterns.
[[fvziw]][[GSDPG00772]][[superelements-206]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#bearh[`cache-mapping`] (`glassfish-web.xml`)
[[fvzfw]][[GSDPG00773]][[subelements-198]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[giyiq]][[GSDPG00291]][[user-group]]
-`user-group`
-~~~~~~~~~~~~
+=== `user-group`
Contains the group to which the principal belongs.
@@ -11427,8 +10737,7 @@
[[superelements-207]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyhy[`security-map`] (`glassfish-resources.xml`)
@@ -11436,44 +10745,38 @@
[[subelements-199]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beaym]][[GSDPG00292]][[use-thread-pool-id]]
-`use-thread-pool-id`
-~~~~~~~~~~~~~~~~~~~~
+=== `use-thread-pool-id`
Specifies the thread pool from which threads are selected for remote
invocations of this bean.
[[fvzhz]][[GSDPG00774]][[superelements-208]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beass[`ejb`] (`glassfish-ejb-jar.xml`)
[[fvzhp]][[GSDPG00775]][[subelements-200]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayo]][[GSDPG00293]][[value]]
-`value`
-~~~~~~~
+=== `value`
Specifies the value of the entity.
[[fvzhq]][[GSDPG00776]][[superelements-209]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beari[`call-property`], link:#beaxv[`stub-property`]
(`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
@@ -11482,15 +10785,13 @@
[[fvzhe]][[GSDPG00777]][[subelements-201]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gikqk]][[GSDPG00294]][[valve]]
-`valve`
-~~~~~~~
+=== `valve`
Specifies a custom valve for this web application. You can define a
valve for all the web applications on a specific virtual server. For
@@ -11498,15 +10799,13 @@
[[giksf]][[GSDPG00778]][[superelements-210]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`)
[[gikvt]][[GSDPG00779]][[subelements-202]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `valve` element.
@@ -11533,8 +10832,7 @@
[[gikuo]][[GSDPG00780]][[attributes-44]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `valve` element.
@@ -11558,8 +10856,7 @@
[[giksd]][[GSDPG00781]][[example-13]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -11571,8 +10868,7 @@
[[gbgdw]][[GSDPG00295]][[vendor]]
-`vendor`
-~~~~~~~~
+=== `vendor`
Specifies a vendor-specific icon, splash screen, text string, or a
combination of these for Java Web Start download and launch screens. The
@@ -11617,23 +10913,20 @@
[[gbgdu]][[GSDPG00782]][[superelements-211]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#gauax[`java-web-start-access`]
(`glassfish-application-client.xml`)
[[gbgcq]][[GSDPG00783]][[subelements-203]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[gkkfd]][[GSDPG00296]][[version-identifier]]
-`version-identifier`
-~~~~~~~~~~~~~~~~~~~~
+=== `version-identifier`
Contains version information for an application or module. For more
information about application versioning, see
@@ -11643,8 +10936,7 @@
[[superelements-212]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`),
link:#beayb[`glassfish-web-app`] (`glassfish-web-app.xml`),
@@ -11656,15 +10948,13 @@
[[subelements-204]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayp]][[GSDPG00297]][[victim-selection-policy]]
-`victim-selection-policy`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `victim-selection-policy`
Specifies how stateful session beans are selected for passivation.
Possible values are First In, First Out (`FIFO`), Least Recently Used
@@ -11688,22 +10978,19 @@
[[fvzhu]][[GSDPG00784]][[superelements-213]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beara[`bean-cache`] (`glassfish-ejb-jar.xml`)
[[fvzfr]][[GSDPG00785]][[subelements-205]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzgi]][[GSDPG00786]][[example-14]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -11724,15 +11011,13 @@
[[fvzil]][[GSDPG00787]][[superelements-214]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxw[`glassfish-application`] (`glassfish-application.xml`)
[[fvzge]][[GSDPG00788]][[subelements-206]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `web` element.
@@ -11759,45 +11044,39 @@
[[beays]][[GSDPG00299]][[web-uri]]
-`web-uri`
-~~~~~~~~~
+=== `web-uri`
Contains the web URI for the application. Must match the corresponding
element in the `application.xml` file.
[[fvzhk]][[GSDPG00789]][[superelements-215]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayr[`web`] (`glassfish-application.xml`)
[[fvzik]][[GSDPG00790]][[subelements-207]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayt]][[GSDPG00300]][[webservice-description]]
-`webservice-description`
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== `webservice-description`
Specifies a name and optional publish location for a web service.
[[fvzjd]][[GSDPG00791]][[superelements-216]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayb[`glassfish-web-app`] (`glassfish-web.xml`),
link:#beasx[`enterprise-beans`] (`glassfish-ejb-jar.xml`)
[[fvzgs]][[GSDPG00792]][[subelements-208]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the
`webservice-description` element.
@@ -11828,45 +11107,39 @@
[[beayu]][[GSDPG00301]][[webservice-description-name]]
-`webservice-description-name`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `webservice-description-name`
Specifies a unique name for the web service within a web or EJB module.
[[fvzgp]][[GSDPG00793]][[superelements-217]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayt[`webservice-description`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvzgw]][[GSDPG00794]][[subelements-209]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[beayv]][[GSDPG00302]][[webservice-endpoint]]
-`webservice-endpoint`
-~~~~~~~~~~~~~~~~~~~~~
+=== `webservice-endpoint`
Specifies information about a web service endpoint.
[[fvzio]][[GSDPG00795]][[superelements-218]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxm[`servlet`] (`glassfish-web.xml`), link:#beass[`ejb`]
(`glassfish-ejb-jar.xml`)
[[fvzjp]][[GSDPG00796]][[subelements-210]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `webservice-endpoint`
element.
@@ -11952,8 +11225,7 @@
[[giyht]][[GSDPG00303]][[work-security-map]]
-`work-security-map`
-~~~~~~~~~~~~~~~~~~~
+=== `work-security-map`
Defines a work security map, which maps a principal associated with an
incoming work instance to a principal in the GlassFish Server's security
@@ -11968,15 +11240,13 @@
[[superelements-219]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#giyiy[`resources`] (`glassfish-resources.xml`)
[[giyih]][[GSDPG00797]][[subelements-211]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `work-security-map`
element.
@@ -12015,8 +11285,7 @@
[[attributes-45]]
-Attributes
-^^^^^^^^^^
+==== Attributes
The following table describes attributes for the `work-security-map`
element.
@@ -12036,8 +11305,7 @@
[[beayw]][[GSDPG00304]][[wsdl-override]]
-`wsdl-override`
-~~~~~~~~~~~~~~~
+=== `wsdl-override`
Specifies a valid URL pointing to a final WSDL document. If not
specified, the WSDL document associated with the `service-ref` in the
@@ -12045,23 +11313,20 @@
[[fvzjl]][[GSDPG00798]][[superelements-220]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beaxk[`service-ref`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`, `glassfish-application-client.xml`)
[[fvzjq]][[GSDPG00799]][[subelements-212]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzjt]][[GSDPG00800]][[example-15]]
-Example
-^^^^^^^
+==== Example
[source,xml]
----
@@ -12074,23 +11339,20 @@
[[beayx]][[GSDPG00305]][[wsdl-port]]
-`wsdl-port`
-~~~~~~~~~~~
+=== `wsdl-port`
Specifies the WSDL port.
[[fvzjo]][[GSDPG00801]][[superelements-221]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beavt[`port-info`] (`glassfish-web.xml`, `glassfish-ejb-jar.xml`,
`glassfish-application-client.xml`)
[[fvzjm]][[GSDPG00802]][[subelements-213]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
The following table describes subelements for the `wsdl-port` element.
@@ -12117,8 +11379,7 @@
[[beayy]][[GSDPG00306]][[wsdl-publish-location]]
-`wsdl-publish-location`
-~~~~~~~~~~~~~~~~~~~~~~~
+=== `wsdl-publish-location`
Specifies the URL of a directory to which a web service's WSDL is
published during deployment. Any required files are published to this
@@ -12127,23 +11388,20 @@
[[fvzjw]][[GSDPG00803]][[superelements-222]]
-Superelements
-^^^^^^^^^^^^^
+==== Superelements
link:#beayt[`webservice-description`] (`glassfish-web.xml`,
`glassfish-ejb-jar.xml`)
[[fvzjr]][[GSDPG00804]][[subelements-214]]
-Subelements
-^^^^^^^^^^^
+==== Subelements
none - contains data
[[fvzjn]][[GSDPG00805]][[example-16]]
-Example
-^^^^^^^
+==== Example
Suppose you have an `ejb.jar` file whose `webservices.xml` file's
`wsdl-file` element contains the following reference:
diff --git a/docs/application-deployment-guide/src/main/jbake/content/dd-files.adoc b/docs/application-deployment-guide/src/main/jbake/content/dd-files.adoc
index a191248..5983389 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/dd-files.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/dd-files.adoc
@@ -5,15 +5,13 @@
prev=asadmin-deployment-subcommands.html
~~~~~~
-GlassFish Server Deployment Descriptor Files
-============================================
+= GlassFish Server Deployment Descriptor Files
[[GSDPG00006]][[giida]]
[[b-glassfish-server-deployment-descriptor-files]]
-B GlassFish Server Deployment Descriptor Files
-----------------------------------------------
+== B GlassFish Server Deployment Descriptor Files
This appendix describes the element hierarchies in the GlassFish Server
deployment descriptors that are included in this release of the
@@ -34,8 +32,7 @@
[[giiie]][[GSDPG00076]][[about-the-glassfish-server-deployment-descriptors]]
-About the GlassFish Server Deployment Descriptors
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About the GlassFish Server Deployment Descriptors
Each deployment descriptor XML file has a corresponding Document Type
Definition (DTD) file, which defines the elements, data, and attributes
@@ -109,8 +106,7 @@
[[beaqk]][[GSDPG00077]][[the-glassfish-application.xml-file]]
-The glassfish-application.xml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The glassfish-application.xml File
The `glassfish-application.xml` file configures an entire Jakarta EE
application (EAR file). The element hierarchy is as follows:
@@ -197,8 +193,7 @@
[[beaql]][[GSDPG00078]][[the-glassfish-web.xml-file]]
-The glassfish-web.xml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The glassfish-web.xml File
The `glassfish-web.xml` file configures a web application (WAR file).
The element hierarchy is as follows:
@@ -359,8 +354,7 @@
[[beaqm]][[GSDPG00079]][[the-glassfish-ejb-jar.xml-file]]
-The glassfish-ejb-jar.xml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The glassfish-ejb-jar.xml File
The `glassfish-ejb-jar.xml` file configures an enterprise bean (EJB JAR
file). The element hierarchy is as follows:
@@ -611,8 +605,7 @@
[[beaqn]][[GSDPG00080]][[the-sun-cmp-mappings.xml-file]]
-The sun-cmp-mappings.xml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The sun-cmp-mappings.xml File
The `sun-cmp-mappings.xml` file configures container-managed persistence
for an EJB 2.0 or 2.1 entity bean. The element hierarchy is as follows:
@@ -812,8 +805,7 @@
[[beaqo]][[GSDPG00081]][[the-glassfish-application-client.xml-file]]
-The glassfish-application-client.xml file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The glassfish-application-client.xml file
The `glassfish-application-client.xml` file configures an Application
Client Container (ACC) client (JAR file). The element hierarchy is as
@@ -897,8 +889,7 @@
[[beaqp]][[GSDPG00082]][[the-sun-acc.xml-file]]
-The sun-acc.xml File
-~~~~~~~~~~~~~~~~~~~~
+=== The sun-acc.xml File
The `sun-acc.xml` file configures the Application Client Container. This
is more of a configuration file than a deployment descriptor. GlassFish
@@ -930,8 +921,7 @@
[[giyhh]][[GSDPG00083]][[the-glassfish-resources.xml-file]]
-The glassfish-resources.xml File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The glassfish-resources.xml File
The `glassfish-resources.xml` file configures application-scoped
resources. The element hierarchy is as follows:
@@ -986,8 +976,7 @@
[[gkiot]][[GSDPG00084]][[weblogic-server-deployment-descriptor-support-in-glassfish-server]]
-WebLogic Server Deployment Descriptor Support in GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== WebLogic Server Deployment Descriptor Support in GlassFish Server
GlassFish Server offers limited support for the
`weblogic-application.xml`, `weblogic.xml`, and
diff --git a/docs/application-deployment-guide/src/main/jbake/content/deploying-applications.adoc b/docs/application-deployment-guide/src/main/jbake/content/deploying-applications.adoc
index f540420..16b5f2a 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/deploying-applications.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/deploying-applications.adoc
@@ -5,15 +5,13 @@
prev=overview.html
~~~~~~
-Deploying Applications
-======================
+= Deploying Applications
[[GSDPG00004]][[beact]]
[[deploying-applications]]
-2 Deploying Applications
-------------------------
+== 2 Deploying Applications
This chapter provides procedures and guidelines for deploying
applications and modules in the GlassFish Server Open Source
@@ -39,8 +37,7 @@
[[gilfm]][[GSDPG00065]][[deploying-applications-and-modules]]
-Deploying Applications and Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying Applications and Modules
Application deployment is a dynamic process, which means that deployed
applications and modules become available without requiring you to
@@ -69,8 +66,7 @@
[[gijmq]][[GSDPG00033]][[to-deploy-an-application-or-module]]
-To Deploy an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy an Application or Module
Use the `deploy` subcommand in remote mode to deploy an assembled
application or module to GlassFish Server. If an error occurs during
@@ -199,8 +195,7 @@
[[gijrc]][[GSDPG00034]][[to-change-targets-for-a-deployed-application-or-module]]
-To Change Targets for a Deployed Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change Targets for a Deployed Application or Module
After deployment, the deployed application or module exists in the
central repository and can be referenced by the server instances or
@@ -228,8 +223,7 @@
[[giulr]][[GSDPG00035]][[to-list-deployed-applications-or-modules]]
-To List Deployed Applications or Modules
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Deployed Applications or Modules
There are a number of commands that can be used to list deployed
applications or modules and their subcomponents. Use the commands in
@@ -294,8 +288,7 @@
[[gijmb]][[GSDPG00036]][[to-redeploy-an-application-or-module]]
-To Redeploy an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Redeploy an Application or Module
Use the `redeploy` subcommand in remote mode to overwrite a
previously-deployed application or module. You can also accomplish this
@@ -376,8 +369,7 @@
[[fvyje]][[GSDPG00037]][[to-disable-an-application-or-module]]
-To Disable an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Disable an Application or Module
Use the `disable` subcommand in remote mode to immediately deactivate a
deployed application or module without removing it from the server.
@@ -439,8 +431,7 @@
[[gijjy]][[GSDPG00038]][[to-enable-an-application-or-module]]
-To Enable an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable an Application or Module
An enabled application or module is runnable and can be accessed by
clients if it has been deployed to an accessible server instance or
@@ -487,8 +478,7 @@
[[gijkl]][[GSDPG00039]][[to-undeploy-an-application-or-module]]
-To Undeploy an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Undeploy an Application or Module
Use the `undeploy` subcommand in remote mode to uninstall a deployed
application or module and remove it from the repository. To reinstate
@@ -548,8 +538,7 @@
[[fwakh]][[GSDPG00040]][[to-reload-changes-to-applications-or-modules-dynamically]]
-To Reload Changes to Applications or Modules Dynamically
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Reload Changes to Applications or Modules Dynamically
Dynamic reloading enables you to change the code or deployment
descriptors of an application or module without needing to perform an
@@ -592,8 +581,7 @@
[[fvxze]][[GSDPG00041]][[to-deploy-an-application-or-module-automatically]]
-To Deploy an Application or Module Automatically
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy an Application or Module Automatically
[NOTE]
====
@@ -660,8 +648,7 @@
[[gijyb]][[GSDPG00042]][[to-deploy-an-application-or-module-by-using-a-deployment-plan]]
-To Deploy an Application or Module by Using a Deployment Plan
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy an Application or Module by Using a Deployment Plan
In the deployment plan for an EAR file, the `glassfish-application.xml`
file is located at the root. The deployment descriptor for each module
@@ -743,8 +730,7 @@
[[gilcn]][[GSDPG00043]][[to-deploy-an-application-or-module-in-a-directory-format]]
-To Deploy an Application or Module in a Directory Format
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy an Application or Module in a Directory Format
[NOTE]
@@ -835,8 +821,7 @@
[[gjiwk]][[GSDPG00066]][[modifying-the-configuration-of-a-web-application-or-module]]
-Modifying the Configuration of a Web Application or Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Modifying the Configuration of a Web Application or Module
You can modify the configuration of a web application or a module by
modifying the deployment descriptors and then repackaging and
@@ -859,8 +844,7 @@
[[giyce]][[GSDPG00044]][[to-set-a-web-context-parameter]]
-To Set a Web Context Parameter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set a Web Context Parameter
Use the `set-web-context-param` subcommand in remote mode to change the
configuration of a deployed application without the need to modify the
@@ -922,8 +906,7 @@
[[giycy]][[GSDPG00045]][[to-unset-a-web-context-parameter]]
-To Unset a Web Context Parameter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Unset a Web Context Parameter
Use the `unset-web-context-param` subcommand in remote mode to unset an
environment entry for a deployed web application or module that has been
@@ -984,8 +967,7 @@
[[giybo]][[GSDPG00046]][[to-list-web-context-parameters]]
-To List Web Context Parameters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Web Context Parameters
Use the `list-web-context-param` subcommand in remote mode to list the
parameters that have previously been set by using the
@@ -1036,8 +1018,7 @@
[[giyhc]][[GSDPG00047]][[to-set-a-web-environment-entry]]
-To Set a Web Environment Entry
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set a Web Environment Entry
An application uses the values of environment entries to customize its
behavior or presentation. Use the `set-web-env-entry` subcommand in
@@ -1100,8 +1081,7 @@
[[giyjr]][[GSDPG00048]][[to-unset-a-web-environment-entry]]
-To Unset a Web Environment Entry
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Unset a Web Environment Entry
Use the `unset-web-env-entry` subcommand in remote mode to unset an
environment entry for a deployed web application or module.
@@ -1136,8 +1116,7 @@
[[giyip]][[GSDPG00049]][[to-list-web-environment-entries]]
-To List Web Environment Entries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Web Environment Entries
Use the `list-web-env-entry` subcommand to list environment entries for
a deployed web application or module. For each entry, the following
@@ -1181,8 +1160,7 @@
[[beaej]][[GSDPG00067]][[web-module-deployment-guidelines]]
-Web Module Deployment Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Web Module Deployment Guidelines
The following guidelines apply to deploying a web module in GlassFish
Server:
@@ -1265,8 +1243,7 @@
[[beaek]][[GSDPG00068]][[ejb-module-deployment-guidelines]]
-EJB Module Deployment Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== EJB Module Deployment Guidelines
[NOTE]
@@ -1325,8 +1302,7 @@
[[gilxc]][[GSDPG00069]][[deploying-a-connector-module]]
-Deploying a Connector Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying a Connector Module
Deploying a stand-alone connector module allows multiple deployed Java
EE applications to share the connector module. A resource adapter
@@ -1340,8 +1316,7 @@
[[fvynl]][[GSDPG00050]][[to-deploy-and-configure-a-stand-alone-connector-module]]
-To Deploy and Configure a Stand-Alone Connector Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy and Configure a Stand-Alone Connector Module
As an alternative to Step link:#gkojp[3] through Step link:#gkohy[6],
you can define application-scoped resources in the
@@ -1387,8 +1362,7 @@
[[bealp]][[GSDPG00332]][[redeploying-a-stand-alone-connector-module]]
-Redeploying a Stand-Alone Connector Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Redeploying a Stand-Alone Connector Module
Redeployment of a connector module maintains all connector connection
pools, connector resources, and administered objects defined for the
@@ -1416,8 +1390,7 @@
[[bealq]][[GSDPG00333]][[deploying-and-configuring-an-embedded-resource-adapter]]
-Deploying and Configuring an Embedded Resource Adapter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying and Configuring an Embedded Resource Adapter
A connector module can be deployed as a Jakarta EE component in a Jakarta EE
application. Such connectors are only visible to components residing in
@@ -1442,8 +1415,7 @@
[[beaem]][[GSDPG00070]][[assembling-and-deploying-an-application-client-module]]
-Assembling and Deploying an Application Client Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Assembling and Deploying an Application Client Module
Deployment is necessary for application clients that communicate with
EJB components or that use Java Web Start launch support. Java Web Start
@@ -1468,8 +1440,7 @@
[[fvyal]][[GSDPG00051]][[to-assemble-and-deploy-an-application-client]]
-To Assemble and Deploy an Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Assemble and Deploy an Application Client
1. Assemble the necessary client components.
+
@@ -1535,8 +1506,7 @@
[[fwahd]][[GSDPG00052]][[to-prepare-another-machine-for-running-an-application-client]]
-To Prepare Another Machine for Running an Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Prepare Another Machine for Running an Application Client
If Java Web Start is enabled, the default URL format for an application
is `http://`host:port`/`context-root. For example:
@@ -1603,8 +1573,7 @@
[[gavpv]][[GSDPG00334]][[to-undeploy-an-application-client]]
-To Undeploy an Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Undeploy an Application Client
After application clients are downloaded, they remain on the client
until they are manually removed. Use the Java Web Start control panel to
@@ -1628,8 +1597,7 @@
[[beael]][[GSDPG00071]][[lifecycle-module-deployment-guidelines]]
-Lifecycle Module Deployment Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Lifecycle Module Deployment Guidelines
A lifecycle module, also called a lifecycle listener module, provides a
means of running long or short Java-based tasks within the GlassFish
@@ -1667,8 +1635,7 @@
[[gbiye]][[GSDPG00072]][[web-service-deployment-guidelines]]
-Web Service Deployment Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Web Service Deployment Guidelines
[NOTE]
@@ -1703,8 +1670,7 @@
[[gkkmb]][[GSDPG00073]][[osgi-bundle-deployment-guidelines]]
-OSGi Bundle Deployment Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== OSGi Bundle Deployment Guidelines
To deploy an OSGi bundle using the Administration Console, select Other
from the Type drop-down list and check the OSGI Type checkbox.
@@ -1736,8 +1702,7 @@
[[gkoif]][[GSDPG00074]][[transparent-jdbc-connection-pool-reconfiguration]]
-Transparent JDBC Connection Pool Reconfiguration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Transparent JDBC Connection Pool Reconfiguration
In this GlassFish Server release, reconfiguration of a JDBC connection
pool due to attribute or property changes can be transparent to the
@@ -1769,8 +1734,7 @@
[[giydj]][[GSDPG00075]][[application-scoped-resources]]
-Application-Scoped Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Application-Scoped Resources
You can define an application-scoped JDBC resource or other resource for
an enterprise application, web module, EJB module, connector module, or
diff --git a/docs/application-deployment-guide/src/main/jbake/content/loe.adoc b/docs/application-deployment-guide/src/main/jbake/content/loe.adoc
index 07734b8..0b9e6c3 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/loe.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:deploying-applications.html#gijlo[2-1 Deploying an Enterprise
Application]
diff --git a/docs/application-deployment-guide/src/main/jbake/content/lof.adoc b/docs/application-deployment-guide/src/main/jbake/content/lof.adoc
index 333254a..7b865b8 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/lof.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/lof.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Figures
-===============
+= List of Figures
[[list-of-figures]]
-List of Figures
----------------
+== List of Figures
* link:overview.html#fwfdj[1-1 Module-Based Assembly and Deployment]
* link:overview.html#fvyip[1-2 Application-Based Assembly and Deployment]
diff --git a/docs/application-deployment-guide/src/main/jbake/content/lot.adoc b/docs/application-deployment-guide/src/main/jbake/content/lot.adoc
index e3017eb..afb520d 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/lot.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=lof.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:dd-files.html#giiht[B-1 GlassFish Server Deployment Descriptors
and DTDs]
diff --git a/docs/application-deployment-guide/src/main/jbake/content/overview.adoc b/docs/application-deployment-guide/src/main/jbake/content/overview.adoc
index 8c0067f..42a8e23 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/overview.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/overview.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Overview of GlassFish Server Open Source Edition 7 Application Deployment
-=========================================================================
+= Overview of GlassFish Server Open Source Edition 7 Application Deployment
[[GSDPG00003]][[gihxo]]
[[overview-of-glassfish-server-open-source-edition-5.0-application-deployment]]
-1 Overview of GlassFish Server Open Source Edition 7 Application Deployment
----------------------------------------------------------------------------
+== 1 Overview of GlassFish Server Open Source Edition 7 Application Deployment
GlassFish Server Open Source Edition 7 provides an environment for
developing and deploying Java applications and web services. GlassFish
@@ -37,8 +35,7 @@
[[gihzx]][[GSDPG00061]][[about-application-deployment]]
-About Application Deployment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Application Deployment
Assembly, also known as packaging, is the process of combining discrete
components of an application or module into a single unit that can be
@@ -67,8 +64,7 @@
[[giptw]][[GSDPG00319]][[general-deployment-functionality]]
-General Deployment Functionality
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== General Deployment Functionality
Various Jakarta EE module types, such as connector module, web module, EJB
module, application client module, can be deployed in the following
@@ -124,8 +120,7 @@
[[gihzc]][[GSDPG00320]][[deployment-descriptors-and-annotations]]
-Deployment Descriptors and Annotations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deployment Descriptors and Annotations
A deployment descriptor is an XML file that describes how a Jakarta EE
application or module should be deployed. Each deployment descriptor XML
@@ -222,8 +217,7 @@
[[gikhs]][[GSDPG00321]][[modules-and-applications]]
-Modules and Applications
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Modules and Applications
An application is a logical collection of one or more modules joined by
application annotations or deployment descriptors. You assemble
@@ -244,8 +238,7 @@
[[beacv]][[GSDPG00307]][[types-of-modules]]
-Types of Modules
-++++++++++++++++
+===== Types of Modules
GlassFish Server supports the following types of modules:
@@ -293,8 +286,7 @@
[[beacu]][[GSDPG00308]][[module-based-deployment]]
-Module-Based Deployment
-+++++++++++++++++++++++
+===== Module-Based Deployment
You can deploy web, EJB, and application client modules separately,
outside of any application. Module-based deployment is appropriate when
@@ -316,8 +308,7 @@
[[beacw]][[GSDPG00309]][[application-based-deployment]]
-Application-Based Deployment
-++++++++++++++++++++++++++++
+===== Application-Based Deployment
Application-based deployment is appropriate when components need to work
together as one unit.
@@ -335,8 +326,7 @@
[[gijla]][[GSDPG00322]][[access-to-shared-framework-classes]]
-Access to Shared Framework Classes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Access to Shared Framework Classes
If you assemble a large, shared library into every module that uses it,
the result is a huge file that takes too long to register with the
@@ -373,8 +363,7 @@
[[gihzk]][[GSDPG00323]][[naming-standards]]
-Naming Standards
-^^^^^^^^^^^^^^^^
+==== Naming Standards
Names of applications and individually-deployed modules must be unique
within a GlassFish Server domain. Modules within an application must
@@ -399,8 +388,7 @@
[[gjjfg]][[GSDPG00310]][[portable-naming]]
-Portable Naming
-+++++++++++++++
+===== Portable Naming
Starting in Jakarta EE 6, the Jakarta EE specification defines the portable
`application-name`, which allows you to specify an application name in
@@ -427,8 +415,7 @@
[[giidg]][[GSDPG00311]][[jndi-naming]]
-JNDI Naming
-+++++++++++
+===== JNDI Naming
Java Naming and Directory Interface (JNDI) lookup names for EJB
components must also be unique. Establishing a consistent naming
@@ -438,8 +425,7 @@
[[beada]][[GSDPG00312]][[directory-structure]]
-Directory Structure
-+++++++++++++++++++
+===== Directory Structure
Application and module directory structures must follow the structure
outlined in the Jakarta EE specification. During deployment, the
@@ -456,8 +442,7 @@
[[gkhhv]][[GSDPG00324]][[module-and-application-versions]]
-Module and Application Versions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Module and Application Versions
Application and module versioning allows multiple versions of the same
application to exist in a GlassFish Server domain, which simplifies
@@ -477,8 +462,7 @@
[[gkhmg]][[GSDPG00314]][[version-identifiers-and-expressions]]
-Version Identifiers and Expressions
-+++++++++++++++++++++++++++++++++++
+===== Version Identifiers and Expressions
The version identifier is a suffix to the module or application name. It
is separated from the name by a colon (`:`). It must begin with a letter
@@ -540,8 +524,7 @@
[[gkhmm]][[GSDPG00315]][[choosing-the-enabled-version]]
-Choosing the Enabled Version
-++++++++++++++++++++++++++++
+===== Choosing the Enabled Version
At most one version of a module or application can be enabled on a
server instance. All other versions are disabled. Enabling one version
@@ -559,8 +542,7 @@
[[gkhob]][[GSDPG00316]][[versioning-restrictions-and-limitations]]
-Versioning Restrictions and Limitations
-+++++++++++++++++++++++++++++++++++++++
+===== Versioning Restrictions and Limitations
Module and application versioning in GlassFish Server is subject to the
following restrictions and limitations:
@@ -598,8 +580,7 @@
[[giphm]][[GSDPG00062]][[about-assembly-and-deployment-events]]
-About Assembly and Deployment Events
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Assembly and Deployment Events
The deployment tools that are provided by GlassFish Server can be used
by any user authorized as an administrator to deploy applications and
@@ -646,8 +627,7 @@
[[giifh]][[GSDPG00063]][[about-deployment-tools]]
-About Deployment Tools
-~~~~~~~~~~~~~~~~~~~~~~
+=== About Deployment Tools
GlassFish Server provides tools for assembling and deploying a module or
application.
@@ -662,8 +642,7 @@
[[giijz]][[GSDPG00325]][[administration-console]]
-Administration Console
-^^^^^^^^^^^^^^^^^^^^^^
+==== Administration Console
The GlassFish Server Administration Console is a browser-based utility
that features a graphical interface that includes extensive online help
@@ -684,8 +663,7 @@
[[giijf]][[GSDPG00326]][[the-asadmin-utility]]
-The `asadmin` Utility
-^^^^^^^^^^^^^^^^^^^^^
+==== The `asadmin` Utility
The GlassFish Server `asadmin` utility is a command-line tool that
invokes subcommands for identifying the operation or task that you want
@@ -725,8 +703,7 @@
[[giijq]][[GSDPG00329]][[netbeans-ide]]
-NetBeans IDE
-^^^^^^^^^^^^
+==== NetBeans IDE
You can use the NetBeans Integrated Development Environment (IDE), or
another IDE, to assemble Jakarta EE applications and modules. The NetBeans
@@ -737,16 +714,14 @@
[[gikwq]][[GSDPG00330]][[eclipse-ide]]
-Eclipse IDE
-^^^^^^^^^^^
+==== Eclipse IDE
In addition to the bundled NetBeans IDE, a plug-in for the Eclipse IDE
extends GlassFish to the Eclipse community.
[[beaee]][[GSDPG00331]][[jsr-88-client]]
-JSR 88 Client
-^^^^^^^^^^^^^
+==== JSR 88 Client
The syntax of the URI entry for the `getDeploymentManager` method is as
follows:
@@ -765,8 +740,7 @@
[[gipud]][[GSDPG00064]][[additional-information-on-application-deployment]]
-Additional Information on Application Deployment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Additional Information on Application Deployment
As specified from Jakarta EE specifications, the relevant specifications
are the following:
diff --git a/docs/application-deployment-guide/src/main/jbake/content/preface.adoc b/docs/application-deployment-guide/src/main/jbake/content/preface.adoc
index f884f93..65368dd 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/preface.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSDPG806]][[sthref2]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -54,8 +52,7 @@
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -160,8 +157,7 @@
[[GSDPG00054]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -205,8 +201,7 @@
[[GSDPG00055]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -246,8 +241,7 @@
[[GSDPG00056]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -290,8 +284,7 @@
[[GSDPG00057]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/application-deployment-guide/src/main/jbake/content/title.adoc b/docs/application-deployment-guide/src/main/jbake/content/title.adoc
index 75dd66d..0991f83 100644
--- a/docs/application-deployment-guide/src/main/jbake/content/title.adoc
+++ b/docs/application-deployment-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Application Deployment Guide, Release 7
-================================================================
+= Eclipse GlassFish Server Application Deployment Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Application Deployment Guide
diff --git a/docs/application-deployment-guide/src/main/jbake/content/toc.adoc b/docs/application-deployment-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..6a3e44a
--- /dev/null
+++ b/docs/application-deployment-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,831 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Application Deployment Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Application Deployment Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSDPG806[Preface]
+
+** link:preface.html#GSDPG00053[GlassFish Server Documentation Set]
+** link:preface.html#GSDPG00054[Related Documentation]
+** link:preface.html#GSDPG00055[Typographic Conventions]
+** link:preface.html#GSDPG00056[Symbol Conventions]
+** link:preface.html#GSDPG00057[Default Paths and File Names]
+
+=== link:overview.html#GSDPG00003[1 Overview of GlassFish Server Open Source Edition 7 Application Deployment]
+
+** link:overview.html#GSDPG00061[About Application Deployment]
+*** link:overview.html#GSDPG00319[General Deployment Functionality]
+*** link:overview.html#GSDPG00320[Deployment Descriptors and Annotations]
+*** link:overview.html#GSDPG00321[Modules and Applications]
+*** link:overview.html#GSDPG00322[Access to Shared Framework Classes]
+*** link:overview.html#GSDPG00323[Naming Standards]
+*** link:overview.html#GSDPG00324[Module and Application Versions]
+** link:overview.html#GSDPG00062[About Assembly and Deployment Events]
+** link:overview.html#GSDPG00063[About Deployment Tools]
+*** link:overview.html#GSDPG00325[Administration Console]
+*** link:overview.html#GSDPG00326[The `asadmin` Utility]
+*** link:overview.html#GSDPG00329[NetBeans IDE]
+*** link:overview.html#GSDPG00330[Eclipse IDE]
+*** link:overview.html#GSDPG00331[JSR 88 Client]
+** link:overview.html#GSDPG00064[Additional Information on Application Deployment]
+
+[[deploying-applications]]
+=== link:deploying-applications.html#GSDPG00004[2 Deploying Applications]
+
+** link:deploying-applications.html#GSDPG00065[Deploying Applications and Modules]
+*** link:deploying-applications.html#GSDPG00033[To Deploy an Application or Module]
+*** link:deploying-applications.html#GSDPG00034[To Change Targets for a Deployed Application or Module]
+*** link:deploying-applications.html#GSDPG00035[To List Deployed Applications or Modules]
+*** link:deploying-applications.html#GSDPG00036[To Redeploy an Application or Module]
+*** link:deploying-applications.html#GSDPG00037[To Disable an Application or Module]
+*** link:deploying-applications.html#GSDPG00038[To Enable an Application or Module]
+*** link:deploying-applications.html#GSDPG00039[To Undeploy an Application or Module]
+*** link:deploying-applications.html#GSDPG00040[To Reload Changes to Applications or Modules Dynamically]
+*** link:deploying-applications.html#GSDPG00041[To Deploy an Application or Module Automatically]
+*** link:deploying-applications.html#GSDPG00042[To Deploy an Application or Module by Using a Deployment Plan]
+*** link:deploying-applications.html#GSDPG00043[To Deploy an Application or Module in a Directory Format]
+** link:deploying-applications.html#GSDPG00066[Modifying the Configuration of a Web Application or Module]
+*** link:deploying-applications.html#GSDPG00044[To Set a Web Context Parameter]
+*** link:deploying-applications.html#GSDPG00045[To Unset a Web Context Parameter]
+*** link:deploying-applications.html#GSDPG00046[To List Web Context Parameters]
+*** link:deploying-applications.html#GSDPG00047[To Set a Web Environment Entry]
+*** link:deploying-applications.html#GSDPG00048[To Unset a Web Environment Entry]
+*** link:deploying-applications.html#GSDPG00049[To List Web Environment Entries]
+** link:deploying-applications.html#GSDPG00067[Web Module Deployment Guidelines]
+** link:deploying-applications.html#GSDPG00068[EJB Module Deployment Guidelines]
+** link:deploying-applications.html#GSDPG00069[Deploying a Connector Module]
+*** link:deploying-applications.html#GSDPG00050[To Deploy and Configure a Stand-Alone Connector Module]
+*** link:deploying-applications.html#GSDPG00332[Redeploying a Stand-Alone Connector Module]
+*** link:deploying-applications.html#GSDPG00333[Deploying and Configuring an Embedded Resource Adapter]
+** link:deploying-applications.html#GSDPG00070[Assembling and Deploying an Application Client Module]
+*** link:deploying-applications.html#GSDPG00051[To Assemble and Deploy an Application Client]
+*** link:deploying-applications.html#GSDPG00052[To Prepare Another Machine for Running an Application Client]
+*** link:deploying-applications.html#GSDPG00334[To Undeploy an Application Client]
+** link:deploying-applications.html#GSDPG00071[Lifecycle Module Deployment Guidelines]
+** link:deploying-applications.html#GSDPG00072[Web Service Deployment Guidelines]
+** link:deploying-applications.html#GSDPG00073[OSGi Bundle Deployment Guidelines]
+** link:deploying-applications.html#GSDPG00074[Transparent JDBC Connection Pool Reconfiguration]
+** link:deploying-applications.html#GSDPG00075[Application-Scoped Resources]
+* link:asadmin-deployment-subcommands.html#GSDPG00005[A The `asadmin` Deployment Subcommands]
+* link:dd-files.html#GSDPG00006[B GlassFish Server Deployment Descriptor Files]
+** link:dd-files.html#GSDPG00076[About the GlassFish Server Deployment Descriptors]
+** link:dd-files.html#GSDPG00077[The glassfish-application.xml File]
+** link:dd-files.html#GSDPG00078[The glassfish-web.xml File]
+** link:dd-files.html#GSDPG00079[The glassfish-ejb-jar.xml File]
+** link:dd-files.html#GSDPG00080[The sun-cmp-mappings.xml File]
+** link:dd-files.html#GSDPG00081[The glassfish-application-client.xml file]
+** link:dd-files.html#GSDPG00082[The sun-acc.xml File]
+** link:dd-files.html#GSDPG00083[The glassfish-resources.xml File]
+** link:dd-files.html#GSDPG00084[WebLogic Server Deployment Descriptor Support in GlassFish Server]
+* link:dd-elements.html#GSDPG00007[C Elements of the GlassFish Server Deployment Descriptors]
+** link:dd-elements.html#GSDPG00085[`activation-config`]
+*** link:dd-elements.html#GSDPG00335[Superelements]
+*** link:dd-elements.html#GSDPG00336[Subelements]
+** link:dd-elements.html#GSDPG00086[`activation-config-property`]
+*** link:dd-elements.html#GSDPG00337[Superelements]
+*** link:dd-elements.html#GSDPG00338[Subelements]
+** link:dd-elements.html#GSDPG00087[`activation-config-property-name`]
+*** link:dd-elements.html#GSDPG00339[Superelements]
+*** link:dd-elements.html#GSDPG00340[Subelements]
+** link:dd-elements.html#GSDPG00088[`activation-config-property-value`]
+*** link:dd-elements.html#GSDPG00341[Superelements]
+*** link:dd-elements.html#GSDPG00342[Subelements]
+** link:dd-elements.html#GSDPG00089[`admin-object-resource`]
+*** link:dd-elements.html#GSDPG840[Superelements]
+*** link:dd-elements.html#GSDPG841[Subelements]
+*** link:dd-elements.html#GSDPG843[Attributes]
+*** link:dd-elements.html#GSDPG845[Properties]
+** link:dd-elements.html#GSDPG00090[`as-context`]
+*** link:dd-elements.html#GSDPG00343[Superelements]
+*** link:dd-elements.html#GSDPG00344[Subelements]
+** link:dd-elements.html#GSDPG00091[`archive-name`]
+*** link:dd-elements.html#GSDPG00345[Superelements]
+*** link:dd-elements.html#GSDPG00346[Subelements]
+** link:dd-elements.html#GSDPG00092[`auth-method`]
+*** link:dd-elements.html#GSDPG00347[Superelements]
+*** link:dd-elements.html#GSDPG00348[Subelements]
+** link:dd-elements.html#GSDPG00093[`auth-realm`]
+*** link:dd-elements.html#GSDPG00349[Superelements]
+*** link:dd-elements.html#GSDPG00350[Subelements]
+*** link:dd-elements.html#GSDPG00351[`Attributes`]
+*** link:dd-elements.html#GSDPG00352[Example]
+** link:dd-elements.html#GSDPG00094[`backend-principal`]
+*** link:dd-elements.html#GSDPG849[Superelements]
+*** link:dd-elements.html#GSDPG850[Subelements]
+*** link:dd-elements.html#GSDPG851[Attributes]
+** link:dd-elements.html#GSDPG00095[`bean-cache`]
+*** link:dd-elements.html#GSDPG00353[Superelements]
+*** link:dd-elements.html#GSDPG00354[Subelements]
+*** link:dd-elements.html#GSDPG00355[Example]
+** link:dd-elements.html#GSDPG00096[`bean-pool`]
+*** link:dd-elements.html#GSDPG00356[Superelements]
+*** link:dd-elements.html#GSDPG00357[Subelements]
+*** link:dd-elements.html#GSDPG00358[Example]
+** link:dd-elements.html#GSDPG00097[`cache`]
+*** link:dd-elements.html#GSDPG00359[Superelements]
+*** link:dd-elements.html#GSDPG00360[Subelements]
+*** link:dd-elements.html#GSDPG00361[Attributes]
+*** link:dd-elements.html#GSDPG00362[Properties]
+*** link:dd-elements.html#GSDPG00363[Cache Class Names]
+** link:dd-elements.html#GSDPG00098[`cache-helper`]
+*** link:dd-elements.html#GSDPG00364[Superelements]
+*** link:dd-elements.html#GSDPG00365[Subelements]
+*** link:dd-elements.html#GSDPG00366[Attributes]
+** link:dd-elements.html#GSDPG00099[`cache-helper-ref`]
+*** link:dd-elements.html#GSDPG00367[Superelements]
+*** link:dd-elements.html#GSDPG00368[Subelements]
+** link:dd-elements.html#GSDPG00100[`cache-idle-timeout-in-seconds`]
+*** link:dd-elements.html#GSDPG00369[Superelements]
+*** link:dd-elements.html#GSDPG00370[Subelements]
+** link:dd-elements.html#GSDPG00101[`cache-mapping`]
+*** link:dd-elements.html#GSDPG00371[Superelements]
+*** link:dd-elements.html#GSDPG00372[Subelements]
+** link:dd-elements.html#GSDPG00102[`call-property`]
+*** link:dd-elements.html#GSDPG00373[Superelements]
+*** link:dd-elements.html#GSDPG00374[Subelements]
+** link:dd-elements.html#GSDPG00103[`caller-propagation`]
+*** link:dd-elements.html#GSDPG00375[Superelements]
+*** link:dd-elements.html#GSDPG00376[Subelements]
+** link:dd-elements.html#GSDPG00104[`cert-db`]
+*** link:dd-elements.html#GSDPG00377[Superelements]
+*** link:dd-elements.html#GSDPG00378[Subelements]
+*** link:dd-elements.html#GSDPG00379[Attributes]
+** link:dd-elements.html#GSDPG00105[`check-all-at-commit`]
+*** link:dd-elements.html#GSDPG00380[Superelements]
+** link:dd-elements.html#GSDPG00106[`check-modified-at-commit`]
+*** link:dd-elements.html#GSDPG00381[Superelements]
+*** link:dd-elements.html#GSDPG00382[Subelements]
+** link:dd-elements.html#GSDPG00107[`check-version-of-accessed-instances`]
+*** link:dd-elements.html#GSDPG00383[Superelements]
+*** link:dd-elements.html#GSDPG00384[Subelements]
+** link:dd-elements.html#GSDPG00108[`checkpoint-at-end-of-method`]
+*** link:dd-elements.html#GSDPG00385[Superelements]
+*** link:dd-elements.html#GSDPG00386[Subelements]
+** link:dd-elements.html#GSDPG00109[`checkpointed-methods`]
+*** link:dd-elements.html#GSDPG00387[Superelements]
+** link:dd-elements.html#GSDPG00110[`class-loader`]
+*** link:dd-elements.html#GSDPG00388[Superelements]
+*** link:dd-elements.html#GSDPG00389[Subelements]
+*** link:dd-elements.html#GSDPG00390[Attributes]
+*** link:dd-elements.html#GSDPG00391[Properties]
+** link:dd-elements.html#GSDPG00111[`client-container`]
+*** link:dd-elements.html#GSDPG00392[Superelements]
+*** link:dd-elements.html#GSDPG00393[Subelements]
+*** link:dd-elements.html#GSDPG00394[Attributes]
+*** link:dd-elements.html#GSDPG00395[Properties]
+** link:dd-elements.html#GSDPG00112[`client-credential`]
+*** link:dd-elements.html#GSDPG00396[Superelements]
+*** link:dd-elements.html#GSDPG00397[Subelements]
+*** link:dd-elements.html#GSDPG00398[Attributes]
+** link:dd-elements.html#GSDPG00113[`cmp`]
+*** link:dd-elements.html#GSDPG00399[Superelements]
+*** link:dd-elements.html#GSDPG00400[Subelements]
+** link:dd-elements.html#GSDPG00114[`cmp-field-mapping`]
+*** link:dd-elements.html#GSDPG00401[Superelements]
+*** link:dd-elements.html#GSDPG00402[Subelements]
+** link:dd-elements.html#GSDPG00115[`cmp-resource`]
+*** link:dd-elements.html#GSDPG00403[Superelements]
+*** link:dd-elements.html#GSDPG00404[Subelements]
+** link:dd-elements.html#GSDPG00116[`cmr-field-mapping`]
+*** link:dd-elements.html#GSDPG00405[Superelements]
+*** link:dd-elements.html#GSDPG00406[Subelements]
+** link:dd-elements.html#GSDPG00117[`cmr-field-name`]
+*** link:dd-elements.html#GSDPG00407[Superelements]
+*** link:dd-elements.html#GSDPG00408[Subelements]
+** link:dd-elements.html#GSDPG00118[`cmt-timeout-in-seconds`]
+*** link:dd-elements.html#GSDPG00409[Superelements]
+*** link:dd-elements.html#GSDPG00410[Subelements]
+** link:dd-elements.html#GSDPG00119[`column-name`]
+*** link:dd-elements.html#GSDPG00411[Superelements]
+*** link:dd-elements.html#GSDPG00412[Subelements]
+** link:dd-elements.html#GSDPG00120[`column-pair`]
+*** link:dd-elements.html#GSDPG00413[Superelements]
+*** link:dd-elements.html#GSDPG00414[Subelements]
+** link:dd-elements.html#GSDPG00121[`commit-option`]
+*** link:dd-elements.html#GSDPG00415[Superelements]
+*** link:dd-elements.html#GSDPG00416[Subelements]
+** link:dd-elements.html#GSDPG00122[`compatibility`]
+*** link:dd-elements.html#GSDPG00417[Superelements]
+*** link:dd-elements.html#GSDPG00418[Subelements]
+** link:dd-elements.html#GSDPG00123[`confidentiality`]
+*** link:dd-elements.html#GSDPG00419[Superelements]
+*** link:dd-elements.html#GSDPG00420[Subelements]
+** link:dd-elements.html#GSDPG00124[`connector-connection-pool`]
+*** link:dd-elements.html#GSDPG879[Superelements]
+*** link:dd-elements.html#GSDPG880[Subelements]
+*** link:dd-elements.html#GSDPG882[Attributes]
+*** link:dd-elements.html#GSDPG884[Properties]
+** link:dd-elements.html#GSDPG00125[`connector-resource`]
+*** link:dd-elements.html#GSDPG886[Superelements]
+*** link:dd-elements.html#GSDPG887[Subelements]
+*** link:dd-elements.html#GSDPG889[Attributes]
+** link:dd-elements.html#GSDPG00126[`consistency`]
+*** link:dd-elements.html#GSDPG00421[Superelements]
+*** link:dd-elements.html#GSDPG00422[Subelements]
+** link:dd-elements.html#GSDPG00127[`constraint-field`]
+*** link:dd-elements.html#GSDPG00423[Superelements]
+*** link:dd-elements.html#GSDPG00424[Subelements]
+*** link:dd-elements.html#GSDPG00425[Attributes]
+** link:dd-elements.html#GSDPG00128[`constraint-field-value`]
+*** link:dd-elements.html#GSDPG00426[Superelements]
+*** link:dd-elements.html#GSDPG00427[Subelements]
+*** link:dd-elements.html#GSDPG00428[Attributes]
+** link:dd-elements.html#GSDPG00129[`context-root`]
+*** link:dd-elements.html#GSDPG00429[Superelements]
+*** link:dd-elements.html#GSDPG00430[Subelements]
+** link:dd-elements.html#GSDPG00130[`cookie-properties`]
+*** link:dd-elements.html#GSDPG00431[Superelements]
+*** link:dd-elements.html#GSDPG00432[Subelements]
+*** link:dd-elements.html#GSDPG00433[Properties]
+** link:dd-elements.html#GSDPG00131[`create-tables-at-deploy`]
+*** link:dd-elements.html#GSDPG00434[Superelements]
+*** link:dd-elements.html#GSDPG00435[Subelements]
+** link:dd-elements.html#GSDPG00132[`custom-resource`]
+*** link:dd-elements.html#GSDPG897[Superelements]
+*** link:dd-elements.html#GSDPG898[Subelements]
+*** link:dd-elements.html#GSDPG900[Attributes]
+** link:dd-elements.html#GSDPG00133[`database-vendor-name`]
+*** link:dd-elements.html#GSDPG00436[Superelements]
+*** link:dd-elements.html#GSDPG00437[Subelements]
+** link:dd-elements.html#GSDPG00134[`debugging-enabled`]
+*** link:dd-elements.html#GSDPG00438[Superelements]
+*** link:dd-elements.html#GSDPG00439[Subelements]
+** link:dd-elements.html#GSDPG00135[`default`]
+*** link:dd-elements.html#GSDPG00440[Superelements]
+*** link:dd-elements.html#GSDPG00441[Subelements]
+** link:dd-elements.html#GSDPG00136[`default-helper`]
+*** link:dd-elements.html#GSDPG00442[Superelements]
+*** link:dd-elements.html#GSDPG00443[Subelements]
+*** link:dd-elements.html#GSDPG00444[Properties]
+** link:dd-elements.html#GSDPG00137[`default-resource-principal`]
+*** link:dd-elements.html#GSDPG00445[Superelements]
+*** link:dd-elements.html#GSDPG00446[Subelements]
+** link:dd-elements.html#GSDPG00138[`description`]
+*** link:dd-elements.html#GSDPG00447[Superelements]
+*** link:dd-elements.html#GSDPG00448[Subelements]
+** link:dd-elements.html#GSDPG00139[`disable-nonportable-jndi-names`]
+*** link:dd-elements.html#GSDPG00449[Superelements]
+*** link:dd-elements.html#GSDPG00450[Subelements]
+** link:dd-elements.html#GSDPG00140[`dispatcher`]
+*** link:dd-elements.html#GSDPG00451[Superelements]
+*** link:dd-elements.html#GSDPG00452[Subelements]
+** link:dd-elements.html#GSDPG00141[`drop-tables-at-undeploy`]
+*** link:dd-elements.html#GSDPG00453[Superelements]
+*** link:dd-elements.html#GSDPG00454[Subelements]
+** link:dd-elements.html#GSDPG00142[`ejb`]
+*** link:dd-elements.html#GSDPG00455[Superelements]
+*** link:dd-elements.html#GSDPG00456[Subelements]
+*** link:dd-elements.html#GSDPG00457[Attributes]
+*** link:dd-elements.html#GSDPG00458[Example]
+** link:dd-elements.html#GSDPG00143[`ejb-name`]
+*** link:dd-elements.html#GSDPG00459[Superelements]
+*** link:dd-elements.html#GSDPG00460[Subelements]
+** link:dd-elements.html#GSDPG00144[`ejb-ref`]
+*** link:dd-elements.html#GSDPG00461[Superelements]
+*** link:dd-elements.html#GSDPG00462[Subelements]
+** link:dd-elements.html#GSDPG00145[`ejb-ref-name`]
+*** link:dd-elements.html#GSDPG00463[Superelements]
+*** link:dd-elements.html#GSDPG00464[Subelements]
+** link:dd-elements.html#GSDPG00146[`eligible`]
+*** link:dd-elements.html#GSDPG00465[Superelements]
+*** link:dd-elements.html#GSDPG00466[Subelements]
+** link:dd-elements.html#GSDPG00147[`endpoint-address-uri`]
+*** link:dd-elements.html#GSDPG00467[Superelements]
+*** link:dd-elements.html#GSDPG00468[Subelements]
+*** link:dd-elements.html#GSDPG00469[Example]
+** link:dd-elements.html#GSDPG00148[`enterprise-beans`]
+*** link:dd-elements.html#GSDPG00470[Superelements]
+*** link:dd-elements.html#GSDPG00471[Subelements]
+*** link:dd-elements.html#GSDPG00472[Example]
+** link:dd-elements.html#GSDPG00149[`entity-mapping`]
+*** link:dd-elements.html#GSDPG00473[Superelements]
+*** link:dd-elements.html#GSDPG00474[Subelements]
+** link:dd-elements.html#GSDPG00150[`establish-trust-in-client`]
+*** link:dd-elements.html#GSDPG00475[Superelements]
+*** link:dd-elements.html#GSDPG00476[Subelements]
+** link:dd-elements.html#GSDPG00151[`establish-trust-in-target`]
+*** link:dd-elements.html#GSDPG00477[Superelements]
+*** link:dd-elements.html#GSDPG00478[Subelements]
+** link:dd-elements.html#GSDPG00152[`external-jndi-resource`]
+*** link:dd-elements.html#GSDPG910[Superelements]
+*** link:dd-elements.html#GSDPG911[Subelements]
+*** link:dd-elements.html#GSDPG913[Attributes]
+** link:dd-elements.html#GSDPG00153[`fetched-with`]
+*** link:dd-elements.html#GSDPG00479[Superelements]
+*** link:dd-elements.html#GSDPG00480[Subelements]
+** link:dd-elements.html#GSDPG00154[`field-name`]
+*** link:dd-elements.html#GSDPG00481[Superelements]
+*** link:dd-elements.html#GSDPG00482[Subelements]
+** link:dd-elements.html#GSDPG00155[`finder`]
+*** link:dd-elements.html#GSDPG00483[Superelements]
+*** link:dd-elements.html#GSDPG00484[Subelements]
+** link:dd-elements.html#GSDPG00156[`flush-at-end-of-method`]
+*** link:dd-elements.html#GSDPG00485[Superelements]
+*** link:dd-elements.html#GSDPG00486[Subelements]
+** link:dd-elements.html#GSDPG00157[`gen-classes`]
+*** link:dd-elements.html#GSDPG00487[Superelements]
+*** link:dd-elements.html#GSDPG00488[Subelements]
+** link:dd-elements.html#GSDPG00158[`glassfish-application`]
+*** link:dd-elements.html#GSDPG00489[Superelements]
+*** link:dd-elements.html#GSDPG00490[Subelements]
+** link:dd-elements.html#GSDPG00159[`glassfish-application-client`]
+*** link:dd-elements.html#GSDPG00491[Superelements]
+*** link:dd-elements.html#GSDPG00492[Subelements]
+** link:dd-elements.html#GSDPG00160[`glassfish-ejb-jar`]
+*** link:dd-elements.html#GSDPG00493[Superelements]
+*** link:dd-elements.html#GSDPG00494[Subelements]
+** link:dd-elements.html#GSDPG00161[`glassfish-web-app`]
+*** link:dd-elements.html#GSDPG00495[Superelements]
+*** link:dd-elements.html#GSDPG00496[Subelements]
+*** link:dd-elements.html#GSDPG00497[Attributes]
+*** link:dd-elements.html#GSDPG00498[Properties]
+** link:dd-elements.html#GSDPG00162[`group-map`]
+*** link:dd-elements.html#GSDPG925[Superelements]
+*** link:dd-elements.html#GSDPG00499[Subelements]
+*** link:dd-elements.html#GSDPG926[Attributes]
+** link:dd-elements.html#GSDPG00163[`group-name`]
+*** link:dd-elements.html#GSDPG00500[Superelements]
+*** link:dd-elements.html#GSDPG00501[Subelements]
+*** link:dd-elements.html#GSDPG00502[`http-method`]
+** link:dd-elements.html#GSDPG00164[`idempotent-url-pattern`]
+*** link:dd-elements.html#GSDPG00503[Superelements]
+*** link:dd-elements.html#GSDPG00504[Subelements]
+*** link:dd-elements.html#GSDPG00505[Attributes]
+*** link:dd-elements.html#GSDPG00506[Example]
+** link:dd-elements.html#GSDPG00165[`integrity`]
+*** link:dd-elements.html#GSDPG00507[Superelements]
+*** link:dd-elements.html#GSDPG00508[Subelements]
+** link:dd-elements.html#GSDPG00166[`ior-security-config`]
+*** link:dd-elements.html#GSDPG00509[Superelements]
+*** link:dd-elements.html#GSDPG00510[Subelements]
+** link:dd-elements.html#GSDPG00167[`is-cache-overflow-allowed`]
+*** link:dd-elements.html#GSDPG00511[Superelements]
+** link:dd-elements.html#GSDPG00168[`is-one-one-cmp`]
+*** link:dd-elements.html#GSDPG00512[Superelements]
+** link:dd-elements.html#GSDPG00169[`is-read-only-bean`]
+*** link:dd-elements.html#GSDPG00513[Superelements]
+*** link:dd-elements.html#GSDPG00514[Subelements]
+** link:dd-elements.html#GSDPG00170[`java-method`]
+*** link:dd-elements.html#GSDPG00515[Superelements]
+*** link:dd-elements.html#GSDPG00516[Subelements]
+** link:dd-elements.html#GSDPG00171[`java-web-start-access`]
+*** link:dd-elements.html#GSDPG00517[Superelements]
+*** link:dd-elements.html#GSDPG00518[Subelements]
+** link:dd-elements.html#GSDPG00172[`jdbc-connection-pool`]
+*** link:dd-elements.html#GSDPG932[Superelements]
+*** link:dd-elements.html#GSDPG933[Subelements]
+*** link:dd-elements.html#GSDPG935[Attributes]
+*** link:dd-elements.html#GSDPG937[GlassFish Server Properties]
+*** link:dd-elements.html#GSDPG939[Database Properties]
+** link:dd-elements.html#GSDPG00173[`jdbc-resource`]
+*** link:dd-elements.html#GSDPG941[Superelements]
+*** link:dd-elements.html#GSDPG942[Subelements]
+*** link:dd-elements.html#GSDPG944[Attributes]
+** link:dd-elements.html#GSDPG00174[`jms-durable-subscription-name`]
+*** link:dd-elements.html#GSDPG00519[Superelements]
+*** link:dd-elements.html#GSDPG00520[Subelements]
+** link:dd-elements.html#GSDPG00175[`jms-max-messages-load`]
+*** link:dd-elements.html#GSDPG00521[Superelements]
+*** link:dd-elements.html#GSDPG00522[Subelements]
+** link:dd-elements.html#GSDPG00176[`jndi-name`]
+*** link:dd-elements.html#GSDPG00523[Superelements]
+*** link:dd-elements.html#GSDPG00524[Subelements]
+** link:dd-elements.html#GSDPG00177[`jnlp-doc`]
+*** link:dd-elements.html#GSDPG00525[Superelements]
+*** link:dd-elements.html#GSDPG00526[Subelements]
+** link:dd-elements.html#GSDPG00178[`jsp-config`]
+*** link:dd-elements.html#GSDPG00527[Superelements]
+*** link:dd-elements.html#GSDPG00528[Subelements]
+*** link:dd-elements.html#GSDPG00529[Properties]
+** link:dd-elements.html#GSDPG00179[`keep-state`]
+*** link:dd-elements.html#GSDPG00530[Superelements]
+*** link:dd-elements.html#GSDPG00531[Subelements]
+** link:dd-elements.html#GSDPG00180[`key-field`]
+*** link:dd-elements.html#GSDPG00532[Superelements]
+*** link:dd-elements.html#GSDPG00533[Subelements]
+*** link:dd-elements.html#GSDPG00534[Attributes]
+** link:dd-elements.html#GSDPG00181[`level`]
+*** link:dd-elements.html#GSDPG00535[Superelements]
+*** link:dd-elements.html#GSDPG00536[Subelements]
+** link:dd-elements.html#GSDPG00182[`local-home-impl`]
+*** link:dd-elements.html#GSDPG00537[Superelements]
+*** link:dd-elements.html#GSDPG00538[Subelements]
+** link:dd-elements.html#GSDPG00183[`local-impl`]
+*** link:dd-elements.html#GSDPG00539[Superelements]
+*** link:dd-elements.html#GSDPG00540[Subelements]
+** link:dd-elements.html#GSDPG00184[`locale-charset-info`]
+*** link:dd-elements.html#GSDPG00541[Superelements]
+*** link:dd-elements.html#GSDPG00542[Subelements]
+*** link:dd-elements.html#GSDPG00543[Attributes]
+** link:dd-elements.html#GSDPG00185[`locale-charset-map`]
+*** link:dd-elements.html#GSDPG00544[Superelements]
+*** link:dd-elements.html#GSDPG00545[Subelements]
+*** link:dd-elements.html#GSDPG00546[Attributes]
+*** link:dd-elements.html#GSDPG00547[Example Agents]
+** link:dd-elements.html#GSDPG00186[`localpart`]
+*** link:dd-elements.html#GSDPG00548[Superelements]
+*** link:dd-elements.html#GSDPG00549[Subelements]
+** link:dd-elements.html#GSDPG00187[`lock-when-loaded`]
+*** link:dd-elements.html#GSDPG00550[Superelements]
+*** link:dd-elements.html#GSDPG00551[Subelements]
+** link:dd-elements.html#GSDPG00188[`lock-when-modified`]
+*** link:dd-elements.html#GSDPG00552[Superelements]
+** link:dd-elements.html#GSDPG00189[`log-service`]
+*** link:dd-elements.html#GSDPG00553[Superelements]
+*** link:dd-elements.html#GSDPG00554[Subelements]
+*** link:dd-elements.html#GSDPG00555[Attributes]
+** link:dd-elements.html#GSDPG00190[`login-config`]
+*** link:dd-elements.html#GSDPG00556[Superelements]
+*** link:dd-elements.html#GSDPG00557[Subelements]
+** link:dd-elements.html#GSDPG00191[`mail-resource`]
+*** link:dd-elements.html#GSDPG957[Superelements]
+*** link:dd-elements.html#GSDPG958[Subelements]
+*** link:dd-elements.html#GSDPG960[Attributes]
+*** link:dd-elements.html#GSDPG962[Properties]
+** link:dd-elements.html#GSDPG00192[`manager-properties`]
+*** link:dd-elements.html#GSDPG00558[Superelements]
+*** link:dd-elements.html#GSDPG00559[Subelements]
+*** link:dd-elements.html#GSDPG00560[Properties]
+** link:dd-elements.html#GSDPG00193[`mapping-properties`]
+*** link:dd-elements.html#GSDPG00561[Superelements]
+** link:dd-elements.html#GSDPG00194[`max-cache-size`]
+*** link:dd-elements.html#GSDPG00562[Superelements]
+*** link:dd-elements.html#GSDPG00563[Subelements]
+** link:dd-elements.html#GSDPG00195[`max-pool-size`]
+*** link:dd-elements.html#GSDPG00564[Superelements]
+*** link:dd-elements.html#GSDPG00565[Subelements]
+** link:dd-elements.html#GSDPG00196[`max-wait-time-in-millis`]
+*** link:dd-elements.html#GSDPG00566[Superelements]
+** link:dd-elements.html#GSDPG00197[`mdb-connection-factory`]
+*** link:dd-elements.html#GSDPG00567[Superelements]
+*** link:dd-elements.html#GSDPG00568[Subelements]
+** link:dd-elements.html#GSDPG00198[`mdb-resource-adapter`]
+*** link:dd-elements.html#GSDPG00569[Superelements]
+*** link:dd-elements.html#GSDPG00570[Subelements]
+** link:dd-elements.html#GSDPG00199[`message`]
+*** link:dd-elements.html#GSDPG00571[Superelements]
+*** link:dd-elements.html#GSDPG00572[Subelements]
+** link:dd-elements.html#GSDPG00200[`message-destination`]
+*** link:dd-elements.html#GSDPG00573[Superelements]
+*** link:dd-elements.html#GSDPG00574[Subelements]
+** link:dd-elements.html#GSDPG00201[`message-destination-name`]
+*** link:dd-elements.html#GSDPG00575[Superelements]
+*** link:dd-elements.html#GSDPG00576[Subelements]
+** link:dd-elements.html#GSDPG00202[`message-destination-ref`]
+*** link:dd-elements.html#GSDPG00577[Superelements]
+*** link:dd-elements.html#GSDPG00578[Subelements]
+** link:dd-elements.html#GSDPG00203[`message-destination-ref-name`]
+*** link:dd-elements.html#GSDPG00579[Superelements]
+*** link:dd-elements.html#GSDPG00580[Subelements]
+** link:dd-elements.html#GSDPG00204[`message-security`]
+*** link:dd-elements.html#GSDPG00581[Superelements]
+*** link:dd-elements.html#GSDPG00582[Subelements]
+** link:dd-elements.html#GSDPG00205[`message-security-binding`]
+*** link:dd-elements.html#GSDPG00583[Superelements]
+*** link:dd-elements.html#GSDPG00584[Subelements]
+*** link:dd-elements.html#GSDPG00585[Attributes]
+** link:dd-elements.html#GSDPG00206[`message-security-config`]
+*** link:dd-elements.html#GSDPG00586[Superelements]
+*** link:dd-elements.html#GSDPG00587[Subelements]
+*** link:dd-elements.html#GSDPG00588[Attributes]
+** link:dd-elements.html#GSDPG00207[`method`]
+*** link:dd-elements.html#GSDPG00589[Superelements]
+*** link:dd-elements.html#GSDPG00590[Subelements]
+** link:dd-elements.html#GSDPG00208[`method-intf`]
+*** link:dd-elements.html#GSDPG00591[Superelements]
+*** link:dd-elements.html#GSDPG00592[Subelements]
+** link:dd-elements.html#GSDPG00209[`method-name`]
+*** link:dd-elements.html#GSDPG00593[Superelements]
+*** link:dd-elements.html#GSDPG00594[Subelements]
+*** link:dd-elements.html#GSDPG00595[Examples]
+** link:dd-elements.html#GSDPG00210[`method-param`]
+*** link:dd-elements.html#GSDPG00596[Superelements]
+*** link:dd-elements.html#GSDPG00597[Subelements]
+** link:dd-elements.html#GSDPG00211[`method-params`]
+*** link:dd-elements.html#GSDPG00598[Superelements]
+*** link:dd-elements.html#GSDPG00599[Subelements]
+** link:dd-elements.html#GSDPG00212[`name`]
+*** link:dd-elements.html#GSDPG00600[Superelements]
+*** link:dd-elements.html#GSDPG00601[Subelements]
+** link:dd-elements.html#GSDPG00213[`named-group`]
+*** link:dd-elements.html#GSDPG00602[Superelements]
+*** link:dd-elements.html#GSDPG00603[Subelements]
+** link:dd-elements.html#GSDPG00214[`namespaceURI`]
+*** link:dd-elements.html#GSDPG00604[Superelements]
+*** link:dd-elements.html#GSDPG00605[Subelements]
+** link:dd-elements.html#GSDPG00215[`none`]
+*** link:dd-elements.html#GSDPG00606[Superelements]
+*** link:dd-elements.html#GSDPG00607[Subelements]
+** link:dd-elements.html#GSDPG00216[`one-one-finders`]
+*** link:dd-elements.html#GSDPG00608[Superelements]
+*** link:dd-elements.html#GSDPG00609[Subelements]
+** link:dd-elements.html#GSDPG00217[`operation-name`]
+*** link:dd-elements.html#GSDPG00610[Superelements]
+*** link:dd-elements.html#GSDPG00611[Subelements]
+** link:dd-elements.html#GSDPG00218[`parameter-encoding`]
+*** link:dd-elements.html#GSDPG00612[Superelements]
+*** link:dd-elements.html#GSDPG00613[Subelements]
+*** link:dd-elements.html#GSDPG00614[Attributes]
+** link:dd-elements.html#GSDPG00219[`pass-by-reference`]
+*** link:dd-elements.html#GSDPG00615[Superelements]
+*** link:dd-elements.html#GSDPG00616[Subelements]
+** link:dd-elements.html#GSDPG00220[`password`]
+*** link:dd-elements.html#GSDPG00617[Superelements]
+*** link:dd-elements.html#GSDPG00618[Subelements]
+** link:dd-elements.html#GSDPG00221[`per-request-load-balancing`]
+*** link:dd-elements.html#GSDPG00619[Superelements]
+*** link:dd-elements.html#GSDPG00620[Subelements]
+** link:dd-elements.html#GSDPG00222[`pm-descriptors`]
+*** link:dd-elements.html#GSDPG00621[Superelements]
+** link:dd-elements.html#GSDPG00223[`pool-idle-timeout-in-seconds`]
+*** link:dd-elements.html#GSDPG00622[Superelements]
+*** link:dd-elements.html#GSDPG00623[Subelements]
+** link:dd-elements.html#GSDPG00224[`port-component-name`]
+*** link:dd-elements.html#GSDPG00624[Superelements]
+*** link:dd-elements.html#GSDPG00625[Subelements]
+** link:dd-elements.html#GSDPG00225[`port-info`]
+*** link:dd-elements.html#GSDPG00626[Superelements]
+*** link:dd-elements.html#GSDPG00627[Subelements]
+** link:dd-elements.html#GSDPG00226[`prefetch-disabled`]
+*** link:dd-elements.html#GSDPG00628[Superelements]
+*** link:dd-elements.html#GSDPG00629[Subelements]
+** link:dd-elements.html#GSDPG00227[`principal`]
+*** link:dd-elements.html#GSDPG00630[Superelements]
+*** link:dd-elements.html#GSDPG00631[Subelements]
+** link:dd-elements.html#GSDPG00228[`principal-map`]
+*** link:dd-elements.html#GSDPG982[Superelements]
+*** link:dd-elements.html#GSDPG00632[Subelements]
+*** link:dd-elements.html#GSDPG983[Attributes]
+** link:dd-elements.html#GSDPG00229[`principal-name`]
+*** link:dd-elements.html#GSDPG00633[Superelements]
+*** link:dd-elements.html#GSDPG00634[Subelements]
+*** link:dd-elements.html#GSDPG00635[Attributes]
+** link:dd-elements.html#GSDPG00230[`property` (with attributes)]
+*** link:dd-elements.html#GSDPG00636[Superelements]
+*** link:dd-elements.html#GSDPG00637[Subelements]
+*** link:dd-elements.html#GSDPG00638[Attributes]
+*** link:dd-elements.html#GSDPG00639[Example]
+** link:dd-elements.html#GSDPG00231[`property` (with subelements)]
+*** link:dd-elements.html#GSDPG00640[Superelements]
+*** link:dd-elements.html#GSDPG00641[Subelements]
+*** link:dd-elements.html#GSDPG00642[Example]
+** link:dd-elements.html#GSDPG00232[`provider-config`]
+*** link:dd-elements.html#GSDPG00643[Superelements]
+*** link:dd-elements.html#GSDPG00644[Subelements]
+*** link:dd-elements.html#GSDPG00645[Attributes]
+** link:dd-elements.html#GSDPG00233[`query-filter`]
+*** link:dd-elements.html#GSDPG00646[Superelements]
+*** link:dd-elements.html#GSDPG00647[Subelements]
+** link:dd-elements.html#GSDPG00234[`query-method`]
+*** link:dd-elements.html#GSDPG00648[Superelements]
+*** link:dd-elements.html#GSDPG00649[Subelements]
+** link:dd-elements.html#GSDPG00235[`query-ordering`]
+*** link:dd-elements.html#GSDPG00650[Superelements]
+*** link:dd-elements.html#GSDPG00651[Subelements]
+** link:dd-elements.html#GSDPG00236[`query-params`]
+*** link:dd-elements.html#GSDPG00652[Superelements]
+*** link:dd-elements.html#GSDPG00653[Subelements]
+** link:dd-elements.html#GSDPG00237[`query-variables`]
+*** link:dd-elements.html#GSDPG00654[Superelements]
+*** link:dd-elements.html#GSDPG00655[Subelements]
+** link:dd-elements.html#GSDPG00238[`read-only`]
+*** link:dd-elements.html#GSDPG00656[Superelements]
+*** link:dd-elements.html#GSDPG00657[Subelements]
+** link:dd-elements.html#GSDPG00239[`realm`]
+*** link:dd-elements.html#GSDPG00658[Superelements]
+*** link:dd-elements.html#GSDPG00659[Subelements]
+** link:dd-elements.html#GSDPG00240[`refresh-field`]
+*** link:dd-elements.html#GSDPG00660[Superelements]
+*** link:dd-elements.html#GSDPG00661[Subelements]
+*** link:dd-elements.html#GSDPG00662[Attributes]
+** link:dd-elements.html#GSDPG00241[`refresh-period-in-seconds`]
+*** link:dd-elements.html#GSDPG00663[Superelements]
+*** link:dd-elements.html#GSDPG00664[Subelements]
+** link:dd-elements.html#GSDPG00242[`removal-timeout-in-seconds`]
+*** link:dd-elements.html#GSDPG00665[Superelements]
+*** link:dd-elements.html#GSDPG00666[Subelements]
+** link:dd-elements.html#GSDPG00243[`remote-home-impl`]
+*** link:dd-elements.html#GSDPG00667[Superelements]
+*** link:dd-elements.html#GSDPG00668[Subelements]
+** link:dd-elements.html#GSDPG00244[`remote-impl`]
+*** link:dd-elements.html#GSDPG00669[Superelements]
+*** link:dd-elements.html#GSDPG00670[Subelements]
+** link:dd-elements.html#GSDPG00245[`request-policy`]
+*** link:dd-elements.html#GSDPG00671[Superelements]
+*** link:dd-elements.html#GSDPG00672[Subelements]
+*** link:dd-elements.html#GSDPG00673[Attributes]
+** link:dd-elements.html#GSDPG00246[`request-protection`]
+*** link:dd-elements.html#GSDPG00674[Superelements]
+*** link:dd-elements.html#GSDPG00675[Subelements]
+*** link:dd-elements.html#GSDPG00676[Attributes]
+** link:dd-elements.html#GSDPG00247[`required`]
+*** link:dd-elements.html#GSDPG00677[Superelements]
+*** link:dd-elements.html#GSDPG00678[Subelements]
+** link:dd-elements.html#GSDPG00248[`res-ref-name`]
+*** link:dd-elements.html#GSDPG00679[Superelements]
+*** link:dd-elements.html#GSDPG00680[Subelements]
+** link:dd-elements.html#GSDPG00249[`resize-quantity`]
+*** link:dd-elements.html#GSDPG00681[Superelements]
+*** link:dd-elements.html#GSDPG00682[Subelements]
+** link:dd-elements.html#GSDPG00250[`resource-adapter-config`]
+*** link:dd-elements.html#GSDPG995[Superelements]
+*** link:dd-elements.html#GSDPG996[Subelements]
+*** link:dd-elements.html#GSDPG998[Attributes]
+*** link:dd-elements.html#GSDPG1000[Properties]
+** link:dd-elements.html#GSDPG00251[`resource-adapter-mid`]
+*** link:dd-elements.html#GSDPG00683[Superelements]
+*** link:dd-elements.html#GSDPG00684[Subelements]
+** link:dd-elements.html#GSDPG00252[`resource-env-ref`]
+*** link:dd-elements.html#GSDPG00685[Superelements]
+*** link:dd-elements.html#GSDPG00686[Subelements]
+*** link:dd-elements.html#GSDPG00687[Example]
+** link:dd-elements.html#GSDPG00253[`resource-env-ref-name`]
+*** link:dd-elements.html#GSDPG00688[Superelements]
+*** link:dd-elements.html#GSDPG00689[Subelements]
+** link:dd-elements.html#GSDPG00254[`resource-ref`]
+*** link:dd-elements.html#GSDPG00690[Superelements]
+*** link:dd-elements.html#GSDPG00691[Subelements]
+*** link:dd-elements.html#GSDPG00692[Example]
+** link:dd-elements.html#GSDPG00255[`resources`]
+*** link:dd-elements.html#GSDPG1003[Superelements]
+*** link:dd-elements.html#GSDPG1004[Subelements]
+** link:dd-elements.html#GSDPG00256[`response-policy`]
+*** link:dd-elements.html#GSDPG00693[Superelements]
+*** link:dd-elements.html#GSDPG00694[Subelements]
+*** link:dd-elements.html#GSDPG00695[Attributes]
+** link:dd-elements.html#GSDPG00257[`response-protection`]
+*** link:dd-elements.html#GSDPG00696[Superelements]
+*** link:dd-elements.html#GSDPG00697[Subelements]
+*** link:dd-elements.html#GSDPG00698[Attributes]
+** link:dd-elements.html#GSDPG00258[`role-name`]
+*** link:dd-elements.html#GSDPG00699[Superelements]
+*** link:dd-elements.html#GSDPG00700[Subelements]
+** link:dd-elements.html#GSDPG00259[`sas-context`]
+*** link:dd-elements.html#GSDPG00701[Superelements]
+*** link:dd-elements.html#GSDPG00702[Subelements]
+** link:dd-elements.html#GSDPG00260[`schema`]
+*** link:dd-elements.html#GSDPG00703[Superelements]
+*** link:dd-elements.html#GSDPG00704[Subelements]
+*** link:dd-elements.html#GSDPG00705[Examples]
+** link:dd-elements.html#GSDPG00261[`schema-generator-properties`]
+*** link:dd-elements.html#GSDPG00706[Superelements]
+*** link:dd-elements.html#GSDPG00707[Subelements]
+*** link:dd-elements.html#GSDPG00708[Properties]
+*** link:dd-elements.html#GSDPG00709[Example]
+** link:dd-elements.html#GSDPG00262[`secondary-table`]
+*** link:dd-elements.html#GSDPG00710[Superelements]
+*** link:dd-elements.html#GSDPG00711[Subelements]
+** link:dd-elements.html#GSDPG00263[`security`]
+*** link:dd-elements.html#GSDPG00712[Superelements]
+*** link:dd-elements.html#GSDPG00713[Subelements]
+** link:dd-elements.html#GSDPG00264[`security-map`]
+*** link:dd-elements.html#GSDPG1014[Superelements]
+*** link:dd-elements.html#GSDPG1015[Subelements]
+*** link:dd-elements.html#GSDPG1017[Attributes]
+** link:dd-elements.html#GSDPG00265[`security-role-mapping`]
+*** link:dd-elements.html#GSDPG00714[Superelements]
+*** link:dd-elements.html#GSDPG00715[Subelements]
+** link:dd-elements.html#GSDPG00266[`service-endpoint-interface`]
+*** link:dd-elements.html#GSDPG00716[Superelements]
+*** link:dd-elements.html#GSDPG00717[Subelements]
+** link:dd-elements.html#GSDPG00267[`service-impl-class`]
+*** link:dd-elements.html#GSDPG00718[Superelements]
+*** link:dd-elements.html#GSDPG00719[Subelements]
+** link:dd-elements.html#GSDPG00268[`service-qname`]
+*** link:dd-elements.html#GSDPG00720[Superelements]
+*** link:dd-elements.html#GSDPG00721[Subelements]
+** link:dd-elements.html#GSDPG00269[`service-ref`]
+*** link:dd-elements.html#GSDPG00722[Superelements]
+*** link:dd-elements.html#GSDPG00723[Subelements]
+** link:dd-elements.html#GSDPG00270[`service-ref-name`]
+*** link:dd-elements.html#GSDPG00724[Superelements]
+*** link:dd-elements.html#GSDPG00725[Subelements]
+** link:dd-elements.html#GSDPG00271[`servlet`]
+*** link:dd-elements.html#GSDPG00726[Superelements]
+*** link:dd-elements.html#GSDPG00727[Subelements]
+** link:dd-elements.html#GSDPG00272[`servlet-impl-class`]
+*** link:dd-elements.html#GSDPG00728[Superelements]
+*** link:dd-elements.html#GSDPG00729[Subelements]
+** link:dd-elements.html#GSDPG00273[`servlet-name`]
+*** link:dd-elements.html#GSDPG00730[Superelements]
+*** link:dd-elements.html#GSDPG00731[Subelements]
+** link:dd-elements.html#GSDPG00274[`session-config`]
+*** link:dd-elements.html#GSDPG00732[Superelements]
+*** link:dd-elements.html#GSDPG00733[Subelements]
+** link:dd-elements.html#GSDPG00275[`session-manager`]
+*** link:dd-elements.html#GSDPG00734[Superelements]
+*** link:dd-elements.html#GSDPG00735[Subelements]
+*** link:dd-elements.html#GSDPG00736[Attributes]
+** link:dd-elements.html#GSDPG00276[`session-properties`]
+*** link:dd-elements.html#GSDPG00737[Superelements]
+*** link:dd-elements.html#GSDPG00738[Subelements]
+*** link:dd-elements.html#GSDPG00739[Properties]
+** link:dd-elements.html#GSDPG00277[`ssl`]
+*** link:dd-elements.html#GSDPG00740[Superelements]
+*** link:dd-elements.html#GSDPG00741[Subelements]
+*** link:dd-elements.html#GSDPG00742[Attributes]
+** link:dd-elements.html#GSDPG00278[`steady-pool-size`]
+*** link:dd-elements.html#GSDPG00743[Superelements]
+*** link:dd-elements.html#GSDPG00744[Subelements]
+** link:dd-elements.html#GSDPG00279[`store-properties`]
+*** link:dd-elements.html#GSDPG00745[Superelements]
+*** link:dd-elements.html#GSDPG00746[Subelements]
+*** link:dd-elements.html#GSDPG00747[Properties]
+** link:dd-elements.html#GSDPG00280[`stub-property`]
+*** link:dd-elements.html#GSDPG00748[Superelements]
+*** link:dd-elements.html#GSDPG00749[Subelements]
+*** link:dd-elements.html#GSDPG00750[Properties]
+*** link:dd-elements.html#GSDPG00751[Example]
+** link:dd-elements.html#GSDPG00281[`sun-cmp-mapping`]
+*** link:dd-elements.html#GSDPG00752[Superelements]
+*** link:dd-elements.html#GSDPG00753[Subelements]
+** link:dd-elements.html#GSDPG00282[`sun-cmp-mappings`]
+*** link:dd-elements.html#GSDPG00754[Superelements]
+*** link:dd-elements.html#GSDPG00755[Subelements]
+** link:dd-elements.html#GSDPG00283[`table-name`]
+*** link:dd-elements.html#GSDPG00756[Superelements]
+*** link:dd-elements.html#GSDPG00757[Subelements]
+** link:dd-elements.html#GSDPG00284[`target-server`]
+*** link:dd-elements.html#GSDPG00758[Superelements]
+*** link:dd-elements.html#GSDPG00759[Subelements]
+*** link:dd-elements.html#GSDPG00760[Attributes]
+** link:dd-elements.html#GSDPG00285[`tie-class`]
+*** link:dd-elements.html#GSDPG00761[Superelements]
+*** link:dd-elements.html#GSDPG00762[Subelements]
+** link:dd-elements.html#GSDPG00286[`timeout`]
+*** link:dd-elements.html#GSDPG00763[Superelements]
+*** link:dd-elements.html#GSDPG00764[Subelements]
+*** link:dd-elements.html#GSDPG00765[Attributes]
+** link:dd-elements.html#GSDPG00287[`transport-config`]
+*** link:dd-elements.html#GSDPG00766[Superelements]
+*** link:dd-elements.html#GSDPG00767[Subelements]
+** link:dd-elements.html#GSDPG00288[`transport-guarantee`]
+*** link:dd-elements.html#GSDPG00768[Superelements]
+*** link:dd-elements.html#GSDPG00769[Subelements]
+** link:dd-elements.html#GSDPG00289[`unique-id`]
+*** link:dd-elements.html#GSDPG00770[Superelements]
+*** link:dd-elements.html#GSDPG00771[Subelements]
+** link:dd-elements.html#GSDPG00290[`url-pattern`]
+*** link:dd-elements.html#GSDPG00772[Superelements]
+*** link:dd-elements.html#GSDPG00773[Subelements]
+** link:dd-elements.html#GSDPG00291[`user-group`]
+*** link:dd-elements.html#GSDPG1039[Superelements]
+*** link:dd-elements.html#GSDPG1040[Subelements]
+** link:dd-elements.html#GSDPG00292[`use-thread-pool-id`]
+*** link:dd-elements.html#GSDPG00774[Superelements]
+*** link:dd-elements.html#GSDPG00775[Subelements]
+** link:dd-elements.html#GSDPG00293[`value`]
+*** link:dd-elements.html#GSDPG00776[Superelements]
+*** link:dd-elements.html#GSDPG00777[Subelements]
+** link:dd-elements.html#GSDPG00294[`valve`]
+*** link:dd-elements.html#GSDPG00778[Superelements]
+*** link:dd-elements.html#GSDPG00779[Subelements]
+*** link:dd-elements.html#GSDPG00780[Attributes]
+*** link:dd-elements.html#GSDPG00781[Example]
+** link:dd-elements.html#GSDPG00295[`vendor`]
+*** link:dd-elements.html#GSDPG00782[Superelements]
+*** link:dd-elements.html#GSDPG00783[Subelements]
+** link:dd-elements.html#GSDPG00296[`version-identifier`]
+*** link:dd-elements.html#GSDPG1043[Superelements]
+*** link:dd-elements.html#GSDPG1044[Subelements]
+** link:dd-elements.html#GSDPG00297[`victim-selection-policy`]
+*** link:dd-elements.html#GSDPG00784[Superelements]
+*** link:dd-elements.html#GSDPG00785[Subelements]
+*** link:dd-elements.html#GSDPG00786[Example]
+** link:dd-elements.html#GSDPG00298[`web`]
+*** link:dd-elements.html#GSDPG00787[Superelements]
+*** link:dd-elements.html#GSDPG00788[Subelements]
+** link:dd-elements.html#GSDPG00299[`web-uri`]
+*** link:dd-elements.html#GSDPG00789[Superelements]
+*** link:dd-elements.html#GSDPG00790[Subelements]
+** link:dd-elements.html#GSDPG00300[`webservice-description`]
+*** link:dd-elements.html#GSDPG00791[Superelements]
+*** link:dd-elements.html#GSDPG00792[Subelements]
+** link:dd-elements.html#GSDPG00301[`webservice-description-name`]
+*** link:dd-elements.html#GSDPG00793[Superelements]
+*** link:dd-elements.html#GSDPG00794[Subelements]
+** link:dd-elements.html#GSDPG00302[`webservice-endpoint`]
+*** link:dd-elements.html#GSDPG00795[Superelements]
+*** link:dd-elements.html#GSDPG00796[Subelements]
+** link:dd-elements.html#GSDPG00303[`work-security-map`]
+*** link:dd-elements.html#GSDPG1048[Superelements]
+*** link:dd-elements.html#GSDPG00797[Subelements]
+*** link:dd-elements.html#GSDPG1050[Attributes]
+** link:dd-elements.html#GSDPG00304[`wsdl-override`]
+*** link:dd-elements.html#GSDPG00798[Superelements]
+*** link:dd-elements.html#GSDPG00799[Subelements]
+*** link:dd-elements.html#GSDPG00800[Example]
+** link:dd-elements.html#GSDPG00305[`wsdl-port`]
+*** link:dd-elements.html#GSDPG00801[Superelements]
+*** link:dd-elements.html#GSDPG00802[Subelements]
+** link:dd-elements.html#GSDPG00306[`wsdl-publish-location`]
+*** link:dd-elements.html#GSDPG00803[Superelements]
+*** link:dd-elements.html#GSDPG00804[Subelements]
+*** link:dd-elements.html#GSDPG00805[Example]
diff --git a/docs/application-development-guide/src/main/jbake/content/class-loaders.adoc b/docs/application-development-guide/src/main/jbake/content/class-loaders.adoc
index 5e93cf4..2a28025 100644
--- a/docs/application-development-guide/src/main/jbake/content/class-loaders.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/class-loaders.adoc
@@ -5,15 +5,13 @@
prev=setting-up-dev-env.html
~~~~~~
-Class Loaders
-=============
+= Class Loaders
[[GSDVG00003]][[beade]]
[[class-loaders]]
-2 Class Loaders
----------------
+== 2 Class Loaders
Understanding Oracle GlassFish Server class loaders can help you
determine where to place supporting JAR and resource files for your
@@ -50,8 +48,7 @@
[[beadf]][[GSDVG00094]][[the-class-loader-hierarchy]]
-The Class Loader Hierarchy
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The Class Loader Hierarchy
Class loaders in the GlassFish Server runtime follow a delegation
hierarchy that is illustrated in the following figure and fully
@@ -131,8 +128,7 @@
[[gfqpi]][[GSDVG00095]][[delegation]]
-Delegation
-~~~~~~~~~~
+=== Delegation
Note that the class loader hierarchy is not a Java inheritance
hierarchy, but a delegation hierarchy. In the delegation design, a class
@@ -167,8 +163,7 @@
[[beadk]][[GSDVG00096]][[using-the-java-optional-package-mechanism]]
-Using the Java Optional Package Mechanism
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the Java Optional Package Mechanism
Optional packages are packages of Java classes and associated native
code that application developers can use to extend the functionality of
@@ -191,8 +186,7 @@
[[gchif]][[GSDVG00097]][[using-the-endorsed-standards-override-mechanism]]
-Using the Endorsed Standards Override Mechanism
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the Endorsed Standards Override Mechanism
Endorsed standards handle changes to classes and APIs that are bundled
in the JDK but are subject to change by external bodies.
@@ -208,8 +202,7 @@
[[beadg]][[GSDVG00098]][[class-loader-universes]]
-Class Loader Universes
-~~~~~~~~~~~~~~~~~~~~~~
+=== Class Loader Universes
Access to components within applications and modules installed on the
server occurs within the context of isolated class loader universes,
@@ -240,8 +233,7 @@
[[gatej]][[GSDVG00099]][[application-specific-class-loading]]
-Application-Specific Class Loading
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Application-Specific Class Loading
You can specify module- or application-specific library classes in one
of the following ways:
@@ -314,8 +306,7 @@
[[beadh]][[GSDVG00100]][[circumventing-class-loader-isolation]]
-Circumventing Class Loader Isolation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Circumventing Class Loader Isolation
Since each application or individually deployed module class loader
universe is isolated, an application or module cannot load classes from
@@ -334,8 +325,7 @@
[[beadj]][[GSDVG00342]][[using-the-common-class-loader]]
-Using the Common Class Loader
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the Common Class Loader
To use the Common class loader, copy the JAR files into the
domain-dir``/lib`` or as-install``/lib`` directory, or use the
@@ -362,16 +352,14 @@
[[gcrnt]][[GSDVG00343]][[sharing-libraries-across-a-cluster]]
-Sharing Libraries Across a Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sharing Libraries Across a Cluster
To share libraries across a specific cluster, copy the JAR files to the
domain-dir``/config/``cluster-config-name``/lib`` directory.
[[beadl]][[GSDVG00344]][[packaging-the-client-jar-for-one-application-in-another-application]]
-Packaging the Client JAR for One Application in Another Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Packaging the Client JAR for One Application in Another Application
By packaging the client JAR for one application in a second application,
you allow an EJB or web component in the second application to call an
@@ -386,8 +374,7 @@
[[fvyab]][[GSDVG00048]][[to-package-the-client-jar-for-one-application-in-another-application]]
-To Package the Client JAR for One Application in Another Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Package the Client JAR for One Application in Another Application
1. Deploy the dependent application.
2. Add the dependent application's client JAR file to the calling
diff --git a/docs/application-development-guide/src/main/jbake/content/connectors.adoc b/docs/application-development-guide/src/main/jbake/content/connectors.adoc
index baaa823..2169fa4 100644
--- a/docs/application-development-guide/src/main/jbake/content/connectors.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/connectors.adoc
@@ -5,15 +5,13 @@
prev=java-clients.html
~~~~~~
-Developing Connectors
-=====================
+= Developing Connectors
[[GSDVG00013]][[bealk]]
[[developing-connectors]]
-11 Developing Connectors
-------------------------
+== 11 Developing Connectors
This chapter describes Oracle GlassFish Server support for the Jakarta EE
Connector Architecture, also known as
@@ -58,8 +56,7 @@
[[beall]][[GSDVG00162]][[connector-support-in-the-glassfish-server]]
-Connector Support in the GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Connector Support in the GlassFish Server
The GlassFish Server supports the development and deployment of resource
adapters that are compatible with the Connector 1.6 specification (and,
@@ -100,8 +97,7 @@
[[bealm]][[GSDVG00474]][[connector-architecture-for-jms-and-jdbc]]
-Connector Architecture for JMS and JDBC
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Connector Architecture for JMS and JDBC
In the Administration Console, connector, JMS, and JDBC resources are
handled differently, but they use the same underlying Connector
@@ -120,8 +116,7 @@
[[bealn]][[GSDVG00475]][[connector-configuration]]
-Connector Configuration
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Connector Configuration
The GlassFish Server does not need to use `sun-ra.xml`, which previous
GlassFish Server versions used, to store server-specific deployment
@@ -138,8 +133,7 @@
[[bealr]][[GSDVG00163]][[advanced-connector-configuration-options]]
-Advanced Connector Configuration Options
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Advanced Connector Configuration Options
The following topics are addressed here:
@@ -158,8 +152,7 @@
[[beals]][[GSDVG00476]][[thread-associations]]
-Thread Associations
-^^^^^^^^^^^^^^^^^^^
+==== Thread Associations
Connectors can submit work instances to the GlassFish Server for
execution. By default, the GlassFish Server services work requests for
@@ -190,8 +183,7 @@
[[bealt]][[GSDVG00477]][[security-maps]]
-Security Maps
-^^^^^^^^^^^^^
+==== Security Maps
Create a security map for a connector connection pool to map an
application principal or a user group to a back end EIS principal. The
@@ -223,8 +215,7 @@
[[giqgt]][[GSDVG00478]][[work-security-maps]]
-Work Security Maps
-^^^^^^^^^^^^^^^^^^
+==== Work Security Maps
A work security map for a resource adapter maps an EIS principal or
group to a application principal or group. A work security map is useful
@@ -247,8 +238,7 @@
[[bealu]][[GSDVG00479]][[overriding-configuration-properties]]
-Overriding Configuration Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Overriding Configuration Properties
You can override the properties (`config-property` elements) specified
in the `ra.xml` file of a resource adapter:
@@ -278,8 +268,7 @@
[[bealv]][[GSDVG00480]][[testing-a-connector-connection-pool]]
-Testing a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Testing a Connector Connection Pool
You can test a connector connection pool for usability in one of these
ways:
@@ -309,8 +298,7 @@
[[gizcv]][[GSDVG00481]][[flushing-a-connector-connection-pool]]
-Flushing a Connector Connection Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Flushing a Connector Connection Pool
Flushing a connector connection pool recreates all the connections in
the pool and brings the pool to the steady pool size without the need
@@ -331,8 +319,7 @@
[[bealw]][[GSDVG00482]][[handling-invalid-connections]]
-Handling Invalid Connections
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Handling Invalid Connections
If a resource adapter generates a `ConnectionErrorOccured` event, the
GlassFish Server considers the connection invalid and removes the
@@ -384,8 +371,7 @@
[[bealx]][[GSDVG00483]][[setting-the-shutdown-timeout]]
-Setting the Shutdown Timeout
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting the Shutdown Timeout
According to the Connector specification, while an application server
shuts down, all resource adapters should be stopped. A resource adapter
@@ -411,8 +397,7 @@
[[gjjyy]][[GSDVG00484]][[specifying-the-class-loading-policy]]
-Specifying the Class Loading Policy
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying the Class Loading Policy
Use the `class-loading-policy` setting to determine which resource
adapters accessible to applications. Allowed values are:
@@ -435,8 +420,7 @@
[[bealy]][[GSDVG00485]][[using-last-agent-optimization-of-transactions]]
-Using Last Agent Optimization of Transactions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Last Agent Optimization of Transactions
Transactions that involve multiple resources or multiple participant
processes are distributed or global transactions. A global transaction
@@ -463,8 +447,7 @@
[[gizba]][[GSDVG00486]][[disabling-pooling-for-a-connection]]
-Disabling Pooling for a Connection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disabling Pooling for a Connection
To disable connection pooling, set the Pooling attribute to false. The
default is true. You can enable or disable connection pooling in one of
@@ -480,8 +463,7 @@
[[gizcs]][[GSDVG00487]][[using-application-scoped-connectors]]
-Using Application-Scoped Connectors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Application-Scoped Connectors
You can define an application-scoped connector or other resource for an
enterprise application, web module, EJB module, connector module, or
@@ -492,8 +474,7 @@
[[bealz]][[GSDVG00164]][[inbound-communication-support]]
-Inbound Communication Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Inbound Communication Support
The Connector specification defines the transaction and message inflow
system contracts for achieving inbound connectivity from an EIS. The
@@ -533,8 +514,7 @@
[[gizdm]][[GSDVG00165]][[outbound-communication-support]]
-Outbound Communication Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Outbound Communication Support
The Connector specification defines the system contracts for achieving
outbound connectivity from an EIS. A resource adapter supporting
@@ -559,8 +539,7 @@
[[beama]][[GSDVG00166]][[configuring-a-message-driven-bean-to-use-a-resource-adapter]]
-Configuring a Message Driven Bean to Use a Resource Adapter
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring a Message Driven Bean to Use a Resource Adapter
The Connectors specification's message inflow contract provides a
generic mechanism to plug in a wide-range of message providers,
diff --git a/docs/application-development-guide/src/main/jbake/content/container_managed-persistence.adoc b/docs/application-development-guide/src/main/jbake/content/container_managed-persistence.adoc
index 9e8d09a..ccc9ea1 100644
--- a/docs/application-development-guide/src/main/jbake/content/container_managed-persistence.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/container_managed-persistence.adoc
@@ -5,15 +5,13 @@
prev=ejb.html
~~~~~~
-Using Container-Managed Persistence
-===================================
+= Using Container-Managed Persistence
[[GSDVG00011]][[beajj]]
[[using-container-managed-persistence]]
-9 Using Container-Managed Persistence
--------------------------------------
+== 9 Using Container-Managed Persistence
This chapter contains information on how EJB 2.1 container-managed
persistence (CMP) works in Oracle GlassFish Server.
@@ -43,8 +41,7 @@
[[beajk]][[GSDVG00150]][[glassfish-server-support-for-cmp]]
-GlassFish Server Support for CMP
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Support for CMP
GlassFish Server support for EJB 2.1 CMP beans includes:
@@ -76,8 +73,7 @@
[[beajl]][[GSDVG00151]][[cmp-mapping]]
-CMP Mapping
-~~~~~~~~~~~
+=== CMP Mapping
Implementation for entity beans that use CMP is mostly a matter of
mapping CMP fields and CMR fields (relationships) to the database.
@@ -90,8 +86,7 @@
[[beajm]][[GSDVG00434]][[mapping-capabilities]]
-Mapping Capabilities
-^^^^^^^^^^^^^^^^^^^^
+==== Mapping Capabilities
Mapping refers to the ability to tie an object-based model to a
relational model of data, usually the schema of a relational database.
@@ -115,8 +110,7 @@
[[beajn]][[GSDVG00435]][[the-mapping-deployment-descriptor-file]]
-The Mapping Deployment Descriptor File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The Mapping Deployment Descriptor File
Each module with CMP beans must have the following files:
@@ -175,8 +169,7 @@
[[beajo]][[GSDVG00436]][[mapping-considerations]]
-Mapping Considerations
-^^^^^^^^^^^^^^^^^^^^^^
+==== Mapping Considerations
The following topics are addressed here:
@@ -193,8 +186,7 @@
[[beajp]][[GSDVG00303]][[join-tables-and-relationships]]
-Join Tables and Relationships
-+++++++++++++++++++++++++++++
+===== Join Tables and Relationships
Use of join tables in the database schema is supported for all types of
relationships, not just many-to-many relationships. For general
@@ -203,8 +195,7 @@
[[beajq]][[GSDVG00304]][[automatic-primary-key-generation]]
-Automatic Primary Key Generation
-++++++++++++++++++++++++++++++++
+===== Automatic Primary Key Generation
The GlassFish Server supports automatic primary key generation for EJB
1.1, 2.0, and 2.1 CMP beans. To specify automatic primary key
@@ -224,8 +215,7 @@
[[beajr]][[GSDVG00305]][[fixed-length-char-primary-keys]]
-Fixed Length CHAR Primary Keys
-++++++++++++++++++++++++++++++
+===== Fixed Length CHAR Primary Keys
If an existing database table has a primary key column in which the
values vary in length, but the type is `CHAR` instead of `VARCHAR`, the
@@ -236,8 +226,7 @@
[[beajs]][[GSDVG00306]][[managed-fields]]
-Managed Fields
-++++++++++++++
+===== Managed Fields
A managed field is a CMP or CMR field that is mapped to the same
database column as another CMP or CMR field. CMP fields mapped to the
@@ -257,8 +246,7 @@
[[beajt]][[GSDVG00307]][[blob-support]]
-BLOB Support
-++++++++++++
+===== BLOB Support
Binary Large Object (BLOB) is a data type used to store values that do
not correspond to other types such as numbers, strings, or dates. Java
@@ -309,8 +297,7 @@
[[beaju]][[GSDVG00308]][[clob-support]]
-CLOB Support
-++++++++++++
+===== CLOB Support
Character Large Object (CLOB) is a data type used to store and retrieve
very long text fields. CLOBs translate into long strings.
@@ -352,8 +339,7 @@
[[beajv]][[GSDVG00152]][[automatic-schema-generation-for-cmp]]
-Automatic Schema Generation for CMP
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Automatic Schema Generation for CMP
The automatic schema generation feature provided in the GlassFish Server
defines database tables based on the fields in entity beans and the
@@ -386,8 +372,7 @@
[[beajw]][[GSDVG00437]][[supported-data-types-for-cmp]]
-Supported Data Types for CMP
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Supported Data Types for CMP
CMP supports a set of JDBC data types that are used in mapping Java data
fields to SQL types. Supported JDBC data types are as follows: BIGINT,
@@ -501,8 +486,7 @@
[[beajx]][[GSDVG00438]][[generation-options-for-cmp]]
-Generation Options for CMP
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Generation Options for CMP
Deployment descriptor elements or `asadmin` command line options can
control automatic schema generation by the following:
@@ -680,8 +664,7 @@
[[beajy]][[GSDVG00153]][[schema-capture]]
-Schema Capture
-~~~~~~~~~~~~~~
+=== Schema Capture
The following topics are addressed here:
@@ -690,8 +673,7 @@
[[beajz]][[GSDVG00439]][[automatic-database-schema-capture]]
-Automatic Database Schema Capture
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Automatic Database Schema Capture
You can configure a CMP bean in GlassFish Server to automatically
capture the database metadata and save it in a `.dbschema` file during
@@ -711,8 +693,7 @@
[[beaka]][[GSDVG00440]][[using-the-capture-schema-utility]]
-Using the `capture-schema` Utility
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the `capture-schema` Utility
You can use the `capture-schema` command to manually generate the
database metadata (`.dbschema`) file. For details, see the
@@ -742,8 +723,7 @@
[[beakb]][[GSDVG00154]][[configuring-the-cmp-resource]]
-Configuring the CMP Resource
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring the CMP Resource
An EJB module that contains CMP beans requires the JNDI name of a JDBC
resource in the `jndi-name` subelement of the `cmp-resource` element in
@@ -774,8 +754,7 @@
[[beaki]][[GSDVG00155]][[performance-related-features]]
-Performance-Related Features
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Performance-Related Features
The GlassFish Server provides the following features to enhance
performance or allow more fine-grained data checking. These features are
@@ -797,8 +776,7 @@
[[beakj]][[GSDVG00441]][[version-column-consistency-checking]]
-Version Column Consistency Checking
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Version Column Consistency Checking
The version consistency feature saves the bean state at first
transactional access and caches it between transactions. The state is
@@ -809,8 +787,7 @@
[[fwbei]][[GSDVG00071]][[to-use-version-consistency]]
-To Use Version Consistency
-++++++++++++++++++++++++++
+===== To Use Version Consistency
1. Create the version column in the primary table.
2. Give the version column a numeric data type.
@@ -830,8 +807,7 @@
[[beakk]][[GSDVG00442]][[relationship-prefetching]]
-Relationship Prefetching
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Relationship Prefetching
In many cases when an entity bean's state is fetched from the database,
its relationship fields are always accessed in the same transaction.
@@ -864,8 +840,7 @@
[[beakl]][[GSDVG00443]][[read-only-beans]]
-Read-Only Beans
-^^^^^^^^^^^^^^^
+==== Read-Only Beans
Another feature that the GlassFish Server provides is the read-only
bean, an entity bean that is never modified by an EJB client. Read-only
@@ -907,8 +882,7 @@
[[gemln]][[GSDVG00156]][[default-fetch-group-flags]]
-Default Fetch Group Flags
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Fetch Group Flags
Using the following flags can improve performance.
@@ -941,8 +915,7 @@
[[beakc]][[GSDVG00157]][[configuring-queries-for-1.1-finders]]
-Configuring Queries for 1.1 Finders
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Queries for 1.1 Finders
The following topics are addressed here:
@@ -954,8 +927,7 @@
[[ganjq]][[GSDVG00444]][[about-jdoql-queries]]
-About JDOQL Queries
-^^^^^^^^^^^^^^^^^^^
+==== About JDOQL Queries
The Enterprise JavaBeans Specification, v1.1 does not specify the format
of the finder method description. The GlassFish Server uses an extension
@@ -1000,8 +972,7 @@
[[gankm]][[GSDVG00445]][[query-filter-expression]]
-Query Filter Expression
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Query Filter Expression
The filter expression is a String containing a Boolean expression
evaluated for each instance of the candidate class. If the filter is not
@@ -1081,8 +1052,7 @@
[[ganjt]][[GSDVG00446]][[query-parameters]]
-Query Parameters
-^^^^^^^^^^^^^^^^
+==== Query Parameters
The parameter declaration is a String containing one or more parameter
type declarations separated by commas. This follows the Java syntax for
@@ -1090,23 +1060,20 @@
[[ganky]][[GSDVG00447]][[query-variables]]
-Query Variables
-^^^^^^^^^^^^^^^
+==== Query Variables
The type declarations follow the Java syntax for local variable
declarations.
[[ganla]][[GSDVG00448]][[jdoql-examples]]
-JDOQL Examples
-^^^^^^^^^^^^^^
+==== JDOQL Examples
This section provides a few query examples.
[[gankk]][[GSDVG00309]][[example-1]]
-Example 1
-+++++++++
+===== Example 1
The following query returns all players called Michael. It defines a
filter that compares the name field with a string literal:
@@ -1129,8 +1096,7 @@
[[ganjz]][[GSDVG00310]][[example-2]]
-Example 2
-+++++++++
+===== Example 2
This query returns all products in a specified price range. It defines
two query parameters which are the lower and upper bound for the price:
@@ -1159,8 +1125,7 @@
[[gankz]][[GSDVG00311]][[example-3]]
-Example 3
-+++++++++
+===== Example 3
This query returns all players having a higher salary than the player
with the specified name. It defines a query parameter for the name
@@ -1200,8 +1165,7 @@
[[beakm]][[GSDVG00158]][[cmp-restrictions-and-optimizations]]
-CMP Restrictions and Optimizations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== CMP Restrictions and Optimizations
This section discusses restrictions and performance optimizations that
pertain to using CMP.
@@ -1221,8 +1185,7 @@
[[gdtfj]][[GSDVG00449]][[disabling-order-by-validation]]
-Disabling ORDER BY Validation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disabling ORDER BY Validation
EJB QL as defined in the EJB 2.1 Specification defines certain
restrictions for the SELECT clause of an ORDER BY query (see section
@@ -1247,8 +1210,7 @@
[[geprt]][[GSDVG00450]][[setting-the-heap-size-on-db2]]
-Setting the Heap Size on DB2
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting the Heap Size on DB2
On DB2, the database configuration parameter `APPLHEAPSZ` determines the
heap size. If you are using the Oracle or DataDirect database driver,
@@ -1257,8 +1219,7 @@
[[beakn]][[GSDVG00451]][[eager-loading-of-field-state]]
-Eager Loading of Field State
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Eager Loading of Field State
By default, the EJB container loads the state for all persistent fields
(excluding relationship, BLOB, and CLOB fields) before invoking the
@@ -1272,8 +1233,7 @@
[[beako]][[GSDVG00452]][[restrictions-on-remote-interfaces]]
-Restrictions on Remote Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Restrictions on Remote Interfaces
The following restrictions apply to the remote interface of an EJB 2.1
bean that uses CMP:
@@ -1295,8 +1255,7 @@
[[gcnto]][[GSDVG00453]][[postgresql-case-insensitivity]]
-PostgreSQL Case Insensitivity
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== PostgreSQL Case Insensitivity
Case-sensitive behavior cannot be achieved for PostgreSQL databases.
PostgreSQL databases internally convert all names to lower case, which
@@ -1310,8 +1269,7 @@
[[beakr]][[GSDVG00454]][[no-support-for-lock-when-loaded-on-sybase]]
-No Support for `lock-when-loaded` on Sybase
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== No Support for `lock-when-loaded` on Sybase
For EJB 2.1 beans, the `lock-when-loaded` consistency level is
implemented by placing update locks on the data corresponding to a bean
@@ -1323,8 +1281,7 @@
[[beakp]][[GSDVG00455]][[sybase-finder-limitation]]
-Sybase Finder Limitation
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sybase Finder Limitation
If a finder method with an input greater than 255 characters is executed
and the primary key column is mapped to a VARCHAR column, Sybase
@@ -1342,8 +1299,7 @@
[[beakq]][[GSDVG00456]][[date-and-time-fields]]
-Date and Time Fields
-^^^^^^^^^^^^^^^^^^^^
+==== Date and Time Fields
If a field type is a Java date or time type (`java.util.Date`,
`java.sql.Date`, `java.sql.Time`, `java.sql.Timestamp`), make sure that
@@ -1380,8 +1336,7 @@
[[beaks]][[GSDVG00457]][[set-recursive_triggers-to-false-on-mssql]]
-Set `RECURSIVE_TRIGGERS` to `false` on MSSQL
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Set `RECURSIVE_TRIGGERS` to `false` on MSSQL
For version consistency triggers on MSSQL, the property
`RECURSIVE_TRIGGERS` must be set to `false`, which is the default. If
@@ -1405,8 +1360,7 @@
[[gbhbr]][[GSDVG00458]][[mysql-database-restrictions]]
-MySQL Database Restrictions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== MySQL Database Restrictions
The following restrictions apply when you use a MySQL database with the
GlassFish Server for persistence.
diff --git a/docs/application-development-guide/src/main/jbake/content/debugging-apps.adoc b/docs/application-development-guide/src/main/jbake/content/debugging-apps.adoc
index f854f38..6d28b2a 100644
--- a/docs/application-development-guide/src/main/jbake/content/debugging-apps.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/debugging-apps.adoc
@@ -5,15 +5,13 @@
prev=class-loaders.html
~~~~~~
-Debugging Applications
-======================
+= Debugging Applications
[[GSDVG00004]][[beafc]]
[[debugging-applications]]
-3 Debugging Applications
-------------------------
+== 3 Debugging Applications
This chapter gives guidelines for debugging applications in the Oracle
GlassFish Server.
@@ -32,8 +30,7 @@
[[beafd]][[GSDVG00101]][[enabling-debugging]]
-Enabling Debugging
-~~~~~~~~~~~~~~~~~~
+=== Enabling Debugging
When you enable debugging, you enable both local and remote debugging.
To start the server in debug mode, use the `--debug` option as follows:
@@ -81,8 +78,7 @@
[[fvyit]][[GSDVG00049]][[to-set-the-server-to-automatically-start-up-in-debug-mode]]
-To Set the Server to Automatically Start Up in Debug Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set the Server to Automatically Start Up in Debug Mode
1. Use the Administration Console. Select the JVM Settings component
under the relevant configuration.
@@ -102,8 +98,7 @@
[[beafe]][[GSDVG00102]][[jpda-options]]
-JPDA Options
-~~~~~~~~~~~~
+=== JPDA Options
The default JPDA options in GlassFish Server are as follows:
@@ -127,8 +122,7 @@
[[beaff]][[GSDVG00103]][[generating-a-stack-trace-for-debugging]]
-Generating a Stack Trace for Debugging
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Generating a Stack Trace for Debugging
To generate a Java stack trace for debugging, use the
`asadmin generate-jvm-report --type=thread` command. The stack trace
@@ -139,8 +133,7 @@
[[gekvq]][[GSDVG00104]][[application-client-debugging]]
-Application Client Debugging
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Application Client Debugging
When the `appclient` script executes the `java` command to run the
Application Client Container (ACC), which in turn runs the client, it
@@ -176,8 +169,7 @@
[[beafk]][[GSDVG00105]][[open-message-queue-debugging]]
-Open Message Queue Debugging
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Open Message Queue Debugging
Open Message Queue has a broker logger, which can be useful for
debugging Java Message Service (JMS) applications, including
@@ -196,8 +188,7 @@
[[beafl]][[GSDVG00106]][[enabling-verbose-mode]]
-Enabling Verbose Mode
-~~~~~~~~~~~~~~~~~~~~~
+=== Enabling Verbose Mode
To have the server logs and messages printed to `System.out` on your
command prompt screen, you can start the server in verbose mode. This
@@ -223,8 +214,7 @@
[[gkpdk]][[GSDVG00107]][[class-loader-debugging]]
-Class Loader Debugging
-~~~~~~~~~~~~~~~~~~~~~~
+=== Class Loader Debugging
To generate class loading messages, use the following
`asadmin create-jvm-options` command:
@@ -257,8 +247,7 @@
[[beafm]][[GSDVG00108]][[glassfish-server-logging]]
-GlassFish Server Logging
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Logging
You can use the GlassFish Server's log files to help debug your
applications. Use the Administration Console. Select the Stand-Alone
@@ -274,8 +263,7 @@
[[beafn]][[GSDVG00109]][[profiling-tools]]
-Profiling Tools
-~~~~~~~~~~~~~~~
+=== Profiling Tools
You can use a profiler to perform remote profiling on the GlassFish
Server to discover bottlenecks in server-side performance. This section
@@ -293,16 +281,14 @@
[[gcicc]][[GSDVG00345]][[the-netbeans-profiler]]
-The NetBeans Profiler
-^^^^^^^^^^^^^^^^^^^^^
+==== The NetBeans Profiler
For information on how to use the NetBeans profiler, see
`http://profiler.netbeans.org/index.html`.
[[beafo]][[GSDVG00346]][[the-hprof-profiler]]
-The HPROF Profiler
-^^^^^^^^^^^^^^^^^^
+==== The HPROF Profiler
The Heap and CPU Profiling Agent (HPROF) is a simple profiler agent
shipped with the Java 2 SDK. It is a dynamically linked library that
@@ -321,8 +307,7 @@
[[fvylg]][[GSDVG00050]][[to-use-hprof-profiling-on-unix]]
-To Use HPROF Profiling on UNIX
-++++++++++++++++++++++++++++++
+===== To Use HPROF Profiling on UNIX
1. Use the Administration Console. Select the JVM Settings component
under the relevant configuration. Then select the Profiler tab.
@@ -353,8 +338,7 @@
----
Hprof usage: -Xrunhprof[:help]|[:<option>=<value>, ...]
-Option Name and Value Description Default
---------------------- ----------- -------
+== Option Name and Value Description Default ----------- -------
heap=dump|sites|all heap profiling all
cpu=samples|old CPU usage off
format=a|b ascii or binary output a
@@ -385,8 +369,7 @@
[[beafr]][[GSDVG00347]][[the-jprobe-profiler]]
-The JProbe Profiler
-^^^^^^^^^^^^^^^^^^^
+==== The JProbe Profiler
Information about JProbe from Sitraka is available at
`http://www.quest.com/jprobe/`.
@@ -396,8 +379,7 @@
[[fvymj]][[GSDVG00051]][[to-enable-remote-profiling-with-jprobe]]
-To Enable Remote Profiling With JProbe
-++++++++++++++++++++++++++++++++++++++
+===== To Enable Remote Profiling With JProbe
1. Install JProbe 3.0.1.1. For details, see the JProbe documentation.
diff --git a/docs/application-development-guide/src/main/jbake/content/ejb.adoc b/docs/application-development-guide/src/main/jbake/content/ejb.adoc
index 5b1ed63..5e804bc 100644
--- a/docs/application-development-guide/src/main/jbake/content/ejb.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/ejb.adoc
@@ -5,15 +5,13 @@
prev=webapps.html
~~~~~~
-Using Enterprise JavaBeans Technology
-=====================================
+= Using Enterprise JavaBeans Technology
[[GSDVG00010]][[beahl]]
[[using-enterprise-javabeans-technology]]
-8 Using Enterprise JavaBeans Technology
----------------------------------------
+== 8 Using Enterprise JavaBeans Technology
This chapter describes how Enterprise JavaBeans ( EJB) technology is
supported in the Oracle GlassFish Server.
@@ -48,8 +46,7 @@
[[beahn]][[GSDVG00145]][[value-added-features]]
-Value Added Features
-~~~~~~~~~~~~~~~~~~~~
+=== Value Added Features
The GlassFish Server provides a number of value additions that relate to
EJB development. References to more in-depth material are included.
@@ -64,8 +61,7 @@
[[beaho]][[GSDVG00420]][[read-only-beans]]
-Read-Only Beans
-^^^^^^^^^^^^^^^
+==== Read-Only Beans
Another feature that the GlassFish Server provides is the read-only
bean, an EJB 2.1 entity bean that is never modified by an EJB client.
@@ -106,8 +102,7 @@
[[beahp]][[GSDVG00421]][[the-pass-by-reference-element]]
-The `pass-by-reference` Element
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `pass-by-reference` Element
The `pass-by-reference` element in the `glassfish-ejb-jar.xml` file
allows you to specify the parameter passing semantics for colocated
@@ -118,8 +113,7 @@
[[beahq]][[GSDVG00422]][[pooling-and-caching]]
-Pooling and Caching
-^^^^^^^^^^^^^^^^^^^
+==== Pooling and Caching
The EJB container of the GlassFish Server pools anonymous instances
(message-driven beans, stateless session beans, and entity beans) to
@@ -153,8 +147,7 @@
[[beahr]][[GSDVG00285]][[pooling-parameters]]
-Pooling Parameters
-++++++++++++++++++
+===== Pooling Parameters
One of the most important parameters for GlassFish Server pooling is
`steady-pool-size`. When `steady-pool-size` is set to a value greater
@@ -184,8 +177,7 @@
[[beahs]][[GSDVG00286]][[caching-parameters]]
-Caching Parameters
-++++++++++++++++++
+===== Caching Parameters
GlassFish Server provides a way that completely avoids caching of entity
beans, using commit option C. Commit option C is particularly useful if
@@ -202,8 +194,7 @@
[[beahu]][[GSDVG00423]][[priority-based-scheduling-of-remote-bean-invocations]]
-Priority Based Scheduling of Remote Bean Invocations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Priority Based Scheduling of Remote Bean Invocations
You can create multiple thread pools, each having its own work queues.
An optional element in the `glassfish-ejb-jar.xml` file,
@@ -216,8 +207,7 @@
[[beahv]][[GSDVG00424]][[immediate-flushing]]
-Immediate Flushing
-^^^^^^^^^^^^^^^^^^
+==== Immediate Flushing
Normally, all entity bean updates within a transaction are batched and
executed at the end of the transaction. The only exception is the
@@ -248,8 +238,7 @@
[[beahw]][[GSDVG00146]][[ejb-timer-service]]
-EJB Timer Service
-~~~~~~~~~~~~~~~~~
+=== EJB Timer Service
The EJB Timer Service uses a database to store persistent information
about EJB timers. The EJB Timer Service in GlassFish Server is
@@ -345,8 +334,7 @@
[[gktqo]][[GSDVG00070]][[to-deploy-an-ejb-timer-to-a-cluster]]
-To Deploy an EJB Timer to a Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Deploy an EJB Timer to a Cluster
This procedure explains how to deploy an EJB timer to a cluster.
@@ -426,8 +414,7 @@
[[beahx]][[GSDVG00147]][[using-session-beans]]
-Using Session Beans
-~~~~~~~~~~~~~~~~~~~
+=== Using Session Beans
This section provides guidelines for creating session beans in the
GlassFish Server environment.
@@ -443,8 +430,7 @@
[[beahy]][[GSDVG00425]][[about-the-session-bean-containers]]
-About the Session Bean Containers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== About the Session Bean Containers
Like an entity bean, a session bean can access a database through Java
Database Connectivity (JDBC) calls. A session bean can also provide
@@ -462,8 +448,7 @@
[[beahz]][[GSDVG00287]][[stateless-container]]
-Stateless Container
-+++++++++++++++++++
+===== Stateless Container
The stateless container manages stateless session beans, which, by
definition, do not carry client-specific states. All session beans (of a
@@ -489,8 +474,7 @@
[[beaia]][[GSDVG00288]][[stateful-container]]
-Stateful Container
-++++++++++++++++++
+===== Stateful Container
The stateful container manages the stateful session beans, which, by
definition, carry the client-specific state. There is a one-to-one
@@ -542,8 +526,7 @@
[[beaib]][[GSDVG00426]][[stateful-session-bean-failover]]
-Stateful Session Bean Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Stateful Session Bean Failover
An SFSB's state can be saved in a persistent store in case a server
instance fails. The state of an SFSB is saved to the persistent store at
@@ -665,8 +648,7 @@
[[beaic]][[GSDVG00289]][[choosing-a-persistence-store]]
-Choosing a Persistence Store
-++++++++++++++++++++++++++++
+===== Choosing a Persistence Store
The following types of persistent storage are supported for passivation
and checkpointing of the SFSB state:
@@ -746,8 +728,7 @@
[[beaid]][[GSDVG00290]][[enabling-checkpointing]]
-Enabling Checkpointing
-++++++++++++++++++++++
+===== Enabling Checkpointing
The following sections describe how to enable SFSB checkpointing:
@@ -796,8 +777,7 @@
[[beaih]][[GSDVG00291]][[specifying-methods-to-be-checkpointed]]
-Specifying Methods to Be Checkpointed
-+++++++++++++++++++++++++++++++++++++
+===== Specifying Methods to Be Checkpointed
If SFSB checkpointing is enabled, checkpointing generally occurs after
any transaction involving the SFSB is completed, even if the transaction
@@ -865,8 +845,7 @@
[[beaii]][[GSDVG00427]][[session-bean-restrictions-and-optimizations]]
-Session Bean Restrictions and Optimizations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Session Bean Restrictions and Optimizations
This section discusses restrictions on developing session beans and
provides some optimization guidelines.
@@ -877,8 +856,7 @@
[[beaij]][[GSDVG00292]][[optimizing-session-bean-performance]]
-Optimizing Session Bean Performance
-+++++++++++++++++++++++++++++++++++
+===== Optimizing Session Bean Performance
For stateful session beans, colocating the stateful beans with their
clients so that the client and bean are executing in the same process
@@ -886,8 +864,7 @@
[[beaik]][[GSDVG00293]][[restricting-transactions]]
-Restricting Transactions
-++++++++++++++++++++++++
+===== Restricting Transactions
The following restrictions on transactions are enforced by the container
and must be observed as session beans are developed:
@@ -905,16 +882,14 @@
[[glanq]][[GSDVG00294]][[ejb-singletons]]
-EJB Singletons
-++++++++++++++
+===== EJB Singletons
EJB Singletons are created for each server instance in a cluster, and
not once per cluster.
[[beail]][[GSDVG00148]][[using-read-only-beans]]
-Using Read-Only Beans
-~~~~~~~~~~~~~~~~~~~~~
+=== Using Read-Only Beans
A read-only bean is an EJB 2.1 entity bean that is never modified by an
EJB client. The data that a read-only bean represents can be updated
@@ -945,8 +920,7 @@
[[beaim]][[GSDVG00428]][[read-only-bean-characteristics-and-life-cycle]]
-Read-Only Bean Characteristics and Life Cycle
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Read-Only Bean Characteristics and Life Cycle
Read-only beans are best suited for situations where the underlying data
never changes, or changes infrequently. For example, a read-only bean
@@ -994,8 +968,7 @@
[[beain]][[GSDVG00429]][[read-only-bean-good-practices]]
-Read-Only Bean Good Practices
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Read-Only Bean Good Practices
For best results, follow these guidelines when developing read-only
beans:
@@ -1010,8 +983,7 @@
[[beaio]][[GSDVG00430]][[refreshing-read-only-beans]]
-Refreshing Read-Only Beans
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Refreshing Read-Only Beans
There are several ways of refreshing read-only beans, as addressed in
the following sections:
@@ -1022,15 +994,13 @@
[[beaip]][[GSDVG00295]][[invoking-a-transactional-method]]
-Invoking a Transactional Method
-+++++++++++++++++++++++++++++++
+===== Invoking a Transactional Method
Invoking any transactional method invokes `ejbLoad`.
[[beaiq]][[GSDVG00296]][[refreshing-periodically]]
-Refreshing Periodically
-+++++++++++++++++++++++
+===== Refreshing Periodically
Use the `refresh-period-in-seconds` element in the
`glassfish-ejb-jar.xml` file to refresh a read-only bean periodically.
@@ -1070,8 +1040,7 @@
[[beair]][[GSDVG00297]][[refreshing-programmatically]]
-Refreshing Programmatically
-+++++++++++++++++++++++++++
+===== Refreshing Programmatically
Typically, beans that update any data that is cached by read-only beans
need to notify the read-only beans to refresh their state. Use
@@ -1117,8 +1086,7 @@
[[beais]][[GSDVG00431]][[deploying-read-only-beans]]
-Deploying Read-Only Beans
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying Read-Only Beans
Read-only beans are deployed in the same manner as other entity beans.
However, in the entry for the bean in the `glassfish-ejb-jar.xml` file,
@@ -1142,8 +1110,7 @@
[[beait]][[GSDVG00149]][[using-message-driven-beans]]
-Using Message-Driven Beans
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Message-Driven Beans
This section describes message-driven beans and explains the
requirements for creating them in the GlassFish Server environment.
@@ -1155,8 +1122,7 @@
[[beaiu]][[GSDVG00432]][[message-driven-bean-configuration]]
-Message-Driven Bean Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message-Driven Bean Configuration
The following topics are addressed here:
@@ -1169,8 +1135,7 @@
[[beaiv]][[GSDVG00298]][[connection-factory-and-destination]]
-Connection Factory and Destination
-++++++++++++++++++++++++++++++++++
+===== Connection Factory and Destination
A message-driven bean is a client to a Connector inbound resource
adapter. The message-driven bean container uses the JMS service
@@ -1191,8 +1156,7 @@
[[beaiw]][[GSDVG00299]][[message-driven-bean-pool]]
-Message-Driven Bean Pool
-++++++++++++++++++++++++
+===== Message-Driven Bean Pool
The container manages a pool of message-driven beans for the concurrent
processing of a stream of messages. The `glassfish-ejb-jar.xml` file
@@ -1210,8 +1174,7 @@
[[beaix]][[GSDVG00300]][[domain-level-settings]]
-Domain-Level Settings
-+++++++++++++++++++++
+===== Domain-Level Settings
You can control the following domain-level message-driven bean settings
in the EJB container:
@@ -1252,8 +1215,7 @@
[[beaiy]][[GSDVG00433]][[message-driven-bean-restrictions-and-optimizations]]
-Message-Driven Bean Restrictions and Optimizations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message-Driven Bean Restrictions and Optimizations
This section discusses the following restrictions and performance
optimizations that pertain to developing message-driven beans:
@@ -1263,8 +1225,7 @@
[[beaiz]][[GSDVG00301]][[pool-tuning-and-monitoring]]
-Pool Tuning and Monitoring
-++++++++++++++++++++++++++
+===== Pool Tuning and Monitoring
The message-driven bean pool is also a pool of threads, with each
message-driven bean instance in the pool associating with a server
@@ -1292,8 +1253,7 @@
[[beaja]][[GSDVG00302]][[the-onmessage-runtime-exception]]
-The `onMessage` Runtime Exception
-+++++++++++++++++++++++++++++++++
+===== The `onMessage` Runtime Exception
Message-driven beans, like other well-behaved MessageListeners, should
not, in general, throw runtime exceptions. If a message-driven bean's
diff --git a/docs/application-development-guide/src/main/jbake/content/java-clients.adoc b/docs/application-development-guide/src/main/jbake/content/java-clients.adoc
index b994b99..0cefe68 100644
--- a/docs/application-development-guide/src/main/jbake/content/java-clients.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/java-clients.adoc
@@ -5,15 +5,13 @@
prev=container_managed-persistence.html
~~~~~~
-Developing Java Clients
-=======================
+= Developing Java Clients
[[GSDVG00012]][[beakt]]
[[developing-java-clients]]
-10 Developing Java Clients
---------------------------
+== 10 Developing Java Clients
This chapter describes how to develop, assemble, and deploy Java
clients.
@@ -43,8 +41,7 @@
[[beaku]][[GSDVG00159]][[introducing-the-application-client-container]]
-Introducing the Application Client Container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Introducing the Application Client Container
The Application Client Container (ACC) includes a set of Java classes,
libraries, and other files that are required for and distributed with
@@ -72,8 +69,7 @@
[[fvymq]][[GSDVG00459]][[acc-security]]
-ACC Security
-^^^^^^^^^^^^
+==== ACC Security
The ACC determines when authentication is needed. This typically occurs
when the client refers to an EJB component that requires authorization
@@ -103,8 +99,7 @@
[[fvymv]][[GSDVG00460]][[acc-naming]]
-ACC Naming
-^^^^^^^^^^
+==== ACC Naming
The client container enables the application clients to use the Java
Naming and Directory Interface (JNDI) to look up Jakarta EE services (such
@@ -113,8 +108,7 @@
[[gbgfe]][[GSDVG00461]][[application-client-annotation]]
-Application Client Annotation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Application Client Annotation
Annotation is supported for the main class and the optional callback
handler class in application clients. For more information, see
@@ -123,8 +117,7 @@
[[gavkg]][[GSDVG00462]][[java-web-start]]
-Java Web Start
-^^^^^^^^^^^^^^
+==== Java Web Start
Java Web Start allows your application client to be easily launched and
automatically downloaded and updated. It is enabled for all application
@@ -133,8 +126,7 @@
[[gipjj]][[GSDVG00463]][[application-client-jar-file]]
-Application Client JAR File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Application Client JAR File
In GlassFish Server 7, the downloaded appclient JAR file is smaller
than in previous releases, with dependent classes in separate JAR files.
@@ -146,8 +138,7 @@
[[beakv]][[GSDVG00160]][[developing-clients-using-the-acc]]
-Developing Clients Using the ACC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Developing Clients Using the ACC
This section describes the procedure to develop, assemble, and deploy
client applications using the ACC.
@@ -170,8 +161,7 @@
[[beakw]][[GSDVG00072]][[to-access-an-ejb-component-from-an-application-client]]
-To Access an EJB Component From an Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Access an EJB Component From an Application Client
1. In your client code, reference the EJB component by using an `@EJB`
annotation or by looking up the JNDI name as defined in the `ejb-jar.xml` file. +
@@ -278,8 +268,7 @@
[[beakx]][[GSDVG00073]][[to-access-a-jms-resource-from-an-application-client]]
-To Access a JMS Resource From an Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Access a JMS Resource From an Application Client
1. Create a JMS client.
+
@@ -334,8 +323,7 @@
[[gavmf]][[GSDVG00464]][[using-java-web-start]]
-Using Java Web Start
-^^^^^^^^^^^^^^^^^^^^
+==== Using Java Web Start
Java Web Start allows your application client to be easily launched and
automatically downloaded and updated. General information about Java Web
@@ -354,8 +342,7 @@
[[gavqb]][[GSDVG00312]][[enabling-and-disabling-java-web-start]]
-Enabling and Disabling Java Web Start
-+++++++++++++++++++++++++++++++++++++
+===== Enabling and Disabling Java Web Start
Java Web Start is enabled for all application clients by default.
@@ -392,8 +379,7 @@
[[gavmk]][[GSDVG00313]][[downloading-and-launching-an-application-client]]
-Downloading and Launching an Application Client
-+++++++++++++++++++++++++++++++++++++++++++++++
+===== Downloading and Launching an Application Client
If Java Web Start is enabled for your deployed application client, you
can launch it for testing. Simply click on the Launch button next to the
@@ -425,8 +411,7 @@
[[gavor]][[GSDVG00314]][[the-application-client-url]]
-The Application Client URL
-++++++++++++++++++++++++++
+===== The Application Client URL
The default URL for an application or module generally is as follows:
@@ -503,8 +488,7 @@
[[gcjlg]][[GSDVG00315]][[signing-jar-files-used-in-java-web-start]]
-Signing JAR Files Used in Java Web Start
-++++++++++++++++++++++++++++++++++++++++
+===== Signing JAR Files Used in Java Web Start
Java Web Start enforces a security sandbox. By default it grants any
application, including application clients, only minimal privileges.
@@ -662,8 +646,7 @@
[[geqxg]][[GSDVG00316]][[error-handling]]
-Error Handling
-++++++++++++++
+===== Error Handling
When an application client is launched using Java Web Start, any error
that the application client logic does not catch and handle is written
@@ -674,8 +657,7 @@
[[geqwd]][[GSDVG00317]][[vendor-icon-splash-screen-and-text]]
-Vendor Icon, Splash Screen, and Text
-++++++++++++++++++++++++++++++++++++
+===== Vendor Icon, Splash Screen, and Text
To specify a vendor-specific icon, splash screen, text string, or a
combination of these for Java Web Start download and launch screens, use
@@ -729,8 +711,7 @@
[[gkmbs]][[GSDVG00318]][[creating-a-custom-jnlp-file]]
-Creating a Custom JNLP File
-+++++++++++++++++++++++++++
+===== Creating a Custom JNLP File
You can partially customize the Java Network Launching Protocol (JNLP)
file that GlassFish Server uses for Java Web Start.
@@ -1107,8 +1088,7 @@
[[gipkt]][[GSDVG00465]][[using-the-embeddable-acc]]
-Using the Embeddable ACC
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the Embeddable ACC
You can embed the ACC into your application client. If you place the
as-install`/lib/gf-client.jar` file in your runtime classpath, your
@@ -1183,8 +1163,7 @@
[[beaky]][[GSDVG00466]][[running-an-application-client-using-the-appclient-script]]
-Running an Application Client Using the `appclient` Script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Running an Application Client Using the `appclient` Script
To run an application client, you can launch the ACC using the
`appclient` script, whether or not Java Web Start is enabled. This is
@@ -1194,8 +1173,7 @@
[[beakz]][[GSDVG00467]][[using-the-package-appclient-script]]
-Using the `package-appclient` Script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the `package-appclient` Script
You can package the GlassFish Server system files required to launch
application clients on remote systems into a single JAR file using the
@@ -1205,8 +1183,7 @@
[[fvymy]][[GSDVG00468]][[the-client.policy-file]]
-The `client.policy` File
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `client.policy` File
The `client.policy` file is the J2SE policy file used by the application
client. Each application client has a `client.policy` file. The default
@@ -1226,8 +1203,7 @@
[[gckgn]][[GSDVG00469]][[using-rmiiiop-over-ssl]]
-Using RMI/IIOP Over SSL
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Using RMI/IIOP Over SSL
You can configure RMI/IIOP over SSL in two ways: using a username and
password, or using a client certificate.
@@ -1326,8 +1302,7 @@
[[ghbpc]][[GSDVG00470]][[connecting-to-a-remote-ejb-module-through-a-firewall]]
-Connecting to a Remote EJB Module Through a Firewall
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Connecting to a Remote EJB Module Through a Firewall
To deploy and run an application client that connects to an EJB module
on a GlassFish Server instance that is behind a firewall, you must set
@@ -1355,8 +1330,7 @@
[[gipkj]][[GSDVG00471]][[specifying-a-splash-screen]]
-Specifying a Splash Screen
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying a Splash Screen
Java SE 6 offers splash screen support, either through a Java
command-line option or a manifest entry in the application's JAR file.
@@ -1396,8 +1370,7 @@
[[gjiec]][[GSDVG00472]][[setting-login-retries]]
-Setting Login Retries
-^^^^^^^^^^^^^^^^^^^^^
+==== Setting Login Retries
You can set a JVM option using the `appclient` script that determines
the number of login retries allowed. This option is
@@ -1416,8 +1389,7 @@
[[gjpjt]][[GSDVG00473]][[using-libraries-with-application-clients]]
-Using Libraries with Application Clients
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Libraries with Application Clients
The Libraries field in the Administration Console's deployment page and
the `--libraries` option of the `asadmin deploy` command do not apply to
@@ -1434,8 +1406,7 @@
[[gkusn]][[GSDVG00161]][[developing-clients-without-the-acc]]
-Developing Clients Without the ACC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Developing Clients Without the ACC
This section describes the procedure to create, assemble, and deploy a
Java-based client that is not packaged using the Application Client
@@ -1452,8 +1423,7 @@
[[gkusp]][[GSDVG00074]][[to-access-an-ejb-component-from-a-stand-alone-client]]
-To access an EJB component from a stand-alone client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To access an EJB component from a stand-alone client
1. In your client code, instantiate the `InitialContext`:
+
@@ -1549,8 +1519,7 @@
[[gkutw]][[GSDVG00075]][[to-access-an-ejb-component-from-a-server-side-module]]
-To access an EJB component from a server-side module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To access an EJB component from a server-side module
A server-side module can be a servlet, another EJB component, or another
type of module.
@@ -1639,8 +1608,7 @@
[[gkuqa]][[GSDVG00076]][[to-access-a-jms-resource-from-a-stand-alone-client]]
-To access a JMS resource from a stand-alone client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To access a JMS resource from a stand-alone client
1. Create a JMS client.
+
diff --git a/docs/application-development-guide/src/main/jbake/content/jdbc.adoc b/docs/application-development-guide/src/main/jbake/content/jdbc.adoc
index 2bae3e4..5aa529c 100644
--- a/docs/application-development-guide/src/main/jbake/content/jdbc.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/jdbc.adoc
@@ -5,15 +5,13 @@
prev=part-services-and-apis.html
~~~~~~
-Using the JDBC API for Database Access
-======================================
+= Using the JDBC API for Database Access
[[GSDVG00017]][[beamj]]
[[using-the-jdbc-api-for-database-access]]
-14 Using the JDBC API for Database Access
------------------------------------------
+== 14 Using the JDBC API for Database Access
This chapter describes how to use the Java Database Connectivity (JDBC)
API for database access with the Oracle GlassFish Server. This chapter
@@ -46,8 +44,7 @@
[[giyck]][[GSDVG00182]][[statements]]
-Statements
-~~~~~~~~~~
+=== Statements
The following topics are addressed here:
@@ -59,8 +56,7 @@
[[giyfu]][[GSDVG00495]][[using-an-initialization-statement]]
-Using an Initialization Statement
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using an Initialization Statement
You can specify a statement that executes each time a physical
connection to the database is created (not reused) from a JDBC
@@ -87,8 +83,7 @@
[[ghqrx]][[GSDVG00496]][[setting-a-statement-timeout]]
-Setting a Statement Timeout
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting a Statement Timeout
An abnormally long running JDBC query executed by an application may
leave it in a hanging state unless a timeout is explicitly set on the
@@ -110,8 +105,7 @@
[[gktbf]][[GSDVG00497]][[statement-leak-detection-and-leaked-statement-reclamation]]
-Statement Leak Detection and Leaked Statement Reclamation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Statement Leak Detection and Leaked Statement Reclamation
If statements are not closed by an application after use, it is possible
for the application to run out of cursors. Enabling statement leak
@@ -159,8 +153,7 @@
[[giyci]][[GSDVG00498]][[statement-caching]]
-Statement Caching
-^^^^^^^^^^^^^^^^^
+==== Statement Caching
Statement caching stores statements, prepared statements, and callable
statements that are executed repeatedly by applications in a cache,
@@ -197,8 +190,7 @@
[[giygg]][[GSDVG00499]][[statement-tracing]]
-Statement Tracing
-^^^^^^^^^^^^^^^^^
+==== Statement Tracing
You can trace the SQL statements executed by applications that use a
JDBC connection pool. Set the SQL Trace Listeners attribute to a
@@ -276,8 +268,7 @@
[[giyeq]][[GSDVG00183]][[connections]]
-Connections
-~~~~~~~~~~~
+=== Connections
The following topics are addressed here:
@@ -291,8 +282,7 @@
[[gktas]][[GSDVG00500]][[transparent-pool-reconfiguration]]
-Transparent Pool Reconfiguration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Transparent Pool Reconfiguration
When the properties or attributes of a JDBC connection pool are changed,
the connection pool is destroyed and re-created. Normally, applications
@@ -331,8 +321,7 @@
[[giygl]][[GSDVG00501]][[disabling-pooling]]
-Disabling Pooling
-^^^^^^^^^^^^^^^^^
+==== Disabling Pooling
To disable connection pooling, set the Pooling attribute to false. The
default is true. You can enable or disable connection pooling in one of
@@ -373,8 +362,7 @@
[[giydr]][[GSDVG00502]][[associating-connections-with-threads]]
-Associating Connections with Threads
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Associating Connections with Threads
To associate connections with a thread, set the Associate With Thread
attribute to `true`. The default is `false`. A `true` setting allows
@@ -416,8 +404,7 @@
[[giyfg]][[GSDVG00503]][[custom-connection-validation]]
-Custom Connection Validation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Custom Connection Validation
You can specify a custom implementation for Connection Validation that
is faster or optimized for a specific database. Set the Validation
@@ -465,8 +452,7 @@
[[beams]][[GSDVG00504]][[sharing-connections]]
-Sharing Connections
-^^^^^^^^^^^^^^^^^^^
+==== Sharing Connections
When multiple connections acquired by an application use the same JDBC
resource, the connection pool provides connection sharing within the
@@ -489,8 +475,7 @@
[[gezfh]][[GSDVG00505]][[marking-bad-connections]]
-Marking Bad Connections
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Marking Bad Connections
The `DataSource` implementation in the GlassFish Server provides a
`markConnectionAsBad` method. A marked bad connection is removed from
@@ -525,8 +510,7 @@
[[gipzl]][[GSDVG00506]][[handling-invalid-connections]]
-Handling Invalid Connections
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Handling Invalid Connections
If a `ConnectionErrorOccured` event occurs, the GlassFish Server
considers the connection invalid and removes the connection from the
@@ -577,8 +561,7 @@
[[giyde]][[GSDVG00184]][[connection-wrapping]]
-Connection Wrapping
-~~~~~~~~~~~~~~~~~~~
+=== Connection Wrapping
The following topics are addressed here:
@@ -588,8 +571,7 @@
[[ghqxi]][[GSDVG00507]][[wrapping-connections]]
-Wrapping Connections
-^^^^^^^^^^^^^^^^^^^^
+==== Wrapping Connections
If the Wrap JDBC Objects option is `true` (the default), wrapped JDBC
objects are returned for `Statement`, `PreparedStatement`,
@@ -611,8 +593,7 @@
[[beamt]][[GSDVG00508]][[obtaining-a-physical-connection-from-a-wrapped-connection]]
-Obtaining a Physical Connection From a Wrapped Connection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Obtaining a Physical Connection From a Wrapped Connection
The `DataSource` implementation in the GlassFish Server provides a
`getConnection` method that retrieves the JDBC driver's `SQLConnection`
@@ -641,8 +622,7 @@
[[ggrum]][[GSDVG00509]][[using-the-connection.unwrap-method]]
-Using the `Connection.unwrap()` Method
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the `Connection.unwrap()` Method
Using the `Connection.unwrap()` method on a vendor-provided interface
returns an object or a wrapper object implementing the vendor-provided
@@ -654,8 +634,7 @@
[[gavro]][[GSDVG00185]][[allowing-non-component-callers]]
-Allowing Non-Component Callers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Allowing Non-Component Callers
You can allow non-Java-EE components, such as servlet filters, lifecycle
modules, and third party persistence managers, to use this JDBC
@@ -694,8 +673,7 @@
[[giydx]][[GSDVG00186]][[using-application-scoped-resources]]
-Using Application-Scoped Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Application-Scoped Resources
You can define an application-scoped database or other resource for an
enterprise application, web module, EJB module, connector module, or
@@ -706,16 +684,14 @@
[[geqvg]][[GSDVG00187]][[restrictions-and-optimizations]]
-Restrictions and Optimizations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Restrictions and Optimizations
This section discusses restrictions and performance optimizations that
affect using the JDBC API.
[[geqvy]][[GSDVG00510]][[disabling-stored-procedure-creation-on-sybase]]
-Disabling Stored Procedure Creation on Sybase
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disabling Stored Procedure Creation on Sybase
By default, DataDirect and Oracle JDBC drivers for Sybase databases
create a stored procedure for each parameterized `PreparedStatement`. On
diff --git a/docs/application-development-guide/src/main/jbake/content/jms.adoc b/docs/application-development-guide/src/main/jbake/content/jms.adoc
index 7365948..a469d93 100644
--- a/docs/application-development-guide/src/main/jbake/content/jms.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/jms.adoc
@@ -5,15 +5,13 @@
prev=jndi.html
~~~~~~
-Using the Java Message Service
-==============================
+= Using the Java Message Service
[[GSDVG00020]][[beaob]]
[[using-the-java-message-service]]
-17 Using the Java Message Service
----------------------------------
+== 17 Using the Java Message Service
This chapter describes how to use the Java Message Service (JMS) API.
The Oracle GlassFish Server has a fully integrated JMS provider: the
@@ -45,8 +43,7 @@
[[gkpcz]][[GSDVG00196]][[using-application-scoped-jms-resources]]
-Using Application-Scoped JMS Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Application-Scoped JMS Resources
You can define an application-scoped JMS or other resource for an
enterprise application, web module, EJB module, connector module, or
@@ -57,8 +54,7 @@
[[beaop]][[GSDVG00197]][[load-balanced-message-inflow]]
-Load-Balanced Message Inflow
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Load-Balanced Message Inflow
You can configure `ActivationSpec` properties of the `jmsra` resource
adapter in the `glassfish-ejb-jar.xml` file for a message-driven bean
@@ -98,8 +94,7 @@
[[beaor]][[GSDVG00198]][[authentication-with-connectionfactory]]
-Authentication With `ConnectionFactory`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Authentication With `ConnectionFactory`
If your web, EJB, or client module has `res-auth` set to `Container`,
but you use the `ConnectionFactory.createConnection("user","password")`
@@ -110,8 +105,7 @@
[[beaot]][[GSDVG00199]][[delivering-soap-messages-using-the-jms-api]]
-Delivering SOAP Messages Using the JMS API
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Delivering SOAP Messages Using the JMS API
Web service clients use the Simple Object Access Protocol (SOAP) to
communicate with web services. SOAP uses a combination of XML-based data
@@ -134,8 +128,7 @@
[[beaou]][[GSDVG00077]][[to-send-soap-messages-using-the-jms-api]]
-To Send SOAP Messages Using the JMS API
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Send SOAP Messages Using the JMS API
1. Import the `MessageTransformer` library.
+
@@ -213,8 +206,7 @@
[[beaov]][[GSDVG00078]][[to-receive-soap-messages-using-the-jms-api]]
-To Receive SOAP Messages Using the JMS API
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Receive SOAP Messages Using the JMS API
1. Import the `MessageTransformer` library.
+
diff --git a/docs/application-development-guide/src/main/jbake/content/jndi.adoc b/docs/application-development-guide/src/main/jbake/content/jndi.adoc
index f5d2973..71365ef 100644
--- a/docs/application-development-guide/src/main/jbake/content/jndi.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/jndi.adoc
@@ -5,15 +5,13 @@
prev=transaction-service.html
~~~~~~
-Using the Java Naming and Directory Interface
-=============================================
+= Using the Java Naming and Directory Interface
[[GSDVG00019]][[beanr]]
[[using-the-java-naming-and-directory-interface]]
-16 Using the Java Naming and Directory Interface
-------------------------------------------------
+== 16 Using the Java Naming and Directory Interface
A naming service maintains a set of bindings, which relate names to
objects. The Jakarta EE naming service is based on the Java Naming and
@@ -44,8 +42,7 @@
[[beans]][[GSDVG00192]][[accessing-the-naming-context]]
-Accessing the Naming Context
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Accessing the Naming Context
The Oracle GlassFish Server provides a naming environment, or context,
which is compliant with standard Jakarta EE requirements. A `Context`
@@ -81,8 +78,7 @@
[[BGBJGGAD]][[GSDVG560]][[portable-global-jndi-names]]
-Portable Global JNDI Names
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Portable Global JNDI Names
If an EJB component is a kind of session bean and it is deployed to any
implementation supporting the EJB 3.1specification (for example,
@@ -107,8 +103,7 @@
[[gcjkd]][[GSDVG00519]][[glassfish-server-v2-vendor-specific-global-jndi-names]]
-GlassFish Server V2 Vendor-Specific Global JNDI Names
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server V2 Vendor-Specific Global JNDI Names
GlassFish Server v2 vendor-specific global JNDI names are assigned
according to the following precedence rules:
@@ -154,8 +149,7 @@
[[gkndi]][[GSDVG00526]][[disabling-glassfish-server-v2-jndi-names]]
-Disabling GlassFish Server V2 JNDI Names
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disabling GlassFish Server V2 JNDI Names
The EJB 3.1 specification supported by GlassFish Server 7 defines
portable EJB JNDI names for session beans. Because of this, there is
@@ -192,8 +186,7 @@
[[beanu]][[GSDVG00520]][[accessing-ejb-components-using-the-cosnaming-naming-context]]
-Accessing EJB Components Using the `CosNaming` Naming Context
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Accessing EJB Components Using the `CosNaming` Naming Context
The preferred way of accessing the naming service, even in code that
runs outside of a Jakarta EE container, is to use the no-argument
@@ -231,8 +224,7 @@
[[beanv]][[GSDVG00521]][[accessing-ejb-components-in-a-remote-glassfish-server]]
-Accessing EJB Components in a Remote GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Accessing EJB Components in a Remote GlassFish Server
The recommended approach for looking up an EJB component in a remote
GlassFish Server from a client that is a servlet or EJB component is to
@@ -295,8 +287,7 @@
[[beanw]][[GSDVG00522]][[naming-environment-for-lifecycle-modules]]
-Naming Environment for Lifecycle Modules
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Naming Environment for Lifecycle Modules
Lifecycle listener modules provide a means of running short or long
duration tasks based on Java technology within the GlassFish Server
@@ -316,8 +307,7 @@
[[beanx]][[GSDVG00193]][[configuring-resources]]
-Configuring Resources
-~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Resources
The GlassFish Server exposes special resources in the naming
environment.
@@ -329,8 +319,7 @@
[[beany]][[GSDVG00523]][[external-jndi-resources]]
-External JNDI Resources
-^^^^^^^^^^^^^^^^^^^^^^^
+==== External JNDI Resources
An external JNDI resource defines custom JNDI contexts and implements
the javax.naming.spi.InitialContextFactory interface. There is no
@@ -349,8 +338,7 @@
[[beanz]][[GSDVG00524]][[custom-resources]]
-Custom Resources
-^^^^^^^^^^^^^^^^
+==== Custom Resources
A custom resource specifies a custom server-wide resource object factory
that implements the javax.naming.spi.ObjectFactory interface. There is
@@ -369,8 +357,7 @@
[[giyvw]][[GSDVG00525]][[built-in-factories-for-custom-resources]]
-Built-in Factories for Custom Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Built-in Factories for Custom Resources
The GlassFish Server provides built-in factories for the following types
of custom resources:
@@ -389,8 +376,7 @@
[[giywi]][[GSDVG00329]][[javabeanfactory]]
-JavaBeanFactory
-+++++++++++++++
+===== JavaBeanFactory
To create a custom resource that provides instances of a JavaBean class,
follow these steps:
@@ -409,8 +395,7 @@
[[giysn]][[GSDVG00330]][[propertiesfactory]]
-PropertiesFactory
-+++++++++++++++++
+===== PropertiesFactory
To create a custom resource that provides properties to applications,
set the custom resource's factory class to
@@ -438,8 +423,7 @@
[[giytz]][[GSDVG00331]][[primitivesandstringfactory]]
-PrimitivesAndStringFactory
-++++++++++++++++++++++++++
+===== PrimitivesAndStringFactory
To create a custom resource that provides Java primitives to
applications, follow these steps:
@@ -465,8 +449,7 @@
[[giywh]][[GSDVG00332]][[urlfactory]]
-URLFactory
-++++++++++
+===== URLFactory
To create a custom resource that provides URL instances to applications,
follow these steps:
@@ -488,8 +471,7 @@
[[gkpdn]][[GSDVG00527]][[using-application-scoped-resources]]
-Using Application-Scoped Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Application-Scoped Resources
You can define an application-scoped JNDI or other resource for an
enterprise application, web module, EJB module, connector module, or
@@ -500,8 +482,7 @@
[[gcpge]][[GSDVG00194]][[using-a-custom-jndi.properties-file]]
-Using a Custom `jndi.properties` File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using a Custom `jndi.properties` File
To use a custom `jndi.properties` file, JAR it and place it in the
domain-dir`/lib` directory. This adds the custom `jndi.properties` file
@@ -514,8 +495,7 @@
[[beaoa]][[GSDVG00195]][[mapping-references]]
-Mapping References
-~~~~~~~~~~~~~~~~~~
+=== Mapping References
The following XML elements in the GlassFish Server deployment
descriptors map resource references in application client, EJB, and web
diff --git a/docs/application-development-guide/src/main/jbake/content/jpa.adoc b/docs/application-development-guide/src/main/jbake/content/jpa.adoc
index 714341f..459b606 100644
--- a/docs/application-development-guide/src/main/jbake/content/jpa.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/jpa.adoc
@@ -5,15 +5,13 @@
prev=webservices.html
~~~~~~
-Configuring the Java Persistence Provider
-=========================================
+= Configuring the Java Persistence Provider
[[GSDVG00008]][[gbxjk]]
[[configuring-the-java-persistence-provider]]
-6 Configuring the Java Persistence Provider
--------------------------------------------
+== 6 Configuring the Java Persistence Provider
This chapter describes Oracle TopLink, the default persistence provider
in GlassFish Server Open Source Edition, and introduces how to use it.
@@ -33,8 +31,7 @@
[[CHDJJAEI]][[GSDVG537]][[overview-of-oracle-toplink]]
-Overview of Oracle TopLink
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Overview of Oracle TopLink
Oracle TopLink is the default persistence provider in Oracle GlassFish
Server. It is a comprehensive standards-based object-persistence and
@@ -116,8 +113,7 @@
[[CHDHDABJ]][[GSDVG538]][[using-oracle-toplink-in-glassfish-server]]
-Using Oracle TopLink in GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Oracle TopLink in GlassFish Server
To run TopLink JPA applications in GlassFish Server, you must configure
the server and coordinate certain server and application settings. These
@@ -154,8 +150,7 @@
[[gbwmj]][[GSDVG00130]][[specifying-the-database-for-an-application]]
-Specifying the Database for an Application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Specifying the Database for an Application
GlassFish Server uses the bundled Apache Derby database by default,
named `jdbc/__default`. If the `transaction-type` element is omitted or
@@ -261,8 +256,7 @@
[[gdkwf]][[GSDVG00138]][[specifying-the-persistence-provider-for-an-application]]
-Specifying the Persistence Provider for an Application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Specifying the Persistence Provider for an Application
If you are using the default persistence provider in an application that
uses the Java Persistence API by injecting or looking up an entity
@@ -314,8 +308,7 @@
[[gescc]][[GSDVG00135]][[primary-key-generation-defaults]]
-Primary Key Generation Defaults
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Primary Key Generation Defaults
In the descriptions of the `@GeneratedValue`, `@SequenceGenerator`, and
`@TableGenerator` annotations in the Java Persistence Specification,
@@ -360,8 +353,7 @@
[[gbwlh]][[GSDVG00136]][[automatic-schema-generation]]
-Automatic Schema Generation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Automatic Schema Generation
The automatic schema generation feature of the GlassFish Server defines
database tables based on the fields or properties in entities and the
@@ -394,8 +386,7 @@
[[gcjgl]][[GSDVG00388]][[annotations]]
-Annotations
-^^^^^^^^^^^
+==== Annotations
The following annotations are used in automatic schema generation:
`@AssociationOverride`, `@AssociationOverrides`, `@AttributeOverride`,
@@ -416,8 +407,7 @@
[[gbwmk]][[GSDVG00389]][[generation-options]]
-Generation Options
-^^^^^^^^^^^^^^^^^^
+==== Generation Options
Schema generation properties or `asadmin` command line options can
control automatic schema generation by the following:
@@ -508,8 +498,7 @@
[[gbxjh]][[GSDVG00139]][[restrictions-and-optimizations]]
-Restrictions and Optimizations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Restrictions and Optimizations
This section discusses restrictions and performance optimizations that
affect using the Java Persistence API.
@@ -526,8 +515,7 @@
[[giqbi]][[GSDVG00390]][[oracle-database-enhancements]]
-Oracle Database Enhancements
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Oracle Database Enhancements
EclipseLink features a number of enhancements for use with Oracle
databases. These enhancements require classes from the Oracle JDBC
@@ -548,8 +536,7 @@
[[ghdtr]][[GSDVG00391]][[extended-persistence-context]]
-Extended Persistence Context
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Extended Persistence Context
The Java Persistence API specification does not specify how the
container and persistence provider should work together to serialize an
@@ -566,8 +553,7 @@
[[gezxw]][[GSDVG00392]][[using-orderby-with-a-shared-session-cache]]
-Using @OrderBy with a Shared Session Cache
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using @OrderBy with a Shared Session Cache
Setting `@OrderBy` on a `ManyToMany` or `OneToMany` relationship field
in which a `List` represents the Many side doesn't work if the session
@@ -587,8 +573,7 @@
[[gdwqi]][[GSDVG00393]][[using-blob-or-clob-types-with-the-inet-oraxo-jdbc-driver]]
-Using BLOB or CLOB Types with the Inet Oraxo JDBC Driver
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using BLOB or CLOB Types with the Inet Oraxo JDBC Driver
To use BLOB or CLOB data types larger than 4 KB for persistence using
the Inet Oraxo JDBC Driver for Oracle Databases, you must set the
@@ -596,8 +581,7 @@
[[geqvh]][[GSDVG00394]][[database-case-sensitivity]]
-Database Case Sensitivity
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Database Case Sensitivity
Mapping references to column or table names must be in accordance with
the expected column or table name case, and ensuring this is the
@@ -615,8 +599,7 @@
[[geqvc]][[GSDVG00246]][[unique-constraints]]
-Unique Constraints
-++++++++++++++++++
+===== Unique Constraints
If column names are not explicitly specified on a field, unique
constraints and foreign key mappings must be specified using uppercase
@@ -642,16 +625,14 @@
[[geqvk]][[GSDVG00247]][[foreign-key-mapping]]
-Foreign Key Mapping
-+++++++++++++++++++
+===== Foreign Key Mapping
Use `@OneToMany(mappedBy="COMPANY")` or specify an explicit column name
for the `Company` field on the `Many` side of the relationship.
[[geqvi]][[GSDVG00248]][[sql-result-set-mapping]]
-SQL Result Set Mapping
-++++++++++++++++++++++
+===== SQL Result Set Mapping
Use the following elements:
@@ -667,8 +648,7 @@
[[geqvo]][[GSDVG00249]][[named-native-queries-and-jdbc-queries]]
-Named Native Queries and JDBC Queries
-+++++++++++++++++++++++++++++++++++++
+===== Named Native Queries and JDBC Queries
Column or table names specified in SQL queries must be in accordance
with the expected case. For example, MySQL requires column names in the
@@ -677,8 +657,7 @@
[[geqxc]][[GSDVG00250]][[postgresql-case-sensitivity]]
-PostgreSQL Case Sensitivity
-+++++++++++++++++++++++++++
+===== PostgreSQL Case Sensitivity
PostgreSQL stores column and table names in lower case. JDBC queries on
PostgreSQL retrieve column or table names in lowercase unless the names
@@ -694,8 +673,7 @@
[[gbxjg]][[GSDVG00395]][[sybase-finder-limitation]]
-Sybase Finder Limitation
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sybase Finder Limitation
If a finder method with an input greater than 255 characters is executed
and the primary key column is mapped to a VARCHAR column, Sybase
@@ -713,8 +691,7 @@
[[gbxjp]][[GSDVG00396]][[mysql-database-restrictions]]
-MySQL Database Restrictions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== MySQL Database Restrictions
The following restrictions apply when you use a MySQL database with the
GlassFish Server for persistence.
diff --git a/docs/application-development-guide/src/main/jbake/content/lifecycle-listeners.adoc b/docs/application-development-guide/src/main/jbake/content/lifecycle-listeners.adoc
index ec22526..5920228 100644
--- a/docs/application-development-guide/src/main/jbake/content/lifecycle-listeners.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/lifecycle-listeners.adoc
@@ -5,15 +5,13 @@
prev=connectors.html
~~~~~~
-Developing Lifecycle Listeners
-==============================
+= Developing Lifecycle Listeners
[[GSDVG00014]][[beamc]]
[[developing-lifecycle-listeners]]
-12 Developing Lifecycle Listeners
----------------------------------
+== 12 Developing Lifecycle Listeners
Lifecycle listener modules provide a means of running short or long
duration Java-based tasks within the Oracle GlassFish Server
@@ -47,8 +45,7 @@
[[beamd]][[GSDVG00167]][[server-life-cycle-events]]
-Server Life Cycle Events
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Server Life Cycle Events
A lifecycle module listens for and performs its tasks in response to the
following events in the server life cycle:
@@ -71,8 +68,7 @@
[[beame]][[GSDVG00168]][[the-lifecyclelistener-interface]]
-The LifecycleListener Interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The LifecycleListener Interface
To create a lifecycle module is to configure a customized class that
implements the com.sun.appserv.server.LifecycleListener interface. You
@@ -95,8 +91,7 @@
[[beamf]][[GSDVG00169]][[the-lifecycleevent-class]]
-The `LifecycleEvent` Class
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The `LifecycleEvent` Class
The `com.sun.appserv.server.LifecycleEvent` class defines a server life
cycle event. The following methods are associated with the event:
@@ -119,8 +114,7 @@
[[beamg]][[GSDVG00170]][[the-server-lifecycle-event-context]]
-The Server Lifecycle Event Context
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The Server Lifecycle Event Context
The com.sun.appserv.server.LifecycleEventContext interface exposes
runtime information about the server. The lifecycle event context is
@@ -150,8 +144,7 @@
[[beamh]][[GSDVG00171]][[deploying-a-lifecycle-module]]
-Deploying a Lifecycle Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying a Lifecycle Module
For instructions on how to deploy a lifecycle module, see the
link:../application-deployment-guide/toc.html#GSDPG[GlassFish Server Open Source Edition Application Deployment
@@ -166,8 +159,7 @@
[[beami]][[GSDVG00172]][[considerations-for-lifecycle-modules]]
-Considerations for Lifecycle Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Considerations for Lifecycle Modules
The resources allocated at initialization or startup should be freed at
shutdown or termination. The lifecycle module classes are called
diff --git a/docs/application-development-guide/src/main/jbake/content/loe.adoc b/docs/application-development-guide/src/main/jbake/content/loe.adoc
index a65d10a..79bf1a6 100644
--- a/docs/application-development-guide/src/main/jbake/content/loe.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:osgi.html#gkvbk[13-1 Example of a WAB Using CDI]
diff --git a/docs/application-development-guide/src/main/jbake/content/lot.adoc b/docs/application-development-guide/src/main/jbake/content/lot.adoc
index 761a322..719858e 100644
--- a/docs/application-development-guide/src/main/jbake/content/lot.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:class-loaders.html#fvxzq[2-1 Oracle GlassFish Server Class
Loaders]
diff --git a/docs/application-development-guide/src/main/jbake/content/mail.adoc b/docs/application-development-guide/src/main/jbake/content/mail.adoc
index 1e896f5..ceee338 100644
--- a/docs/application-development-guide/src/main/jbake/content/mail.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/mail.adoc
@@ -4,15 +4,13 @@
prev=jms.html
~~~~~~
-Using the Jakarta Mail API
-==========================
+= Using the Jakarta Mail API
[[GSDVG00021]][[beaow]]
[[using-the-jakarta-mail-api]]
-18 Using the Jakarta Mail API
------------------------------
+== 18 Using the Jakarta Mail API
This chapter describes how to use the Jakarta Mail API, which provides a set
of abstract classes defining objects that comprise a mail system.
@@ -36,8 +34,7 @@
[[beaox]][[GSDVG00200]][[introducing-jakarta-mail]]
-Introducing Jakarta Mail
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Introducing Jakarta Mail
The Jakarta Mail API defines classes such as `Message`, `Store`, and
`Transport`. The API can be extended and can be subclassed to provide
@@ -66,8 +63,7 @@
[[beaoy]][[GSDVG00201]][[creating-a-jakarta-mail-session]]
-Creating a Jakarta Mail Session
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating a Jakarta Mail Session
You can create a Jakarta Mail session in the following ways:
@@ -79,8 +75,7 @@
[[beaoz]][[GSDVG00202]][[jakarta-mail-session-properties]]
-Jakarta Mail Session Properties
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Jakarta Mail Session Properties
You can set properties for a Jakarta Mail `Session` object. Every property
name must start with a `mail-` prefix. The GlassFish Server changes the
@@ -97,8 +92,7 @@
[[beapa]][[GSDVG00203]][[looking-up-a-jakarta-mail-session]]
-Looking Up a Jakarta Mail Session
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Looking Up a Jakarta Mail Session
The standard Java Naming and Directory Interface (JNDI) subcontext for
Jakarta Mail sessions is `java:comp/env/mail`.
@@ -126,8 +120,7 @@
[[fwfiy]][[GSDVG00204]][[sending-and-reading-messages-using-jakarta-mail]]
-Sending and Reading Messages Using Jakarta Mail
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Sending and Reading Messages Using Jakarta Mail
The following topics are addressed here:
@@ -136,8 +129,7 @@
[[beapb]][[GSDVG00079]][[to-send-a-message-using-jakarta-mail]]
-To Send a Message Using Jakarta Mail
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Send a Message Using Jakarta Mail
1. Import the packages that you need.
+
@@ -191,8 +183,7 @@
[[beapc]][[GSDVG00080]][[to-read-a-message-using-jakarta-mail]]
-To Read a Message Using Jakarta Mail
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Read a Message Using Jakarta Mail
1. Import the packages that you need.
+
@@ -248,8 +239,7 @@
[[gkpfg]][[GSDVG00205]][[using-application-scoped-jakarta-mail-resources]]
-Using Application-Scoped Jakarta Mail Resources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Application-Scoped Jakarta Mail Resources
You can define an application-scoped Jakarta Mail or other resource for an
enterprise application, web module, EJB module, connector module, or
diff --git a/docs/application-development-guide/src/main/jbake/content/osgi.adoc b/docs/application-development-guide/src/main/jbake/content/osgi.adoc
index 68a6114..d7dc722 100644
--- a/docs/application-development-guide/src/main/jbake/content/osgi.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/osgi.adoc
@@ -5,14 +5,12 @@
prev=lifecycle-listeners.html
~~~~~~
-Developing OSGi-enabled Jakarta EE Applications
-===============================================
+= Developing OSGi-enabled Jakarta EE Applications
[[GSDVG00015]][[gkpch]]
[[developing-osgi-enabled-java-ee-applications]]
-13 Developing OSGi-enabled Jakarta EE Applications
---------------------------------------------------
+== 13 Developing OSGi-enabled Jakarta EE Applications
This chapter describes the features and interfaces that GlassFish Server
provides to develop OSGi-enabled enterprise applications. This chapter
@@ -24,8 +22,7 @@
[[gkpay]][[GSDVG00173]][[overview-of-osgi-application-and-glassfish-server]]
-Overview of OSGi Application and GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Overview of OSGi Application and GlassFish Server
{productName} is fully-compliant with Jakarta EE 10, so it provides the
latest Jakarta EE APIs and frameworks. It is built using OSGi technology,
@@ -63,8 +60,7 @@
[[glhek]][[GSDVG00488]][[benefits-of-using-osgi-in-enterprise-java-applications]]
-Benefits of Using OSGi in Enterprise Java Applications
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Benefits of Using OSGi in Enterprise Java Applications
Enterprise applications typically need transactional, secured access to
data stores, messaging systems and other such enterprise information
@@ -98,8 +94,7 @@
[[gkqff]][[GSDVG00174]][[developing-osgi-application-bundles-for-glassfish-server]]
-Developing OSGi Application Bundles for GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Developing OSGi Application Bundles for GlassFish Server
GlassFish Server enables interaction between OSGi components and Jakarta EE
components. OSGi services managed by the OSGi framework can invoke Java
@@ -119,8 +114,7 @@
[[gkupd]][[GSDVG00489]][[developing-plain-osgi-bundles]]
-Developing Plain OSGi Bundles
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Developing Plain OSGi Bundles
Jakarta EE components (like an EJB or Servlet) can look up Jakarta EE platform
services using JNDI names in the associated Jakarta EE naming context. Such
@@ -141,8 +135,7 @@
[[gkunk]][[GSDVG00319]][[http-service]]
-HTTP Service
-++++++++++++
+===== HTTP Service
The GlassFish Server web container is made available as a service for
OSGi users who do not use OSGi Web Application Bundles (WABs). This
@@ -198,8 +191,7 @@
[[gkunn]][[GSDVG00320]][[transaction-service]]
-Transaction Service
-+++++++++++++++++++
+===== Transaction Service
The Java Transaction API (JTA) defines three interfaces to interact with
the transaction management system: `UserTransaction`,
@@ -251,8 +243,7 @@
[[gkuof]][[GSDVG00321]][[jdbc-data-source-service]]
-JDBC Data Source Service
-++++++++++++++++++++++++
+===== JDBC Data Source Service
Any JDBC data source created in GlassFish Server is automatically made
available as an OSGi Service; therefore, OSGi bundles can track
@@ -276,8 +267,7 @@
[[gkuoq]][[GSDVG00322]][[jms-resource-service]]
-JMS Resource Service
-++++++++++++++++++++
+===== JMS Resource Service
Like JDBC data sources, JMS administered objects, such as destinations
and connection factories, are also automatically made available as OSGi
@@ -311,8 +301,7 @@
[[gkunr]][[GSDVG00490]][[developing-web-application-bundles]]
-Developing Web Application Bundles
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Developing Web Application Bundles
When a web application is packaged and deployed as an OSGi bundle, it is
called a Web Application Bundle (WAB). WAB support is based on the OSGi
@@ -342,8 +331,7 @@
[[gkvau]][[GSDVG00323]][[required-wab-metadata]]
-Required WAB Metadata
-+++++++++++++++++++++
+===== Required WAB Metadata
In addition to the standard OSGi metadata, the main attributes of
`META-INF/MANIFEST.MF` of the WAB must have an additional attribute
@@ -386,8 +374,7 @@
[[gkvat]][[GSDVG00324]][[how-wabs-consume-osgi-services]]
-How WABs Consume OSGi Services
-++++++++++++++++++++++++++++++
+===== How WABs Consume OSGi Services
Since a WAB has a valid `Bundle-Context`, it can consume OSGi services.
Although you are free to use any OSGi API to locate OSGi services,
@@ -411,8 +398,7 @@
[[gkvbi]][[GSDVG00325]][[osgi-cdi-extension-for-wabs]]
-OSGi CDI Extension for WABs
-+++++++++++++++++++++++++++
+===== OSGi CDI Extension for WABs
GlassFish Server includes a CDI extension that enables web applications,
such as servlets, that are part of WABs to express a type-safe
@@ -470,8 +456,7 @@
[[gkunh]][[GSDVG00491]][[developing-ejb-application-bundles]]
-Developing EJB Application Bundles
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Developing EJB Application Bundles
Another type of hybrid application bundle is the EJB Application Bundle.
When an EJB Jar is packaged with additional OSGi metadata and deployed
@@ -481,8 +466,7 @@
[[gkvck]][[GSDVG00326]][[required-ejb-metadata]]
-Required EJB Metadata
-+++++++++++++++++++++
+===== Required EJB Metadata
An EJB Application Bundle must have a manifest metadata called
Export-EJB in order to be considered as an EJB Bundle. For syntax of
@@ -512,8 +496,7 @@
[[gkvcj]][[GSDVG00327]][[how-ejb-bundles-consume-osgi-services]]
-How EJB Bundles Consume OSGi Services
-+++++++++++++++++++++++++++++++++++++
+===== How EJB Bundles Consume OSGi Services
Since an EJB has a valid Bundle-Context, it can consume OSGi services.
Although you are free to use any OSGi API to locate OSGi services,
@@ -537,8 +520,7 @@
[[gkvbj]][[GSDVG00328]][[using-the-osgi-cdi-extension-with-ejb-bundles]]
-Using the OSGi CDI Extension With EJB Bundles
-+++++++++++++++++++++++++++++++++++++++++++++
+===== Using the OSGi CDI Extension With EJB Bundles
GlassFish Server includes a CDI extension that enables EJB application
bundles to express a type-safe dependency on an OSGi Service using CDI
@@ -559,8 +541,7 @@
[[gkveh]][[GSDVG00175]][[deploying-osgi-bundles-in-glassfish-server]]
-Deploying OSGi Bundles in GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying OSGi Bundles in GlassFish Server
For instruction on deploying OSGi bundle, see
"link:../application-deployment-guide/deploying-applications.html#GSDPG00073[
diff --git a/docs/application-development-guide/src/main/jbake/content/part-apps-and-app-comps.adoc b/docs/application-development-guide/src/main/jbake/content/part-apps-and-app-comps.adoc
index e371c6a..966e5d5 100644
--- a/docs/application-development-guide/src/main/jbake/content/part-apps-and-app-comps.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/part-apps-and-app-comps.adoc
@@ -5,16 +5,13 @@
prev=debugging-apps.html
~~~~~~
-Developing Applications and Application Components
-==================================================
+= Developing Applications and Application Components
[[fvyme]][[GSDVG00046]][[part-ii]]
-Part II
--------
+== Part II
[[developing-applications-and-application-components]]
-Developing Applications and Application Components
---------------------------------------------------
+== Developing Applications and Application Components
diff --git a/docs/application-development-guide/src/main/jbake/content/part-services-and-apis.adoc b/docs/application-development-guide/src/main/jbake/content/part-services-and-apis.adoc
index 38fcd05..372c437 100644
--- a/docs/application-development-guide/src/main/jbake/content/part-services-and-apis.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/part-services-and-apis.adoc
@@ -5,15 +5,12 @@
prev=osgi.html
~~~~~~
-Using Services and APIs
-=======================
+= Using Services and APIs
[[fvyam]][[GSDVG00047]][[part-iii]]
-Part III
---------
+== Part III
[[using-services-and-apis]]
-Using Services and APIs
------------------------
+== Using Services and APIs
diff --git a/docs/application-development-guide/src/main/jbake/content/part-tasks-and-tools.adoc b/docs/application-development-guide/src/main/jbake/content/part-tasks-and-tools.adoc
index aab182e..97cfe03 100644
--- a/docs/application-development-guide/src/main/jbake/content/part-tasks-and-tools.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/part-tasks-and-tools.adoc
@@ -5,15 +5,12 @@
prev=preface.html
~~~~~~
-Development Tasks and Tools
-===========================
+= Development Tasks and Tools
[[fvxzc]][[GSDVG00045]][[part-i]]
-Part I
-------
+== Part I
[[development-tasks-and-tools]]
-Development Tasks and Tools
----------------------------
+== Development Tasks and Tools
diff --git a/docs/application-development-guide/src/main/jbake/content/preface.adoc b/docs/application-development-guide/src/main/jbake/content/preface.adoc
index b24bff3..d93f5ea 100644
--- a/docs/application-development-guide/src/main/jbake/content/preface.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/preface.adoc
@@ -5,15 +5,13 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSDVG528]][[sthref2]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -59,8 +57,7 @@
[[GSDVG00082]][[ghpbz]]
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -165,8 +162,7 @@
[[GSDVG00083]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -210,8 +206,7 @@
[[GSDVG00084]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -251,8 +246,7 @@
[[GSDVG00085]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -295,8 +289,7 @@
[[GSDVG00086]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/application-development-guide/src/main/jbake/content/securing-apps.adoc b/docs/application-development-guide/src/main/jbake/content/securing-apps.adoc
index d37ec18..f866355 100644
--- a/docs/application-development-guide/src/main/jbake/content/securing-apps.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/securing-apps.adoc
@@ -5,15 +5,13 @@
prev=part-apps-and-app-comps.html
~~~~~~
-Securing Applications
-=====================
+= Securing Applications
[[GSDVG00006]][[beabg]]
[[securing-applications]]
-4 Securing Applications
------------------------
+== 4 Securing Applications
This chapter describes how to write secure Jakarta EE applications, which
contain components that perform user authentication and access
@@ -57,8 +55,7 @@
[[beabh]][[GSDVG00114]][[security-goals]]
-Security Goals
-~~~~~~~~~~~~~~
+=== Security Goals
In an enterprise computing environment, there are many security risks.
The goal of the GlassFish Server is to provide highly secure,
@@ -95,8 +92,7 @@
[[beabi]][[GSDVG00115]][[glassfish-server-specific-security-features]]
-GlassFish Server Specific Security Features
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Specific Security Features
The GlassFish Server supports the Jakarta EE security model, as well as the
following features which are specific to the GlassFish Server:
@@ -111,8 +107,7 @@
[[beabj]][[GSDVG00116]][[container-security]]
-Container Security
-~~~~~~~~~~~~~~~~~~
+=== Container Security
The component containers are responsible for providing Jakarta EE
application security. The container provides two security forms:
@@ -129,8 +124,7 @@
[[beabl]][[GSDVG00362]][[declarative-security]]
-Declarative Security
-^^^^^^^^^^^^^^^^^^^^
+==== Declarative Security
Declarative security means that the security mechanism for an
application is declared and handled externally to the application.
@@ -152,8 +146,7 @@
[[beabm]][[GSDVG00239]][[application-level-security]]
-Application Level Security
-++++++++++++++++++++++++++
+===== Application Level Security
For an application, roles used by any application must be defined in
`@DeclareRoles` annotations in the code or `role-name` elements in the
@@ -179,8 +172,7 @@
[[beabn]][[GSDVG00240]][[component-level-security]]
-Component Level Security
-++++++++++++++++++++++++
+===== Component Level Security
Component level security encompasses web components and EJB components.
@@ -194,8 +186,7 @@
[[beabk]][[GSDVG00363]][[programmatic-security]]
-Programmatic Security
-^^^^^^^^^^^^^^^^^^^^^
+==== Programmatic Security
Programmatic security involves an EJB component or servlet using method
calls to the security API, as specified by the Jakarta EE security model,
@@ -219,8 +210,7 @@
[[beacr]][[GSDVG00117]][[roles-principals-and-principal-to-role-mapping]]
-Roles, Principals, and Principal to Role Mapping
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Roles, Principals, and Principal to Role Mapping
By default, any groups that an authenticated user belongs to will be
mapped to roles with the same names. Therefore, the Default Principal To
@@ -320,8 +310,7 @@
[[beabo]][[GSDVG00118]][[realm-configuration]]
-Realm Configuration
-~~~~~~~~~~~~~~~~~~~
+=== Realm Configuration
The following topics are addressed here:
@@ -332,8 +321,7 @@
[[beabp]][[GSDVG00364]][[supported-realms]]
-Supported Realms
-^^^^^^^^^^^^^^^^
+==== Supported Realms
The following realms are supported in the current release of the
GlassFish Server:
@@ -359,8 +347,7 @@
[[beabq]][[GSDVG00365]][[how-to-configure-a-realm]]
-How to Configure a Realm
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== How to Configure a Realm
You can configure a realm in one of these ways:
@@ -373,8 +360,7 @@
[[beabr]][[GSDVG00366]][[how-to-set-a-realm-for-an-application-or-module]]
-How to Set a Realm for an Application or Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How to Set a Realm for an Application or Module
The following deployment descriptor elements have optional `realm` or
`realm-name` data subelements or attributes that override the domain's
@@ -408,8 +394,7 @@
[[beabs]][[GSDVG00367]][[creating-a-custom-realm]]
-Creating a Custom Realm
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Creating a Custom Realm
You can create a custom realm by providing a custom Java Authentication
and Authorization Service (JAAS) login module class and a custom realm
@@ -602,8 +587,7 @@
[[BACDEIHB]][[GSDVG563]][[java-ee-security-api-support]]
-Jakarta EE Security API Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Jakarta EE Security API Support
JSR-375 defines several authentication-related plugin SPIs, such as,
`HttpAuthenticationMechanism` interface, the `IdentityStore` and
@@ -635,8 +619,7 @@
[[beabt]][[GSDVG00119]][[jacc-support]]
-JACC Support
-~~~~~~~~~~~~
+=== JACC Support
JACC (Java Authorization Contract for Containers) is part of the Jakarta EE
specification and defined by http://www.jcp.org/en/jsr/detail?id=115[JSR
@@ -660,8 +643,7 @@
[[beabu]][[GSDVG00120]][[pluggable-audit-module-support]]
-Pluggable Audit Module Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Pluggable Audit Module Support
Audit modules collect and store information on incoming requests
(servlets, EJB components) and outgoing responses. You can create a
@@ -674,8 +656,7 @@
[[beabv]][[GSDVG00368]][[configuring-an-audit-module]]
-Configuring an Audit Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring an Audit Module
To configure an audit module, you can perform one of the following
tasks:
@@ -690,8 +671,7 @@
[[beabw]][[GSDVG00369]][[the-auditmodule-class]]
-The `AuditModule` Class
-^^^^^^^^^^^^^^^^^^^^^^^
+==== The `AuditModule` Class
You can create a custom audit module by implementing a class that
extends `com.sun.enterprise.security.audit.AuditModule`.
@@ -769,8 +749,7 @@
[[beabx]][[GSDVG00121]][[the-server.policy-file]]
-The `server.policy` File
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== The `server.policy` File
Each GlassFish Server domain has its own global J2SE policy file,
located in domain-dir`/config`. The file is named `server.policy`.
@@ -789,8 +768,7 @@
[[beaby]][[GSDVG00370]][[default-permissions]]
-Default Permissions
-^^^^^^^^^^^^^^^^^^^
+==== Default Permissions
Internal server code is granted all permissions. These are covered by
the `AllPermission` grant blocks to various parts of the server
@@ -814,8 +792,7 @@
[[gilzz]][[GSDVG00371]][[system-properties]]
-System Properties
-^^^^^^^^^^^^^^^^^
+==== System Properties
The following predefined system properties, also called variables, are
available for use in the `server.policy` file. The system property most
@@ -866,8 +843,7 @@
[[beabz]][[GSDVG00372]][[changing-permissions-for-an-application]]
-Changing Permissions for an Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Changing Permissions for an Application
The default policy for each domain limits the permissions of Jakarta EE
deployed applications to the minimal set of permissions required for
@@ -1009,8 +985,7 @@
[[gbyah]][[GSDVG00373]][[enabling-and-disabling-the-security-manager]]
-Enabling and Disabling the Security Manager
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enabling and Disabling the Security Manager
The security manager is disabled by default.
@@ -1091,8 +1066,7 @@
[[beaca]][[GSDVG00122]][[configuring-message-security-for-web-services]]
-Configuring Message Security for Web Services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Message Security for Web Services
In message security, security information is applied at the message
layer and travels along with the web services message. Web Services
@@ -1152,8 +1126,7 @@
[[gbjxw]][[GSDVG00374]][[message-security-providers]]
-Message Security Providers
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Security Providers
When you first install the GlassFish Server, the providers
`XWS_ClientProvider` and `XWS_ServerProvider` are configured but
@@ -1278,8 +1251,7 @@
[[beacb]][[GSDVG00375]][[message-security-responsibilities]]
-Message Security Responsibilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Security Responsibilities
In the GlassFish Server, the system administrator and application
deployer roles are expected to take primary responsibility for
@@ -1296,8 +1268,7 @@
[[beacc]][[GSDVG00241]][[application-developer-responsibilities]]
-Application Developer Responsibilities
-++++++++++++++++++++++++++++++++++++++
+===== Application Developer Responsibilities
The application developer can turn on message security, but is not
responsible for doing so. Message security can be set up by the system
@@ -1318,8 +1289,7 @@
[[beacd]][[GSDVG00242]][[application-deployer-responsibilities]]
-Application Deployer Responsibilities
-+++++++++++++++++++++++++++++++++++++
+===== Application Deployer Responsibilities
The application deployer is responsible for the following:
@@ -1338,8 +1308,7 @@
[[beace]][[GSDVG00243]][[system-administrator-responsibilities]]
-System Administrator Responsibilities
-+++++++++++++++++++++++++++++++++++++
+===== System Administrator Responsibilities
The system administrator is responsible for the following:
@@ -1361,8 +1330,7 @@
[[beacf]][[GSDVG00376]][[application-specific-message-protection]]
-Application-Specific Message Protection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Application-Specific Message Protection
When the GlassFish Server provided configuration is insufficient for
your security needs, and you want to override the default protection,
@@ -1405,8 +1373,7 @@
[[beacg]][[GSDVG00244]][[using-a-signature-to-enable-message-protection-for-all-methods]]
-Using a Signature to Enable Message Protection for All Methods
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Using a Signature to Enable Message Protection for All Methods
To enable message protection for all methods using digital signature,
update the `message-security-binding` element for the EJB web service
@@ -1466,8 +1433,7 @@
[[beach]][[GSDVG00245]][[configuring-message-protection-for-a-specific-method-based-on-digital-signatures]]
-Configuring Message Protection for a Specific Method Based on Digital Signatures
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuring Message Protection for a Specific Method Based on Digital Signatures
To enable message protection for a specific method, or for a set of
methods that can be identified using a wildcard value, follow these
@@ -1541,8 +1507,7 @@
[[beaci]][[GSDVG00377]][[understanding-and-running-the-sample-application]]
-Understanding and Running the Sample Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Understanding and Running the Sample Application
This section discusses the WSS sample application. This sample
application is installed on your system only if you installed the J2EE
@@ -1581,8 +1546,7 @@
[[beacj]][[GSDVG00054]][[to-set-up-the-sample-application]]
-To Set Up the Sample Application
-++++++++++++++++++++++++++++++++
+===== To Set Up the Sample Application
[[GSDVG535]]
@@ -1621,8 +1585,7 @@
[[beack]][[GSDVG00055]][[to-run-the-sample-application]]
-To Run the Sample Application
-+++++++++++++++++++++++++++++
+===== To Run the Sample Application
1. Make sure that the GlassFish Server is running. +
Message security providers are set up when the Ant targets are run, so
@@ -1681,8 +1644,7 @@
[[beacm]][[GSDVG00123]][[programmatic-login-using-the-programmaticlogin-class]]
-Programmatic Login Using the ProgrammaticLogin Class
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Programmatic Login Using the ProgrammaticLogin Class
Programmatic login allows a deployed Jakarta EE application or module to
invoke a login method. If the login is successful, a `SecurityContext`
@@ -1713,8 +1675,7 @@
[[beacn]][[GSDVG00378]][[programmatic-login-precautions]]
-Programmatic Login Precautions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Programmatic Login Precautions
The GlassFish Server is not involved in how the login information
(`user`, `password`) is obtained by the deployed application.
@@ -1750,8 +1711,7 @@
[[beaco]][[GSDVG00379]][[granting-programmatic-login-permission]]
-Granting Programmatic Login Permission
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Granting Programmatic Login Permission
The `ProgrammaticLoginPermission` permission is required to invoke the
programmatic login mechanism for an application if the security manager
@@ -1775,8 +1735,7 @@
[[beacp]][[GSDVG00380]][[the-programmaticlogin-class]]
-The `ProgrammaticLogin` Class
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `ProgrammaticLogin` Class
The `com.sun.appserv.security.ProgrammaticLogin` class enables a user to
perform login programmatically.
@@ -1862,8 +1821,7 @@
[[beacq]][[GSDVG00124]][[user-authentication-for-single-sign-on]]
-User Authentication for Single Sign-on
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== User Authentication for Single Sign-on
The single sign-on feature of the GlassFish Server allows multiple web
applications deployed to the same virtual server to share the user
@@ -1936,8 +1894,7 @@
[[gizel]][[GSDVG00125]][[adding-authentication-mechanisms-to-the-servlet-container]]
-Adding Authentication Mechanisms to the Servlet Container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Adding Authentication Mechanisms to the Servlet Container
You can use JSR 196 in the web tier to facilitate the injection of
pluggable authentication modules within the servlet constraint
@@ -1960,8 +1917,7 @@
[[BACCFGBF]][[GSDVG564]][[the-glassfish-server-and-jsr-375]]
-The GlassFish Server and JSR-375
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The GlassFish Server and JSR-375
The Glassfish Server implements JSR-375 to provide built-in support for
BASIC, FORM and Custom FORM authentication mechanisms. JSR-375 also
@@ -1987,8 +1943,7 @@
[[built-in-authentication-mechanisms]]
-Built-in Authentication Mechanisms
-++++++++++++++++++++++++++++++++++
+===== Built-in Authentication Mechanisms
An application packages its own `HttpAuthenticationMechanism` by
including in a bean archive that is a part of the application.
@@ -2051,8 +2006,7 @@
[[custom-authentication-mechanism]]
-Custom Authentication Mechanism
-+++++++++++++++++++++++++++++++
+===== Custom Authentication Mechanism
An application provider can choose to provide its own custom
authentication mechanism, apart from built-in authentication mechanism.
@@ -2169,8 +2123,7 @@
[[gizfz]][[GSDVG00381]][[the-glassfish-server-and-jsr-196]]
-The GlassFish Server and JSR 196
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The GlassFish Server and JSR 196
The GlassFish Server implements the Servlet Container Profile of JSR
196, Java Authentication Service Provider Interface for Containers. JSR
@@ -2210,8 +2163,7 @@
[[gizdx]][[GSDVG00382]][[writing-a-server-authentication-module]]
-Writing a Server Authentication Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Writing a Server Authentication Module
A key step in adding an authentication mechanism to a compatible
server-side message processing runtime such as the GlassFish Server
@@ -2290,8 +2242,7 @@
[[gizeb]][[GSDVG00383]][[sample-server-authentication-module]]
-Sample Server Authentication Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sample Server Authentication Module
The class `MySam.java` is a sample SAM implementation. Notice that the
sample implements the five methods of the ServerAuthModule interface.
@@ -2509,8 +2460,7 @@
[[gizfa]][[GSDVG00384]][[compiling-and-installing-a-server-authentication-module]]
-Compiling and Installing a Server Authentication Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Compiling and Installing a Server Authentication Module
Before you can use the sample SAM, you need to compile, install, and
configure it. Then you can bind it to an application.
@@ -2523,8 +2473,7 @@
[[gizfe]][[GSDVG00385]][[configuring-a-server-authentication-module]]
-Configuring a Server Authentication Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring a Server Authentication Module
You can configure a SAM in one of these ways:
@@ -2565,8 +2514,7 @@
[[gizfm]][[GSDVG00386]][[binding-a-server-authentication-module-to-your-application]]
-Binding a Server Authentication Module to Your Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Binding a Server Authentication Module to Your Application
After you install and configure the SAM, you can bind it for use by the
container on behalf of one or more of your applications. You have two
diff --git a/docs/application-development-guide/src/main/jbake/content/setting-up-dev-env.adoc b/docs/application-development-guide/src/main/jbake/content/setting-up-dev-env.adoc
index c761972..6609930 100644
--- a/docs/application-development-guide/src/main/jbake/content/setting-up-dev-env.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/setting-up-dev-env.adoc
@@ -5,15 +5,13 @@
prev=part-tasks-and-tools.html
~~~~~~
-Setting Up a Development Environment
-====================================
+= Setting Up a Development Environment
[[GSDVG00002]][[beaaq]]
[[setting-up-a-development-environment]]
-1 Setting Up a Development Environment
---------------------------------------
+== 1 Setting Up a Development Environment
This chapter gives guidelines for setting up an application development
environment in the Oracle GlassFish Server. Setting up an environment
@@ -30,8 +28,7 @@
[[beaar]][[GSDVG00090]][[installing-and-preparing-the-server-for-development]]
-Installing and Preparing the Server for Development
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installing and Preparing the Server for Development
For more information about GlassFish Server installation, see the
link:../installation-guide/toc.html#GSING[
@@ -70,8 +67,7 @@
[[beaas]][[GSDVG00091]][[high-availability-features]]
-High Availability Features
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== High Availability Features
High availability features such as load balancing and session failover
are discussed in detail in the link:../ha-administration-guide/toc.html#GSHAG[GlassFish Server Open Source
@@ -89,8 +85,7 @@
[[beaat]][[GSDVG00092]][[development-tools]]
-Development Tools
-~~~~~~~~~~~~~~~~~
+=== Development Tools
The following general tools are provided with the GlassFish Server:
@@ -110,8 +105,7 @@
[[beaau]][[GSDVG00333]][[the-asadmin-command]]
-The `asadmin` Command
-^^^^^^^^^^^^^^^^^^^^^
+==== The `asadmin` Command
The `asadmin` command allows you to configure a local or remote server
and perform both administrative and development tasks at the command
@@ -123,8 +117,7 @@
[[beaav]][[GSDVG00334]][[the-administration-console]]
-The Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The Administration Console
The Administration Console lets you configure the server and perform
both administrative and development tasks using a web browser. For
@@ -143,8 +136,7 @@
[[beaba]][[GSDVG00337]][[the-migration-tool]]
-The Migration Tool
-^^^^^^^^^^^^^^^^^^
+==== The Migration Tool
The Migration Tool converts and reassembles Jakarta EE applications and
modules developed on other application servers. This tool also generates
@@ -155,8 +147,7 @@
[[beaaw]][[GSDVG00338]][[the-netbeans-ide]]
-The NetBeans IDE
-^^^^^^^^^^^^^^^^
+==== The NetBeans IDE
The NetBeans IDE allows you to create, assemble, and debug code from a
single, easy-to-use interface. The GlassFish edition of the GlassFish
@@ -171,24 +162,21 @@
[[beabb]][[GSDVG00340]][[debugging-tools]]
-Debugging Tools
-^^^^^^^^^^^^^^^
+==== Debugging Tools
You can use several debugging tools with the GlassFish Server. For more
information, see link:debugging-apps.html#beafc[Debugging Applications].
[[beabc]][[GSDVG00341]][[profiling-tools]]
-Profiling Tools
-^^^^^^^^^^^^^^^
+==== Profiling Tools
You can use several profilers with the GlassFish Server. For more
information, see link:debugging-apps.html#beafn[Profiling Tools].
[[beabf]][[GSDVG00093]][[sample-applications]]
-Sample Applications
-~~~~~~~~~~~~~~~~~~~
+=== Sample Applications
The samples are available from `https://github.com/eclipse-ee4j/glassfish-samples`.
diff --git a/docs/application-development-guide/src/main/jbake/content/title.adoc b/docs/application-development-guide/src/main/jbake/content/title.adoc
index 52a3e53..cc4a9e9 100644
--- a/docs/application-development-guide/src/main/jbake/content/title.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Application Development Guide, Release 7
-=================================================================
+= Eclipse GlassFish Server Application Development Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Application Development Guide
diff --git a/docs/application-development-guide/src/main/jbake/content/toc.adoc b/docs/application-development-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..1218d10
--- /dev/null
+++ b/docs/application-development-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,399 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Application Development Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Application Development Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSDVG528[Preface]
+
+** link:preface.html#GSDVG00082[GlassFish Server Documentation Set]
+** link:preface.html#GSDVG00083[Related Documentation]
+** link:preface.html#GSDVG00084[Typographic Conventions]
+** link:preface.html#GSDVG00085[Symbol Conventions]
+** link:preface.html#GSDVG00086[Default Paths and File Names]
+
+[[part-i]]
+=== link:part-tasks-and-tools.html#GSDVG00045[Part I]
+
+* link:part-tasks-and-tools.html#development-tasks-and-tools[Development Tasks and Tools]
+
+[[setting-up-a-development-environment]]
+=== link:setting-up-dev-env.html#GSDVG00002[1 Setting Up a Development Environment]
+
+** link:setting-up-dev-env.html#GSDVG00090[Installing and Preparing the Server for Development]
+** link:setting-up-dev-env.html#GSDVG00091[High Availability Features]
+** link:setting-up-dev-env.html#GSDVG00092[Development Tools]
+*** link:setting-up-dev-env.html#GSDVG00333[The `asadmin` Command]
+*** link:setting-up-dev-env.html#GSDVG00334[The Administration Console]
+*** link:setting-up-dev-env.html#GSDVG00337[The Migration Tool]
+*** link:setting-up-dev-env.html#GSDVG00338[The NetBeans IDE]
+*** link:setting-up-dev-env.html#GSDVG00340[Debugging Tools]
+*** link:setting-up-dev-env.html#GSDVG00341[Profiling Tools]
+** link:setting-up-dev-env.html#GSDVG00093[Sample Applications]
+
+[[class-loaders]]
+=== link:class-loaders.html#GSDVG00003[2 Class Loaders]
+
+** link:class-loaders.html#GSDVG00094[The Class Loader Hierarchy]
+** link:class-loaders.html#GSDVG00095[Delegation]
+** link:class-loaders.html#GSDVG00096[Using the Java Optional Package Mechanism]
+** link:class-loaders.html#GSDVG00097[Using the Endorsed Standards Override Mechanism]
+** link:class-loaders.html#GSDVG00098[Class Loader Universes]
+** link:class-loaders.html#GSDVG00099[Application-Specific Class Loading]
+** link:class-loaders.html#GSDVG00100[Circumventing Class Loader Isolation]
+*** link:class-loaders.html#GSDVG00342[Using the Common Class Loader]
+*** link:class-loaders.html#GSDVG00343[Sharing Libraries Across a Cluster]
+*** link:class-loaders.html#GSDVG00344[Packaging the Client JAR for One Application in Another Application]
+*** link:class-loaders.html#GSDVG00048[To Package the Client JAR for One Application in Another Application]
+
+[[debugging-applications]]
+=== link:debugging-apps.html#GSDVG00004[3 Debugging Applications]
+
+** link:debugging-apps.html#GSDVG00101[Enabling Debugging]
+*** link:debugging-apps.html#GSDVG00049[To Set the Server to Automatically Start Up in Debug Mode]
+** link:debugging-apps.html#GSDVG00102[JPDA Options]
+** link:debugging-apps.html#GSDVG00103[Generating a Stack Trace for Debugging]
+** link:debugging-apps.html#GSDVG00104[Application Client Debugging]
+** link:debugging-apps.html#GSDVG00105[Open Message Queue Debugging]
+** link:debugging-apps.html#GSDVG00106[Enabling Verbose Mode]
+** link:debugging-apps.html#GSDVG00107[Class Loader Debugging]
+** link:debugging-apps.html#GSDVG00108[GlassFish Server Logging]
+** link:debugging-apps.html#GSDVG00109[Profiling Tools]
+*** link:debugging-apps.html#GSDVG00345[The NetBeans Profiler]
+*** link:debugging-apps.html#GSDVG00346[The HPROF Profiler]
+*** link:debugging-apps.html#GSDVG00347[The JProbe Profiler]
+
+[[part-ii]]
+=== link:part-apps-and-app-comps.html#GSDVG00046[Part II]
+
+* link:part-apps-and-app-comps.html#developing-applications-and-application-components[Developing Applications and Application Components]
+
+[[securing-applications]]
+=== link:securing-apps.html#GSDVG00006[4 Securing Applications]
+
+** link:securing-apps.html#GSDVG00114[Security Goals]
+** link:securing-apps.html#GSDVG00115[GlassFish Server Specific Security Features]
+** link:securing-apps.html#GSDVG00116[Container Security]
+*** link:securing-apps.html#GSDVG00362[Declarative Security]
+*** link:securing-apps.html#GSDVG00363[Programmatic Security]
+** link:securing-apps.html#GSDVG00117[Roles, Principals, and Principal to Role Mapping]
+** link:securing-apps.html#GSDVG00118[Realm Configuration]
+*** link:securing-apps.html#GSDVG00364[Supported Realms]
+*** link:securing-apps.html#GSDVG00365[How to Configure a Realm]
+*** link:securing-apps.html#GSDVG00366[How to Set a Realm for an Application or Module]
+*** link:securing-apps.html#GSDVG00367[Creating a Custom Realm]
+** link:securing-apps.html#GSDVG563[Jakarta EE Security API Support]
+** link:securing-apps.html#GSDVG00119[JACC Support]
+** link:securing-apps.html#GSDVG00120[Pluggable Audit Module Support]
+*** link:securing-apps.html#GSDVG00368[Configuring an Audit Module]
+*** link:securing-apps.html#GSDVG00369[The `AuditModule` Class]
+** link:securing-apps.html#GSDVG00121[The `server.policy` File]
+*** link:securing-apps.html#GSDVG00370[Default Permissions]
+*** link:securing-apps.html#GSDVG00371[System Properties]
+*** link:securing-apps.html#GSDVG00372[Changing Permissions for an Application]
+*** link:securing-apps.html#GSDVG00373[Enabling and Disabling the Security Manager]
+** link:securing-apps.html#GSDVG00122[Configuring Message Security for Web Services]
+*** link:securing-apps.html#GSDVG00374[Message Security Providers]
+*** link:securing-apps.html#GSDVG00375[Message Security Responsibilities]
+*** link:securing-apps.html#GSDVG00376[Application-Specific Message Protection]
+*** link:securing-apps.html#GSDVG00377[Understanding and Running the Sample Application]
+** link:securing-apps.html#GSDVG00123[Programmatic Login Using the ProgrammaticLogin Class]
+*** link:securing-apps.html#GSDVG00378[Programmatic Login Precautions]
+*** link:securing-apps.html#GSDVG00379[Granting Programmatic Login Permission]
+*** link:securing-apps.html#GSDVG00380[The `ProgrammaticLogin` Class]
+** link:securing-apps.html#GSDVG00124[User Authentication for Single Sign-on]
+** link:securing-apps.html#GSDVG00125[Adding Authentication Mechanisms to the Servlet Container]
+*** link:securing-apps.html#GSDVG564[The GlassFish Server and JSR-375]
+*** link:securing-apps.html#GSDVG00381[The GlassFish Server and JSR 196]
+*** link:securing-apps.html#GSDVG00382[Writing a Server Authentication Module]
+*** link:securing-apps.html#GSDVG00383[Sample Server Authentication Module]
+*** link:securing-apps.html#GSDVG00384[Compiling and Installing a Server Authentication Module]
+*** link:securing-apps.html#GSDVG00385[Configuring a Server Authentication Module]
+*** link:securing-apps.html#GSDVG00386[Binding a Server Authentication Module to Your Application]
+
+[[developing-web-services]]
+=== link:webservices.html#GSDVG00007[5 Developing Web Services]
+
+** link:webservices.html#GSDVG00126[Creating Portable Web Service Artifacts]
+** link:webservices.html#GSDVG00127[Deploying a Web Service]
+** link:webservices.html#GSDVG00128[The Web Service URI, WSDL File, and Test Page]
+** link:webservices.html#GSDVG536[The Databinding Provider]
+*** link:webservices.html#GSDVG00387[Using the `jbi.xml` File]
+
+[[configuring-the-java-persistence-provider]]
+=== link:jpa.html#GSDVG00008[6 Configuring the Java Persistence Provider]
+
+** link:jpa.html#GSDVG537[Overview of Oracle TopLink]
+** link:jpa.html#GSDVG538[Using Oracle TopLink in GlassFish Server]
+** link:jpa.html#GSDVG00130[Specifying the Database for an Application]
+** link:jpa.html#GSDVG00138[Specifying the Persistence Provider for an Application]
+** link:jpa.html#GSDVG00135[Primary Key Generation Defaults]
+** link:jpa.html#GSDVG00136[Automatic Schema Generation]
+*** link:jpa.html#GSDVG00388[Annotations]
+*** link:jpa.html#GSDVG00389[Generation Options]
+** link:jpa.html#GSDVG00139[Restrictions and Optimizations]
+*** link:jpa.html#GSDVG00390[Oracle Database Enhancements]
+*** link:jpa.html#GSDVG00391[Extended Persistence Context]
+*** link:jpa.html#GSDVG00392[Using @OrderBy with a Shared Session Cache]
+*** link:jpa.html#GSDVG00393[Using BLOB or CLOB Types with the Inet Oraxo JDBC Driver]
+*** link:jpa.html#GSDVG00394[Database Case Sensitivity]
+*** link:jpa.html#GSDVG00395[Sybase Finder Limitation]
+*** link:jpa.html#GSDVG00396[MySQL Database Restrictions]
+
+[[developing-web-applications]]
+=== link:webapps.html#GSDVG00009[7 Developing Web Applications]
+
+** link:webapps.html#GSDVG00140[Using Servlets]
+*** link:webapps.html#GSDVG00397[Caching Servlet Results]
+*** link:webapps.html#GSDVG00398[About the Servlet Engine]
+** link:webapps.html#GSDVG00141[Using JavaServer Pages]
+*** link:webapps.html#GSDVG00399[JSP Tag Libraries and Standard Portable Tags]
+*** link:webapps.html#GSDVG00400[JSP Caching]
+*** link:webapps.html#GSDVG00401[Options for Compiling JSP Files]
+** link:webapps.html#GSDVG00142[Creating and Managing Sessions]
+*** link:webapps.html#GSDVG00402[Configuring Sessions]
+*** link:webapps.html#GSDVG00403[Session Managers]
+** link:webapps.html#GSDVG00143[Using Comet]
+*** link:webapps.html#GSDVG00404[Introduction to Comet]
+*** link:webapps.html#GSDVG00405[Grizzly Comet]
+*** link:webapps.html#GSDVG00406[Bayeux Protocol]
+** link:webapps.html#GSDVG00144[Advanced Web Application Features]
+*** link:webapps.html#GSDVG00407[Internationalization Issues]
+*** link:webapps.html#GSDVG00408[Virtual Server Properties]
+*** link:webapps.html#GSDVG00409[Class Loader Delegation]
+*** link:webapps.html#GSDVG00410[Using the `default-web.xml` File]
+*** link:webapps.html#GSDVG00411[Configuring Logging and Monitoring in the Web Container]
+*** link:webapps.html#GSDVG00412[Configuring Idempotent URL Requests]
+*** link:webapps.html#GSDVG00413[Header Management]
+*** link:webapps.html#GSDVG00414[Configuring Valves and Catalina Listeners]
+*** link:webapps.html#GSDVG00415[Alternate Document Roots]
+*** link:webapps.html#GSDVG00416[Using a context.xml File]
+*** link:webapps.html#GSDVG00417[Enabling WebDav]
+*** link:webapps.html#GSDVG00418[Using SSI]
+*** link:webapps.html#GSDVG00419[Using CGI]
+
+[[using-enterprise-javabeans-technology]]
+=== link:ejb.html#GSDVG00010[8 Using Enterprise JavaBeans Technology]
+
+** link:ejb.html#GSDVG00145[Value Added Features]
+*** link:ejb.html#GSDVG00420[Read-Only Beans]
+*** link:ejb.html#GSDVG00421[The `pass-by-reference` Element]
+*** link:ejb.html#GSDVG00422[Pooling and Caching]
+*** link:ejb.html#GSDVG00423[Priority Based Scheduling of Remote Bean Invocations]
+*** link:ejb.html#GSDVG00424[Immediate Flushing]
+** link:ejb.html#GSDVG00146[EJB Timer Service]
+*** link:ejb.html#GSDVG00070[To Deploy an EJB Timer to a Cluster]
+** link:ejb.html#GSDVG00147[Using Session Beans]
+*** link:ejb.html#GSDVG00425[About the Session Bean Containers]
+*** link:ejb.html#GSDVG00426[Stateful Session Bean Failover]
+*** link:ejb.html#GSDVG00427[Session Bean Restrictions and Optimizations]
+** link:ejb.html#GSDVG00148[Using Read-Only Beans]
+*** link:ejb.html#GSDVG00428[Read-Only Bean Characteristics and Life Cycle]
+*** link:ejb.html#GSDVG00429[Read-Only Bean Good Practices]
+*** link:ejb.html#GSDVG00430[Refreshing Read-Only Beans]
+*** link:ejb.html#GSDVG00431[Deploying Read-Only Beans]
+** link:ejb.html#GSDVG00149[Using Message-Driven Beans]
+*** link:ejb.html#GSDVG00432[Message-Driven Bean Configuration]
+*** link:ejb.html#GSDVG00433[Message-Driven Bean Restrictions and Optimizations]
+
+[[using-container-managed-persistence]]
+=== link:container_managed-persistence.html#GSDVG00011[9 Using Container-Managed Persistence]
+
+** link:container_managed-persistence.html#GSDVG00150[GlassFish Server Support for CMP]
+** link:container_managed-persistence.html#GSDVG00151[CMP Mapping]
+*** link:container_managed-persistence.html#GSDVG00434[Mapping Capabilities]
+*** link:container_managed-persistence.html#GSDVG00435[The Mapping Deployment Descriptor File]
+*** link:container_managed-persistence.html#GSDVG00436[Mapping Considerations]
+** link:container_managed-persistence.html#GSDVG00152[Automatic Schema Generation for CMP]
+*** link:container_managed-persistence.html#GSDVG00437[Supported Data Types for CMP]
+*** link:container_managed-persistence.html#GSDVG00438[Generation Options for CMP]
+** link:container_managed-persistence.html#GSDVG00153[Schema Capture]
+*** link:container_managed-persistence.html#GSDVG00439[Automatic Database Schema Capture]
+*** link:container_managed-persistence.html#GSDVG00440[Using the `capture-schema` Utility]
+** link:container_managed-persistence.html#GSDVG00154[Configuring the CMP Resource]
+** link:container_managed-persistence.html#GSDVG00155[Performance-Related Features]
+*** link:container_managed-persistence.html#GSDVG00441[Version Column Consistency Checking]
+*** link:container_managed-persistence.html#GSDVG00442[Relationship Prefetching]
+*** link:container_managed-persistence.html#GSDVG00443[Read-Only Beans]
+** link:container_managed-persistence.html#GSDVG00156[Default Fetch Group Flags]
+** link:container_managed-persistence.html#GSDVG00157[Configuring Queries for 1.1 Finders]
+*** link:container_managed-persistence.html#GSDVG00444[About JDOQL Queries]
+*** link:container_managed-persistence.html#GSDVG00445[Query Filter Expression]
+*** link:container_managed-persistence.html#GSDVG00446[Query Parameters]
+*** link:container_managed-persistence.html#GSDVG00447[Query Variables]
+*** link:container_managed-persistence.html#GSDVG00448[JDOQL Examples]
+** link:container_managed-persistence.html#GSDVG00158[CMP Restrictions and Optimizations]
+*** link:container_managed-persistence.html#GSDVG00449[Disabling ORDER BY Validation]
+*** link:container_managed-persistence.html#GSDVG00450[Setting the Heap Size on DB2]
+*** link:container_managed-persistence.html#GSDVG00451[Eager Loading of Field State]
+*** link:container_managed-persistence.html#GSDVG00452[Restrictions on Remote Interfaces]
+*** link:container_managed-persistence.html#GSDVG00453[PostgreSQL Case Insensitivity]
+*** link:container_managed-persistence.html#GSDVG00454[No Support for `lock-when-loaded` on Sybase]
+*** link:container_managed-persistence.html#GSDVG00455[Sybase Finder Limitation]
+*** link:container_managed-persistence.html#GSDVG00456[Date and Time Fields]
+*** link:container_managed-persistence.html#GSDVG00457[Set `RECURSIVE_TRIGGERS` to `false` on MSSQL]
+*** link:container_managed-persistence.html#GSDVG00458[MySQL Database Restrictions]
+
+[[developing-java-clients]]
+=== link:java-clients.html#GSDVG00012[10 Developing Java Clients]
+
+** link:java-clients.html#GSDVG00159[Introducing the Application Client Container]
+*** link:java-clients.html#GSDVG00459[ACC Security]
+*** link:java-clients.html#GSDVG00460[ACC Naming]
+*** link:java-clients.html#GSDVG00461[Application Client Annotation]
+*** link:java-clients.html#GSDVG00462[Java Web Start]
+*** link:java-clients.html#GSDVG00463[Application Client JAR File]
+** link:java-clients.html#GSDVG00160[Developing Clients Using the ACC]
+*** link:java-clients.html#GSDVG00072[To Access an EJB Component From an Application Client]
+*** link:java-clients.html#GSDVG00073[To Access a JMS Resource From an Application Client]
+*** link:java-clients.html#GSDVG00464[Using Java Web Start]
+*** link:java-clients.html#GSDVG00465[Using the Embeddable ACC]
+*** link:java-clients.html#GSDVG00466[Running an Application Client Using the `appclient` Script]
+*** link:java-clients.html#GSDVG00467[Using the `package-appclient` Script]
+*** link:java-clients.html#GSDVG00468[The `client.policy` File]
+*** link:java-clients.html#GSDVG00469[Using RMI/IIOP Over SSL]
+*** link:java-clients.html#GSDVG00470[Connecting to a Remote EJB Module Through a Firewall]
+*** link:java-clients.html#GSDVG00471[Specifying a Splash Screen]
+*** link:java-clients.html#GSDVG00472[Setting Login Retries]
+*** link:java-clients.html#GSDVG00473[Using Libraries with Application Clients]
+** link:java-clients.html#GSDVG00161[Developing Clients Without the ACC]
+*** link:java-clients.html#GSDVG00074[To access an EJB component from a stand-alone client]
+*** link:java-clients.html#GSDVG00075[To access an EJB component from a server-side module]
+*** link:java-clients.html#GSDVG00076[To access a JMS resource from a stand-alone client]
+
+[[developing-connectors]]
+=== link:connectors.html#GSDVG00013[11 Developing Connectors]
+
+** link:connectors.html#GSDVG00162[Connector Support in the GlassFish Server]
+*** link:connectors.html#GSDVG00474[Connector Architecture for JMS and JDBC]
+*** link:connectors.html#GSDVG00475[Connector Configuration]
+** link:connectors.html#GSDVG00163[Advanced Connector Configuration Options]
+*** link:connectors.html#GSDVG00476[Thread Associations]
+*** link:connectors.html#GSDVG00477[Security Maps]
+*** link:connectors.html#GSDVG00478[Work Security Maps]
+*** link:connectors.html#GSDVG00479[Overriding Configuration Properties]
+*** link:connectors.html#GSDVG00480[Testing a Connector Connection Pool]
+*** link:connectors.html#GSDVG00481[Flushing a Connector Connection Pool]
+*** link:connectors.html#GSDVG00482[Handling Invalid Connections]
+*** link:connectors.html#GSDVG00483[Setting the Shutdown Timeout]
+*** link:connectors.html#GSDVG00484[Specifying the Class Loading Policy]
+*** link:connectors.html#GSDVG00485[Using Last Agent Optimization of Transactions]
+*** link:connectors.html#GSDVG00486[Disabling Pooling for a Connection]
+*** link:connectors.html#GSDVG00487[Using Application-Scoped Connectors]
+** link:connectors.html#GSDVG00164[Inbound Communication Support]
+** link:connectors.html#GSDVG00165[Outbound Communication Support]
+** link:connectors.html#GSDVG00166[Configuring a Message Driven Bean to Use a Resource Adapter]
+
+[[developing-lifecycle-listeners]]
+=== link:lifecycle-listeners.html#GSDVG00014[12 Developing Lifecycle Listeners]
+
+** link:lifecycle-listeners.html#GSDVG00167[Server Life Cycle Events]
+** link:lifecycle-listeners.html#GSDVG00168[The LifecycleListener Interface]
+** link:lifecycle-listeners.html#GSDVG00169[The `LifecycleEvent` Class]
+** link:lifecycle-listeners.html#GSDVG00170[The Server Lifecycle Event Context]
+** link:lifecycle-listeners.html#GSDVG00171[Deploying a Lifecycle Module]
+** link:lifecycle-listeners.html#GSDVG00172[Considerations for Lifecycle Modules]
+
+[[developing-osgi-enabled-java-ee-applications]]
+=== link:osgi.html#GSDVG00015[13 Developing OSGi-enabled Jakarta EE Applications]
+
+** link:osgi.html#GSDVG00173[Overview of OSGi Application and GlassFish Server]
+*** link:osgi.html#GSDVG00488[Benefits of Using OSGi in Enterprise Java Applications]
+** link:osgi.html#GSDVG00174[Developing OSGi Application Bundles for GlassFish Server]
+*** link:osgi.html#GSDVG00489[Developing Plain OSGi Bundles]
+*** link:osgi.html#GSDVG00490[Developing Web Application Bundles]
+*** link:osgi.html#GSDVG00491[Developing EJB Application Bundles]
+** link:osgi.html#GSDVG00175[Deploying OSGi Bundles in GlassFish Server]
+
+[[part-iii]]
+=== link:part-services-and-apis.html#GSDVG00047[Part III]
+
+* link:part-services-and-apis.html#using-services-and-apis[Using Services and APIs]
+
+[[using-the-jdbc-api-for-database-access]]
+=== link:jdbc.html#GSDVG00017[14 Using the JDBC API for Database Access]
+
+** link:jdbc.html#GSDVG00182[Statements]
+*** link:jdbc.html#GSDVG00495[Using an Initialization Statement]
+*** link:jdbc.html#GSDVG00496[Setting a Statement Timeout]
+*** link:jdbc.html#GSDVG00497[Statement Leak Detection and Leaked Statement Reclamation]
+*** link:jdbc.html#GSDVG00498[Statement Caching]
+*** link:jdbc.html#GSDVG00499[Statement Tracing]
+** link:jdbc.html#GSDVG00183[Connections]
+*** link:jdbc.html#GSDVG00500[Transparent Pool Reconfiguration]
+*** link:jdbc.html#GSDVG00501[Disabling Pooling]
+*** link:jdbc.html#GSDVG00502[Associating Connections with Threads]
+*** link:jdbc.html#GSDVG00503[Custom Connection Validation]
+*** link:jdbc.html#GSDVG00504[Sharing Connections]
+*** link:jdbc.html#GSDVG00505[Marking Bad Connections]
+*** link:jdbc.html#GSDVG00506[Handling Invalid Connections]
+** link:jdbc.html#GSDVG00184[Connection Wrapping]
+*** link:jdbc.html#GSDVG00507[Wrapping Connections]
+*** link:jdbc.html#GSDVG00508[Obtaining a Physical Connection From a Wrapped Connection]
+*** link:jdbc.html#GSDVG00509[Using the `Connection.unwrap()` Method]
+** link:jdbc.html#GSDVG00185[Allowing Non-Component Callers]
+** link:jdbc.html#GSDVG00186[Using Application-Scoped Resources]
+** link:jdbc.html#GSDVG00187[Restrictions and Optimizations]
+*** link:jdbc.html#GSDVG00510[Disabling Stored Procedure Creation on Sybase]
+
+[[using-the-transaction-service]]
+=== link:transaction-service.html#GSDVG00018[15 Using the Transaction Service]
+
+** link:transaction-service.html#GSDVG00188[Handling Transactions with Databases]
+*** link:transaction-service.html#GSDVG00511[Using JDBC Transaction Isolation Levels]
+*** link:transaction-service.html#GSDVG00512[Using Non-Transactional Connections]
+** link:transaction-service.html#GSDVG00189[Handling Transactions with Enterprise Beans]
+*** link:transaction-service.html#GSDVG00513[Flat Transactions]
+*** link:transaction-service.html#GSDVG00514[Global and Local Transactions]
+*** link:transaction-service.html#GSDVG00515[Commit Options]
+*** link:transaction-service.html#GSDVG00516[Bean-Level Container-Managed Transaction Timeouts]
+** link:transaction-service.html#GSDVG00190[Handling Transactions with the Java Message Service]
+*** link:transaction-service.html#GSDVG00517[Transactions and Non-Persistent Messages]
+*** link:transaction-service.html#GSDVG00518[Using the ConfigurableTransactionSupport Interface]
+** link:transaction-service.html#GSDVG00191[The Transaction Manager, the Transaction Synchronization Registry, and `UserTransaction`]
+
+[[using-the-java-naming-and-directory-interface]]
+=== link:jndi.html#GSDVG00019[16 Using the Java Naming and Directory Interface]
+
+** link:jndi.html#GSDVG00192[Accessing the Naming Context]
+*** link:jndi.html#GSDVG560[Portable Global JNDI Names]
+*** link:jndi.html#GSDVG00519[GlassFish Server V2 Vendor-Specific Global JNDI Names]
+*** link:jndi.html#GSDVG00526[Disabling GlassFish Server V2 JNDI Names]
+*** link:jndi.html#GSDVG00520[Accessing EJB Components Using the `CosNaming` Naming Context]
+*** link:jndi.html#GSDVG00521[Accessing EJB Components in a Remote GlassFish Server]
+*** link:jndi.html#GSDVG00522[Naming Environment for Lifecycle Modules]
+** link:jndi.html#GSDVG00193[Configuring Resources]
+*** link:jndi.html#GSDVG00523[External JNDI Resources]
+*** link:jndi.html#GSDVG00524[Custom Resources]
+*** link:jndi.html#GSDVG00525[Built-in Factories for Custom Resources]
+*** link:jndi.html#GSDVG00527[Using Application-Scoped Resources]
+** link:jndi.html#GSDVG00194[Using a Custom `jndi.properties` File]
+** link:jndi.html#GSDVG00195[Mapping References]
+
+[[using-the-java-message-service]]
+=== link:jms.html#GSDVG00020[17 Using the Java Message Service]
+
+** link:jms.html#GSDVG00196[Using Application-Scoped JMS Resources]
+** link:jms.html#GSDVG00197[Load-Balanced Message Inflow]
+** link:jms.html#GSDVG00198[Authentication With `ConnectionFactory`]
+** link:jms.html#GSDVG00199[Delivering SOAP Messages Using the JMS API]
+*** link:jms.html#GSDVG00077[To Send SOAP Messages Using the JMS API]
+*** link:jms.html#GSDVG00078[To Receive SOAP Messages Using the JMS API]
+
+[[using-the-jakarta-mail-api]]
+=== link:mail.html#GSDVG00021[18 Using the Jakarta Mail API]
+
+** link:mail.html#GSDVG00200[Introducing Jakarta Mail]
+** link:mail.html#GSDVG00201[Creating a Jakarta Mail Session]
+** link:mail.html#GSDVG00202[Jakarta Mail Session Properties]
+** link:mail.html#GSDVG00203[Looking Up a Jakarta Mail Session]
+** link:mail.html#GSDVG00204[Sending and Reading Messages Using Jakarta Mail]
+*** link:mail.html#GSDVG00079[To Send a Message Using Jakarta Mail]
+*** link:mail.html#GSDVG00080[To Read a Message Using Jakarta Mail]
+** link:mail.html#GSDVG00205[Using Application-Scoped Jakarta Mail Resources]
diff --git a/docs/application-development-guide/src/main/jbake/content/transaction-service.adoc b/docs/application-development-guide/src/main/jbake/content/transaction-service.adoc
index 5c38c18..cb0f6c9 100644
--- a/docs/application-development-guide/src/main/jbake/content/transaction-service.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/transaction-service.adoc
@@ -5,15 +5,13 @@
prev=jdbc.html
~~~~~~
-Using the Transaction Service
-=============================
+= Using the Transaction Service
[[GSDVG00018]][[beanm]]
[[using-the-transaction-service]]
-15 Using the Transaction Service
---------------------------------
+== 15 Using the Transaction Service
The Jakarta EE platform provides several abstractions that simplify
development of dependable transaction processing for applications. This
@@ -41,8 +39,7 @@
[[giybi]][[GSDVG00188]][[handling-transactions-with-databases]]
-Handling Transactions with Databases
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Handling Transactions with Databases
The following topics are addressed here:
@@ -51,8 +48,7 @@
[[beamv]][[GSDVG00511]][[using-jdbc-transaction-isolation-levels]]
-Using JDBC Transaction Isolation Levels
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using JDBC Transaction Isolation Levels
Not all database vendors support all transaction isolation levels
available in the JDBC API. The GlassFish Server permits specifying any
@@ -160,8 +156,7 @@
[[beamu]][[GSDVG00512]][[using-non-transactional-connections]]
-Using Non-Transactional Connections
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Non-Transactional Connections
You can specify a non-transactional database connection in any of these
ways:
@@ -221,8 +216,7 @@
[[beaje]][[GSDVG00189]][[handling-transactions-with-enterprise-beans]]
-Handling Transactions with Enterprise Beans
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Handling Transactions with Enterprise Beans
This section describes the transaction support built into the Enterprise
JavaBeans programming model for the GlassFish Server.
@@ -240,8 +234,7 @@
[[beajf]][[GSDVG00513]][[flat-transactions]]
-Flat Transactions
-^^^^^^^^^^^^^^^^^
+==== Flat Transactions
The Enterprise JavaBeans Specification, v3.0 requires support for flat
(as opposed to nested) transactions. In a flat transaction, each
@@ -256,8 +249,7 @@
[[beajg]][[GSDVG00514]][[global-and-local-transactions]]
-Global and Local Transactions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Global and Local Transactions
Both local and global transactions are demarcated using the
javax.transaction.UserTransaction interface, which the client must use.
@@ -267,8 +259,7 @@
[[beajh]][[GSDVG00515]][[commit-options]]
-Commit Options
-^^^^^^^^^^^^^^
+==== Commit Options
The EJB protocol is designed to give the container the flexibility to
select the disposition of the instance state at the time a transaction
@@ -320,8 +311,7 @@
[[beaht]][[GSDVG00516]][[bean-level-container-managed-transaction-timeouts]]
-Bean-Level Container-Managed Transaction Timeouts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Bean-Level Container-Managed Transaction Timeouts
The transaction timeout for the domain is specified using the
Transaction Timeout setting of the Transaction Service. A transaction
@@ -339,8 +329,7 @@
[[gknrh]][[GSDVG00190]][[handling-transactions-with-the-java-message-service]]
-Handling Transactions with the Java Message Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Handling Transactions with the Java Message Service
The following topics are addressed here:
@@ -349,8 +338,7 @@
[[beaoq]][[GSDVG00517]][[transactions-and-non-persistent-messages]]
-Transactions and Non-Persistent Messages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Transactions and Non-Persistent Messages
During transaction recovery, non-persistent messages might be lost. If
the broker fails between the transaction manager's prepare and commit
@@ -360,8 +348,7 @@
[[gdyya]][[GSDVG00518]][[using-the-configurabletransactionsupport-interface]]
-Using the ConfigurableTransactionSupport Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the ConfigurableTransactionSupport Interface
The Jakarta EE Connector 1.6 specification allows a resource adapter to use
the `transaction-support` attribute to specify the level of transaction
@@ -382,8 +369,7 @@
[[gaxit]][[GSDVG00191]][[the-transaction-manager-the-transaction-synchronization-registry-and-usertransaction]]
-The Transaction Manager, the Transaction Synchronization Registry, and `UserTransaction`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The Transaction Manager, the Transaction Synchronization Registry, and `UserTransaction`
To access a `UserTransaction` instance, you can either look it up using
the `java:comp/``UserTransaction` JNDI name or inject it using the
diff --git a/docs/application-development-guide/src/main/jbake/content/webapps.adoc b/docs/application-development-guide/src/main/jbake/content/webapps.adoc
index f566840..1bfb1aa 100644
--- a/docs/application-development-guide/src/main/jbake/content/webapps.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/webapps.adoc
@@ -5,15 +5,13 @@
prev=jpa.html
~~~~~~
-Developing Web Applications
-===========================
+= Developing Web Applications
[[GSDVG00009]][[beafs]]
[[developing-web-applications]]
-7 Developing Web Applications
------------------------------
+== 7 Developing Web Applications
This chapter describes how web applications are supported in the Oracle
GlassFish Server.
@@ -44,8 +42,7 @@
[[beagj]][[GSDVG00140]][[using-servlets]]
-Using Servlets
-~~~~~~~~~~~~~~
+=== Using Servlets
GlassFish Server supports the Java Servlet Specification version 4.0.
@@ -79,8 +76,7 @@
[[beagm]][[GSDVG00397]][[caching-servlet-results]]
-Caching Servlet Results
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Caching Servlet Results
The GlassFish Server can cache the results of invoking a servlet, a JSP,
or any URL pattern to make subsequent invocations of the same servlet,
@@ -121,8 +117,7 @@
[[beagn]][[GSDVG00251]][[caching-features]]
-Caching Features
-++++++++++++++++
+===== Caching Features
The GlassFish Server has the following web application response caching
capabilities:
@@ -167,8 +162,7 @@
[[beago]][[GSDVG00252]][[default-cache-configuration]]
-Default Cache Configuration
-+++++++++++++++++++++++++++
+===== Default Cache Configuration
If you enable caching but do not provide any special configuration for a
servlet or JSP, the default cache configuration is as follows:
@@ -190,8 +184,7 @@
[[beagp]][[GSDVG00253]][[caching-example]]
-Caching Example
-+++++++++++++++
+===== Caching Example
Here is an example cache element in the `glassfish-web.xml` file:
@@ -247,8 +240,7 @@
[[beagq]][[GSDVG00254]][[the-cachekeygenerator-interface]]
-The CacheKeyGenerator Interface
-+++++++++++++++++++++++++++++++
+===== The CacheKeyGenerator Interface
The built-in default CacheHelper implementation allows web applications
to customize the key generation. An application component (in a servlet
@@ -263,8 +255,7 @@
[[beagr]][[GSDVG00398]][[about-the-servlet-engine]]
-About the Servlet Engine
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== About the Servlet Engine
Servlets exist in and are managed by the servlet engine in the GlassFish
Server. The servlet engine is an internal object that handles all
@@ -279,8 +270,7 @@
[[beags]][[GSDVG00255]][[instantiating-and-removing-servlets]]
-Instantiating and Removing Servlets
-+++++++++++++++++++++++++++++++++++
+===== Instantiating and Removing Servlets
After the servlet engine instantiates the servlet, the servlet engine
calls the servlet's `init` method to perform any necessary
@@ -296,8 +286,7 @@
[[beagt]][[GSDVG00256]][[request-handling]]
-Request Handling
-++++++++++++++++
+===== Request Handling
When a request is made, the GlassFish Server hands the incoming data to
the servlet engine. The servlet engine processes the request's input
@@ -326,8 +315,7 @@
[[beagu]][[GSDVG00141]][[using-javaserver-pages]]
-Using JavaServer Pages
-~~~~~~~~~~~~~~~~~~~~~~
+=== Using JavaServer Pages
The GlassFish Server supports the following JSP features:
@@ -353,8 +341,7 @@
[[beagv]][[GSDVG00399]][[jsp-tag-libraries-and-standard-portable-tags]]
-JSP Tag Libraries and Standard Portable Tags
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== JSP Tag Libraries and Standard Portable Tags
GlassFish Server supports tag libraries and standard portable tags. For
more information, see the JavaServer Pages Standard Tag Library (JSTL)
@@ -371,8 +358,7 @@
[[beagw]][[GSDVG00400]][[jsp-caching]]
-JSP Caching
-^^^^^^^^^^^
+==== JSP Caching
JSP caching lets you cache tag invocation results within the Java
engine. Each can be cached using different cache criteria. For example,
@@ -392,8 +378,7 @@
[[gaxbq]][[GSDVG00257]][[enabling-jsp-caching]]
-Enabling JSP Caching
-++++++++++++++++++++
+===== Enabling JSP Caching
To globally enable JSP caching, set the `jspCachingEnabled` property to
`true`. The default is `false`. For example:
@@ -436,8 +421,7 @@
[[gaxcr]][[GSDVG00258]][[caching-scope]]
-Caching Scope
-+++++++++++++
+===== Caching Scope
JSP caching is available in three different scopes: `request`,
`session`, and `application`. The default is `application`. To use a
@@ -475,8 +459,7 @@
[[beagx]][[GSDVG00259]][[the-cache-tag]]
-The `cache` Tag
-+++++++++++++++
+===== The `cache` Tag
The cache tag caches the body between the beginning and ending tags
according to the attributes specified. The first time the tag is
@@ -558,8 +541,7 @@
[[beagy]][[GSDVG00260]][[the-flush-tag]]
-The `flush` Tag
-+++++++++++++++
+===== The `flush` Tag
Forces the cache to be flushed. If a `key` is specified, only the entry
with that key is flushed. If no key is specified, the entire cache is
@@ -612,8 +594,7 @@
[[beagz]][[GSDVG00401]][[options-for-compiling-jsp-files]]
-Options for Compiling JSP Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Options for Compiling JSP Files
GlassFish Server provides the following ways of compiling JSP source
files into servlets:
@@ -628,8 +609,7 @@
[[beaha]][[GSDVG00142]][[creating-and-managing-sessions]]
-Creating and Managing Sessions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating and Managing Sessions
This section describes how to create and manage HTTP sessions that
allows users and transaction information to persist between
@@ -642,8 +622,7 @@
[[beahb]][[GSDVG00402]][[configuring-sessions]]
-Configuring Sessions
-^^^^^^^^^^^^^^^^^^^^
+==== Configuring Sessions
The following topics are addressed here:
@@ -655,8 +634,7 @@
[[beahc]][[GSDVG00261]][[http-sessions-cookies-and-url-rewriting]]
-HTTP Sessions, Cookies, and URL Rewriting
-+++++++++++++++++++++++++++++++++++++++++
+===== HTTP Sessions, Cookies, and URL Rewriting
To configure whether and how HTTP sessions use cookies and URL
rewriting, edit the `session-properties` and `cookie-properties`
@@ -674,8 +652,7 @@
[[beahd]][[GSDVG00262]][[coordinating-session-access]]
-Coordinating Session Access
-+++++++++++++++++++++++++++
+===== Coordinating Session Access
Make sure that multiple threads don't simultaneously modify the same
session object in conflicting ways. If the persistence type is
@@ -695,8 +672,7 @@
[[ghmih]][[GSDVG00263]][[saving-sessions-during-redeployment]]
-Saving Sessions During Redeployment
-+++++++++++++++++++++++++++++++++++
+===== Saving Sessions During Redeployment
Whenever a redeployment is done, the sessions at that transit time
become invalid unless you use the `--keepstate=true` option of the
@@ -731,8 +707,7 @@
[[gixeb]][[GSDVG00264]][[logging-session-attributes]]
-Logging Session Attributes
-++++++++++++++++++++++++++
+===== Logging Session Attributes
You can write session attribute values to an access log. The access log
format token ``%session.``name``%`` logs one of the following:
@@ -747,8 +722,7 @@
[[beahe]][[GSDVG00265]][[distributed-sessions-and-persistence]]
-Distributed Sessions and Persistence
-++++++++++++++++++++++++++++++++++++
+===== Distributed Sessions and Persistence
A distributed HTTP session can run in multiple GlassFish Server
instances, provided the following criteria are met:
@@ -842,8 +816,7 @@
[[beahf]][[GSDVG00403]][[session-managers]]
-Session Managers
-^^^^^^^^^^^^^^^^
+==== Session Managers
A session manager automatically creates new session objects whenever a
new session starts. In some circumstances, clients do not join the
@@ -874,8 +847,7 @@
[[beahg]][[GSDVG00266]][[the-memory-persistence-type]]
-The `memory` Persistence Type
-+++++++++++++++++++++++++++++
+===== The `memory` Persistence Type
This persistence type is not designed for a production environment that
requires session persistence. It provides no session persistence.
@@ -920,8 +892,7 @@
[[beahh]][[GSDVG00267]][[the-file-persistence-type]]
-The `file` Persistence Type
-+++++++++++++++++++++++++++
+===== The `file` Persistence Type
This persistence type provides session persistence to the local file
system, and allows a single server domain to recover the session state
@@ -976,8 +947,7 @@
[[gdshu]][[GSDVG00268]][[the-replicated-persistence-type]]
-The `replicated` Persistence Type
-+++++++++++++++++++++++++++++++++
+===== The `replicated` Persistence Type
The replicated persistence type uses other servers in the cluster for
session persistence. Clustered server instances replicate session state.
@@ -1069,8 +1039,7 @@
[[ggrgt]][[GSDVG00143]][[using-comet]]
-Using Comet
-~~~~~~~~~~~
+=== Using Comet
This section explains the Comet programming technique and how to create
and deploy a Comet-enabled application with the Oracle GlassFish Server.
@@ -1083,8 +1052,7 @@
[[ggrgy]][[GSDVG00404]][[introduction-to-comet]]
-Introduction to Comet
-^^^^^^^^^^^^^^^^^^^^^
+==== Introduction to Comet
Comet is a programming technique that allows a web server to send
updates to clients without requiring the clients to explicitly request
@@ -1117,8 +1085,7 @@
[[ggrib]][[GSDVG00270]][[the-grizzly-implementation-of-comet]]
-The Grizzly Implementation of Comet
-+++++++++++++++++++++++++++++++++++
+===== The Grizzly Implementation of Comet
A limitation of the Comet technique is that you must use it with a web
server that supports non-blocking connections to avoid poor performance.
@@ -1156,8 +1123,7 @@
[[ggrim]][[GSDVG00271]][[client-technologies-to-use-with-comet]]
-Client Technologies to Use With Comet
-+++++++++++++++++++++++++++++++++++++
+===== Client Technologies to Use With Comet
In addition to creating a web component that uses the Comet APIs, you
need to enable your client to accept asynchronous updates from the web
@@ -1183,8 +1149,7 @@
[[ggrgo]][[GSDVG00272]][[types-of-comet-connections]]
-Types of Comet Connections
-++++++++++++++++++++++++++
+===== Types of Comet Connections
When working with Comet, as implemented in Grizzly, you have two
different ways to handle client connections to the server:
@@ -1247,8 +1212,7 @@
[[ghgxk]][[GSDVG00405]][[grizzly-comet]]
-Grizzly Comet
-^^^^^^^^^^^^^
+==== Grizzly Comet
For details on using Grizzly Comet including a sample application, refer
to the https://eclipse-ee4j.github.io/grizzly/comet.html[Grizzly Comet documentation].
@@ -1294,8 +1258,7 @@
[[ghgxn]][[GSDVG00406]][[bayeux-protocol]]
-Bayeux Protocol
-^^^^^^^^^^^^^^^
+==== Bayeux Protocol
The Bayeux protocol, often referred to as `Cometd`, greatly simplifies
the use of Comet. No server-side coding is needed for servers such as
@@ -1310,8 +1273,7 @@
[[ghhaw]][[GSDVG00280]][[enabling-comet]]
-Enabling Comet
-++++++++++++++
+===== Enabling Comet
Before running a Comet-enabled application, you need to enable Comet in
the HTTP listener for your application by setting a special attribute in
@@ -1327,8 +1289,7 @@
[[ghhap]][[GSDVG00067]][[to-configure-the-web.xml-file]]
-To Configure the `web.xml` File
-+++++++++++++++++++++++++++++++
+===== To Configure the `web.xml` File
To enable the Bayeux protocol on the GlassFish Server, you must
reference the `CometdServlet` in your web application's `web.xml` file.
@@ -1377,8 +1338,7 @@
[[ghhtv]][[GSDVG00068]][[to-write-deploy-and-run-the-client]]
-To Write, Deploy, and Run the Client
-++++++++++++++++++++++++++++++++++++
+===== To Write, Deploy, and Run the Client
1. Add script tags to the HTML page. For example:
+
@@ -1434,8 +1394,7 @@
[[beaft]][[GSDVG00144]][[advanced-web-application-features]]
-Advanced Web Application Features
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Advanced Web Application Features
The following topics are addressed here:
@@ -1455,8 +1414,7 @@
[[beafu]][[GSDVG00407]][[internationalization-issues]]
-Internationalization Issues
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Internationalization Issues
The following topics are addressed here:
@@ -1465,8 +1423,7 @@
[[beafv]][[GSDVG00281]][[the-servers-default-locale]]
-The Server's Default Locale
-+++++++++++++++++++++++++++
+===== The Server's Default Locale
To set the default locale of the entire GlassFish Server, which
determines the locale of the Administration Console, the logs, and so
@@ -1476,8 +1433,7 @@
[[beafw]][[GSDVG00282]][[servlet-character-encoding]]
-Servlet Character Encoding
-++++++++++++++++++++++++++
+===== Servlet Character Encoding
This section explains how the GlassFish Server determines the character
encoding for the servlet request and the servlet response. For encodings
@@ -1518,8 +1474,7 @@
[[gilyj]][[GSDVG00408]][[virtual-server-properties]]
-Virtual Server Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Virtual Server Properties
You can set virtual server properties in the following ways:
@@ -1554,8 +1509,7 @@
[[beagb]][[GSDVG00409]][[class-loader-delegation]]
-Class Loader Delegation
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Class Loader Delegation
The Servlet specification recommends that a web application class loader
look in the local class loader before delegating to its parent. To make
@@ -1582,8 +1536,7 @@
[[beagc]][[GSDVG00410]][[using-the-default-web.xml-file]]
-Using the `default-web.xml` File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the `default-web.xml` File
You can use the `default-web.xml` file to define features such as
filters and security constraints that apply to all web applications.
@@ -1629,8 +1582,7 @@
[[fvymc]][[GSDVG00069]][[to-use-the-default-web.xml-file]]
-To Use the `default-web.xml` File
-+++++++++++++++++++++++++++++++++
+===== To Use the `default-web.xml` File
1. Place the JAR file for the filter, security constraint, or other
feature in the domain-dir`/lib` directory.
@@ -1640,8 +1592,7 @@
[[beagd]][[GSDVG00411]][[configuring-logging-and-monitoring-in-the-web-container]]
-Configuring Logging and Monitoring in the Web Container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Logging and Monitoring in the Web Container
For information about configuring logging and monitoring in the web
container using the Administration Console, click the Help button in the
@@ -1651,8 +1602,7 @@
[[beage]][[GSDVG00412]][[configuring-idempotent-url-requests]]
-Configuring Idempotent URL Requests
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Idempotent URL Requests
An idempotent request is one that does not cause any change or
inconsistency in an application when retried. To enhance the
@@ -1669,8 +1619,7 @@
[[beagf]][[GSDVG00283]][[specifying-an-idempotent-url]]
-Specifying an Idempotent URL
-++++++++++++++++++++++++++++
+===== Specifying an Idempotent URL
To configure idempotent URL response, specify the URLs that can be
safely retried in `idempotent-url-pattern` elements in the
@@ -1689,8 +1638,7 @@
[[beagg]][[GSDVG00284]][[characteristics-of-an-idempotent-url]]
-Characteristics of an Idempotent URL
-++++++++++++++++++++++++++++++++++++
+===== Characteristics of an Idempotent URL
Since all requests for a given session are sent to the same application
server instance, and if that GlassFish Server instance is unreachable,
@@ -1725,8 +1673,7 @@
[[beagi]][[GSDVG00413]][[header-management]]
-Header Management
-^^^^^^^^^^^^^^^^^
+==== Header Management
In all Editions of the GlassFish Server, the `Enumeration` from
`request.getHeaders()` contains multiple elements (one element per
@@ -1738,8 +1685,7 @@
[[geqrh]][[GSDVG00414]][[configuring-valves-and-catalina-listeners]]
-Configuring Valves and Catalina Listeners
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Valves and Catalina Listeners
You can configure custom valves and Catalina listeners for web modules
or virtual servers by defining properties. A valve class must implement
@@ -1770,8 +1716,7 @@
[[geqpl]][[GSDVG00415]][[alternate-document-roots]]
-Alternate Document Roots
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Alternate Document Roots
An alternate document root (docroot) allows a web application to serve
requests for certain resources from outside its own docroot, based on
@@ -1894,8 +1839,7 @@
[[geurd]][[GSDVG00416]][[using-a-context.xml-file]]
-Using a context.xml File
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using a context.xml File
You can define a `context.xml` file for all web applications, for web
applications assigned to a specific virtual server, or for a specific
@@ -1942,8 +1886,7 @@
[[gezcx]][[GSDVG00417]][[enabling-webdav]]
-Enabling WebDav
-^^^^^^^^^^^^^^^
+==== Enabling WebDav
To enable WebDav in the GlassFish Server, you edit the `web.xml` and
`glassfish-web.xml` files as follows.
@@ -2050,8 +1993,7 @@
[[ghepd]][[GSDVG00418]][[using-ssi]]
-Using SSI
-^^^^^^^^^
+==== Using SSI
To enable SSI (server-side includes) processing for a specific web
module, add the `SSIServlet` to your `web.xml` file as follows:
@@ -2118,8 +2060,7 @@
[[ghepi]][[GSDVG00419]][[using-cgi]]
-Using CGI
-^^^^^^^^^
+==== Using CGI
To enable CGI (common gateway interface) processing for a specific web
module, add the `CGIServlet` to your `web.xml` file as follows:
diff --git a/docs/application-development-guide/src/main/jbake/content/webservices.adoc b/docs/application-development-guide/src/main/jbake/content/webservices.adoc
index da73c0d..ce9c81c 100644
--- a/docs/application-development-guide/src/main/jbake/content/webservices.adoc
+++ b/docs/application-development-guide/src/main/jbake/content/webservices.adoc
@@ -5,15 +5,13 @@
prev=securing-apps.html
~~~~~~
-Developing Web Services
-=======================
+= Developing Web Services
[[GSDVG00007]][[gaszn]]
[[developing-web-services]]
-5 Developing Web Services
--------------------------
+== 5 Developing Web Services
This chapter describes Oracle GlassFish Server support for web services.
The following topics are addressed here:
@@ -68,8 +66,7 @@
[[gbizi]][[GSDVG00126]][[creating-portable-web-service-artifacts]]
-Creating Portable Web Service Artifacts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating Portable Web Service Artifacts
For a tutorial that shows how to use the `wsimport` and `wsgen`
commands, see "https://eclipse-ee4j.github.io/jakartaee-tutorial/#web-services[
@@ -77,8 +74,7 @@
[[gbixz]][[GSDVG00127]][[deploying-a-web-service]]
-Deploying a Web Service
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying a Web Service
You deploy a web service endpoint to the GlassFish Server just as you
would any servlet, stateless session bean (SLSB), or application.
@@ -108,8 +104,7 @@
[[gbiyw]][[GSDVG00128]][[the-web-service-uri-wsdl-file-and-test-page]]
-The Web Service URI, WSDL File, and Test Page
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== The Web Service URI, WSDL File, and Test Page
Clients can run a deployed web service by accessing its service endpoint
address URI, which has the following format:
@@ -171,8 +166,7 @@
[[CHDEBBCH]][[GSDVG536]][[the-databinding-provider]]
-The Databinding Provider
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== The Databinding Provider
The JAX-WS reference implementation (RI) used to be dependent on the
JAXB RI for databinding. JAXB and JAX-WS implementations have been
@@ -308,8 +302,7 @@
[[gelxr]][[GSDVG00387]][[using-the-jbi.xml-file]]
-Using the `jbi.xml` File
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the `jbi.xml` File
Section 6.3.1 of the JSR 208 specification describes the `jbi.xml` file.
This is a deployment descriptor, located in the `META-INF` directory. To
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/checklist.adoc b/docs/deployment-planning-guide/src/main/jbake/content/checklist.adoc
index 85f0194..d9c66d6 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/checklist.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/checklist.adoc
@@ -4,23 +4,20 @@
prev=planning.html
~~~~~~
-Checklist for Deployment
-========================
+= Checklist for Deployment
[[GSPLG00003]][[abfeq]]
[[checklist-for-deployment]]
-3 Checklist for Deployment
---------------------------
+== 3 Checklist for Deployment
This appendix provides a checklist to get started on evaluation and
production with the GlassFish Server.
[[sthref7]][[checklist]]
-Checklist
-~~~~~~~~~
+=== Checklist
[[sthref8]][[sthref9]]
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/concepts.adoc b/docs/deployment-planning-guide/src/main/jbake/content/concepts.adoc
index 09615b5..37eb683 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/concepts.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/concepts.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Product Concepts
-================
+= Product Concepts
[[GSPLG00001]][[abfaq]]
[[product-concepts]]
-1 Product Concepts
-------------------
+== 1 Product Concepts
GlassFish Server Open Source Edition provides a robust platform for the
development, deployment, and management of Jakarta EE applications. Key
@@ -51,8 +49,7 @@
[[abfat]][[GSPLG00041]][[containers]]
-Containers
-^^^^^^^^^^
+==== Containers
Each server instance includes two containers: web and EJB. A container
is a runtime environment that provides services such as security and
@@ -85,8 +82,7 @@
[[abfav]][[GSPLG00043]][[web-services]]
-Web Services
-^^^^^^^^^^^^
+==== Web Services
Clients can access a Jakarta EE application as a remote web service in
addition to accessing it through HTTP, RMI/IIOP, and JMS. Web services
@@ -103,8 +99,7 @@
[[abfaw]][[GSPLG00044]][[client-access]]
-Client Access
-^^^^^^^^^^^^^
+==== Client Access
Clients can access Jakarta EE applications in several ways. Browser clients
access web applications using hypertext transfer protocol (HTTP). For
@@ -137,8 +132,7 @@
[[abfax]][[GSPLG00045]][[external-systems-and-resources]]
-External Systems and Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== External Systems and Resources
On the Jakarta EE platform, an external system is called a resource. For
example, a database management system is a JDBC resource. Each resource
@@ -174,8 +168,7 @@
[[abfay]][[GSPLG00017]][[glassfish-server-components]]
-GlassFish Server Components
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Components
This section describes the components in GlassFish Server.
@@ -195,8 +188,7 @@
[[abfaz]][[GSPLG00046]][[server-instances]]
-Server Instances
-^^^^^^^^^^^^^^^^
+==== Server Instances
A server instance is a GlassFish Server running in a single Java Virtual
Machine (JVM) process. GlassFish Server is certified with Java platform,
@@ -213,8 +205,7 @@
[[abfba]][[GSPLG00047]][[administrative-domains]]
-Administrative Domains
-^^^^^^^^^^^^^^^^^^^^^^
+==== Administrative Domains
An administrative domain (or simply domain) is a group of server
instances that are administered together. A server instance belongs to a
@@ -240,8 +231,7 @@
[[abfbb]][[GSPLG00024]][[domain-administration-server-das]]
-Domain Administration Server (DAS)
-++++++++++++++++++++++++++++++++++
+===== Domain Administration Server (DAS)
A domain has one Domain Administration Server (DAS), a specially
designated GlassFish Server instance that hosts the administrative
@@ -282,8 +272,7 @@
[[abfbc]][[GSPLG00048]][[clusters]]
-Clusters
-^^^^^^^^
+==== Clusters
A cluster is a named collection of server instances that share the same
applications, resources, and configuration information. You can group
@@ -316,8 +305,7 @@
[[abfbe]][[GSPLG00049]][[named-configurations]]
-Named Configurations
-^^^^^^^^^^^^^^^^^^^^
+==== Named Configurations
A named configuration is an abstraction that encapsulates GlassFish
Server property settings. Clusters and stand-alone server instances
@@ -345,8 +333,7 @@
[[abfbf]][[GSPLG00050]][[http-load-balancer-plug-in]]
-HTTP Load Balancer Plug-in
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== HTTP Load Balancer Plug-in
The load balancer distributes the workload among multiple physical
machines, thereby increasing the overall throughput of the system. The
@@ -394,8 +381,7 @@
[[abfbg]][[GSPLG00051]][[session-persistence]]
-Session Persistence
-^^^^^^^^^^^^^^^^^^^
+==== Session Persistence
Jakarta EE applications typically have significant amounts of session state
data. A web shopping cart is the classic example of a session state.
@@ -454,8 +440,7 @@
[[abfbh]][[GSPLG00052]][[iiop-load-balancing-in-a-cluster]]
-IIOP Load Balancing in a Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== IIOP Load Balancing in a Cluster
With IIOP load balancing, IIOP client requests are distributed to
different server instances or name servers. The goal is to spread the
@@ -502,8 +487,7 @@
[[abfbi]][[GSPLG00053]][[message-queue-and-jms-resources]]
-Message Queue and JMS Resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Queue and JMS Resources
The Open Message Queue (Message Queue) provides reliable, asynchronous
messaging for distributed applications. Message Queue is an enterprise
@@ -530,8 +514,7 @@
[[abfca]][[GSPLG00018]][[configuration-roadmap-for-high-availability-of-glassfish-server]]
-Configuration Roadmap for High Availability of GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuration Roadmap for High Availability of GlassFish Server
The following procedure lists the major tasks for configuring GlassFish
Server for high availability. The procedure also provides
@@ -539,8 +522,7 @@
[[sthref6]][[to-configure-glassfish-server-for-high-availability]]
-To Configure GlassFish Server for High Availability
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure GlassFish Server for High Availability
1. Determine your requirements and goals for performance and QoS. +
For more information, see the following documentation:
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/loe.adoc b/docs/deployment-planning-guide/src/main/jbake/content/loe.adoc
index a43abbc..b66d3ce 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/loe.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:planning.html#fygam[2-1 Calculation of Response Time]
* link:planning.html#fygaj[2-2 Calculation of Requests Per Second]
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/lot.adoc b/docs/deployment-planning-guide/src/main/jbake/content/lot.adoc
index 9345c10..daf8bff 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/lot.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/lot.adoc
@@ -5,11 +5,9 @@
prev=loe.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:checklist.html#sthref9[3-1 Checklist]
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/planning.adoc b/docs/deployment-planning-guide/src/main/jbake/content/planning.adoc
index 9cee352..19ea42d 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/planning.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/planning.adoc
@@ -5,15 +5,13 @@
prev=concepts.html
~~~~~~
-Planning your Deployment
-========================
+= Planning your Deployment
[[GSPLG00002]][[abfcb]]
[[planning-your-deployment]]
-2 Planning your Deployment
---------------------------
+== 2 Planning your Deployment
Before deploying GlassFish Server, first determine the performance and
availability goals, and then make decisions about the hardware, network,
@@ -29,8 +27,7 @@
[[abfcc]][[GSPLG00019]][[establishing-performance-goals]]
-Establishing Performance Goals
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Establishing Performance Goals
At its simplest, high performance means maximizing throughput and
reducing response time. Beyond these basic goals, you can establish
@@ -65,8 +62,7 @@
[[abfcd]][[GSPLG00054]][[estimating-throughput]]
-Estimating Throughput
-^^^^^^^^^^^^^^^^^^^^^
+==== Estimating Throughput
In broad terms, throughput measures the amount of work performed by
GlassFish Server. For GlassFish Server, throughput can be defined as the
@@ -86,8 +82,7 @@
[[abfce]][[GSPLG00055]][[estimating-load-on-glassfish-server-instances]]
-Estimating Load on GlassFish Server Instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Estimating Load on GlassFish Server Instances
Consider the following factors to estimate the load on GlassFish Server
instances.
@@ -101,8 +96,7 @@
[[abfcf]][[GSPLG00025]][[maximum-number-of-concurrent-users]]
-Maximum Number of Concurrent Users
-++++++++++++++++++++++++++++++++++
+===== Maximum Number of Concurrent Users
Users interact with an application through a client, such as a web
browser or Java program. Based on the user's actions, the client
@@ -125,8 +119,7 @@
[[abfcg]][[GSPLG00026]][[think-time]]
-Think Time
-++++++++++
+===== Think Time
A user does not submit requests continuously. A user submits a request,
the server receives and processes the request, and then returns a
@@ -145,8 +138,7 @@
[[abfch]][[GSPLG00027]][[average-response-time]]
-Average Response Time
-+++++++++++++++++++++
+===== Average Response Time
Response time refers to the amount of time GlassFish Server takes to
return the results of a request to the user. The response time is
@@ -215,8 +207,7 @@
[[abfcj]][[GSPLG00028]][[requests-per-minute]]
-Requests Per Minute
-+++++++++++++++++++
+===== Requests Per Minute
If you know the number of concurrent users at any given time, the
response time of their requests, and the average user think time, then
@@ -268,8 +259,7 @@
[[abfcp]][[GSPLG00020]][[planning-the-network-configuration]]
-Planning the Network Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Planning the Network Configuration
When planning how to integrate the GlassFish Server into the network,
estimate the bandwidth requirements and plan the network in such a way
@@ -286,8 +276,7 @@
[[gkvdm]][[GSPLG00056]][[setting-up-traffic-separation]]
-Setting Up Traffic Separation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting Up Traffic Separation
You can separate external traffic, such as client requests, from the
internal traffic, such as session state failover, database transactions,
@@ -311,8 +300,7 @@
[[abfcq]][[GSPLG00057]][[estimating-bandwidth-requirements]]
-Estimating Bandwidth Requirements
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Estimating Bandwidth Requirements
To decide on the desired size and bandwidth of the network, first
determine the network traffic and identify its peak. Check if there is a
@@ -337,8 +325,7 @@
[[abfcr]][[GSPLG00058]][[calculating-bandwidth-required]]
-Calculating Bandwidth Required
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Calculating Bandwidth Required
Based on the calculations made in link:#abfcc[Establishing Performance
Goals], determine the additional bandwidth required for deploying
@@ -373,8 +360,7 @@
[[abfct]][[GSPLG00059]][[estimating-peak-load]]
-Estimating Peak Load
-^^^^^^^^^^^^^^^^^^^^
+==== Estimating Peak Load
Having an even load throughout the day is probably not realistic. You
need to determine when the peak load occurs, how long it lasts, and what
@@ -402,8 +388,7 @@
[[abfcw]][[GSPLG00060]][[choosing-network-cards]]
-Choosing Network Cards
-^^^^^^^^^^^^^^^^^^^^^^
+==== Choosing Network Cards
For greater bandwidth and optimal network performance, use at least 100
Mbps Ethernet cards or, preferably, 1 Gbps Ethernet cards between
@@ -411,8 +396,7 @@
[[abfcy]][[GSPLG00021]][[planning-for-availability]]
-Planning for Availability
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Planning for Availability
The following topics are addressed here:
@@ -422,8 +406,7 @@
[[abfcz]][[GSPLG00061]][[rightsizing-availability]]
-Rightsizing Availability
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Rightsizing Availability
To plan availability of systems and applications, assess the
availability needs of the user groups that access different
@@ -450,8 +433,7 @@
[[abfda]][[GSPLG00062]][[using-clusters-to-improve-availability]]
-Using Clusters to Improve Availability
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Clusters to Improve Availability
At the most basic level, a cluster is a group of GlassFish Server
instances—often hosted on multiple physical servers—that appear to
@@ -468,8 +450,7 @@
[[abfdb]][[GSPLG00063]][[adding-redundancy-to-the-system]]
-Adding Redundancy to the System
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Adding Redundancy to the System
One way to achieve high availability is to add hardware and software
redundancy to the system. When one unit fails, the redundant unit takes
@@ -479,8 +460,7 @@
[[abfdc]][[GSPLG00029]][[identifying-failure-classes]]
-Identifying Failure Classes
-+++++++++++++++++++++++++++
+===== Identifying Failure Classes
The level of redundancy is determined by the failure classes (types of
failure) that the system needs to tolerate. Some examples of failure
@@ -504,8 +484,7 @@
[[abfdf]][[GSPLG00030]][[planning-failover-capacity]]
-Planning Failover Capacity
-++++++++++++++++++++++++++
+===== Planning Failover Capacity
Failover capacity planning implies deciding how many additional servers
and processes you need to add to the GlassFish Server deployment so that
@@ -527,8 +506,7 @@
[[abfdg]][[GSPLG00022]][[design-decisions]]
-Design Decisions
-~~~~~~~~~~~~~~~~
+=== Design Decisions
Design decisions include whether you are designing the system for peak
or steady-state load, the number of machines in various roles and their
@@ -542,8 +520,7 @@
[[abfdh]][[GSPLG00064]][[designing-for-peak-or-steady-state-load]]
-Designing for Peak or Steady State Load
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Designing for Peak or Steady State Load
In a typical deployment, there is a difference between steady state and
peak workloads:
@@ -572,8 +549,7 @@
[[abfdi]][[GSPLG00065]][[system-sizing]]
-System Sizing
-^^^^^^^^^^^^^
+==== System Sizing
Based on the load on the GlassFish Server instances and failover
requirements, you can determine the number of applications server
@@ -584,8 +560,7 @@
[[gkvcu]][[GSPLG00066]][[sizing-the-administration-thread-pool]]
-Sizing the Administration Thread Pool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sizing the Administration Thread Pool
The default `admin-thread-pool` size of 50 should be adequate for most
cluster deployments. If you have unusually large clusters, you may need
@@ -596,8 +571,7 @@
[[abfdn]][[GSPLG00023]][[planning-message-queue-broker-deployment]]
-Planning Message Queue Broker Deployment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Planning Message Queue Broker Deployment
The Java Message Service (JMS) API is a messaging standard that allows
Jakarta EE applications and components to create, send, receive, and read
@@ -638,8 +612,7 @@
[[abfdo]][[GSPLG00067]][[multi-broker-clusters]]
-Multi-Broker Clusters
-^^^^^^^^^^^^^^^^^^^^^
+==== Multi-Broker Clusters
Message Queue supports using multiple interconnected broker instances
known as a broker cluster. With broker clusters, client connections are
@@ -682,8 +655,7 @@
[[abfdp]][[GSPLG00031]][[master-broker-and-client-synchronization-for-conventional-clusters]]
-Master Broker and Client Synchronization for Conventional Clusters
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Master Broker and Client Synchronization for Conventional Clusters
In a configuration for a conventional broker cluster, each destination
is replicated on all of the brokers in a cluster. Each broker knows
@@ -716,8 +688,7 @@
[[abfdq]][[GSPLG00068]][[configuring-glassfish-server-to-use-message-queue-brokers]]
-Configuring GlassFish Server to Use Message Queue Brokers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring GlassFish Server to Use Message Queue Brokers
By default, Message Queue brokers (JMS hosts) run in the same JVM as the
GlassFish Server process. However, Message Queue brokers (JMS hosts) can
@@ -737,8 +708,7 @@
[[abfdt]][[GSPLG00032]][[java-message-service-type]]
-Java Message Service Type
-+++++++++++++++++++++++++
+===== Java Message Service Type
There are three types of integration between GlassFish Server and
Message Queue brokers: embedded, local, and remote. You can set this
@@ -795,8 +765,7 @@
[[abfdr]][[GSPLG00033]][[managing-jms-with-the-administration-console]]
-Managing JMS with the Administration Console
-++++++++++++++++++++++++++++++++++++++++++++
+===== Managing JMS with the Administration Console
In the Administration Console, you can set JMS properties using the Java
Message Service node for a particular configuration. You can set
@@ -821,8 +790,7 @@
[[abfds]][[GSPLG00034]][[managing-jms-with-asadmin]]
-Managing JMS with asadmin
-+++++++++++++++++++++++++
+===== Managing JMS with asadmin
In addition to the Administration Console, you can use the `asadmin`
command-line utility to manage the Java Message Service and JMS hosts.
@@ -846,8 +814,7 @@
[[abfdw]][[GSPLG00035]][[default-jms-host]]
-Default JMS Host
-++++++++++++++++
+===== Default JMS Host
You can specify the default JMS Host in the Administration Console Java
Message Service page. If the Java Message Service type is LOCAL,
@@ -869,8 +836,7 @@
[[abfdx]][[GSPLG00069]][[example-deployment-scenarios]]
-Example Deployment Scenarios
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Example Deployment Scenarios
To accommodate your messaging needs, modify the Java Message Service and
JMS host list to suit your deployment, performance, and availability needs.
@@ -884,8 +850,7 @@
[[abfdy]][[GSPLG00036]][[default-deployment]]
-Default Deployment
-++++++++++++++++++
+===== Default Deployment
Installing the GlassFish Server automatically creates a domain
administration server (DAS). By default, the Java Message Service type
@@ -899,8 +864,7 @@
[[abfdz]][[GSPLG00037]][[using-a-message-queue-broker-cluster-with-a-glassfish-server-cluster]]
-Using a Message Queue Broker Cluster with a GlassFish Server Cluster
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Using a Message Queue Broker Cluster with a GlassFish Server Cluster
In EMBEDDED or LOCAL mode, when a GlassFish Server is configured, a
Message Queue broker cluster is auto-configured with each GlassFish
@@ -913,8 +877,7 @@
[[abfeb]][[GSPLG00038]][[specifying-an-application-specific-message-queue-broker-cluster]]
-Specifying an Application-Specific Message Queue Broker Cluster
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Specifying an Application-Specific Message Queue Broker Cluster
In some cases, an application may need to use a different Message Queue
broker cluster than the one used by the GlassFish Server cluster. To do
@@ -931,8 +894,7 @@
[[abfec]][[GSPLG00039]][[application-clients]]
-Application Clients
-+++++++++++++++++++
+===== Application Clients
When an application client or standalone application accesses a JMS
administered object for the first time, the client JVM retrieves the
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/preface.adoc b/docs/deployment-planning-guide/src/main/jbake/content/preface.adoc
index 518c86b..10406b2 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/preface.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[sthref2]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -43,8 +41,7 @@
[[sthref3]][[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -149,8 +146,7 @@
[[GSPLG00011]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -194,8 +190,7 @@
[[GSPLG00013]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -235,8 +230,7 @@
[[GSPLG00014]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -279,8 +273,7 @@
[[GSPLG00012]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/title.adoc b/docs/deployment-planning-guide/src/main/jbake/content/title.adoc
index b30db8a..46936a1 100644
--- a/docs/deployment-planning-guide/src/main/jbake/content/title.adoc
+++ b/docs/deployment-planning-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Deployment Planning Guide, Release 7
-=============================================================
+= Eclipse GlassFish Server Deployment Planning Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Deployment Planning Guide
diff --git a/docs/deployment-planning-guide/src/main/jbake/content/toc.adoc b/docs/deployment-planning-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..6e4fcc8
--- /dev/null
+++ b/docs/deployment-planning-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,71 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Deployment Planning Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Deployment Planning Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#sthref3[GlassFish Server Documentation Set]
+** link:preface.html#GSPLG00011[Related Documentation]
+** link:preface.html#GSPLG00013[Typographic Conventions]
+** link:preface.html#GSPLG00014[Symbol Conventions]
+** link:preface.html#GSPLG00012[Default Paths and File Names]
+
+[[product-concepts]]
+=== link:concepts.html#GSPLG00001[1 Product Concepts]
+
+** link:concepts.html#GSPLG00016[Jakarta EE Platform Overview]
+*** link:concepts.html#GSPLG00040[Jakarta EE Applications]
+*** link:concepts.html#GSPLG00041[Containers]
+*** link:concepts.html#GSPLG00042[Jakarta EE Services]
+*** link:concepts.html#GSPLG00043[Web Services]
+*** link:concepts.html#GSPLG00044[Client Access]
+*** link:concepts.html#GSPLG00045[External Systems and Resources]
+** link:concepts.html#GSPLG00017[GlassFish Server Components]
+*** link:concepts.html#GSPLG00046[Server Instances]
+*** link:concepts.html#GSPLG00047[Administrative Domains]
+*** link:concepts.html#GSPLG00048[Clusters]
+*** link:concepts.html#GSPLG00049[Named Configurations]
+*** link:concepts.html#GSPLG00050[HTTP Load Balancer Plug-in]
+*** link:concepts.html#GSPLG00051[Session Persistence]
+*** link:concepts.html#GSPLG00052[IIOP Load Balancing in a Cluster]
+*** link:concepts.html#GSPLG00053[Message Queue and JMS Resources]
+** link:concepts.html#GSPLG00018[Configuration Roadmap for High Availability of GlassFish Server]
+*** link:concepts.html#sthref6[To Configure GlassFish Server for High Availability]
+
+[[planning-your-deployment]]
+=== link:planning.html#GSPLG00002[2 Planning your Deployment]
+
+** link:planning.html#GSPLG00019[Establishing Performance Goals]
+*** link:planning.html#GSPLG00054[Estimating Throughput]
+*** link:planning.html#GSPLG00055[Estimating Load on GlassFish Server Instances]
+** link:planning.html#GSPLG00020[Planning the Network Configuration]
+*** link:planning.html#GSPLG00056[Setting Up Traffic Separation]
+*** link:planning.html#GSPLG00057[Estimating Bandwidth Requirements]
+*** link:planning.html#GSPLG00058[Calculating Bandwidth Required]
+*** link:planning.html#GSPLG00059[Estimating Peak Load]
+*** link:planning.html#GSPLG00060[Choosing Network Cards]
+** link:planning.html#GSPLG00021[Planning for Availability]
+*** link:planning.html#GSPLG00061[Rightsizing Availability]
+*** link:planning.html#GSPLG00062[Using Clusters to Improve Availability]
+*** link:planning.html#GSPLG00063[Adding Redundancy to the System]
+** link:planning.html#GSPLG00022[Design Decisions]
+*** link:planning.html#GSPLG00064[Designing for Peak or Steady State Load]
+*** link:planning.html#GSPLG00065[System Sizing]
+*** link:planning.html#GSPLG00066[Sizing the Administration Thread Pool]
+** link:planning.html#GSPLG00023[Planning Message Queue Broker Deployment]
+*** link:planning.html#GSPLG00067[Multi-Broker Clusters]
+*** link:planning.html#GSPLG00068[Configuring GlassFish Server to Use Message Queue Brokers]
+*** link:planning.html#GSPLG00069[Example Deployment Scenarios]
+
+[[checklist-for-deployment]]
+=== link:checklist.html#GSPLG00003[3 Checklist for Deployment]
+
+** link:checklist.html#checklist[Checklist]
diff --git a/docs/embedded-server-guide/src/main/jbake/content/embedded-server-guide.adoc b/docs/embedded-server-guide/src/main/jbake/content/embedded-server-guide.adoc
index 0d6b931..9198f68 100644
--- a/docs/embedded-server-guide/src/main/jbake/content/embedded-server-guide.adoc
+++ b/docs/embedded-server-guide/src/main/jbake/content/embedded-server-guide.adoc
@@ -4,15 +4,13 @@
prev=preface.html
~~~~~~
-Eclipse GlassFish Server 7 Embedded Server Guide
-================================================
+= Eclipse GlassFish Server 7 Embedded Server Guide
[[GSESG00001]][[gjldt]]
[[glassfish-server-open-source-edition-embedded-server-guide]]
-1 Eclipse GlassFish Server 7 Embedded Server Guide
---------------------------------------------------
+== 1 Eclipse GlassFish Server 7 Embedded Server Guide
This document explains how to run applications in embedded GlassFish
Server Open Source Edition and to develop applications in which
@@ -33,8 +31,7 @@
[[giidt]][[GSESG00035]][[introduction-to-embedded-glassfish-server]]
-Introduction to Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Introduction to Embedded GlassFish Server
Embedded Eclipse GlassFish Server enables you to use
GlassFish Server as a library. Embedded GlassFish Server also enables
@@ -80,8 +77,7 @@
[[gkubb]][[GSESG00036]][[embedded-glassfish-server-file-system]]
-Embedded GlassFish Server File System
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Embedded GlassFish Server File System
The following Embedded GlassFish Server directories and files are
important if you are referencing a nonembedded installation of GlassFish
@@ -93,8 +89,7 @@
[[gikqf]][[GSESG00054]][[installation-root-directory]]
-Installation Root Directory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Installation Root Directory
The installation root directory, represented as as-install, is the
parent of the directory that embedded GlassFish Server uses for
@@ -112,8 +107,7 @@
[[gikvf]][[GSESG00055]][[instance-root-directory]]
-Instance Root Directory
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Instance Root Directory
The instance root directory, represented as domain-dir, is the parent
directory of a server instance directory. Embedded GlassFish Server Open
@@ -144,8 +138,7 @@
[[giiak]][[GSESG00056]][[the-domain.xml-file]]
-The `domain.xml` File
-^^^^^^^^^^^^^^^^^^^^^
+==== The `domain.xml` File
Using an existing `domain.xml` file avoids the need to configure
embedded GlassFish Server programmatically in your application. Your
@@ -169,8 +162,7 @@
[[giijw]][[GSESG00037]][[including-the-glassfish-server-embedded-server-api-in-applications]]
-Including the GlassFish Server Embedded Server API in Applications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Including the GlassFish Server Embedded Server API in Applications
Eclipse GlassFish Server provides an application programming
interface (API) for developing applications in which GlassFish Server is
@@ -190,8 +182,7 @@
[[giide]][[GSESG00057]][[setting-the-class-path]]
-Setting the Class Path
-^^^^^^^^^^^^^^^^^^^^^^
+==== Setting the Class Path
To enable your applications to locate the class libraries for embedded
GlassFish Server, add one of the following JAR files to your class path:
@@ -232,8 +223,7 @@
[[giiky]][[GSESG00058]][[creating-starting-and-stopping-embedded-glassfish-server]]
-Creating, Starting, and Stopping Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Creating, Starting, and Stopping Embedded GlassFish Server
Before you can run applications, you must set up and run the embedded
GlassFish Server.
@@ -245,8 +235,7 @@
[[gihyr]][[GSESG00043]][[creating-and-configuring-an-embedded-glassfish-server]]
-Creating and Configuring an Embedded GlassFish Server
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Creating and Configuring an Embedded GlassFish Server
To create and configure an embedded GlassFish Server, perform these
tasks:
@@ -387,8 +376,7 @@
[[gihyz]][[GSESG00044]][[running-an-embedded-glassfish-server]]
-Running an Embedded GlassFish Server
-++++++++++++++++++++++++++++++++++++
+===== Running an Embedded GlassFish Server
After you create an embedded GlassFish Server as described in
link:#gihyr[Creating and Configuring an Embedded GlassFish Server], you
@@ -504,8 +492,7 @@
[[giigc]][[GSESG00059]][[deploying-and-undeploying-an-application-in-an-embedded-glassfish-server]]
-Deploying and Undeploying an Application in an Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying and Undeploying an Application in an Embedded GlassFish Server
Deploying an application installs the files that comprise the
application into Embedded GlassFish Server and makes the application
@@ -524,8 +511,7 @@
[[gilrf]][[GSESG00021]][[to-deploy-an-application-from-an-archive-file-or-a-directory]]
-To Deploy an Application From an Archive File or a Directory
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Deploy an Application From an Archive File or a Directory
An archive file contains the resources, deployment descriptor, and
classes of an application. The content of the file must be organized in
@@ -592,8 +578,7 @@
[[gilpm]][[GSESG00045]][[undeploying-an-application]]
-Undeploying an Application
-++++++++++++++++++++++++++
+===== Undeploying an Application
Undeploy an application when the application is no longer required to
run in GlassFish Server. For example, before stopping GlassFish Server,
@@ -642,8 +627,7 @@
[[gjrcs]][[GSESG00046]][[creating-a-scattered-archive]]
-Creating a Scattered Archive
-++++++++++++++++++++++++++++
+===== Creating a Scattered Archive
Deploying a module from a scattered archive (WAR or JAR) enables you to
deploy an unpackaged module whose resources, deployment descriptor, and
@@ -764,8 +748,7 @@
[[gkvgc]][[GSESG00047]][[creating-a-scattered-enterprise-archive]]
-Creating a Scattered Enterprise Archive
-+++++++++++++++++++++++++++++++++++++++
+===== Creating a Scattered Enterprise Archive
Deploying an application from a scattered enterprise archive (EAR)
enables you to deploy an unpackaged application whose resources,
@@ -913,8 +896,7 @@
[[gjldy]][[GSESG00060]][[running-asadmin-commands-using-the-glassfish-server-embedded-server-api]]
Running `asadmin` Commands Using the GlassFish Server Embedded Server
-API
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== API
Running link:../reference-manual/asadmin.html#GSRFM00263[`asadmin`] commands from an application enables
the application to configure the embedded GlassFish Server to suit the
@@ -988,8 +970,7 @@
[[gikrt]][[GSESG00061]][[sample-applications]]
-Sample Applications
-^^^^^^^^^^^^^^^^^^^
+==== Sample Applications
[[GSESG00016]][[gionq]]
Example 1-12 Using an Existing `domain.xml` File and Deploying an
@@ -1050,8 +1031,7 @@
[[gijhs]][[GSESG00038]][[testing-applications-with-the-maven-plug-in-for-embedded-glassfish-server]]
-Testing Applications with the Maven Plug-in for Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Testing Applications with the Maven Plug-in for Embedded GlassFish Server
If you are using http://maven.apache.org/[Apache Maven]
(`http://maven.apache.org/`), the plug-in for embedded GlassFish Server
@@ -1075,8 +1055,7 @@
[[gihus]][[GSESG00022]][[to-set-up-your-maven-environment]]
-To Set Up Your Maven Environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up Your Maven Environment
Setting up your Maven environment enables Maven to download the required
embedded GlassFish Server distribution file when you build your project.
@@ -1295,8 +1274,7 @@
[[giivt]][[GSESG00023]][[to-build-and-start-an-application-from-maven]]
-To Build and Start an Application From Maven
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Build and Start an Application From Maven
If you are using Maven to manage the development of your application,
you can use a Maven goal to build and start the application in embedded
@@ -1332,8 +1310,7 @@
[[gijly]][[GSESG00024]][[to-stop-embedded-glassfish-server]]
-To Stop Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop Embedded GlassFish Server
1. Change to the root directory of the Maven project for your
application.
@@ -1351,8 +1328,7 @@
[[gijjn]][[GSESG00025]][[to-redeploy-an-application-that-was-built-and-started-from-maven]]
-To Redeploy an Application That Was Built and Started From Maven
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Redeploy an Application That Was Built and Started From Maven
An application that was built and started from Maven continues to run in
Embedded GlassFish Server until Embedded GlassFish Server is stopped.
@@ -1364,8 +1340,7 @@
[[gjkps]][[GSESG00062]][[maven-goals-for-embedded-glassfish-server]]
-Maven Goals for Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Maven Goals for Embedded GlassFish Server
You can use the following Maven goals to test your applications with
embedded GlassFish Server:
@@ -1379,8 +1354,7 @@
[[gjkxo]][[GSESG00048]][[embedded-glassfishrun-goal]]
-`embedded-glassfish:run` Goal
-+++++++++++++++++++++++++++++
+===== `embedded-glassfish:run` Goal
This goal starts the server and deploys an application. You can redeploy
if you change the application. The application can be a packaged archive
@@ -1465,8 +1439,7 @@
[[gjkwy]][[GSESG00049]][[embedded-glassfishstart-goal]]
-`embedded-glassfish:start` Goal
-+++++++++++++++++++++++++++++++
+===== `embedded-glassfish:start` Goal
This goal starts the server. You can set the parameters described in the
following table.
@@ -1513,8 +1486,7 @@
[[gjkvc]][[GSESG00050]][[embedded-glassfishdeploy-goal]]
-`embedded-glassfish:deploy` Goal
-++++++++++++++++++++++++++++++++
+===== `embedded-glassfish:deploy` Goal
This goal deploys an application. You can redeploy if you change the
application. The application can be a packaged archive or a directory
@@ -1564,8 +1536,7 @@
[[gjkvg]][[GSESG00051]][[embedded-glassfishundeploy-goal]]
-`embedded-glassfish:undeploy` Goal
-++++++++++++++++++++++++++++++++++
+===== `embedded-glassfish:undeploy` Goal
[NOTE]
@@ -1617,8 +1588,7 @@
[[gjkyl]][[GSESG00052]][[embedded-glassfishstop-goal]]
-`embedded-glassfish:stop` Goal
-++++++++++++++++++++++++++++++
+===== `embedded-glassfish:stop` Goal
This goal stops the server. You can set the parameters described in the
following table.
@@ -1636,8 +1606,7 @@
[[gjkxq]][[GSESG00053]][[embedded-glassfishadmin-goal]]
-`embedded-glassfish:admin` Goal
-+++++++++++++++++++++++++++++++
+===== `embedded-glassfish:admin` Goal
This goal runs a GlassFish Server administration command. You must use
either the command and commandParameters parameters in combination or
@@ -1669,8 +1638,7 @@
[[gjlde]][[GSESG00039]][[using-the-ejb-3.1-embeddable-api-with-embedded-glassfish-server]]
-Using the EJB 3.1 Embeddable API with Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the EJB 3.1 Embeddable API with Embedded GlassFish Server
The EJB 3.1 Embeddable API is designed for unit testing of EJB modules.
You must use this API with a pre-installed, nonembedded GlassFish Server
@@ -1719,8 +1687,7 @@
[[gjlcr]][[GSESG00026]][[to-use-the-ejb-3.1-embeddable-api-with-embedded-glassfish-server]]
-To Use the EJB 3.1 Embeddable API with Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Use the EJB 3.1 Embeddable API with Embedded GlassFish Server
1. To specify GlassFish Server as the Container Provider, include
`glassfish-embedded-static-shell.jar` or `glassfish-embedded-all.jar` in
@@ -1769,8 +1736,7 @@
[[gksnv]][[GSESG00063]][[ejb-3.1-embeddable-api-properties]]
-EJB 3.1 Embeddable API Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== EJB 3.1 Embeddable API Properties
Properties that can be passed to the
`EJBContainer#createEJBContainer(Properties)` method are summarized in
@@ -1827,8 +1793,7 @@
[[gjxff]][[GSESG00064]][[using-maven-with-the-ejb-3.1-embeddable-api-and-embedded-glassfish-server]]
-Using Maven with the EJB 3.1 Embeddable API and Embedded GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Maven with the EJB 3.1 Embeddable API and Embedded GlassFish Server
When using Maven with the EJB 3.1 Embeddable API and Embedded GlassFish
Server, you cannot use the features of the Maven plug-in. You must start
@@ -1898,8 +1863,7 @@
[[gjlfe]][[GSESG00040]][[changing-log-levels-in-embedded-glassfish-server]]
-Changing Log Levels in Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Changing Log Levels in Embedded GlassFish Server
To change log levels in Embedded GlassFish Server, you can follow the
steps in this section or you can use the Embedded Server API as shown in
@@ -1967,8 +1931,7 @@
[[gksmw]][[GSESG00041]][[default-java-persistence-data-source-for-embedded-glassfish-server]]
-Default Java Persistence Data Source for Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Java Persistence Data Source for Embedded GlassFish Server
The `jdbc/__default` Java DB database is preconfigured with Embedded
GlassFish Server. It is used when an application is deployed in Embedded
@@ -1986,8 +1949,7 @@
[[gihxf]][[GSESG00042]][[restrictions-for-embedded-glassfish-server]]
-Restrictions for Embedded GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Restrictions for Embedded GlassFish Server
The `glassfish-embedded-web.jar` file for embedded GlassFish Server
supports only these features of nonembedded GlassFish Server:
diff --git a/docs/embedded-server-guide/src/main/jbake/content/loe.adoc b/docs/embedded-server-guide/src/main/jbake/content/loe.adoc
index bcb2c6e..9d4202b 100644
--- a/docs/embedded-server-guide/src/main/jbake/content/loe.adoc
+++ b/docs/embedded-server-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:embedded-server-guide.html#gikmz[1-1 Creating an Embedded
GlassFish Server]
diff --git a/docs/embedded-server-guide/src/main/jbake/content/lot.adoc b/docs/embedded-server-guide/src/main/jbake/content/lot.adoc
index 4e733e5..103c307 100644
--- a/docs/embedded-server-guide/src/main/jbake/content/lot.adoc
+++ b/docs/embedded-server-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:embedded-server-guide.html#gksir[1-1 Methods of the
BootstrapProperties Class]
diff --git a/docs/embedded-server-guide/src/main/jbake/content/preface.adoc b/docs/embedded-server-guide/src/main/jbake/content/preface.adoc
index 7af9c08..34817b5 100644
--- a/docs/embedded-server-guide/src/main/jbake/content/preface.adoc
+++ b/docs/embedded-server-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[sthref2]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -55,8 +53,7 @@
[[GSESG00027]][[ghpbz]]
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -161,8 +158,7 @@
[[GSESG00028]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -206,8 +202,7 @@
[[GSESG00029]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -247,8 +242,7 @@
[[GSESG00030]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -291,8 +285,7 @@
[[GSESG00031]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/embedded-server-guide/src/main/jbake/content/title.adoc b/docs/embedded-server-guide/src/main/jbake/content/title.adoc
index c17ca9d..48ddb23 100644
--- a/docs/embedded-server-guide/src/main/jbake/content/title.adoc
+++ b/docs/embedded-server-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Embedded Server Guide, Release 7
-=========================================================
+= Eclipse GlassFish Server Embedded Server Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Embedded Server Guide
diff --git a/docs/embedded-server-guide/src/main/jbake/content/toc.adoc b/docs/embedded-server-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..f287093
--- /dev/null
+++ b/docs/embedded-server-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,46 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Embedded Server Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Embedded Server Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#GSESG00027[GlassFish Server Documentation Set]
+** link:preface.html#GSESG00028[Related Documentation]
+** link:preface.html#GSESG00029[Typographic Conventions]
+** link:preface.html#GSESG00030[Symbol Conventions]
+** link:preface.html#GSESG00031[Default Paths and File Names]
+
+[[glassfish-server-open-source-edition-embedded-server-guide]]
+=== link:embedded-server-guide.html#GSESG00001[1 Eclipse GlassFish Server 7 Embedded Server Guide]
+
+** link:embedded-server-guide.html#GSESG00035[Introduction to Embedded GlassFish Server]
+** link:embedded-server-guide.html#GSESG00036[Embedded GlassFish Server File System]
+*** link:embedded-server-guide.html#GSESG00054[Installation Root Directory]
+*** link:embedded-server-guide.html#GSESG00055[Instance Root Directory]
+*** link:embedded-server-guide.html#GSESG00056[The `domain.xml` File]
+** link:embedded-server-guide.html#GSESG00037[Including the GlassFish Server Embedded Server API in Applications]
+*** link:embedded-server-guide.html#GSESG00057[Setting the Class Path]
+*** link:embedded-server-guide.html#GSESG00058[Creating, Starting, and Stopping Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00059[Deploying and Undeploying an Application in an Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00061[Sample Applications]
+** link:embedded-server-guide.html#GSESG00038[Testing Applications with the Maven Plug-in for Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00022[To Set Up Your Maven Environment]
+*** link:embedded-server-guide.html#GSESG00023[To Build and Start an Application From Maven]
+*** link:embedded-server-guide.html#GSESG00024[To Stop Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00025[To Redeploy an Application That Was Built and Started From Maven]
+*** link:embedded-server-guide.html#GSESG00062[Maven Goals for Embedded GlassFish Server]
+** link:embedded-server-guide.html#GSESG00039[Using the EJB 3.1 Embeddable API with Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00026[To Use the EJB 3.1 Embeddable API with Embedded GlassFish Server]
+*** link:embedded-server-guide.html#GSESG00063[EJB 3.1 Embeddable API Properties]
+*** link:embedded-server-guide.html#GSESG00064[Using Maven with the EJB 3.1 Embeddable API and Embedded GlassFish Server]
+** link:embedded-server-guide.html#GSESG00040[Changing Log Levels in Embedded GlassFish Server]
+** link:embedded-server-guide.html#GSESG00041[Default Java Persistence Data Source for Embedded GlassFish Server]
+** link:embedded-server-guide.html#GSESG00042[Restrictions for Embedded GlassFish Server]
diff --git a/docs/error-messages-reference/src/main/jbake/content/error-messages.adoc b/docs/error-messages-reference/src/main/jbake/content/error-messages.adoc
index 393029a..e4c69ee 100644
--- a/docs/error-messages-reference/src/main/jbake/content/error-messages.adoc
+++ b/docs/error-messages-reference/src/main/jbake/content/error-messages.adoc
@@ -4,13 +4,11 @@
prev=preface.html
~~~~~~
-GlassFish Server Open Source Edition Error Messages
-===================================================
+= GlassFish Server Open Source Edition Error Messages
[[sthref2]][[glassfish-server-open-source-edition-error-messages]]
-1 GlassFish Server Open Source Edition Error Messages
------------------------------------------------------
+== 1 GlassFish Server Open Source Edition Error Messages
This chapter provides a compilation of error messages that you might
encounter when using GlassFish Server Open Source Edition.
diff --git a/docs/error-messages-reference/src/main/jbake/content/preface.adoc b/docs/error-messages-reference/src/main/jbake/content/preface.adoc
index 7da9e26..cf9b221 100644
--- a/docs/error-messages-reference/src/main/jbake/content/preface.adoc
+++ b/docs/error-messages-reference/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSEMR00001]][[gkbbw]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -50,8 +48,7 @@
[[BABJIEEB]][[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -155,8 +152,7 @@
[[BABBDGAE]][[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -199,8 +195,7 @@
[[BABGCFGH]][[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -239,8 +234,7 @@
[[BABHAGID]][[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -282,8 +276,7 @@
[[BABEACJI]][[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/error-messages-reference/src/main/jbake/content/title.adoc b/docs/error-messages-reference/src/main/jbake/content/title.adoc
index 5e6085c..65f4e0b 100644
--- a/docs/error-messages-reference/src/main/jbake/content/title.adoc
+++ b/docs/error-messages-reference/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-Eclipse GlassFish Server Error Message Reference, Release 7
-===========================================================
+= Eclipse GlassFish Server Error Message Reference, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Error Message Reference
diff --git a/docs/error-messages-reference/src/main/jbake/content/toc.adoc b/docs/error-messages-reference/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..edba138
--- /dev/null
+++ b/docs/error-messages-reference/src/main/jbake/content/toc.adoc
@@ -0,0 +1,23 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Error Message Reference, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Error Message Reference, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSEMR00001[Preface]
+
+** link:preface.html#BABJIEEB[GlassFish Server Documentation Set]
+** link:preface.html#BABBDGAE[Related Documentation]
+** link:preface.html#BABGCFGH[Typographic Conventions]
+** link:preface.html#BABHAGID[Symbol Conventions]
+** link:preface.html#BABEACJI[Default Paths and File Names]
+
+[[glassfish-server-open-source-edition-error-messages]]
+=== link:error-messages.html#sthref2[1 GlassFish Server Open Source Edition Error Messages]
+
diff --git a/docs/ha-administration-guide/src/main/jbake/content/clusters.adoc b/docs/ha-administration-guide/src/main/jbake/content/clusters.adoc
index c7442d6..536ce7c 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/clusters.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/clusters.adoc
@@ -5,15 +5,13 @@
prev=nodes.html
~~~~~~
-Administering GlassFish Server Clusters
-=======================================
+= Administering GlassFish Server Clusters
[[GSHAG00005]][[gjfom]]
[[administering-glassfish-server-clusters]]
-4 Administering GlassFish Server Clusters
------------------------------------------
+== 4 Administering GlassFish Server Clusters
A cluster is a collection of GlassFish Server instances that work
together as one logical entity. A cluster provides a runtime environment
@@ -35,8 +33,7 @@
[[gjfqp]][[GSHAG00183]][[about-glassfish-server-clusters]]
-About GlassFish Server Clusters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About GlassFish Server Clusters
A cluster is a named collection of GlassFish Server instances that share
the same applications, resources, and configuration information. For
@@ -72,8 +69,7 @@
[[gjfnl]][[GSHAG00184]][[group-management-service]]
-Group Management Service
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Group Management Service
The Group Management Service (GMS) is an infrastructure component that
is enabled for the instances in a cluster. When GMS is enabled, if a
@@ -101,8 +97,7 @@
[[CHDFEGAG]][[GSHAG485]][[protocols-and-transports-for-gms]]
-Protocols and Transports for GMS
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Protocols and Transports for GMS
You can specify that GMS should use one of the following combinations of
protocol and transport for broadcasting messages:
@@ -138,8 +133,7 @@
[[gjfpd]][[GSHAG00264]][[gms-configuration-settings]]
-GMS Configuration Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GMS Configuration Settings
GlassFish Server has the following types of GMS settings:
@@ -218,8 +212,7 @@
[[gjfog]][[GSHAG00265]][[dotted-names-for-gms-settings]]
-Dotted Names for GMS Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Dotted Names for GMS Settings
Below are sample link:../reference-manual/get.html#GSRFM00139[`get`] subcommands to get all the GMS
configuration settings (attributes associated with the referenced
@@ -260,8 +253,7 @@
[[gkoac]][[GSHAG00098]][[to-preconfigure-nondefault-gms-configuration-settings]]
-To Preconfigure Nondefault GMS Configuration Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Preconfigure Nondefault GMS Configuration Settings
You can preconfigure GMS with values different than the defaults without
requiring a restart of the DAS and the cluster.
@@ -327,8 +319,7 @@
[[gkqqo]][[GSHAG00099]][[to-change-gms-settings-after-cluster-creation]]
-To Change GMS Settings After Cluster Creation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change GMS Settings After Cluster Creation
To avoid the need to restart the DAS and the cluster, configure GMS
configuration settings before cluster creation as explained in
@@ -408,8 +399,7 @@
[[gklhl]][[GSHAG00100]][[to-check-the-health-of-instances-in-a-cluster]]
-To Check the Health of Instances in a Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Check the Health of Instances in a Cluster
The `get-health` subcommand only works when GMS is enabled. This is the
quickest way to evaluate the health of a cluster and to detect if
@@ -451,8 +441,7 @@
[[gklhd]][[GSHAG00101]][[to-validate-that-multicast-transport-is-available-for-a-cluster]]
-To Validate That Multicast Transport Is Available for a Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Validate That Multicast Transport Is Available for a Cluster
[[GSHAG370]]
@@ -569,8 +558,7 @@
[[CHDGAIBJ]][[GSHAG00373]][[discovering-a-cluster-when-multicast-transport-is-unavailable]]
-Discovering a Cluster When Multicast Transport Is Unavailable
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Discovering a Cluster When Multicast Transport Is Unavailable
When multicast transport is unavailable, GlassFish Server instances that
are joining a cluster cannot rely on broadcast messages from GMS to
@@ -603,8 +591,7 @@
[[CHDCGIFF]][[GSHAG486]][[to-discover-a-cluster-when-multiple-instances-in-a-cluster-are-running-on-a-host]]
-To Discover a Cluster When Multiple Instances in a Cluster are Running on a Host
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Discover a Cluster When Multiple Instances in a Cluster are Running on a Host
If multiple instances in the same cluster are running on a host, you
must provide a list of uniform resource indicators (URIs). Each URI must
@@ -772,8 +759,7 @@
[[CHDIGFCG]][[GSHAG489]][[to-discover-a-cluster-when-each-instance-in-a-cluster-is-running-on-a-different-host]]
-To Discover a Cluster When Each Instance in a Cluster Is Running on a Different Host
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Discover a Cluster When Each Instance in a Cluster Is Running on a Different Host
If all instances in a cluster and the DAS are running on different
hosts, you can specify the locations of instances to use for discovering
@@ -895,8 +881,7 @@
[[gjdlw]][[GSHAG00266]][[using-the-multi-homing-feature-with-gms]]
-Using the Multi-Homing Feature With GMS
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using the Multi-Homing Feature With GMS
Multi-homing enables GlassFish Server clusters to be used in an
environment that uses multiple Network Interface Cards (NICs). A
@@ -918,8 +903,7 @@
[[gjdoo]][[GSHAG00224]][[traffic-separation-using-multi-homing]]
-Traffic Separation Using Multi-Homing
-+++++++++++++++++++++++++++++++++++++
+===== Traffic Separation Using Multi-Homing
You can separate the internal traffic resulting from GMS from the
external traffic. Traffic separation enables you plan a network better
@@ -987,8 +971,7 @@
[[gkqdy]][[GSHAG00185]][[creating-listing-and-deleting-clusters]]
-Creating, Listing, and Deleting Clusters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Listing, and Deleting Clusters
GlassFish Server enables you to create clusters, obtain information
about clusters, and delete clusters that are no longer required.
@@ -1001,8 +984,7 @@
[[gkqdm]][[GSHAG00103]][[to-create-a-cluster]]
-To Create a Cluster
-^^^^^^^^^^^^^^^^^^^
+==== To Create a Cluster
Use the `create-cluster` subcommand in remote mode to create a cluster.
@@ -1190,8 +1172,7 @@
[[gkqdn]][[GSHAG00104]][[to-list-all-clusters-in-a-domain]]
-To List All Clusters in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List All Clusters in a Domain
Use the `list-clusters` subcommand in remote mode to obtain information
about existing clusters in a domain.
@@ -1243,8 +1224,7 @@
[[gkqcp]][[GSHAG00105]][[to-delete-a-cluster]]
-To Delete a Cluster
-^^^^^^^^^^^^^^^^^^^
+==== To Delete a Cluster
Use the `delete-cluster` subcommand in remote mode to remove a cluster
from the DAS configuration.
diff --git a/docs/ha-administration-guide/src/main/jbake/content/http-load-balancing.adoc b/docs/ha-administration-guide/src/main/jbake/content/http-load-balancing.adoc
index d199c38..3d90645 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/http-load-balancing.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/http-load-balancing.adoc
@@ -5,15 +5,13 @@
prev=named-configurations.html
~~~~~~
-Configuring HTTP Load Balancing
-===============================
+= Configuring HTTP Load Balancing
[[GSHAG00009]][[abdgs]]
[[configuring-http-load-balancing]]
-7 Configuring HTTP Load Balancing
----------------------------------
+== 7 Configuring HTTP Load Balancing
This chapter describes how to configure HTTP load balancing on GlassFish
Server 7.
@@ -28,8 +26,7 @@
[[abdgx]][[GSHAG00202]][[setting-up-http-load-balancing]]
-Setting Up HTTP Load Balancing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up HTTP Load Balancing
This section describes how to set up load balancing for GlassFish
Server.
@@ -43,8 +40,7 @@
[[abdgy]][[GSHAG00281]][[prerequisites-for-setting-up-http-load-balancing]]
-Prerequisites for Setting Up HTTP Load Balancing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Prerequisites for Setting Up HTTP Load Balancing
Before configuring your load balancer, you must:
@@ -63,8 +59,7 @@
[[gksdt]][[GSHAG00282]][[configuring-glassfish-server-with-apache-http-server-and-mod_jk]]
-Configuring GlassFish Server with Apache HTTP Server and `mod_jk`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring GlassFish Server with Apache HTTP Server and `mod_jk`
GlassFish Server 7 can be configured for load balancing with Apache
HTTP Server as a front end by enabling the Apache `mod_jk` connector
@@ -75,8 +70,7 @@
[[gksde]][[GSHAG00143]][[to-configure-the-mod_jk-connector-module]]
-To Configure the `mod_jk` Connector Module
-++++++++++++++++++++++++++++++++++++++++++
+===== To Configure the `mod_jk` Connector Module
1. Install http://httpd.apache.org/docs/2.2/install.html[Apache HTTP Server]
(`http://httpd.apache.org/docs/2.2/install.html`) and
@@ -201,8 +195,7 @@
[[CHDCCGDC]][[GSHAG494]][[configuring-glassfish-server-with-apache-http-server-and-mod_proxy_ajp]]
-Configuring GlassFish Server with Apache HTTP Server and `mod_proxy_ajp`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring GlassFish Server with Apache HTTP Server and `mod_proxy_ajp`
GlassFish Server 7 can be configured for load balancing with Apache
HTTP Server as a front end by enabling the Apache `mod_proxy_ajp`
@@ -215,8 +208,7 @@
[[to-configure-the-mod_proxy_ajp-connector-module]]
-To Configure the `mod_proxy_ajp` Connector Module
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Configure the `mod_proxy_ajp` Connector Module
1. Install http://httpd.apache.org/docs/2.2/install.html[Apache HTTP Server]
(`http://httpd.apache.org/docs/2.2/install.html`).
@@ -269,8 +261,7 @@
[[abdgz]][[GSHAG00284]][[http-load-balancer-deployments]]
-HTTP Load Balancer Deployments
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== HTTP Load Balancer Deployments
You can configure your load balancer in different ways, depending on
your goals and environment, as described in the following sections:
@@ -280,8 +271,7 @@
[[abdha]][[GSHAG00232]][[using-clustered-server-instances]]
-Using Clustered Server Instances
-++++++++++++++++++++++++++++++++
+===== Using Clustered Server Instances
The most common way to deploy the load balancer is with a cluster or
clusters of server instances. By default all the instances in a cluster
@@ -306,8 +296,7 @@
[[abdhc]][[GSHAG00233]][[using-multiple-standalone-instances]]
-Using Multiple Standalone Instances
-+++++++++++++++++++++++++++++++++++
+===== Using Multiple Standalone Instances
It is also possible to configure your load balancer to use multiple
standalone instances, and load balance and failover requests between
diff --git a/docs/ha-administration-guide/src/main/jbake/content/instances.adoc b/docs/ha-administration-guide/src/main/jbake/content/instances.adoc
index ea45d75..f91da36 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/instances.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/instances.adoc
@@ -5,14 +5,12 @@
prev=clusters.html
~~~~~~
-Administering GlassFish Server Instances
-========================================
+= Administering GlassFish Server Instances
[[GSHAG00006]][[gkrbv]]
[[administering-glassfish-server-instances]]
-5 Administering GlassFish Server Instances
-------------------------------------------
+== 5 Administering GlassFish Server Instances
A GlassFish Server instance is a single Virtual Machine for the Java
platform (Java Virtual Machine or JVM machine) on a single node in which
@@ -37,8 +35,7 @@
[[gkrbn]][[GSHAG00186]][[types-of-glassfish-server-instances]]
-Types of GlassFish Server Instances
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Types of GlassFish Server Instances
Each GlassFish Server instance is one of the following types of
instance:
@@ -73,8 +70,7 @@
[[gkqal]][[GSHAG00187]][[administering-glassfish-server-instances-centrally]]
-Administering GlassFish Server Instances Centrally
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering GlassFish Server Instances Centrally
Centralized administration requires the Distributed Component Object
Model (DCOM) remote protocol or secure shell (SSH) to be set up. If DCOM
@@ -97,8 +93,7 @@
[[gkqch]][[GSHAG00106]][[to-create-an-instance-centrally]]
-To Create an Instance Centrally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Instance Centrally
Use the `create-instance` subcommand in remote mode to create a
GlassFish Server instance centrally. Creating an instance adds the
@@ -263,8 +258,7 @@
[[gkrcb]][[GSHAG00107]][[to-list-all-instances-in-a-domain]]
-To List All Instances in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List All Instances in a Domain
Use the `list-instances` subcommand in remote mode to obtain information
about existing instances in a domain.
@@ -328,8 +322,7 @@
[[gkqcw]][[GSHAG00108]][[to-delete-an-instance-centrally]]
-To Delete an Instance Centrally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an Instance Centrally
Use the `delete-instance` subcommand in remote mode to delete a
GlassFish Server instance centrally.
@@ -415,8 +408,7 @@
[[gkqcj]][[GSHAG00109]][[to-start-a-cluster]]
-To Start a Cluster
-^^^^^^^^^^^^^^^^^^
+==== To Start a Cluster
Use the `start-cluster` subcommand in remote mode to start a cluster.
@@ -480,8 +472,7 @@
[[gkqcl]][[GSHAG00110]][[to-stop-a-cluster]]
-To Stop a Cluster
-^^^^^^^^^^^^^^^^^
+==== To Stop a Cluster
Use the `stop-cluster` subcommand in remote mode to stop a cluster.
@@ -529,8 +520,7 @@
[[gkqaw]][[GSHAG00111]][[to-start-an-individual-instance-centrally]]
-To Start an Individual Instance Centrally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start an Individual Instance Centrally
Use the `start-instance` subcommand in remote mode to start an
individual instance centrally.
@@ -609,8 +599,7 @@
[[gkqaj]][[GSHAG00112]][[to-stop-an-individual-instance-centrally]]
-To Stop an Individual Instance Centrally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop an Individual Instance Centrally
Use the `stop-instance` subcommand in remote mode to stop an individual
instance centrally.
@@ -655,8 +644,7 @@
[[gkqcc]][[GSHAG00113]][[to-restart-an-individual-instance-centrally]]
-To Restart an Individual Instance Centrally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Restart an Individual Instance Centrally
Use the `restart-instance` subcommand in remote mode to start an
individual instance centrally.
@@ -713,8 +701,7 @@
[[gkqdw]][[GSHAG00188]][[administering-glassfish-server-instances-locally]]
-Administering GlassFish Server Instances Locally
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering GlassFish Server Instances Locally
Local administration does not require DCOM or SSH to be set up. If
neither DCOM nor SSH is set up, you must log in to each host where
@@ -741,8 +728,7 @@
[[gkqbl]][[GSHAG00114]][[to-create-an-instance-locally]]
-To Create an Instance Locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Instance Locally
Use the `create-local-instance` subcommand in remote mode to create a
GlassFish Server instance locally. Creating an instance adds the
@@ -994,8 +980,7 @@
[[gkqed]][[GSHAG00115]][[to-delete-an-instance-locally]]
-To Delete an Instance Locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an Instance Locally
Use the `delete-local-instance` subcommand in remote mode to delete a
GlassFish Server instance locally.
@@ -1094,8 +1079,7 @@
[[gkqak]][[GSHAG00116]][[to-start-an-individual-instance-locally]]
-To Start an Individual Instance Locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start an Individual Instance Locally
Use the `start-local-instance` subcommand in local mode to start an
individual instance locally.
@@ -1159,8 +1143,7 @@
[[gkqci]][[GSHAG00117]][[to-stop-an-individual-instance-locally]]
-To Stop an Individual Instance Locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop an Individual Instance Locally
Use the `stop-local-instance` subcommand in local mode to stop an
individual instance locally.
@@ -1216,8 +1199,7 @@
[[gkqef]][[GSHAG00118]][[to-restart-an-individual-instance-locally]]
-To Restart an Individual Instance Locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Restart an Individual Instance Locally
Use the `restart-local-instance` subcommand in local mode to restart an
individual instance locally.
@@ -1276,8 +1258,7 @@
[[gkrdd]][[GSHAG00189]][[resynchronizing-glassfish-server-instances-and-the-das]]
-Resynchronizing GlassFish Server Instances and the DAS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Resynchronizing GlassFish Server Instances and the DAS
Configuration data for a GlassFish Server instance is stored as follows:
@@ -1294,8 +1275,7 @@
[[gksbo]][[GSHAG00267]][[default-synchronization-for-files-and-directories]]
-Default Synchronization for Files and Directories
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Default Synchronization for Files and Directories
The `--sync` option of the subcommands for starting an instance controls
the type of synchronization between the DAS and the instance's files
@@ -1438,8 +1418,7 @@
[[gksak]][[GSHAG00119]][[to-resynchronize-an-instance-and-the-das-online]]
-To Resynchronize an Instance and the DAS Online
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize an Instance and the DAS Online
Resynchronizing an instance and the DAS updates the instance with
changes to the instance's configuration files on the DAS. An instance is
@@ -1565,8 +1544,7 @@
[[gksav]][[GSHAG00120]][[to-resynchronize-library-files]]
-To Resynchronize Library Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize Library Files
To ensure that library files are resynchronized correctly, you must
ensure that each library file is placed in the correct directory for the
@@ -1626,8 +1604,7 @@
[[gksco]][[GSHAG00121]][[to-resynchronize-custom-configuration-files-for-an-instance]]
-To Resynchronize Custom Configuration Files for an Instance
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize Custom Configuration Files for an Instance
Configuration files in the domain-dir`/config` directory that are
resynchronized are resynchronized for the entire domain. If you create a
@@ -1707,8 +1684,7 @@
[[gkscp]][[GSHAG00122]][[to-resynchronize-users-changes-to-files]]
-To Resynchronize Users' Changes to Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize Users' Changes to Files
A change to the `config/domain.xml` file is required to cause the DAS to
resynchronize instances' files. If other files in the domain directory
@@ -1738,8 +1714,7 @@
[[gksaz]][[GSHAG00123]][[to-resynchronize-additional-configuration-files]]
-To Resynchronize Additional Configuration Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize Additional Configuration Files
By default, GlassFish Server synchronizes only the following
configuration files:
@@ -1800,8 +1775,7 @@
[[gksdj]][[GSHAG00124]][[to-prevent-deletion-of-application-generated-files]]
-To Prevent Deletion of Application-Generated Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Prevent Deletion of Application-Generated Files
When the DAS resynchronizes an instance's files, the DAS deletes from
the instance's cache any files that are not listed for
@@ -1815,8 +1789,7 @@
[[gksdy]][[GSHAG00125]][[to-resynchronize-an-instance-and-the-das-offline]]
-To Resynchronize an Instance and the DAS Offline
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Resynchronize an Instance and the DAS Offline
Resynchronizing an instance and the DAS offline updates the instance's
cache without the need for the instance to be able to communicate with
@@ -1950,8 +1923,7 @@
[[gkqcr]][[GSHAG00190]][[migrating-ejb-timers]]
-Migrating EJB Timers
-~~~~~~~~~~~~~~~~~~~~
+=== Migrating EJB Timers
If a GlassFish Server server instance stops or fails abnormally, it may
be desirable to migrate the EJB timers defined for that stopped server
@@ -1967,8 +1939,7 @@
[[gkvwo]][[GSHAG00126]][[to-enable-automatic-ejb-timer-migration-for-failed-clustered-instances]]
-To Enable Automatic EJB Timer Migration for Failed Clustered Instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable Automatic EJB Timer Migration for Failed Clustered Instances
Automatic migration of EJB timers is enabled by default for clustered
server instances that are stopped normally. If the Group Management
@@ -2007,8 +1978,7 @@
[[abdji]][[GSHAG00127]][[to-migrate-ejb-timers-manually]]
-To Migrate EJB Timers Manually
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Migrate EJB Timers Manually
EJB timers can be migrated manually from a stopped source instance to a
specified target instance in the same cluster if GMS notification is not
diff --git a/docs/ha-administration-guide/src/main/jbake/content/jms.adoc b/docs/ha-administration-guide/src/main/jbake/content/jms.adoc
index 41a0bd8..3cd69d2 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/jms.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/jms.adoc
@@ -5,15 +5,13 @@
prev=session-persistence-and-failover.html
~~~~~~
-Configuring Java Message Service High Availability
-==================================================
+= Configuring Java Message Service High Availability
[[GSHAG00012]][[abdbk]]
[[configuring-java-message-service-high-availability]]
-10 Configuring Java Message Service High Availability
------------------------------------------------------
+== 10 Configuring Java Message Service High Availability
This chapter describes how to configure the high availability features
of the Java Message Service (JMS). It covers how to configure Message
@@ -26,8 +24,7 @@
[[abdbx]][[GSHAG00212]][[using-message-queue-broker-clusters-with-glassfish-server]]
-Using Message Queue Broker Clusters With GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using Message Queue Broker Clusters With GlassFish Server
This section describes how the JMS service uses Message Queue broker
clusters to support high-availability JMS messaging in GlassFish Server
@@ -54,8 +51,7 @@
[[gktgs]][[GSHAG00311]][[about-message-queue-broker-clusters]]
-About Message Queue Broker Clusters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== About Message Queue Broker Clusters
The following discussion provides a brief overview of Message Queue
broker clusters. For complete information, see "link:../../openmq/mq-tech-over/broker-clusters.html#GMTOV00028[Broker
@@ -120,8 +116,7 @@
[[gktft]][[GSHAG00312]][[configuring-glassfish-clusters-to-use-message-queue-broker-clusters]]
-Configuring GlassFish Clusters to Use Message Queue Broker Clusters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring GlassFish Clusters to Use Message Queue Broker Clusters
When a GlassFish Server cluster is created, the JMS service
automatically configures a Message Queue conventional broker cluster
@@ -171,8 +166,7 @@
[[gktge]][[GSHAG00155]][[to-configure-a-glassfish-cluster-to-use-an-embedded-or-local-conventional-broker-cluster-with-master-broker]]
-To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster With Master Broker
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster With Master Broker
Use the `configure-jms-cluster` subcommand in remote `asadmin` mode to
configure a conventional broker cluster with master broker to service a
@@ -224,8 +218,7 @@
[[gktfr]][[GSHAG00156]][[to-configure-a-glassfish-cluster-to-use-an-embedded-or-local-conventional-broker-cluster-of-peer-brokers]]
-To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster of Peer Brokers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster of Peer Brokers
Use the `configure-jms-cluster` subcommand in remote `asadmin` mode to
configure a conventional broker cluster of peer brokers to service a
@@ -287,8 +280,7 @@
[[gkthc]][[GSHAG00157]][[to-change-the-master-broker-in-an-embedded-or-local-broker-cluster]]
-To Change the Master Broker in an Embedded or Local Broker Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change the Master Broker in an Embedded or Local Broker Cluster
Use the `change-master-broker` subcommand in remote `asadmin` mode to
change the master broker to a different broker in a conventional broker
@@ -329,8 +321,7 @@
[[gktgj]][[GSHAG00158]][[to-migrate-between-types-of-embedded-or-local-conventional-broker-clusters]]
-To Migrate Between Types of Embedded or Local Conventional Broker Clusters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Migrate Between Types of Embedded or Local Conventional Broker Clusters
If the need arises to convert from a conventional broker cluster with
master broker to a conventional broker cluster of peer brokers, or the
@@ -339,8 +330,7 @@
[[gktfl]][[GSHAG00159]][[to-configure-a-glassfish-cluster-to-use-a-local-enhanced-broker-cluster]]
-To Configure a GlassFish Cluster to Use a Local Enhanced Broker Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a GlassFish Cluster to Use a Local Enhanced Broker Cluster
Use the `configure-jms-cluster` subcommand in remote `asadmin` mode to
configure an enhanced broker cluster to service a GlassFish Server
@@ -400,8 +390,7 @@
[[abdby]][[GSHAG00160]][[to-configure-a-glassfish-cluster-to-use-a-remote-broker-cluster]]
-To Configure a GlassFish Cluster to Use a Remote Broker Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a GlassFish Cluster to Use a Remote Broker Cluster
[[GSHAG439]]
@@ -446,8 +435,7 @@
[[abdbv]][[GSHAG00213]][[connection-failover]]
-Connection Failover
-~~~~~~~~~~~~~~~~~~~
+=== Connection Failover
The use of Message Queue broker clusters provides JMS connection
failover, including several options that control how connection failures
@@ -536,8 +524,7 @@
[[abdbw]][[GSHAG00214]][[load-balanced-delivery-to-mdbs]]
-Load-Balanced Delivery to MDBs
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Load-Balanced Delivery to MDBs
When a message-driven bean (MDB) application is deployed to a GlassFish
cluster, incoming messages are delivered randomly to MDBs without regard
diff --git a/docs/ha-administration-guide/src/main/jbake/content/loe.adoc b/docs/ha-administration-guide/src/main/jbake/content/loe.adoc
index 71ea9b5..957eeb7 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/loe.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:ssh-setup.html#sthref7[2-1 Creating an Alias for the Windows
User's Password]
diff --git a/docs/ha-administration-guide/src/main/jbake/content/named-configurations.adoc b/docs/ha-administration-guide/src/main/jbake/content/named-configurations.adoc
index ac634d3..297dcb8 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/named-configurations.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/named-configurations.adoc
@@ -5,14 +5,12 @@
prev=instances.html
~~~~~~
-Administering Named Configurations
-==================================
+= Administering Named Configurations
[[GSHAG00007]][[abdjk]]
[[administering-named-configurations]]
-6 Administering Named Configurations
-------------------------------------
+== 6 Administering Named Configurations
A named configuration is a set of configuration information for
GlassFish Server instances and clusters. A configuration sets port
@@ -34,8 +32,7 @@
[[abdjl]][[GSHAG00191]][[about-named-configurations]]
-About Named Configurations
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Named Configurations
Configurations exist in a domain. Multiple GlassFish Server instances or
clusters in the domain can reference the same configuration, or they can
@@ -45,8 +42,7 @@
[[abdjm]][[GSHAG00268]][[types-of-named-configurations]]
-Types of Named Configurations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Types of Named Configurations
Each named configuration is one of the following types of configuration:
@@ -69,8 +65,7 @@
[[abdjn]][[GSHAG00269]][[the-default-config-configuration]]
-The `default-config` Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== The `default-config` Configuration
The `default-config` configuration is a special configuration that acts
as a template for creating named configurations. Clusters and instances
@@ -79,8 +74,7 @@
[[abdjo]][[GSHAG00270]][[automatically-created-configurations]]
-Automatically Created Configurations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Automatically Created Configurations
When you create a cluster or an instance, you can choose whether to
specify an existing configuration that the new cluster or instance will
@@ -108,8 +102,7 @@
[[gdgca]][[GSHAG00271]][[directory-for-configuration-synchronization]]
-Directory for Configuration Synchronization
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Directory for Configuration Synchronization
When a named configuration is created, GlassFish Server creates a
configuration directory on the domain administration server (DAS) at
@@ -125,8 +118,7 @@
[[abdjq]][[GSHAG00192]][[creating-listing-and-deleting-named-configurations]]
-Creating, Listing, and Deleting Named Configurations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Listing, and Deleting Named Configurations
GlassFish Server enables you to create configurations for use by
clusters and instances, obtain information about configurations, and
@@ -141,8 +133,7 @@
[[abdjr]][[GSHAG00128]][[to-create-a-named-configuration]]
-To Create a Named Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Named Configuration
Use the `copy-config` subcommand in remote mode to create a named
configuration by copying an existing configuration.
@@ -220,8 +211,7 @@
[[gkrgg]][[GSHAG00129]][[to-list-the-named-configurations-in-a-domain]]
-To List the Named Configurations in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List the Named Configurations in a Domain
Use the `list-configs` subcommand in remote mode to list existing named
configurations in a domain.
@@ -260,8 +250,7 @@
[[abdju]][[GSHAG00130]][[to-list-the-targets-of-a-named-configuration]]
-To List the Targets of a Named Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List the Targets of a Named Configuration
Use the `list-clusters` subcommand and the `list-instances` subcommand
in remote mode to list the targets of a named configuration.
@@ -322,8 +311,7 @@
[[abdjv]][[GSHAG00131]][[to-delete-a-named-configuration]]
-To Delete a Named Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Named Configuration
Use the `delete-config` subcommand in remote mode to delete an existing
named configuration from the configuration of the DAS.
@@ -421,8 +409,7 @@
[[gkrgf]][[GSHAG00193]][[modifying-properties-for-named-configurations-and-instances]]
-Modifying Properties for Named Configurations and Instances
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Modifying Properties for Named Configurations and Instances
The properties in a named configuration define port numbers for
unclustered instances that reference the configuration or clustered
@@ -439,8 +426,7 @@
[[gkrls]][[GSHAG00272]][[properties-for-port-numbers-in-a-named-configuration]]
-Properties for Port Numbers in a Named Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Properties for Port Numbers in a Named Configuration
The default configuration `default-config` contains properties that
define the initial values of port numbers in a configuration that is
@@ -518,8 +504,7 @@
[[fxxvk]][[GSHAG00132]][[to-modify-a-named-configurations-properties]]
-To Modify a Named Configuration's Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Modify a Named Configuration's Properties
Use the `get` subcommand and the `set` subcommand in remote mode to
modify a named configuration's properties.
@@ -600,8 +585,7 @@
[[abdjt]][[GSHAG00133]][[to-modify-port-numbers-of-an-instance]]
-To Modify Port Numbers of an Instance
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Modify Port Numbers of an Instance
Use the `get` subcommand and the `set` subcommand in remote mode to
modify the port numbers of an instance.
diff --git a/docs/ha-administration-guide/src/main/jbake/content/nodes.adoc b/docs/ha-administration-guide/src/main/jbake/content/nodes.adoc
index 1aa6685..5e1adff 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/nodes.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/nodes.adoc
@@ -5,15 +5,13 @@
prev=ssh-setup.html
~~~~~~
-Administering GlassFish Server Nodes
-====================================
+= Administering GlassFish Server Nodes
[[GSHAG00004]][[gkrle]]
[[administering-glassfish-server-nodes]]
-3 Administering GlassFish Server Nodes
---------------------------------------
+== 3 Administering GlassFish Server Nodes
A node represents a host on which the GlassFish Server software is
installed. A node must exist for every host on which GlassFish Server
@@ -31,8 +29,7 @@
[[gksgh]][[GSHAG00179]][[types-of-glassfish-server-nodes]]
-Types of GlassFish Server Nodes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Types of GlassFish Server Nodes
Each GlassFish Server node is one of the following types of node:
@@ -66,8 +63,7 @@
[[CHDBIHFJ]][[GSHAG463]][[creating-listing-testing-and-deleting-dcom-nodes]]
-Creating, Listing, Testing, and Deleting `DCOM` Nodes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Listing, Testing, and Deleting `DCOM` Nodes
A `DCOM` node supports communication over DCOM. If DCOM is set up and
you plan to administer your GlassFish Server instances centrally, the
@@ -88,8 +84,7 @@
[[CHDIGBJB]][[GSHAG464]][[to-create-a-dcom-node]]
-To Create a `DCOM` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a `DCOM` Node
Use the `create-node-dcom` subcommand in remote mode to create a `DCOM` node.
@@ -182,8 +177,7 @@
[[CHDDCBEG]][[GSHAG469]][[to-list-dcom-nodes-in-a-domain]]
-To List `DCOM` Nodes in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List `DCOM` Nodes in a Domain
Use the `list-nodes-dcom` subcommand in remote mode to obtain
information about existing `DCOM` nodes in a domain.
@@ -252,8 +246,7 @@
[[CHDIFJCC]][[GSHAG473]][[to-test-if-a-dcom-node-is-reachable]]
-To Test if a `DCOM` Node is Reachable
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Test if a `DCOM` Node is Reachable
Use the `ping-node-dcom` subcommand in remote mode to test if a `DCOM`
node is reachable.
@@ -306,8 +299,7 @@
[[CHDCFHBA]][[GSHAG477]][[to-delete-a-dcom-node]]
-To Delete a `DCOM` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a `DCOM` Node
Use the `delete-node-dcom` subcommand in remote mode to delete a `DCOM` node.
@@ -378,8 +370,7 @@
[[gkrkn]][[GSHAG00180]][[creating-listing-testing-and-deleting-ssh-nodes]]
-Creating, Listing, Testing, and Deleting `SSH` Nodes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Listing, Testing, and Deleting `SSH` Nodes
An `SSH` node supports communication over SSH. If SSH is set up and you
plan to administer your GlassFish Server instances centrally, the
@@ -407,8 +398,7 @@
[[gkrnf]][[GSHAG00088]][[to-create-an-ssh-node]]
-To Create an `SSH` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an `SSH` Node
Use the `create-node-ssh` subcommand in remote mode to create an `SSH`
node.
@@ -504,8 +494,7 @@
[[gkrme]][[GSHAG00089]][[to-list-ssh-nodes-in-a-domain]]
-To List `SSH` Nodes in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List `SSH` Nodes in a Domain
Use the `list-nodes-ssh` subcommand in remote mode to obtain information
about existing `SSH` nodes in a domain.
@@ -572,8 +561,7 @@
[[gksig]][[GSHAG00090]][[to-test-if-an-ssh-node-is-reachable]]
-To Test if an `SSH` Node is Reachable
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Test if an `SSH` Node is Reachable
Use the `ping-node-ssh` subcommand in remote mode to test if an `SSH`
node is reachable.
@@ -626,8 +614,7 @@
[[gkrlz]][[GSHAG00091]][[to-delete-an-ssh-node]]
-To Delete an `SSH` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an `SSH` Node
Use the `delete-node-ssh` subcommand in remote mode to delete an `SSH`
node.
@@ -698,8 +685,7 @@
[[gkrnp]][[GSHAG00181]][[creating-listing-and-deleting-config-nodes]]
-Creating, Listing, and Deleting `CONFIG` Nodes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Creating, Listing, and Deleting `CONFIG` Nodes
A `CONFIG` node does not support remote communication. If neither DCOM
nor SSH is set up and you plan to administer your instances locally, the
@@ -718,8 +704,7 @@
[[gkrll]][[GSHAG00092]][[to-create-a-config-node]]
-To Create a `CONFIG` Node
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a `CONFIG` Node
Use the `create-node-config` command in remote mode to create a `CONFIG` node.
@@ -793,8 +778,7 @@
[[gkrjr]][[GSHAG00093]][[to-list-config-nodes-in-a-domain]]
-To List `CONFIG` Nodes in a Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List `CONFIG` Nodes in a Domain
Use the `list-nodes-config` subcommand in remote mode to obtain
information about existing `CONFIG` nodes in a domain.
@@ -865,8 +849,7 @@
[[gkrms]][[GSHAG00094]][[to-delete-a-config-node]]
-To Delete a `CONFIG` Node
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a `CONFIG` Node
Use the `delete-node-config` subcommand in remote mode to delete a
`CONFIG` node.
@@ -935,8 +918,7 @@
[[gksjd]][[GSHAG00182]][[updating-and-changing-the-type-of-a-node]]
-Updating and Changing the Type of a Node
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Updating and Changing the Type of a Node
GlassFish Server enables you to update the configuration data of any
node and to change the type of a node.
@@ -950,8 +932,7 @@
[[CHDHHAAE]][[GSHAG481]][[to-update-a-dcom-node]]
-To Update a `DCOM` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a `DCOM` Node
Use the `update-node-dcom` subcommand in remote mode to update a `DCOM` node.
@@ -1004,8 +985,7 @@
[[gksjq]][[GSHAG00095]][[to-update-an-ssh-node]]
-To Update an `SSH` Node
-^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update an `SSH` Node
Use the `update-node-ssh` subcommand in remote mode to update an `SSH` node.
@@ -1060,8 +1040,7 @@
[[gksjv]][[GSHAG00096]][[to-update-a-config-node]]
-To Update a `CONFIG` Node
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a `CONFIG` Node
Use the `update-node-config` subcommand in remote mode to update a
`CONFIG` node.
@@ -1114,8 +1093,7 @@
[[gkski]][[GSHAG00097]][[to-change-the-type-of-a-node]]
-To Change the Type of a Node
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change the Type of a Node
The subcommands for updating a node can also be used to change the type
of a node.
diff --git a/docs/ha-administration-guide/src/main/jbake/content/overview.adoc b/docs/ha-administration-guide/src/main/jbake/content/overview.adoc
index 02a5ce6..a70785e 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/overview.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/overview.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-High Availability in GlassFish Server
-=====================================
+= High Availability in GlassFish Server
[[GSHAG00002]][[abdaq]]
[[high-availability-in-glassfish-server]]
-1 High Availability in GlassFish Server
----------------------------------------
+== 1 High Availability in GlassFish Server
This chapter describes the high availability features in Eclipse GlassFish Server 7.
@@ -26,8 +24,7 @@
[[abdar]][[GSHAG00168]][[overview-of-high-availability]]
-Overview of High Availability
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Overview of High Availability
High availability applications and services provide their functionality
continuously, regardless of hardware and software failures. To make such
@@ -48,8 +45,7 @@
[[gksdm]][[GSHAG00252]][[load-balancing-with-the-apache-mod_jk-or-mod_proxy_ajp-module]]
-Load Balancing With the Apache `mod_jk` or `mod_proxy_ajp` Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Load Balancing With the Apache `mod_jk` or `mod_proxy_ajp` Module
A common load balancing configuration for GlassFish Server 7 is to use
the Apache HTTP Server as the web server front-end, and the Apache
@@ -62,8 +58,7 @@
[[gaynn]][[GSHAG00253]][[high-availability-session-persistence]]
-High Availability Session Persistence
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== High Availability Session Persistence
GlassFish Server provides high availability of HTTP requests and session
data (both HTTP session data and stateful session bean data).
@@ -91,8 +86,7 @@
[[gayna]][[GSHAG00254]][[high-availability-java-message-service]]
-High Availability Java Message Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== High Availability Java Message Service
GlassFish Server supports the Java Message Service (JMS) API and JMS
messaging through its built-in jmsra resource adapter communicating with
@@ -129,8 +123,7 @@
[[gaymz]][[GSHAG00255]][[rmi-iiop-load-balancing-and-failover]]
-RMI-IIOP Load Balancing and Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== RMI-IIOP Load Balancing and Failover
With RMI-IIOP load balancing, IIOP client requests are distributed to
different server instances or name servers, which spreads the load
@@ -162,8 +155,7 @@
[[gaymr]][[GSHAG00169]][[how-glassfish-server-provides-high-availability]]
-How GlassFish Server Provides High Availability
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== How GlassFish Server Provides High Availability
GlassFish Server provides high availability through the following
subcomponents and features:
@@ -173,8 +165,7 @@
[[gjghv]][[GSHAG00256]][[storage-for-session-state-data]]
-Storage for Session State Data
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Storage for Session State Data
Storing session state data enables the session state to be recovered
after the failover of a server instance in a cluster. Recovering the
@@ -204,8 +195,7 @@
[[abdax]][[GSHAG00257]][[highly-available-clusters]]
-Highly Available Clusters
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Highly Available Clusters
A highly available cluster integrates a state replication service with
clusters and load balancer.
@@ -223,8 +213,7 @@
[[abday]][[GSHAG00218]][[clusters-instances-sessions-and-load-balancing]]
-Clusters, Instances, Sessions, and Load Balancing
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== Clusters, Instances, Sessions, and Load Balancing
Clusters, server instances, load balancers, and sessions are related as
follows:
@@ -253,8 +242,7 @@
[[gktax]][[GSHAG00219]][[protocols-for-centralized-cluster-administration]]
-Protocols for Centralized Cluster Administration
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== Protocols for Centralized Cluster Administration
GlassFish Server uses the Distributed Component Object Model (DCOM)
remote protocol or secure shell (SSH) to ensure that clusters that span
@@ -287,8 +275,7 @@
[[gbcot]][[GSHAG00170]][[recovering-from-failures]]
-Recovering from Failures
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Recovering from Failures
You can use various techniques to manually recover individual
subcomponents after hardware failures such as disk crashes.
@@ -302,8 +289,7 @@
[[gcmkp]][[GSHAG00258]][[recovering-the-domain-administration-server]]
-Recovering the Domain Administration Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Recovering the Domain Administration Server
Loss of the Domain Administration Server (DAS) affects only
administration. GlassFish Server clusters and standalone instances, and
@@ -325,8 +311,7 @@
[[gcmkc]][[GSHAG00259]][[recovering-glassfish-server-instances]]
-Recovering GlassFish Server Instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Recovering GlassFish Server Instances
GlassFish Server provide tools for backing up and restoring GlassFish
Server instances. For more information, see link:instances.html#gksdy[To
@@ -334,8 +319,7 @@
[[gcmjs]][[GSHAG00260]][[recovering-the-http-load-balancer-and-web-server]]
-Recovering the HTTP Load Balancer and Web Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Recovering the HTTP Load Balancer and Web Server
There are no explicit commands to back up only a web server
configuration. Simply zip the web server installation directory. After
@@ -358,8 +342,7 @@
[[gcmjr]][[GSHAG00261]][[recovering-message-queue]]
-Recovering Message Queue
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Recovering Message Queue
When a Message Queue broker becomes unavailable, the method you use to
restore the broker to operation depends on the nature of the failure
@@ -387,8 +370,7 @@
[[glaiv]][[GSHAG00220]][[recovering-from-power-failure-and-failures-other-than-disk-storage]]
-Recovering From Power Failure and Failures Other Than Disk Storage
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Recovering From Power Failure and Failures Other Than Disk Storage
When a host is affected by a power failure or failure of a non-disk
component such as memory, processor or network card, restore Message
@@ -401,8 +383,7 @@
[[glaiu]][[GSHAG00221]][[recovering-from-failure-of-disk-storage]]
-Recovering from Failure of Disk Storage
-+++++++++++++++++++++++++++++++++++++++
+===== Recovering from Failure of Disk Storage
Message Queue uses disk storage for software, configuration files and
persistent data stores. In a default GlassFish installation, all three
@@ -433,8 +414,7 @@
[[abdaz]][[GSHAG00171]][[more-information]]
-More Information
-~~~~~~~~~~~~~~~~
+=== More Information
For information about planning a high-availability deployment, including
assessing hardware requirements, planning network configuration, and
diff --git a/docs/ha-administration-guide/src/main/jbake/content/preface.adoc b/docs/ha-administration-guide/src/main/jbake/content/preface.adoc
index edbd6cc..41355cd 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/preface.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/preface.adoc
@@ -5,15 +5,13 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSHAG00001]][[pref]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -63,8 +61,7 @@
[[oracle-glassfish-server-documentation-set]]
-Oracle GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Oracle GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -166,8 +163,7 @@
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -206,8 +202,7 @@
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -240,8 +235,7 @@
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/ha-administration-guide/src/main/jbake/content/rmi-iiop.adoc b/docs/ha-administration-guide/src/main/jbake/content/rmi-iiop.adoc
index 219658d..82bc467 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/rmi-iiop.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/rmi-iiop.adoc
@@ -4,14 +4,12 @@
prev=jms.html
~~~~~~
-RMI-IIOP Load Balancing and Failover
-====================================
+= RMI-IIOP Load Balancing and Failover
[[GSHAG00013]][[fxxqs]]
[[rmi-iiop-load-balancing-and-failover]]
-11 RMI-IIOP Load Balancing and Failover
----------------------------------------
+== 11 RMI-IIOP Load Balancing and Failover
This chapter describes using high-availability features for remote EJB
references and JNDI objects over RMI-IIOP in GlassFish Server.
@@ -22,8 +20,7 @@
[[abdbe]][[GSHAG00215]][[overview]]
-Overview
-~~~~~~~~
+=== Overview
With RMI-IIOP load balancing, IIOP client requests are distributed to
different server instances or name servers. The goal is to spread the
@@ -38,8 +35,7 @@
[[abdbf]][[GSHAG00313]][[general-requirements-for-configuring-load-balancing]]
-General Requirements for Configuring Load Balancing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== General Requirements for Configuring Load Balancing
Oracle GlassFish Server provides high availability of remote EJB
references and `NameService` objects over RMI-IIOP, provided all the
@@ -64,8 +60,7 @@
[[gknpk]][[GSHAG00314]][[load-balancing-models]]
-Load Balancing Models
-^^^^^^^^^^^^^^^^^^^^^
+==== Load Balancing Models
GlassFish Server supports two general models for load balancing:
@@ -83,8 +78,7 @@
[[gknqo]][[GSHAG00216]][[initialcontext-load-balancing]]
-`InitialContext` Load Balancing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== `InitialContext` Load Balancing
The following topics are addressed here:
@@ -94,8 +88,7 @@
[[gknpn]][[GSHAG00315]][[initialcontext-summary]]
-`InitialContext` Summary
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== `InitialContext` Summary
When `InitialContext` load balancing is used, the client calls the
`InitialContext()` method to create a new `InitialContext` (IC) object
@@ -124,8 +117,7 @@
[[abdbg]][[GSHAG00316]][[initialcontext-algorithm]]
-`InitialContext` Algorithm
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== `InitialContext` Algorithm
GlassFish Server uses a randomization and round-robin algorithm for
RMI-IIOP load balancing and failover.
@@ -160,8 +152,7 @@
[[abdbd]][[GSHAG00317]][[enabling-rmi-iiop-hardware-load-balancing-and-failover]]
-Enabling RMI-IIOP Hardware Load Balancing and Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enabling RMI-IIOP Hardware Load Balancing and Failover
You can enable RMI-IIOP load balancing and failover for applications
running in the application client container (ACC). Weighted round-robin
@@ -169,8 +160,7 @@
[[abdbi]][[GSHAG00161]][[to-enable-rmi-iiop-hardware-load-balancing-for-the-application-client-container]]
-To Enable RMI-IIOP Hardware Load Balancing for the Application Client Container
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Enable RMI-IIOP Hardware Load Balancing for the Application Client Container
This procedure provides an overview of the steps necessary to enable
RMI-IIOP load balancing and failover with the application client
@@ -356,8 +346,7 @@
[[gknpv]][[GSHAG00217]][[per-request-load-balancing-prlb]]
-Per-Request Load Balancing (PRLB)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Per-Request Load Balancing (PRLB)
The following topics are addressed here:
@@ -366,8 +355,7 @@
[[gksgt]][[GSHAG00318]][[prlb-summary]]
-PRLB Summary
-^^^^^^^^^^^^
+==== PRLB Summary
Per Request Load Balancing (PRLB) is a method for load balancing
stateless EJBs that enables load-balancing for each request to an EJB
@@ -391,8 +379,7 @@
[[gksgy]][[GSHAG00319]][[enabling-per-request-load-balancing]]
-Enabling Per-Request Load Balancing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enabling Per-Request Load Balancing
You can enable Per-Request Load Balancing (PRLB) by setting the boolean
`per-request-load-balancing` property to `true` in the
@@ -402,8 +389,7 @@
[[gksgo]][[GSHAG00162]][[to-enable-rmi-iiop-per-request-load-balancing-for-a-stateless-ejb]]
-To Enable RMI-IIOP Per-Request Load Balancing for a Stateless EJB
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Enable RMI-IIOP Per-Request Load Balancing for a Stateless EJB
This procedure describes how to enable PRLB for a stateless EJB that is
deployed to clustered GlassFish Server instances. This procedure also
diff --git a/docs/ha-administration-guide/src/main/jbake/content/rolling-upgrade.adoc b/docs/ha-administration-guide/src/main/jbake/content/rolling-upgrade.adoc
index 3421d6f..b2f56ef 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/rolling-upgrade.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/rolling-upgrade.adoc
@@ -5,15 +5,13 @@
prev=http-load-balancing.html
~~~~~~
-Upgrading Applications Without Loss of Availability
-===================================================
+= Upgrading Applications Without Loss of Availability
[[GSHAG00010]][[abdik]]
[[upgrading-applications-without-loss-of-availability]]
-8 Upgrading Applications Without Loss of Availability
------------------------------------------------------
+== 8 Upgrading Applications Without Loss of Availability
Upgrading an application to a new version without loss of availability
to users is called a rolling upgrade. Carefully managing the two
@@ -57,8 +55,7 @@
[[abdil]][[GSHAG00205]][[application-compatibility]]
-Application Compatibility
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Application Compatibility
Rolling upgrades pose varying degrees of difficulty depending on the
magnitude of changes between the two application versions.
@@ -95,8 +92,7 @@
[[abdim]][[GSHAG00206]][[upgrading-in-a-single-cluster]]
-Upgrading In a Single Cluster
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading In a Single Cluster
You can perform a rolling upgrade of an application deployed to a single
cluster, providing the cluster's configuration is not shared with any
@@ -104,8 +100,7 @@
[[fxxvd]][[GSHAG00151]][[to-upgrade-an-application-in-a-single-cluster]]
-To Upgrade an Application in a Single Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade an Application in a Single Cluster
1. Deploy the upgraded application to the cluster in a disabled state
and with a new version identifier. For example:
@@ -145,13 +140,11 @@
[[abdin]][[GSHAG00207]][[upgrading-in-multiple-clusters]]
-Upgrading in Multiple Clusters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading in Multiple Clusters
[[fxxvb]][[GSHAG00152]][[to-upgrade-a-compatible-application-in-two-or-more-clusters]]
-To Upgrade a Compatible Application in Two or More Clusters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade a Compatible Application in Two or More Clusters
Repeat the following procedure for each cluster.
@@ -194,8 +187,7 @@
[[abdio]][[GSHAG00208]][[upgrading-incompatible-applications]]
-Upgrading Incompatible Applications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading Incompatible Applications
If the new version of the application is incompatible with the old
version, use the following procedure. For information on what makes
@@ -220,8 +212,7 @@
[[abdip]][[GSHAG00153]][[to-upgrade-an-incompatible-application-by-creating-a-second-cluster]]
-To Upgrade an Incompatible Application by Creating a Second Cluster
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade an Incompatible Application by Creating a Second Cluster
1. Create a "shadow cluster" on the same or a different set of machines
as the existing cluster. If you already have a second cluster, skip this
diff --git a/docs/ha-administration-guide/src/main/jbake/content/session-persistence-and-failover.adoc b/docs/ha-administration-guide/src/main/jbake/content/session-persistence-and-failover.adoc
index ca47ad5..1aa4f5b 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/session-persistence-and-failover.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/session-persistence-and-failover.adoc
@@ -5,14 +5,12 @@
prev=rolling-upgrade.html
~~~~~~
-Configuring High Availability Session Persistence and Failover
-==============================================================
+= Configuring High Availability Session Persistence and Failover
[[GSHAG00011]][[abdkz]]
[[configuring-high-availability-session-persistence-and-failover]]
-9 Configuring High Availability Session Persistence and Failover
-----------------------------------------------------------------
+== 9 Configuring High Availability Session Persistence and Failover
This chapter explains how to enable and configure high availability
session persistence.
@@ -23,8 +21,7 @@
[[abdla]][[GSHAG00209]][[overview-of-session-persistence-and-failover]]
-Overview of Session Persistence and Failover
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Overview of Session Persistence and Failover
GlassFish Server provides high availability session persistence through
failover of HTTP session data and stateful session bean (SFSB) session
@@ -55,8 +52,7 @@
[[abdlb]][[GSHAG00300]][[requirements]]
-Requirements
-^^^^^^^^^^^^
+==== Requirements
A distributed session can run in multiple Oracle GlassFish Server
instances, if:
@@ -103,8 +99,7 @@
[[abdlc]][[GSHAG00301]][[restrictions]]
-Restrictions
-^^^^^^^^^^^^
+==== Restrictions
When configuring session persistence and failover, note the following restrictions:
@@ -188,8 +183,7 @@
[[abdle]][[GSHAG00210]][[enabling-the-high-availability-session-persistence-service]]
-Enabling the High Availability Session Persistence Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Enabling the High Availability Session Persistence Service
This section explains how to configure and enable the high availability
session persistence service.
@@ -202,8 +196,7 @@
[[abdlf]][[GSHAG00154]][[to-enable-availability-for-a-cluster-standalone-instance-or-container]]
-To Enable Availability for a Cluster, Standalone Instance or Container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable Availability for a Cluster, Standalone Instance or Container
This procedure explains how to enable high availability for a cluster as
a whole, or for Web, EJB, or JMS containers that run in a cluster, or
@@ -322,8 +315,7 @@
[[abdll]][[GSHAG00303]][[configuring-availability-for-individual-web-applications]]
-Configuring Availability for Individual Web Applications
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Availability for Individual Web Applications
To enable and configure availability for an individual web application,
edit the application deployment descriptor file, `glassfish-web.xml`.
@@ -336,8 +328,7 @@
[[abdlm]][[GSHAG00247]][[example]]
-Example
-+++++++
+===== Example
[source,xml]
----
@@ -356,9 +347,7 @@
[[gkwqu]][[GSHAG00304]][[configuring-replication-and-multi-threaded-concurrent-access-to-httpsessions]]
-Configuring Replication and Multi-Threaded Concurrent Access to
-`HttpSessions`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Replication and Multi-Threaded Concurrent Access to `HttpSessions`
If you are using Memory Replication and your web application involves
multiple client threads concurrently accessing the same session ID, then
@@ -387,8 +376,7 @@
[[gkwrj]][[GSHAG00248]][[example-1]]
-Example
-+++++++
+===== Example
The following is an example snippet from a `glassfish-web.xml` file that
illustrates where to add the `relaxVersionSemantics` property.
@@ -410,8 +398,7 @@
[[abdln]][[GSHAG00305]][[using-single-sign-on-with-session-failover]]
-Using Single Sign-on with Session Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Single Sign-on with Session Failover
In a single application server instance, once a user is authenticated by
an application, the user is not required to re-authenticate individually
@@ -440,8 +427,7 @@
[[abdlo]][[GSHAG00249]][[single-sign-on-groups]]
-Single Sign-On Groups
-+++++++++++++++++++++
+===== Single Sign-On Groups
Applications that can be accessed through a single name and password
combination constitute a single sign-on group. For HTTP sessions
@@ -487,8 +473,7 @@
[[gkyyl]][[GSHAG00306]][[using-coherenceweb-for-http-session-persistence]]
-Using Coherence*Web for HTTP Session Persistence
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Coherence*Web for HTTP Session Persistence
Built on top of Oracle Coherence, Coherence*Web is an HTTP session
management module dedicated to managing session state in clustered
@@ -507,8 +492,7 @@
[[abdlp]][[GSHAG00211]][[stateful-session-bean-failover]]
-Stateful Session Bean Failover
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Stateful Session Bean Failover
Stateful session beans (SFSBs) contain client-specific state. There is a
one-to-one relationship between clients and the stateful session beans.
@@ -549,8 +533,7 @@
[[abdlq]][[GSHAG00307]][[configuring-availability-for-the-ejb-container]]
-Configuring Availability for the EJB Container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Availability for the EJB Container
To enable availability for the EJB container use the `asadmin set`
command to set the following three properties for the configuration:
@@ -583,8 +566,7 @@
[[abdls]][[GSHAG00250]][[configuring-the-sfsb-session-store-when-availability-is-disabled]]
-Configuring the SFSB Session Store When Availability Is Disabled
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configuring the SFSB Session Store When Availability Is Disabled
If availability is disabled, the local file system is used for SFSB
state passivation, but not persistence. To change where the SFSB state
@@ -594,8 +576,7 @@
[[abdlt]][[GSHAG00308]][[configuring-availability-for-an-individual-application-or-ejb-module]]
-Configuring Availability for an Individual Application or EJB Module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Availability for an Individual Application or EJB Module
You can enable SFSB availability for an individual application or EJB
module during deployment:
@@ -609,8 +590,7 @@
[[abdlu]][[GSHAG00309]][[configuring-availability-for-an-individual-bean]]
-Configuring Availability for an Individual Bean
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configuring Availability for an Individual Bean
To enable availability and select methods to be checkpointed for an
individual SFSB, use the `glassfish-ejb-jar.xml` deployment descriptor
@@ -639,8 +619,7 @@
[[abdlw]][[GSHAG00310]][[specifying-methods-to-be-checkpointed]]
-Specifying Methods to Be Checkpointed
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Specifying Methods to Be Checkpointed
If enabled, checkpointing generally occurs after the bean completes any
transaction, even if the transaction rolls back. To specify additional
diff --git a/docs/ha-administration-guide/src/main/jbake/content/ssh-setup.adoc b/docs/ha-administration-guide/src/main/jbake/content/ssh-setup.adoc
index 0fb21c3..d51258a 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/ssh-setup.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/ssh-setup.adoc
@@ -5,15 +5,13 @@
prev=overview.html
~~~~~~
-Enabling Centralized Administration of GlassFish Server Instances
-=================================================================
+= Enabling Centralized Administration of GlassFish Server Instances
[[GSHAG00003]][[gkshg]]
[[enabling-centralized-administration-of-glassfish-server-instances]]
-2 Enabling Centralized Administration of GlassFish Server Instances
--------------------------------------------------------------------
+== 2 Enabling Centralized Administration of GlassFish Server Instances
GlassFish Server uses the Distributed Component Object Model (DCOM)
remote protocol or secure shell (SSH) to ensure that clusters that span
@@ -54,8 +52,7 @@
[[gkshz]][[GSHAG00172]][[about-centralized-administration-of-glassfish-server-instances]]
-About Centralized Administration of GlassFish Server Instances
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Centralized Administration of GlassFish Server Instances
The use of DCOM or SSH to enable centralized administration of remote
instances is optional and is required only for specific operations.
@@ -67,8 +64,7 @@
[[determining-whether-to-enable-centralized-administration]]
-Determining Whether to Enable Centralized Administration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Determining Whether to Enable Centralized Administration
Before setting up a GlassFish Server cluster, use the following
considerations to determine whether to enable centralized administration
@@ -111,8 +107,7 @@
[[considerations-for-using-dcom-for-centralized-administration]]
-Considerations for Using DCOM for Centralized Administration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Considerations for Using DCOM for Centralized Administration
DCOM enables communications between Windows hosts. In a typical
GlassFish Server deployment, the DAS acts as a DCOM client, and hosts
@@ -142,8 +137,7 @@
[[considerations-for-using-ssh-for-centralized-administration]]
-Considerations for Using SSH for Centralized Administration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Considerations for Using SSH for Centralized Administration
In a typical GlassFish Server deployment, the DAS acts as the SSH
client, and hosts where instances reside act as SSH servers. The SSH
@@ -164,8 +158,7 @@
[[gksmt]][[GSHAG00262]][[obtaining-ssh-software]]
-Obtaining SSH Software
-++++++++++++++++++++++
+===== Obtaining SSH Software
On UNIX and Linux systems, SSH software is typically installed as part
of the base operating system.
@@ -178,8 +171,7 @@
[[gkshj]][[GSHAG00263]][[determining-the-ssh-user]]
-Determining the SSH User
-++++++++++++++++++++++++
+===== Determining the SSH User
Before setting up SSH, decide which SSH user GlassFish Server will use
when connecting to remote hosts. For the following reasons,
@@ -194,8 +186,7 @@
[[glghe]][[GSHAG00222]][[requirements-for-the-ssh-users-environment]]
-Requirements for the SSH User's Environment
-+++++++++++++++++++++++++++++++++++++++++++
+===== Requirements for the SSH User's Environment
The environment of the SSH user on any remote host to which the user
will connect must meet the requirements that are stated in
@@ -216,8 +207,7 @@
[[glgfy]][[GSHAG00223]][[file-access-permissions-on-uac-enabled-windows-systems]]
-File Access Permissions on UAC-Enabled Windows Systems
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== File Access Permissions on UAC-Enabled Windows Systems
[NOTE]
@@ -240,8 +230,7 @@
[[CEGIFJJF]][[GSHAG448]][[setting-up-dcom-and-testing-the-dcom-set-up]]
-Setting Up DCOM and Testing the DCOM Set Up
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up DCOM and Testing the DCOM Set Up
Setting up DCOM on a host involves the following tasks:
@@ -256,8 +245,7 @@
[[CEGDAFHD]][[GSHAG449]][[windows-operating-system-settings]]
-Windows Operating System Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Windows Operating System Settings
To enable access to a host over DCOM, ensure that the following items in
the Windows operating system are set as follows on the host:
@@ -275,8 +263,7 @@
[[CEGCJGCF]][[GSHAG450]][[to-enable-the-windows-user-to-run-scripts-on-a-remote-host]]
-To Enable the Windows User to Run Scripts on a Remote Host
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable the Windows User to Run Scripts on a Remote Host
To run scripts on a remote host, full control over the following Windows
registry keys must be allowed for the Windows user or the group that
@@ -352,8 +339,7 @@
[[CEGCDCEF]][[GSHAG452]][[to-set-up-password-authentication-for-the-windows-user]]
-To Set Up Password Authentication for the Windows User
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up Password Authentication for the Windows User
When a GlassFish Server subcommand uses DCOM to log in to a remote host,
GlassFish Server requires the Windows user's password to authenticate
@@ -465,8 +451,7 @@
[[CEGJFADH]][[GSHAG457]][[to-test-the-connection-over-dcom-to-a-remote-host]]
-To Test the Connection Over DCOM to a Remote Host
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Test the Connection Over DCOM to a Remote Host
Testing the connection over DCOM to a remote host verifies that the
required Windows services are running, the required ports are open, and
@@ -554,8 +539,7 @@
[[gksiy]][[GSHAG00173]][[setting-up-cygwin-ssh-on-windows]]
-Setting Up Cygwin SSH on Windows
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up Cygwin SSH on Windows
Set up Cygwin SSH on the DAS host and on all hosts where instances in
your cluster will reside.
@@ -570,8 +554,7 @@
[[gksjn]][[GSHAG00071]][[to-download-and-install-cygwin]]
-To Download and Install Cygwin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Download and Install Cygwin
For centralized GlassFish Server administration, a basic Cygwin
installation that includes the SSH client and the SSH server daemon
@@ -625,8 +608,7 @@
[[gksin]][[GSHAG00072]][[to-set-the-path-for-windows-and-for-the-cygwin-shell]]
-To Set the Path for Windows and for the Cygwin Shell
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set the Path for Windows and for the Cygwin Shell
To enable GlassFish Server tools to find commands for SSH, each user's
path for Windows and for the Cygwin shell must contain the following directories:
@@ -648,8 +630,7 @@
[[gksov]][[GSHAG00073]][[to-set-the-home-directory-for-the-cygwin-ssh-user]]
-To Set the Home Directory for the Cygwin SSH User
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set the Home Directory for the Cygwin SSH User
The SSH Server Daemon `sshd` locates a user's home directory from the
configuration in the user database, not from environment variables such
@@ -677,8 +658,7 @@
[[gkskx]][[GSHAG00074]][[to-configure-and-start-the-cygwin-ssh-server-daemon-sshd]]
-To Configure and Start the Cygwin SSH Server Daemon `sshd`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure and Start the Cygwin SSH Server Daemon `sshd`
[[GSHAG322]]
@@ -754,8 +734,7 @@
[[gkskf]][[GSHAG00174]][[setting-up-the-mks-toolkit-on-windows]]
-Setting Up the MKS Toolkit on Windows
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up the MKS Toolkit on Windows
Set up the MKS Toolkit on the DAS host and on all hosts where instances
in your cluster will reside.
@@ -770,8 +749,7 @@
[[gksmq]][[GSHAG00075]][[to-install-the-mks-toolkit]]
-To Install the MKS Toolkit
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Install the MKS Toolkit
For centralized GlassFish Server administration, the default
installation of the MKS Toolkit is sufficient.
@@ -790,8 +768,7 @@
[[gksmu]][[GSHAG00076]][[to-set-the-path-for-windows-and-for-the-mks-toolkit-shell]]
-To Set the Path for Windows and for the MKS Toolkit Shell
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set the Path for Windows and for the MKS Toolkit Shell
To enable GlassFish Server tools to find commands for SSH, each user's
path for Windows and for the MKS Toolkit shell must contain the
@@ -816,8 +793,7 @@
[[gksox]][[GSHAG00077]][[to-set-the-home-directory-for-the-mks-toolkit-ssh-user]]
-To Set the Home Directory for the MKS Toolkit SSH User
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set the Home Directory for the MKS Toolkit SSH User
The SSH Server Daemon `sshd` locates a user's home directory from the
configuration in the user database, not from environment variables such
@@ -919,8 +895,7 @@
[[gksnx]][[GSHAG00078]][[to-configure-and-start-the-mks-toolkit-ssh-server-daemon-sshd]]
-To Configure and Start the MKS Toolkit SSH Server Daemon `sshd`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure and Start the MKS Toolkit SSH Server Daemon `sshd`
[NOTE]
@@ -976,8 +951,7 @@
[[gksja]][[GSHAG00175]][[setting-up-ssh-on-unix-and-linux-systems]]
-Setting Up SSH on UNIX and Linux Systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up SSH on UNIX and Linux Systems
Setting up SSH on UNIX and Linux systems involves verifying that the SSH
server daemon `sshd` is running and, if necessary, starting this daemon.
@@ -999,8 +973,7 @@
[[gksjx]][[GSHAG00079]][[to-set-up-ssh-on-oracle-solaris-systems]]
-To Set Up SSH on Oracle Solaris Systems
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up SSH on Oracle Solaris Systems
1. Ensure that the following options in the configuration file
`/etc/ssh/sshd_config` are set to `yes`:
@@ -1050,8 +1023,7 @@
[[gkspz]][[GSHAG00080]][[to-set-up-ssh-on-macos-systems]]
-To Set Up SSH on MacOS Systems
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up SSH on MacOS Systems
1. Open System Preferences and click Sharing. +
The Sharing window opens.
@@ -1092,8 +1064,7 @@
[[gksrd]][[GSHAG00081]][[to-set-up-ssh-on-linux-systems]]
-To Set Up SSH on Linux systems
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up SSH on Linux systems
1. Ensure that the following options in the configuration file
`/etc/ssh/sshd_config` are set to `yes`:
@@ -1136,8 +1107,7 @@
[[gkslw]][[GSHAG00176]][[testing-the-ssh-setup-on-a-host]]
-Testing the SSH Setup on a Host
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Testing the SSH Setup on a Host
After setting up SSH on a host, test the setup to ensure that you can
use SSH to contact the host from another host. Testing the SSH setup on
@@ -1149,8 +1119,7 @@
[[gkskk]][[GSHAG00082]][[to-test-the-ssh-setup-on-a-host]]
-To Test the SSH Setup on a Host
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Test the SSH Setup on a Host
1. From another host, use SSH to log in into the host that you are
testing as the SSH user.
@@ -1205,8 +1174,7 @@
[[gkshh]][[GSHAG00177]][[setting-up-ssh-user-authentication]]
-Setting Up SSH User Authentication
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Setting Up SSH User Authentication
When a GlassFish Server subcommand uses SSH to log in to a remote host,
GlassFish Server must be able to authenticate the SSH user. Setting up
@@ -1249,8 +1217,7 @@
[[gksqe]][[GSHAG00083]][[to-set-up-public-key-authentication-without-encryption]]
-To Set Up Public Key Authentication Without Encryption
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up Public Key Authentication Without Encryption
Use the `setup-ssh` subcommand in local mode to set up public key
authentication without encryption. This subcommand enables you to set up
@@ -1382,8 +1349,7 @@
[[gktaq]][[GSHAG00084]][[to-set-up-encrypted-public-key-authentication]]
-To Set Up Encrypted Public Key Authentication
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up Encrypted Public Key Authentication
Encrypted key file authentication uses an encrypted private key file
that is protected with a passphrase. This passphrase must be provided to
@@ -1610,8 +1576,7 @@
[[gktbd]][[GSHAG00085]][[to-set-up-password-authentication]]
-To Set Up Password Authentication
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set Up Password Authentication
To use SSH to log in to a remote host, GlassFish Server requires the SSH
user's password. To provide this password securely to GlassFish Server,
@@ -1709,8 +1674,7 @@
[[gkshn]][[GSHAG00178]][[installing-and-removing-glassfish-server-software-on-multiple-hosts]]
-Installing and Removing GlassFish Server Software on Multiple Hosts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installing and Removing GlassFish Server Software on Multiple Hosts
GlassFish Server software must be installed on all hosts where GlassFish
Server will run. How to install GlassFish Server software on multiple
@@ -1736,8 +1700,7 @@
[[gksil]][[GSHAG00086]][[to-copy-a-glassfish-server-installation-to-multiple-hosts]]
-To Copy a GlassFish Server Installation to Multiple Hosts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Copy a GlassFish Server Installation to Multiple Hosts
Use the `install-node-dcom` subcommand or the `install-node-ssh`
subcommand in local mode to copy an installation of GlassFish Server
@@ -1873,8 +1836,7 @@
[[gktaw]][[GSHAG00087]][[to-remove-glassfish-server-software-from-multiple-hosts]]
-To Remove GlassFish Server Software From Multiple Hosts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Remove GlassFish Server Software From Multiple Hosts
Use the `uninstall-node-dcom` subcommand or the `uninstall-node-ssh`
subcommand in local mode to remove GlassFish Server software from
diff --git a/docs/ha-administration-guide/src/main/jbake/content/title.adoc b/docs/ha-administration-guide/src/main/jbake/content/title.adoc
index d0773ee..935d06a 100644
--- a/docs/ha-administration-guide/src/main/jbake/content/title.adoc
+++ b/docs/ha-administration-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-Eclipse GlassFish Server High Availability Administration Guide, Release 7
-==========================================================================
+= Eclipse GlassFish Server High Availability Administration Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
High Availability Administration Guide
diff --git a/docs/ha-administration-guide/src/main/jbake/content/toc.adoc b/docs/ha-administration-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..235aa03
--- /dev/null
+++ b/docs/ha-administration-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,232 @@
+type=page
+status=published
+title=Eclipse GlassFish Server High Availability Administration Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server High Availability Administration Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSHAG00001[Preface]
+
+** link:preface.html#GSHAG00163[Oracle GlassFish Server Documentation Set]
+** link:preface.html#GSHAG00165[Typographic Conventions]
+** link:preface.html#GSHAG00166[Symbol Conventions]
+** link:preface.html#GSHAG00164[Default Paths and File Names]
+
+[[high-availability-in-glassfish-server]]
+=== link:overview.html#GSHAG00002[1 High Availability in GlassFish Server]
+
+** link:overview.html#GSHAG00168[Overview of High Availability]
+*** link:overview.html#GSHAG00252[Load Balancing With the Apache `mod_jk` or `mod_proxy_ajp` Module]
+*** link:overview.html#GSHAG00253[High Availability Session Persistence]
+*** link:overview.html#GSHAG00254[High Availability Java Message Service]
+*** link:overview.html#GSHAG00255[RMI-IIOP Load Balancing and Failover]
+** link:overview.html#GSHAG00169[How GlassFish Server Provides High Availability]
+*** link:overview.html#GSHAG00256[Storage for Session State Data]
+*** link:overview.html#GSHAG00257[Highly Available Clusters]
+** link:overview.html#GSHAG00170[Recovering from Failures]
+*** link:overview.html#GSHAG00258[Recovering the Domain Administration Server]
+*** link:overview.html#GSHAG00259[Recovering GlassFish Server Instances]
+*** link:overview.html#GSHAG00260[Recovering the HTTP Load Balancer and Web Server]
+*** link:overview.html#GSHAG00261[Recovering Message Queue]
+** link:overview.html#GSHAG00171[More Information]
+
+[[enabling-centralized-administration-of-glassfish-server-instances]]
+=== link:ssh-setup.html#GSHAG00003[2 Enabling Centralized Administration of GlassFish Server Instances]
+
+** link:ssh-setup.html#GSHAG00172[About Centralized Administration of GlassFish Server Instances]
+*** link:ssh-setup.html#GSHAG446[Determining Whether to Enable Centralized Administration]
+*** link:ssh-setup.html#GSHAG447[Considerations for Using DCOM for Centralized Administration]
+*** link:ssh-setup.html#GSHAG320[Considerations for Using SSH for Centralized Administration]
+** link:ssh-setup.html#GSHAG448[Setting Up DCOM and Testing the DCOM Set Up]
+*** link:ssh-setup.html#GSHAG449[Windows Operating System Settings]
+*** link:ssh-setup.html#GSHAG450[To Enable the Windows User to Run Scripts on a Remote Host]
+*** link:ssh-setup.html#GSHAG452[To Set Up Password Authentication for the Windows User]
+*** link:ssh-setup.html#GSHAG457[To Test the Connection Over DCOM to a Remote Host]
+** link:ssh-setup.html#GSHAG00173[Setting Up Cygwin SSH on Windows]
+*** link:ssh-setup.html#GSHAG00071[To Download and Install Cygwin]
+*** link:ssh-setup.html#GSHAG00072[To Set the Path for Windows and for the Cygwin Shell]
+*** link:ssh-setup.html#GSHAG00073[To Set the Home Directory for the Cygwin SSH User]
+*** link:ssh-setup.html#GSHAG00074[To Configure and Start the Cygwin SSH Server Daemon `sshd`]
+** link:ssh-setup.html#GSHAG00174[Setting Up the MKS Toolkit on Windows]
+*** link:ssh-setup.html#GSHAG00075[To Install the MKS Toolkit]
+*** link:ssh-setup.html#GSHAG00076[To Set the Path for Windows and for the MKS Toolkit Shell]
+*** link:ssh-setup.html#GSHAG00077[To Set the Home Directory for the MKS Toolkit SSH User]
+*** link:ssh-setup.html#GSHAG00078[To Configure and Start the MKS Toolkit SSH Server Daemon `sshd`]
+** link:ssh-setup.html#GSHAG00175[Setting Up SSH on UNIX and Linux Systems]
+*** link:ssh-setup.html#GSHAG00079[To Set Up SSH on Oracle Solaris Systems]
+*** link:ssh-setup.html#GSHAG00080[To Set Up SSH on MacOS Systems]
+*** link:ssh-setup.html#GSHAG00081[To Set Up SSH on Linux systems]
+** link:ssh-setup.html#GSHAG00176[Testing the SSH Setup on a Host]
+*** link:ssh-setup.html#GSHAG00082[To Test the SSH Setup on a Host]
+** link:ssh-setup.html#GSHAG00177[Setting Up SSH User Authentication]
+*** link:ssh-setup.html#GSHAG00083[To Set Up Public Key Authentication Without Encryption]
+*** link:ssh-setup.html#GSHAG00084[To Set Up Encrypted Public Key Authentication]
+*** link:ssh-setup.html#GSHAG00085[To Set Up Password Authentication]
+** link:ssh-setup.html#GSHAG00178[Installing and Removing GlassFish Server Software on Multiple Hosts]
+*** link:ssh-setup.html#GSHAG00086[To Copy a GlassFish Server Installation to Multiple Hosts]
+*** link:ssh-setup.html#GSHAG00087[To Remove GlassFish Server Software From Multiple Hosts]
+
+[[administering-glassfish-server-nodes]]
+=== link:nodes.html#GSHAG00004[3 Administering GlassFish Server Nodes]
+
+** link:nodes.html#GSHAG00179[Types of GlassFish Server Nodes]
+** link:nodes.html#GSHAG463[Creating, Listing, Testing, and Deleting `DCOM` Nodes]
+*** link:nodes.html#GSHAG464[To Create a `DCOM` Node]
+*** link:nodes.html#GSHAG469[To List `DCOM` Nodes in a Domain]
+*** link:nodes.html#GSHAG473[To Test if a `DCOM` Node is Reachable]
+*** link:nodes.html#GSHAG477[To Delete a `DCOM` Node]
+** link:nodes.html#GSHAG00180[Creating, Listing, Testing, and Deleting `SSH` Nodes]
+*** link:nodes.html#GSHAG00088[To Create an `SSH` Node]
+*** link:nodes.html#GSHAG00089[To List `SSH` Nodes in a Domain]
+*** link:nodes.html#GSHAG00090[To Test if an `SSH` Node is Reachable]
+*** link:nodes.html#GSHAG00091[To Delete an `SSH` Node]
+** link:nodes.html#GSHAG00181[Creating, Listing, and Deleting `CONFIG` Nodes]
+*** link:nodes.html#GSHAG00092[To Create a `CONFIG` Node]
+*** link:nodes.html#GSHAG00093[To List `CONFIG` Nodes in a Domain]
+*** link:nodes.html#GSHAG00094[To Delete a `CONFIG` Node]
+** link:nodes.html#GSHAG00182[Updating and Changing the Type of a Node]
+*** link:nodes.html#GSHAG481[To Update a `DCOM` Node]
+*** link:nodes.html#GSHAG00095[To Update an `SSH` Node]
+*** link:nodes.html#GSHAG00096[To Update a `CONFIG` Node]
+*** link:nodes.html#GSHAG00097[To Change the Type of a Node]
+
+[[administering-glassfish-server-clusters]]
+=== link:clusters.html#GSHAG00005[4 Administering GlassFish Server Clusters]
+
+** link:clusters.html#GSHAG00183[About GlassFish Server Clusters]
+** link:clusters.html#GSHAG00184[Group Management Service]
+*** link:clusters.html#GSHAG485[Protocols and Transports for GMS]
+*** link:clusters.html#GSHAG00264[GMS Configuration Settings]
+*** link:clusters.html#GSHAG00265[Dotted Names for GMS Settings]
+*** link:clusters.html#GSHAG00098[To Preconfigure Nondefault GMS Configuration Settings]
+*** link:clusters.html#GSHAG00099[To Change GMS Settings After Cluster Creation]
+*** link:clusters.html#GSHAG00100[To Check the Health of Instances in a Cluster]
+*** link:clusters.html#GSHAG00101[To Validate That Multicast Transport Is Available for a Cluster]
+*** link:clusters.html#GSHAG00373[Discovering a Cluster When Multicast Transport Is Unavailable]
+*** link:clusters.html#GSHAG00266[Using the Multi-Homing Feature With GMS]
+** link:clusters.html#GSHAG00185[Creating, Listing, and Deleting Clusters]
+*** link:clusters.html#GSHAG00103[To Create a Cluster]
+*** link:clusters.html#GSHAG00104[To List All Clusters in a Domain]
+*** link:clusters.html#GSHAG00105[To Delete a Cluster]
+
+[[administering-glassfish-server-instances]]
+=== link:instances.html#GSHAG00006[5 Administering GlassFish Server Instances]
+
+** link:instances.html#GSHAG00186[Types of GlassFish Server Instances]
+** link:instances.html#GSHAG00187[Administering GlassFish Server Instances Centrally]
+*** link:instances.html#GSHAG00106[To Create an Instance Centrally]
+*** link:instances.html#GSHAG00107[To List All Instances in a Domain]
+*** link:instances.html#GSHAG00108[To Delete an Instance Centrally]
+*** link:instances.html#GSHAG00109[To Start a Cluster]
+*** link:instances.html#GSHAG00110[To Stop a Cluster]
+*** link:instances.html#GSHAG00111[To Start an Individual Instance Centrally]
+*** link:instances.html#GSHAG00112[To Stop an Individual Instance Centrally]
+*** link:instances.html#GSHAG00113[To Restart an Individual Instance Centrally]
+** link:instances.html#GSHAG00188[Administering GlassFish Server Instances Locally]
+*** link:instances.html#GSHAG00114[To Create an Instance Locally]
+*** link:instances.html#GSHAG00115[To Delete an Instance Locally]
+*** link:instances.html#GSHAG00116[To Start an Individual Instance Locally]
+*** link:instances.html#GSHAG00117[To Stop an Individual Instance Locally]
+*** link:instances.html#GSHAG00118[To Restart an Individual Instance Locally]
+** link:instances.html#GSHAG00189[Resynchronizing GlassFish Server Instances and the DAS]
+*** link:instances.html#GSHAG00267[Default Synchronization for Files and Directories]
+*** link:instances.html#GSHAG00119[To Resynchronize an Instance and the DAS Online]
+*** link:instances.html#GSHAG00120[To Resynchronize Library Files]
+*** link:instances.html#GSHAG00121[To Resynchronize Custom Configuration Files for an Instance]
+*** link:instances.html#GSHAG00122[To Resynchronize Users' Changes to Files]
+*** link:instances.html#GSHAG00123[To Resynchronize Additional Configuration Files]
+*** link:instances.html#GSHAG00124[To Prevent Deletion of Application-Generated Files]
+*** link:instances.html#GSHAG00125[To Resynchronize an Instance and the DAS Offline]
+** link:instances.html#GSHAG00190[Migrating EJB Timers]
+*** link:instances.html#GSHAG00126[To Enable Automatic EJB Timer Migration for Failed Clustered Instances]
+*** link:instances.html#GSHAG00127[To Migrate EJB Timers Manually]
+
+[[administering-named-configurations]]
+=== link:named-configurations.html#GSHAG00007[6 Administering Named Configurations]
+
+** link:named-configurations.html#GSHAG00191[About Named Configurations]
+*** link:named-configurations.html#GSHAG00268[Types of Named Configurations]
+*** link:named-configurations.html#GSHAG00269[The `default-config` Configuration]
+*** link:named-configurations.html#GSHAG00270[Automatically Created Configurations]
+*** link:named-configurations.html#GSHAG00271[Directory for Configuration Synchronization]
+** link:named-configurations.html#GSHAG00192[Creating, Listing, and Deleting Named Configurations]
+*** link:named-configurations.html#GSHAG00128[To Create a Named Configuration]
+*** link:named-configurations.html#GSHAG00129[To List the Named Configurations in a Domain]
+*** link:named-configurations.html#GSHAG00130[To List the Targets of a Named Configuration]
+*** link:named-configurations.html#GSHAG00131[To Delete a Named Configuration]
+** link:named-configurations.html#GSHAG00193[Modifying Properties for Named Configurations and Instances]
+*** link:named-configurations.html#GSHAG00272[Properties for Port Numbers in a Named Configuration]
+*** link:named-configurations.html#GSHAG00132[To Modify a Named Configuration's Properties]
+*** link:named-configurations.html#GSHAG00133[To Modify Port Numbers of an Instance]
+
+[[configuring-http-load-balancing]]
+=== link:http-load-balancing.html#GSHAG00009[7 Configuring HTTP Load Balancing]
+
+** link:http-load-balancing.html#GSHAG00202[Setting Up HTTP Load Balancing]
+*** link:http-load-balancing.html#GSHAG00281[Prerequisites for Setting Up HTTP Load Balancing]
+*** link:http-load-balancing.html#GSHAG00282[Configuring GlassFish Server with Apache HTTP Server and `mod_jk`]
+*** link:http-load-balancing.html#GSHAG494[Configuring GlassFish Server with Apache HTTP Server and `mod_proxy_ajp`]
+*** link:http-load-balancing.html#GSHAG00284[HTTP Load Balancer Deployments]
+
+[[upgrading-applications-without-loss-of-availability]]
+=== link:rolling-upgrade.html#GSHAG00010[8 Upgrading Applications Without Loss of Availability]
+
+** link:rolling-upgrade.html#GSHAG00205[Application Compatibility]
+** link:rolling-upgrade.html#GSHAG00206[Upgrading In a Single Cluster]
+*** link:rolling-upgrade.html#GSHAG00151[To Upgrade an Application in a Single Cluster]
+** link:rolling-upgrade.html#GSHAG00207[Upgrading in Multiple Clusters]
+*** link:rolling-upgrade.html#GSHAG00152[To Upgrade a Compatible Application in Two or More Clusters]
+** link:rolling-upgrade.html#GSHAG00208[Upgrading Incompatible Applications]
+*** link:rolling-upgrade.html#GSHAG00153[To Upgrade an Incompatible Application by Creating a Second Cluster]
+
+[[configuring-high-availability-session-persistence-and-failover]]
+=== link:session-persistence-and-failover.html#GSHAG00011[9 Configuring High Availability Session Persistence and Failover]
+
+** link:session-persistence-and-failover.html#GSHAG00209[Overview of Session Persistence and Failover]
+*** link:session-persistence-and-failover.html#GSHAG00300[Requirements]
+*** link:session-persistence-and-failover.html#GSHAG00301[Restrictions]
+*** link:session-persistence-and-failover.html#GSHAG00302[Scope]
+** link:session-persistence-and-failover.html#GSHAG00210[Enabling the High Availability Session Persistence Service]
+*** link:session-persistence-and-failover.html#GSHAG00154[To Enable Availability for a Cluster, Standalone Instance or Container]
+*** link:session-persistence-and-failover.html#GSHAG00303[Configuring Availability for Individual Web Applications]
+*** link:session-persistence-and-failover.html#GSHAG00305[Using Single Sign-on with Session Failover]
+*** link:session-persistence-and-failover.html#GSHAG00306[Using Coherence*Web for HTTP Session Persistence]
+** link:session-persistence-and-failover.html#GSHAG00211[Stateful Session Bean Failover]
+*** link:session-persistence-and-failover.html#GSHAG00307[Configuring Availability for the EJB Container]
+*** link:session-persistence-and-failover.html#GSHAG00308[Configuring Availability for an Individual Application or EJB Module]
+*** link:session-persistence-and-failover.html#GSHAG00309[Configuring Availability for an Individual Bean]
+*** link:session-persistence-and-failover.html#GSHAG00310[Specifying Methods to Be Checkpointed]
+
+[[configuring-java-message-service-high-availability]]
+=== link:jms.html#GSHAG00012[10 Configuring Java Message Service High Availability]
+
+** link:jms.html#GSHAG00212[Using Message Queue Broker Clusters With GlassFish Server]
+*** link:jms.html#GSHAG00311[About Message Queue Broker Clusters]
+*** link:jms.html#GSHAG00312[Configuring GlassFish Clusters to Use Message Queue Broker Clusters]
+*** link:jms.html#GSHAG00155[To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster With Master Broker]
+*** link:jms.html#GSHAG00156[To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster of Peer Brokers]
+*** link:jms.html#GSHAG00157[To Change the Master Broker in an Embedded or Local Broker Cluster]
+*** link:jms.html#GSHAG00158[To Migrate Between Types of Embedded or Local Conventional Broker Clusters]
+*** link:jms.html#GSHAG00159[To Configure a GlassFish Cluster to Use a Local Enhanced Broker Cluster]
+*** link:jms.html#GSHAG00160[To Configure a GlassFish Cluster to Use a Remote Broker Cluster]
+** link:jms.html#GSHAG00213[Connection Failover]
+** link:jms.html#GSHAG00214[Load-Balanced Delivery to MDBs]
+
+[[rmi-iiop-load-balancing-and-failover]]
+=== link:rmi-iiop.html#GSHAG00013[11 RMI-IIOP Load Balancing and Failover]
+
+** link:rmi-iiop.html#GSHAG00215[Overview]
+*** link:rmi-iiop.html#GSHAG00313[General Requirements for Configuring Load Balancing]
+*** link:rmi-iiop.html#GSHAG00314[Load Balancing Models]
+** link:rmi-iiop.html#GSHAG00216[`InitialContext` Load Balancing]
+*** link:rmi-iiop.html#GSHAG00315[`InitialContext` Summary]
+*** link:rmi-iiop.html#GSHAG00316[`InitialContext` Algorithm]
+*** link:rmi-iiop.html#GSHAG00317[Enabling RMI-IIOP Hardware Load Balancing and Failover]
+** link:rmi-iiop.html#GSHAG00217[Per-Request Load Balancing (PRLB)]
+*** link:rmi-iiop.html#GSHAG00318[PRLB Summary]
+*** link:rmi-iiop.html#GSHAG00319[Enabling Per-Request Load Balancing]
diff --git a/docs/installation-guide/src/main/jbake/content/installing.adoc b/docs/installation-guide/src/main/jbake/content/installing.adoc
index 9b92b10..e356152 100644
--- a/docs/installation-guide/src/main/jbake/content/installing.adoc
+++ b/docs/installation-guide/src/main/jbake/content/installing.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Installing Eclipse GlassFish Server 7
-=====================================
+= Installing Eclipse GlassFish Server 7
[[GSING00002]][[ggssq]]
[[installing-glassfish-server-5.0]]
-1 Installing Eclipse GlassFish Server 7
----------------------------------------
+== 1 Installing Eclipse GlassFish Server 7
This chapter provides instructions for installing Eclipse GlassFish Server 7
software on Solaris, Linux, Mac OS X, and Windows systems.
@@ -26,8 +24,7 @@
[[gjiaz]][[GSING00022]][[installation-requirements]]
-Installation Requirements
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installation Requirements
Before installing Eclipse GlassFish Server 7, ensure that
your system meets the requirements listed in "link:../release-notes/release-notes.html#GSRLN00131[Hardware
@@ -50,8 +47,7 @@
[[gkxfw]][[javassist-library-license-notice]]
-Javassist Library License Notice
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Javassist Library License Notice
You are receiving a copy of the Javassist (Java Programming Assistant)
Library in source form at
@@ -573,8 +569,7 @@
[[ggrlg]][[GSING00023]][[installation-files-for-glassfish-server-5.0]]
-Installation Files for GlassFish Server 7
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installation Files for GlassFish Server 7
The following topics are addressed here:
@@ -585,8 +580,7 @@
[[gkbaj]][[GSING00035]][[glassfish-server-download-locations]]
-GlassFish Server Download Locations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server Download Locations
Installation files for Eclipse GlassFish Server 7 are
available by download from the
@@ -600,8 +594,7 @@
[[gkbby]][[GSING00036]][[glassfish-server-installation-methods]]
-GlassFish Server Installation Methods
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server Installation Methods
link:#ghtqe[Table 1-1] lists the various GlassFish Server Open Source
Edition installation methods. The table also provides links to
@@ -636,8 +629,7 @@
[[gkudi]][[GSING00037]][[choosing-an-installation-method]]
-Choosing an Installation Method
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Choosing an Installation Method
There are two general sets of questions you should consider when
deciding which GlassFish Server 7 installation method to use.
@@ -647,8 +639,7 @@
[[gkuau]][[GSING00029]][[zip-package]]
-ZIP Package
-+++++++++++
+===== ZIP Package
The relative features and strengths of the GlassFish Server ZIP packages
are listed below.
@@ -662,8 +653,7 @@
[[gkudp]][[GSING00030]][[full-platform-or-web-profile-distribution]]
-Full Platform or Web Profile Distribution
-+++++++++++++++++++++++++++++++++++++++++
+===== Full Platform or Web Profile Distribution
Each of the installation methods listed in link:#ghtqe[Table 1-1] also
let you choose to install either the GlassFish Server Full Platform or
@@ -766,8 +756,7 @@
[[gkbbb]][[GSING00038]][[glassfish-server-zip-files]]
-GlassFish Server ZIP Files
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server ZIP Files
The Eclipse GlassFish Server 7 multi-platform ZIP files
are compatible with Solaris, Linux, Mac OS, UNIX, and Windows operating
@@ -803,8 +792,7 @@
[[ghmxb]][[GSING00024]][[installing-glassfish-server-from-a-zip-file]]
-Installing GlassFish Server From a ZIP File
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installing GlassFish Server From a ZIP File
This section describes how to install GlassFish Server Open Source
Edition 7 using the multi-platform ZIP file. GlassFish Server is
@@ -823,8 +811,7 @@
[[ggrks]][[GSING00006]][[to-install-glassfish-server-using-the-zip-file]]
-To Install GlassFish Server Using the ZIP File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Install GlassFish Server Using the ZIP File
Before You Begin
diff --git a/docs/installation-guide/src/main/jbake/content/lot.adoc b/docs/installation-guide/src/main/jbake/content/lot.adoc
index 681c677..64c7d98 100644
--- a/docs/installation-guide/src/main/jbake/content/lot.adoc
+++ b/docs/installation-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:installing.html#ghtqe[1-1 GlassFish Server 7 Installation
Methods]
diff --git a/docs/installation-guide/src/main/jbake/content/preface.adoc b/docs/installation-guide/src/main/jbake/content/preface.adoc
index 609bc61..c813c8c 100644
--- a/docs/installation-guide/src/main/jbake/content/preface.adoc
+++ b/docs/installation-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSING00001]][[gjxfa]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -52,8 +50,7 @@
[[GSING00014]][[ghpbz]]
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -158,8 +155,7 @@
[[GSING00015]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -203,8 +199,7 @@
[[GSING00016]][[fwbkx]]
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -244,8 +239,7 @@
[[GSING00017]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -288,8 +282,7 @@
[[GSING00018]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/installation-guide/src/main/jbake/content/title.adoc b/docs/installation-guide/src/main/jbake/content/title.adoc
index d40f014..e729cb4 100644
--- a/docs/installation-guide/src/main/jbake/content/title.adoc
+++ b/docs/installation-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Installation Guide, Release 7
-======================================================
+= Eclipse GlassFish Server Installation Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Installation Guide
diff --git a/docs/installation-guide/src/main/jbake/content/toc.adoc b/docs/installation-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..cf7e32d
--- /dev/null
+++ b/docs/installation-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,31 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Installation Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Installation Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSING00001[Preface]
+
+** link:preface.html#GSING00014[GlassFish Server Documentation Set]
+** link:preface.html#GSING00015[Related Documentation]
+** link:preface.html#GSING00016[Typographic Conventions]
+** link:preface.html#GSING00017[Symbol Conventions]
+** link:preface.html#GSING00018[Default Paths and File Names]
+
+=== link:installing.html#GSING00002[1 Installing Eclipse GlassFish Server 7]
+
+** link:installing.html#GSING00022[Installation Requirements]
+*** link:installing.html#gkxfw[Javassist Library License Notice]
+** link:installing.html#GSING00023[Installation Files for GlassFish Server 7]
+*** link:installing.html#GSING00035[GlassFish Server Download Locations]
+*** link:installing.html#GSING00036[GlassFish Server Installation Methods]
+*** link:installing.html#GSING00037[Choosing an Installation Method]
+*** link:installing.html#GSING00038[GlassFish Server ZIP Files]
+** link:installing.html#GSING00024[Installing GlassFish Server From a ZIP File]
+*** link:installing.html#GSING00006[To Install GlassFish Server Using the ZIP File]
diff --git a/docs/parent/src/main/jbake/content/toc.adoc b/docs/parent/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..1faa9b9
--- /dev/null
+++ b/docs/parent/src/main/jbake/content/toc.adoc
@@ -0,0 +1,11 @@
+type=page
+status=published
+title=Dummy
+next=title.html
+~~~~~~
+Dummy
+=====
+
+[[contents]]
+== Contents
+
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/loe.adoc b/docs/performance-tuning-guide/src/main/jbake/content/loe.adoc
index dcfbe92..7cd4a63 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/loe.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:tuning-java.html#fxxpw[4-1 Heap Configuration on Solaris]
* link:tuning-java.html#fxxpz[4-2 Heap Configuration on Windows]
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/lof.adoc b/docs/performance-tuning-guide/src/main/jbake/content/lof.adoc
index 3c3b2e4..fec358d 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/lof.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/lof.adoc
@@ -5,11 +5,9 @@
prev=loe.html
~~~~~~
-List of Figures
-===============
+= List of Figures
[[list-of-figures]]
-List of Figures
----------------
+== List of Figures
* link:overview.html#gacmj[1-1 Jakarta EE Application Model]
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/lot.adoc b/docs/performance-tuning-guide/src/main/jbake/content/lot.adoc
index 60e5911..3196ffa 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/lot.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=lof.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:overview.html#gacmh[1-1 Performance Tuning Roadmap]
* link:overview.html#gacmp[1-2 Factors That Affect Performance]
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/overview.adoc b/docs/performance-tuning-guide/src/main/jbake/content/overview.adoc
index 119fea3..7678304 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/overview.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/overview.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Overview of GlassFish Server Performance Tuning
-===============================================
+= Overview of GlassFish Server Performance Tuning
[[GSPTG00003]][[giekg]]
[[overview-of-glassfish-server-performance-tuning]]
-1 Overview of GlassFish Server Performance Tuning
--------------------------------------------------
+== 1 Overview of GlassFish Server Performance Tuning
You can significantly improve performance of the Oracle GlassFish Server
and of applications deployed to it by adjusting a few deployment and
@@ -31,8 +29,7 @@
[[abear]][[GSPTG00048]][[process-overview]]
-Process Overview
-~~~~~~~~~~~~~~~~
+=== Process Overview
The following table outlines the overall GlassFish Server 7
administration process, and shows where performance tuning fits in the
@@ -95,8 +92,7 @@
[[abeas]][[GSPTG00035]][[performance-tuning-sequence]]
-Performance Tuning Sequence
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Performance Tuning Sequence
Application developers should tune applications prior to production use.
Tuning applications often produces dramatic performance improvements.
@@ -117,8 +113,7 @@
[[abeat]][[GSPTG00049]][[understanding-operational-requirements]]
-Understanding Operational Requirements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Understanding Operational Requirements
Before you begin to deploy and tune your application on the GlassFish
Server, it is important to clearly define the operational environment.
@@ -133,8 +128,7 @@
[[abeau]][[GSPTG00154]][[application-architecture]]
-Application Architecture
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Application Architecture
The Jakarta EE Application model, as shown in the following figure, is very
flexible; allowing the application architect to split application logic
@@ -166,16 +160,14 @@
[[abeav]][[GSPTG00155]][[security-requirements]]
-Security Requirements
-^^^^^^^^^^^^^^^^^^^^^
+==== Security Requirements
Most business applications require security. This section discusses
security considerations and decisions.
[[abeaw]][[GSPTG00080]][[user-authentication-and-authorization]]
-User Authentication and Authorization
-+++++++++++++++++++++++++++++++++++++
+===== User Authentication and Authorization
Application users must be authenticated. The GlassFish Server provides a
number of choices for user authentication, including file-based,
@@ -213,8 +205,7 @@
[[abeax]][[GSPTG00081]][[encryption]]
-Encryption
-++++++++++
+===== Encryption
For security reasons, sensitive user inputs and application output must
be encrypted. Most business-oriented web applications encrypt all or
@@ -269,8 +260,7 @@
[[gkvjf]][[GSPTG00156]][[high-availability-clustering-load-balancing-and-failover]]
-High Availability Clustering, Load Balancing, and Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== High Availability Clustering, Load Balancing, and Failover
GlassFish Server 7 enables multiple GlassFish Server instances to be
clustered to provide high availability through failure protection,
@@ -302,8 +292,7 @@
[[abeay]][[GSPTG00157]][[hardware-resources]]
-Hardware Resources
-^^^^^^^^^^^^^^^^^^
+==== Hardware Resources
The type and quantity of hardware resources available greatly influence
performance tuning and site planning.
@@ -329,8 +318,7 @@
[[abeaz]][[GSPTG00158]][[administration]]
-Administration
-^^^^^^^^^^^^^^
+==== Administration
A single GlassFish Server installation on a server can encompass
multiple instances. A group of one or more instances that are
@@ -361,8 +349,7 @@
[[abeba]][[GSPTG00050]][[general-tuning-concepts]]
-General Tuning Concepts
-~~~~~~~~~~~~~~~~~~~~~~~
+=== General Tuning Concepts
Some key concepts that affect performance tuning are:
@@ -437,8 +424,7 @@
[[abebb]][[GSPTG00159]][[capacity-planning]]
-Capacity Planning
-^^^^^^^^^^^^^^^^^
+==== Capacity Planning
The previous discussion guides you towards defining a deployment
architecture. However, you determine the actual size of the deployment
@@ -454,8 +440,7 @@
[[gacmz]][[GSPTG00036]][[to-determine-capacity]]
-To Determine Capacity
-+++++++++++++++++++++
+===== To Determine Capacity
1. Determine performance on a single CPU.
+
@@ -492,8 +477,7 @@
[[abebc]][[GSPTG00160]][[user-expectations]]
-User Expectations
-^^^^^^^^^^^^^^^^^
+==== User Expectations
Application end-users generally have some performance expectations.
Often you can numerically quantify them. To ensure that customer needs
@@ -526,8 +510,7 @@
[[abebd]][[GSPTG00051]][[further-information]]
-Further Information
-~~~~~~~~~~~~~~~~~~~
+=== Further Information
* For more information on Java performance, see
http://java.sun.com/docs/performance[Java Performance Documentation]
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/preface.adoc b/docs/performance-tuning-guide/src/main/jbake/content/preface.adoc
index e129f7a..2d1d5dd 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/preface.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/preface.adoc
@@ -5,15 +5,13 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSPTG00002]][[pref]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -48,8 +46,7 @@
[[oracle-glassfish-server-documentation-set]]
-Oracle GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Oracle GlassFish Server Documentation Set
[width="100%",cols="<30%,<70%",options="header",]
|===
@@ -147,8 +144,7 @@
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -189,8 +185,7 @@
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -235,8 +230,7 @@
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/title.adoc b/docs/performance-tuning-guide/src/main/jbake/content/title.adoc
index 4331bd9..d224d72 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/title.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Performance Tuning Guide, Release 7
-============================================================
+= Eclipse GlassFish Server Performance Tuning Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Performance Tuning Guide
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/toc.adoc b/docs/performance-tuning-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..3fa5dc2
--- /dev/null
+++ b/docs/performance-tuning-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,145 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Performance Tuning Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Performance Tuning Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSPTG00002[Preface]
+
+** link:preface.html#GSPTG00043[Oracle GlassFish Server Documentation Set]
+** link:preface.html#GSPTG00045[Typographic Conventions]
+** link:preface.html#GSPTG00046[Symbol Conventions]
+** link:preface.html#GSPTG00044[Default Paths and File Names]
+
+[[overview-of-glassfish-server-performance-tuning]]
+=== link:overview.html#GSPTG00003[1 Overview of GlassFish Server Performance Tuning]
+
+** link:overview.html#GSPTG00048[Process Overview]
+*** link:overview.html#GSPTG00035[Performance Tuning Sequence]
+** link:overview.html#GSPTG00049[Understanding Operational Requirements]
+*** link:overview.html#GSPTG00154[Application Architecture]
+*** link:overview.html#GSPTG00155[Security Requirements]
+*** link:overview.html#GSPTG00156[High Availability Clustering, Load Balancing, and Failover]
+*** link:overview.html#GSPTG00157[Hardware Resources]
+*** link:overview.html#GSPTG00158[Administration]
+** link:overview.html#GSPTG00050[General Tuning Concepts]
+*** link:overview.html#GSPTG00159[Capacity Planning]
+*** link:overview.html#GSPTG00160[User Expectations]
+** link:overview.html#GSPTG00051[Further Information]
+
+[[tuning-your-application]]
+=== link:tuning-apps.html#GSPTG00004[2 Tuning Your Application]
+
+** link:tuning-apps.html#GSPTG00052[Java Programming Guidelines]
+*** link:tuning-apps.html#GSPTG00161[Avoid Serialization and Deserialization]
+*** link:tuning-apps.html#GSPTG00162[Use `StringBuilder` to Concatenate Strings]
+*** link:tuning-apps.html#GSPTG00163[Assign null to Variables That Are No Longer Needed]
+*** link:tuning-apps.html#GSPTG00164[Declare Methods as final Only If Necessary]
+*** link:tuning-apps.html#GSPTG00165[Declare Constants as static final]
+*** link:tuning-apps.html#GSPTG00166[Avoid Finalizers]
+*** link:tuning-apps.html#GSPTG00167[Declare Method Arguments final]
+*** link:tuning-apps.html#GSPTG00168[Synchronize Only When Necessary]
+*** link:tuning-apps.html#GSPTG00169[Use DataHandlers for SOAP Attachments]
+** link:tuning-apps.html#GSPTG00053[Java Server Page and Servlet Tuning]
+*** link:tuning-apps.html#GSPTG00170[Suggested Coding Practices]
+** link:tuning-apps.html#GSPTG00054[EJB Performance Tuning]
+*** link:tuning-apps.html#GSPTG00171[Goals]
+*** link:tuning-apps.html#GSPTG00172[Monitoring EJB Components]
+*** link:tuning-apps.html#GSPTG00173[General Guidelines]
+*** link:tuning-apps.html#GSPTG00174[Using Local and Remote Interfaces]
+*** link:tuning-apps.html#GSPTG00175[Improving Performance of EJB Transactions]
+*** link:tuning-apps.html#GSPTG00176[Using Special Techniques]
+*** link:tuning-apps.html#GSPTG00177[Tuning Tips for Specific Types of EJB Components]
+*** link:tuning-apps.html#GSPTG00178[JDBC and Database Access]
+*** link:tuning-apps.html#GSPTG00179[Tuning Message-Driven Beans]
+
+[[tuning-the-glassfish-server]]
+=== link:tuning-glassfish.html#GSPTG00005[3 Tuning the GlassFish Server]
+
+** link:tuning-glassfish.html#GSPTG00055[Using the GlassFish Server Performance Tuner]
+** link:tuning-glassfish.html#GSPTG00056[Deployment Settings]
+*** link:tuning-glassfish.html#GSPTG00180[Disable Auto-Deployment]
+*** link:tuning-glassfish.html#GSPTG00181[Use Pre-compiled JavaServer Pages]
+*** link:tuning-glassfish.html#GSPTG00182[Disable Dynamic Application Reloading]
+** link:tuning-glassfish.html#GSPTG00057[Logger Settings]
+*** link:tuning-glassfish.html#GSPTG00183[General Settings]
+*** link:tuning-glassfish.html#GSPTG00184[Log Levels]
+** link:tuning-glassfish.html#GSPTG00058[Web Container Settings]
+*** link:tuning-glassfish.html#GSPTG00185[Session Properties: Session Timeout]
+*** link:tuning-glassfish.html#GSPTG00186[Manager Properties: Reap Interval]
+*** link:tuning-glassfish.html#GSPTG00187[Disable Dynamic JSP Reloading]
+** link:tuning-glassfish.html#GSPTG00059[EJB Container Settings]
+*** link:tuning-glassfish.html#GSPTG00188[Monitoring the EJB Container]
+*** link:tuning-glassfish.html#GSPTG00189[Tuning the EJB Container]
+** link:tuning-glassfish.html#GSPTG00060[Java Message Service Settings]
+** link:tuning-glassfish.html#GSPTG00061[Transaction Service Settings]
+*** link:tuning-glassfish.html#GSPTG00190[Monitoring the Transaction Service]
+*** link:tuning-glassfish.html#GSPTG00191[Tuning the Transaction Service]
+** link:tuning-glassfish.html#GSPTG00062[HTTP Service Settings]
+*** link:tuning-glassfish.html#GSPTG00192[Monitoring the HTTP Service]
+*** link:tuning-glassfish.html#GSPTG00193[HTTP Service Access Logging]
+** link:tuning-glassfish.html#GSPTG00063[Network Listener Settings]
+*** link:tuning-glassfish.html#GSPTG00194[General Settings]
+*** link:tuning-glassfish.html#GSPTG00195[HTTP Settings]
+*** link:tuning-glassfish.html#GSPTG00196[File Cache Settings]
+** link:tuning-glassfish.html#GSPTG00064[Transport Settings]
+** link:tuning-glassfish.html#GSPTG00065[Thread Pool Settings]
+*** link:tuning-glassfish.html#GSPTG00197[Max Thread Pool Size]
+*** link:tuning-glassfish.html#GSPTG00198[Min Thread Pool Size]
+** link:tuning-glassfish.html#GSPTG00066[ORB Settings]
+*** link:tuning-glassfish.html#GSPTG00199[Overview]
+*** link:tuning-glassfish.html#GSPTG00200[How a Client Connects to the ORB]
+*** link:tuning-glassfish.html#GSPTG00201[Monitoring the ORB]
+*** link:tuning-glassfish.html#GSPTG00202[Tuning the ORB]
+** link:tuning-glassfish.html#GSPTG00067[Resource Settings]
+*** link:tuning-glassfish.html#GSPTG00203[JDBC Connection Pool Settings]
+*** link:tuning-glassfish.html#GSPTG00204[Connector Connection Pool Settings]
+** link:tuning-glassfish.html#GSPTG00068[Load Balancer Settings]
+
+[[tuning-the-java-runtime-system]]
+=== link:tuning-java.html#GSPTG00006[4 Tuning the Java Runtime System]
+
+** link:tuning-java.html#GSPTG00069[Java Virtual Machine Settings]
+** link:tuning-java.html#GSPTG00070[Start Options]
+** link:tuning-java.html#GSPTG00071[Tuning High Availability Persistence]
+** link:tuning-java.html#GSPTG00072[Managing Memory and Garbage Collection]
+*** link:tuning-java.html#GSPTG00205[Tuning the Garbage Collector]
+*** link:tuning-java.html#GSPTG00206[Tracing Garbage Collection]
+*** link:tuning-java.html#GSPTG00207[Other Garbage Collector Settings]
+*** link:tuning-java.html#GSPTG00208[Tuning the Java Heap]
+*** link:tuning-java.html#GSPTG00209[Rebasing DLLs on Windows]
+** link:tuning-java.html#GSPTG00073[Further Information]
+
+[[tuning-the-operating-system-and-platform]]
+=== link:tuning-os.html#GSPTG00007[5 Tuning the Operating System and Platform]
+
+** link:tuning-os.html#GSPTG00074[Server Scaling]
+*** link:tuning-os.html#GSPTG00210[Processors]
+*** link:tuning-os.html#GSPTG00211[Memory]
+*** link:tuning-os.html#GSPTG00212[Disk Space]
+*** link:tuning-os.html#GSPTG00213[Networking]
+*** link:tuning-os.html#GSPTG00214[UDP Buffer Sizes]
+** link:tuning-os.html#GSPTG00075[Solaris 10 Platform-Specific Tuning Information]
+** link:tuning-os.html#GSPTG00076[Tuning for the Solaris OS]
+*** link:tuning-os.html#GSPTG00215[Tuning Parameters]
+*** link:tuning-os.html#GSPTG00216[File Descriptor Setting]
+** link:tuning-os.html#GSPTG00077[Tuning for Solaris on x86]
+*** link:tuning-os.html#GSPTG00217[File Descriptors]
+*** link:tuning-os.html#GSPTG00218[IP Stack Settings]
+** link:tuning-os.html#GSPTG00078[Tuning for Linux platforms]
+*** link:tuning-os.html#GSPTG00219[Startup Files]
+*** link:tuning-os.html#GSPTG00220[File Descriptors]
+*** link:tuning-os.html#GSPTG00221[Virtual Memory]
+*** link:tuning-os.html#GSPTG00222[Network Interface]
+*** link:tuning-os.html#GSPTG00223[Disk I/O Settings]
+*** link:tuning-os.html#GSPTG00224[TCP/IP Settings]
+** link:tuning-os.html#GSPTG00079[Tuning UltraSPARC CMT-Based Systems]
+*** link:tuning-os.html#GSPTG00225[Tuning Operating System and TCP Settings]
+*** link:tuning-os.html#GSPTG00226[Disk Configuration]
+*** link:tuning-os.html#GSPTG00227[Network Configuration]
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/tuning-apps.adoc b/docs/performance-tuning-guide/src/main/jbake/content/tuning-apps.adoc
index 97822fa..b061b06 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/tuning-apps.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/tuning-apps.adoc
@@ -5,15 +5,13 @@
prev=overview.html
~~~~~~
-Tuning Your Application
-=======================
+= Tuning Your Application
[[GSPTG00004]][[abebe]]
[[tuning-your-application]]
-2 Tuning Your Application
--------------------------
+== 2 Tuning Your Application
This chapter provides information on tuning applications for maximum
performance. A complete guide to writing high performance Java and Java
@@ -27,8 +25,7 @@
[[abebf]][[GSPTG00052]][[java-programming-guidelines]]
-Java Programming Guidelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Java Programming Guidelines
This section covers issues related to Java coding and performance. The
guidelines outlined are not specific to GlassFish Server, but are
@@ -52,8 +49,7 @@
[[abebg]][[GSPTG00161]][[avoid-serialization-and-deserialization]]
-Avoid Serialization and Deserialization
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Avoid Serialization and Deserialization
Serialization and deserialization of objects is a CPU-intensive
procedure and is likely to slow down your application. Use the
@@ -63,8 +59,7 @@
[[abebh]][[GSPTG00162]][[use-stringbuilder-to-concatenate-strings]]
-Use `StringBuilder` to Concatenate Strings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Use `StringBuilder` to Concatenate Strings
To improve performance, instead of using string concatenation, use
`StringBuilder.append()`.
@@ -106,8 +101,7 @@
[[abebi]][[GSPTG00163]][[assign-null-to-variables-that-are-no-longer-needed]]
-Assign null to Variables That Are No Longer Needed
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Assign null to Variables That Are No Longer Needed
Explicitly assigning a null value to variables that are no longer needed
helps the garbage collector to identify the parts of memory that can be
@@ -127,8 +121,7 @@
[[abebj]][[GSPTG00164]][[declare-methods-as-final-only-if-necessary]]
-Declare Methods as final Only If Necessary
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Declare Methods as final Only If Necessary
Modern optimizing dynamic compilers can perform inlining and other
inter-procedural optimizations, even if Java methods are not declared
@@ -140,16 +133,14 @@
[[abebk]][[GSPTG00165]][[declare-constants-as-static-final]]
-Declare Constants as static final
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Declare Constants as static final
The dynamic compiler can perform some constant folding optimizations
easily, when you declare constants as `static final` variables.
[[abebl]][[GSPTG00166]][[avoid-finalizers]]
-Avoid Finalizers
-^^^^^^^^^^^^^^^^
+==== Avoid Finalizers
Adding finalizers to code makes the garbage collector more expensive and
unpredictable. The virtual machine does not guarantee the time at which
@@ -159,8 +150,7 @@
[[abebm]][[GSPTG00167]][[declare-method-arguments-final]]
-Declare Method Arguments final
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Declare Method Arguments final
Declare method arguments `final` if they are not modified in the method.
In general, declare all variables `final` if they are not modified after
@@ -168,8 +158,7 @@
[[abebn]][[GSPTG00168]][[synchronize-only-when-necessary]]
-Synchronize Only When Necessary
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Synchronize Only When Necessary
Do not synchronize code blocks or methods unless synchronization is
required. Keep synchronized blocks or methods as short as possible to
@@ -179,8 +168,7 @@
[[abebo]][[GSPTG00169]][[use-datahandlers-for-soap-attachments]]
-Use DataHandlers for SOAP Attachments
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Use DataHandlers for SOAP Attachments
Using a `javax.activation.DataHandler` for a SOAP attachment will
improve performance.
@@ -213,8 +201,7 @@
[[abebp]][[GSPTG00053]][[java-server-page-and-servlet-tuning]]
-Java Server Page and Servlet Tuning
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Java Server Page and Servlet Tuning
Many applications running on the GlassFish Server use servlets or
JavaServer Pages (JSP) technology in the presentation tier. This section
@@ -223,8 +210,7 @@
[[abebq]][[GSPTG00170]][[suggested-coding-practices]]
-Suggested Coding Practices
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Suggested Coding Practices
This section provides some tips on coding practices that improve servlet
and JSP application performance.
@@ -238,8 +224,7 @@
[[abebr]][[GSPTG00082]][[general-guidelines]]
-General Guidelines
-++++++++++++++++++
+===== General Guidelines
Follow these general guidelines to increase performance of the
presentation tier:
@@ -252,8 +237,7 @@
[[abebs]][[GSPTG00083]][[avoid-shared-modified-class-variables]]
-Avoid Shared Modified Class Variables
-+++++++++++++++++++++++++++++++++++++
+===== Avoid Shared Modified Class Variables
In the servlet multithread model (the default), a single instance of a
servlet is created for each application server instance. All requests
@@ -264,8 +248,7 @@
[[abebt]][[GSPTG00084]][[http-session-handling]]
-HTTP Session Handling
-+++++++++++++++++++++
+===== HTTP Session Handling
Follow these guidelines when using HTTP sessions:
@@ -291,8 +274,7 @@
[[abebu]][[GSPTG00085]][[configuration-and-deployment-tips]]
-Configuration and Deployment Tips
-+++++++++++++++++++++++++++++++++
+===== Configuration and Deployment Tips
Follow these configuration tips to improve performance. These tips are
intended for production environments, not development environments.
@@ -356,8 +338,7 @@
[[abebw]][[GSPTG00054]][[ejb-performance-tuning]]
-EJB Performance Tuning
-~~~~~~~~~~~~~~~~~~~~~~
+=== EJB Performance Tuning
The GlassFish Server's high-performance EJB container has numerous
parameters that affect performance. Individual EJB components also have
@@ -405,8 +386,7 @@
[[abeby]][[GSPTG00172]][[monitoring-ejb-components]]
-Monitoring EJB Components
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Monitoring EJB Components
When the EJB container has monitoring enabled, you can examine
statistics for individual beans based on the bean pool and cache
@@ -494,8 +474,7 @@
[[abebz]][[GSPTG00086]][[monitoring-individual-ejb-components]]
-Monitoring Individual EJB Components
-++++++++++++++++++++++++++++++++++++
+===== Monitoring Individual EJB Components
To gather method invocation statistics for all methods in a bean, use
the following command:
@@ -569,8 +548,7 @@
[[abeca]][[GSPTG00173]][[general-guidelines-1]]
-General Guidelines
-^^^^^^^^^^^^^^^^^^
+==== General Guidelines
The following guidelines can improve performance of EJB components. Keep
in mind that decomposing an application into many EJB components creates
@@ -580,8 +558,7 @@
[[abecb]][[GSPTG00087]][[use-high-performance-beans]]
-Use High Performance Beans
-++++++++++++++++++++++++++
+===== Use High Performance Beans
Use high-performance beans as much as possible to improve the overall
performance of your application. For more information, see
@@ -608,8 +585,7 @@
[[abecc]][[GSPTG00088]][[use-caching]]
-Use Caching
-+++++++++++
+===== Use Caching
Caching can greatly improve performance when used wisely. For example:
@@ -625,8 +601,7 @@
[[abecd]][[GSPTG00089]][[use-the-appropriate-stubs]]
-Use the Appropriate Stubs
-+++++++++++++++++++++++++
+===== Use the Appropriate Stubs
The stub classes needed by EJB applications are generated dynamically at
runtime when an EJB client needs them. This means that it is not
@@ -643,16 +618,14 @@
[[abece]][[GSPTG00090]][[remove-unneeded-stateful-session-beans]]
-Remove Unneeded Stateful Session Beans
-++++++++++++++++++++++++++++++++++++++
+===== Remove Unneeded Stateful Session Beans
Removing unneeded stateful session beans avoids passivating them, which
requires disk operations.
[[abecf]][[GSPTG00091]][[cache-and-pool-tuning-tips]]
-Cache and Pool Tuning Tips
-++++++++++++++++++++++++++
+===== Cache and Pool Tuning Tips
Follow these tips when using the EJB cache and pools to improve
performance:
@@ -677,16 +650,14 @@
[[abecg]][[GSPTG00174]][[using-local-and-remote-interfaces]]
-Using Local and Remote Interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Local and Remote Interfaces
This section describes some considerations when EJB components are used
by local and remote clients.
[[abech]][[GSPTG00092]][[prefer-local-interfaces]]
-Prefer Local Interfaces
-+++++++++++++++++++++++
+===== Prefer Local Interfaces
An EJB component can have remote and local interfaces. Clients not
located in the same application server instance as the bean (remote
@@ -709,8 +680,7 @@
[[abeci]][[GSPTG00093]][[using-pass-by-reference-semantics]]
-Using Pass-By-Reference Semantics
-+++++++++++++++++++++++++++++++++
+===== Using Pass-By-Reference Semantics
By default, the GlassFish Server uses pass-by-value semantics for
calling the remote interface of a bean, even if it is co-located. This
@@ -764,8 +734,7 @@
[[abecj]][[GSPTG00175]][[improving-performance-of-ejb-transactions]]
-Improving Performance of EJB Transactions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Improving Performance of EJB Transactions
This section provides some tips to improve performance when using
transactions.
@@ -783,24 +752,21 @@
[[abeck]][[GSPTG00094]][[use-container-managed-transactions]]
-Use Container-Managed Transactions
-++++++++++++++++++++++++++++++++++
+===== Use Container-Managed Transactions
Container-managed transactions are preferred for consistency, and
provide better performance.
[[abecl]][[GSPTG00095]][[do-not-encompass-user-input-time]]
-Do Not Encompass User Input Time
-++++++++++++++++++++++++++++++++
+===== Do Not Encompass User Input Time
To avoid resources being held unnecessarily for long periods, a
transaction should not encompass user input or user think time.
[[abecm]][[GSPTG00096]][[identify-non-transactional-methods]]
-Identify Non-Transactional Methods
-++++++++++++++++++++++++++++++++++
+===== Identify Non-Transactional Methods
Declare non-transactional methods of session EJB components with
`NotSupported` or `Never` transaction attributes. These attributes can
@@ -809,8 +775,7 @@
[[abecn]][[GSPTG00097]][[use-tx_required-for-long-transaction-chains]]
-Use `TX_REQUIRED` for Long Transaction Chains
-+++++++++++++++++++++++++++++++++++++++++++++
+===== Use `TX_REQUIRED` for Long Transaction Chains
For very large transaction chains, use the transaction attribute
`TX_REQUIRED.` To ensure EJB methods in a call chain, use the same
@@ -818,8 +783,7 @@
[[abeco]][[GSPTG00098]][[use-lowest-cost-database-locking]]
-Use Lowest Cost Database Locking
-++++++++++++++++++++++++++++++++
+===== Use Lowest Cost Database Locking
Use the lowest cost locking available from the database that is
consistent with any transaction. Commit the data after the transaction
@@ -827,8 +791,7 @@
[[abecp]][[GSPTG00099]][[use-xa-capable-data-sources-only-when-needed]]
-Use XA-Capable Data Sources Only When Needed
-++++++++++++++++++++++++++++++++++++++++++++
+===== Use XA-Capable Data Sources Only When Needed
When multiple database resources, connector resources or JMS resources
are involved in one transaction, a distributed or global transaction
@@ -841,8 +804,7 @@
[[abecq]][[GSPTG00100]][[configure-jdbc-resources-as-one-phase-commit-resources]]
-Configure JDBC Resources as One-Phase Commit Resources
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Configure JDBC Resources as One-Phase Commit Resources
To improve performance of transactions involving multiple resources, the
GlassFish Server uses last agent optimization (LAO), which allows the
@@ -861,8 +823,7 @@
[[abecr]][[GSPTG00101]][[use-the-least-expensive-transaction-attribute]]
-Use the Least Expensive Transaction Attribute
-+++++++++++++++++++++++++++++++++++++++++++++
+===== Use the Least Expensive Transaction Attribute
Set the following transaction attributes in the EJB deployment
descriptor file (`ejb-jar.xml`). Options are listed from best
@@ -878,8 +839,7 @@
[[abecs]][[GSPTG00176]][[using-special-techniques]]
-Using Special Techniques
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using Special Techniques
Special performance-enhancing techniques are discussed in the following
sections:
@@ -889,8 +849,7 @@
[[abect]][[GSPTG00102]][[version-consistency]]
-Version Consistency
-+++++++++++++++++++
+===== Version Consistency
[NOTE]
@@ -990,8 +949,7 @@
[[abecu]][[GSPTG00103]][[request-partitioning]]
-Request Partitioning
-++++++++++++++++++++
+===== Request Partitioning
Request partitioning enables you to assign a request priority to an EJB
component. This gives you the flexibility to make certain EJB components
@@ -1064,8 +1022,7 @@
[[abecv]][[GSPTG00177]][[tuning-tips-for-specific-types-of-ejb-components]]
-Tuning Tips for Specific Types of EJB Components
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning Tips for Specific Types of EJB Components
This section provides tips for tuning various specific types of EJB components:
@@ -1084,8 +1041,7 @@
[[abecw]][[GSPTG00104]][[entity-beans]]
-Entity Beans
-++++++++++++
+===== Entity Beans
Depending on the usage of a particular entity bean, one should tune
`max-cache-size` so that the beans that are used less frequently (for
@@ -1096,8 +1052,7 @@
[[abecx]][[GSPTG00105]][[stateful-session-beans]]
-Stateful Session Beans
-++++++++++++++++++++++
+===== Stateful Session Beans
When a stateful bean represents a user, a reasonable `max-cache-size` of
beans is the expected number of concurrent users on the application
@@ -1127,8 +1082,7 @@
[[abecz]][[GSPTG00106]][[stateless-session-beans]]
-Stateless Session Beans
-+++++++++++++++++++++++
+===== Stateless Session Beans
Stateless session beans are more readily pooled than entity or the
stateful session beans. Valid values for `steady-pool-size`,
@@ -1150,8 +1104,7 @@
[[abeda]][[GSPTG00107]][[read-only-entity-beans]]
-Read-Only Entity Beans
-++++++++++++++++++++++
+===== Read-Only Entity Beans
Read-only entity beans cache data from the database. GlassFish Server
supports read-only beans that use both bean-managed persistence (BMP)
@@ -1215,8 +1168,7 @@
[[abedc]][[GSPTG00108]][[pre-fetching-container-managed-relationship-cmr-beans]]
-Pre-Fetching Container Managed Relationship (CMR) Beans
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Pre-Fetching Container Managed Relationship (CMR) Beans
If a container-managed relationship (CMR) exists in your application,
loading one bean will load all its related beans. The canonical example
@@ -1324,8 +1276,7 @@
[[abedd]][[GSPTG00178]][[jdbc-and-database-access]]
-JDBC and Database Access
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== JDBC and Database Access
The following are some tips to improve the performance of database
access:
@@ -1337,32 +1288,28 @@
[[abede]][[GSPTG00109]][[use-jdbc-directly]]
-Use JDBC Directly
-+++++++++++++++++
+===== Use JDBC Directly
When dealing with large amounts of data, such as searching a large
database, use JDBC directly rather than using Entity EJB components.
[[abedf]][[GSPTG00110]][[encapsulate-business-logic-in-entity-ejb-components]]
-Encapsulate Business Logic in Entity EJB Components
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Encapsulate Business Logic in Entity EJB Components
Combine business logic with the Entity EJB component that holds the data
needed for that logic to process.
[[abedg]][[GSPTG00111]][[close-connections]]
-Close Connections
-+++++++++++++++++
+===== Close Connections
To ensure that connections are returned to the pool, always close the
connections after use.
[[abedh]][[GSPTG00112]][[minimize-the-database-transaction-isolation-level]]
-Minimize the Database Transaction Isolation Level
-+++++++++++++++++++++++++++++++++++++++++++++++++
+===== Minimize the Database Transaction Isolation Level
Use the default isolation level provided by the JDBC driver rather than
calling `setTransactionIsolationLevel()`, unless you are certain that
@@ -1385,24 +1332,21 @@
[[abedi]][[GSPTG00179]][[tuning-message-driven-beans]]
-Tuning Message-Driven Beans
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning Message-Driven Beans
This section provides some tips to improve performance when using JMS
with message-driven beans (MDBs).
[[abedj]][[GSPTG00113]][[use-getconnection]]
-Use `getConnection()`
-+++++++++++++++++++++
+===== Use `getConnection()`
JMS connections are served from a connection pool. This means that
calling `getConnection()` on a Queue connection factory is fast.
[[abedk]][[GSPTG00114]][[tune-the-message-driven-beans-pool-size]]
-Tune the Message-Driven Bean's Pool Size
-++++++++++++++++++++++++++++++++++++++++
+===== Tune the Message-Driven Bean's Pool Size
The container for message-driven beans (MDB) is different than the
containers for entity and session beans. In the MDB container, sessions
@@ -1428,8 +1372,7 @@
[[abedl]][[GSPTG00115]][[cache-bean-specific-resources]]
-Cache Bean-Specific Resources
-+++++++++++++++++++++++++++++
+===== Cache Bean-Specific Resources
Use the `setMessageDrivenContext()` or `ejbCreate()` method to cache
bean specific resources, and release those resources from the
@@ -1437,8 +1380,7 @@
[[abedm]][[GSPTG00116]][[limit-use-of-jms-connections]]
-Limit Use of JMS Connections
-++++++++++++++++++++++++++++
+===== Limit Use of JMS Connections
When designing an application that uses JMS connections make sure you
use a methodology that sparingly uses connections, by either pooling
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/tuning-glassfish.adoc b/docs/performance-tuning-guide/src/main/jbake/content/tuning-glassfish.adoc
index 3588ee2..a050537 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/tuning-glassfish.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/tuning-glassfish.adoc
@@ -5,15 +5,13 @@
prev=tuning-apps.html
~~~~~~
-Tuning the GlassFish Server
-===========================
+= Tuning the GlassFish Server
[[GSPTG00005]][[abedn]]
[[tuning-the-glassfish-server]]
-3 Tuning the GlassFish Server
------------------------------
+== 3 Tuning the GlassFish Server
This chapter describes some ways to tune your GlassFish Server
installation for optimum performance.
@@ -46,8 +44,7 @@
[[gkxwm]][[GSPTG00055]][[using-the-glassfish-server-performance-tuner]]
-Using the GlassFish Server Performance Tuner
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Using the GlassFish Server Performance Tuner
You can significantly improve the performance of GlassFish Server and
the applications deployed on it by adjusting a few deployment and server
@@ -81,8 +78,7 @@
[[abedo]][[GSPTG00056]][[deployment-settings]]
-Deployment Settings
-~~~~~~~~~~~~~~~~~~~
+=== Deployment Settings
Deployment settings can have significant impact on performance. Follow
these guidelines when configuring deployment settings for best
@@ -94,8 +90,7 @@
[[abedp]][[GSPTG00180]][[disable-auto-deployment]]
-Disable Auto-Deployment
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Disable Auto-Deployment
Enabling auto-deployment will adversely affect deployment, though it is
a convenience in a development environment. For a production system,
@@ -113,8 +108,7 @@
[[abedq]][[GSPTG00181]][[use-pre-compiled-javaserver-pages]]
-Use Pre-compiled JavaServer Pages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Use Pre-compiled JavaServer Pages
Compiling JSP files is resource intensive and time consuming.
Pre-compiling JSP files before deploying applications on the server will
@@ -130,8 +124,7 @@
[[abedr]][[GSPTG00182]][[disable-dynamic-application-reloading]]
-Disable Dynamic Application Reloading
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disable Dynamic Application Reloading
If dynamic reloading is enabled, the server periodically checks for
changes in deployed applications and automatically reloads the
@@ -146,8 +139,7 @@
[[abeds]][[GSPTG00057]][[logger-settings]]
-Logger Settings
-~~~~~~~~~~~~~~~
+=== Logger Settings
The GlassFish Server produces writes log messages and exception stack
trace output to the log file in the logs directory of the instance,
@@ -156,8 +148,7 @@
[[abedt]][[GSPTG00183]][[general-settings]]
-General Settings
-^^^^^^^^^^^^^^^^
+==== General Settings
In general, writing to the system log slows down performance slightly;
and increased disk access (increasing the log level, decreasing the file
@@ -169,8 +160,7 @@
[[abedu]][[GSPTG00184]][[log-levels]]
-Log Levels
-^^^^^^^^^^
+==== Log Levels
Set the log level for the server and its subsystems in the GlassFish
Server Administration Console. Navigate to the
@@ -182,8 +172,7 @@
[[abedw]][[GSPTG00058]][[web-container-settings]]
-Web Container Settings
-~~~~~~~~~~~~~~~~~~~~~~
+=== Web Container Settings
Set Web container settings in the GlassFish Server Administration
Console by navigating to the Configurations>configuration-name>Web
@@ -199,8 +188,7 @@
[[abedx]][[GSPTG00185]][[session-properties-session-timeout]]
-Session Properties: Session Timeout
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Session Properties: Session Timeout
Session timeout determines how long the server maintains a session if a
user does not explicitly invalidate the session. The default value is 30
@@ -212,8 +200,7 @@
[[abedy]][[GSPTG00186]][[manager-properties-reap-interval]]
-Manager Properties: Reap Interval
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Manager Properties: Reap Interval
Modifying the reap interval can improve performance, but setting it
without considering the nature of your sessions and business logic can
@@ -241,8 +228,7 @@
[[abedz]][[GSPTG00187]][[disable-dynamic-jsp-reloading]]
-Disable Dynamic JSP Reloading
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Disable Dynamic JSP Reloading
On a production system, improve web container performance by disabling
dynamic JSP reloading. To do so, edit the `default-web.xml` file in the
@@ -271,8 +257,7 @@
[[abeea]][[GSPTG00059]][[ejb-container-settings]]
-EJB Container Settings
-~~~~~~~~~~~~~~~~~~~~~~
+=== EJB Container Settings
The EJB Container has many settings that affect performance. As with
other areas, use monitor the EJB Container to track its execution and
@@ -285,8 +270,7 @@
[[abeeb]][[GSPTG00188]][[monitoring-the-ejb-container]]
-Monitoring the EJB Container
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Monitoring the EJB Container
Monitoring the EJB container is disabled by default. You can enable EJB
monitoring through the GlassFish Server Administration Console by
@@ -298,8 +282,7 @@
[[abeec]][[GSPTG00189]][[tuning-the-ejb-container]]
-Tuning the EJB Container
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning the EJB Container
The EJB container caches and pools EJB components for better
performance. Tuning the cache and pool properties can provide
@@ -318,8 +301,7 @@
[[abeed]][[GSPTG00117]][[overview-of-ejb-pooling-and-caching]]
-Overview of EJB Pooling and Caching
-+++++++++++++++++++++++++++++++++++
+===== Overview of EJB Pooling and Caching
Both stateless session beans and entity beans can be pooled to improve
server performance. In addition, both stateful session beans and entity
@@ -361,8 +343,7 @@
[[abeee]][[GSPTG00118]][[tuning-the-ejb-pool]]
-Tuning the EJB Pool
-+++++++++++++++++++
+===== Tuning the EJB Pool
A bean in the pool represents the pooled state in the EJB lifecycle.
This means that the bean does not have an identity. The advantage of
@@ -426,8 +407,7 @@
[[abeeg]][[GSPTG00119]][[tuning-the-ejb-cache]]
-Tuning the EJB Cache
-++++++++++++++++++++
+===== Tuning the EJB Cache
A bean in the cache represents the ready state in the EJB lifecycle.
This means that the bean has an identity (for example, a primary key or
@@ -507,8 +487,7 @@
[[abeei]][[GSPTG00120]][[pool-and-cache-settings-for-individual-ejb-components]]
-Pool and Cache Settings for Individual EJB Components
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Pool and Cache Settings for Individual EJB Components
Individual EJB pool and cache settings in the `sun-ejb-jar.xml`
deployment descriptor override those of the EJB container. The following
@@ -542,8 +521,7 @@
[[abeej]][[GSPTG00121]][[commit-option]]
-Commit Option
-+++++++++++++
+===== Commit Option
The commit option controls the action taken by the EJB container when an
EJB component completes a transaction. The commit option has a
@@ -596,8 +574,7 @@
[[abeel]][[GSPTG00060]][[java-message-service-settings]]
-Java Message Service Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Java Message Service Settings
The Type attribute that determines whether the Java Message Service
(JMS) is on local or remote system affects performance. Local JMS
@@ -610,8 +587,7 @@
[[abeem]][[GSPTG00061]][[transaction-service-settings]]
-Transaction Service Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Transaction Service Settings
The transaction manager makes it possible to commit and roll back
distributed transactions.
@@ -627,8 +603,7 @@
[[abeen]][[GSPTG00190]][[monitoring-the-transaction-service]]
-Monitoring the Transaction Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Monitoring the Transaction Service
Transaction Manager monitoring is disabled by default. Enable monitoring
of the transaction service through the GlassFish Server Administration
@@ -646,8 +621,7 @@
[[abeeo]][[GSPTG00122]][[viewing-monitoring-information]]
-Viewing Monitoring Information
-++++++++++++++++++++++++++++++
+===== Viewing Monitoring Information
To view monitoring information for the transaction service in the
GlassFish Server Administration Console, navigate to the server (Admin
@@ -663,8 +637,7 @@
[[abeep]][[GSPTG00191]][[tuning-the-transaction-service]]
-Tuning the Transaction Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning the Transaction Service
This property can be used to disable the transaction logging, where the
performance is of utmost importance more than the recovery. This
@@ -680,8 +653,7 @@
[[abeeq]][[GSPTG00123]][[disable-distributed-transaction-logging]]
-Disable Distributed Transaction Logging
-+++++++++++++++++++++++++++++++++++++++
+===== Disable Distributed Transaction Logging
You can disable transaction logging through the Administration Console
or by using the following `asadmin set` subcommand:
@@ -702,8 +674,7 @@
[[abeer]][[GSPTG00124]][[recover-on-restart-automatic-recovery]]
-Recover On Restart (Automatic Recovery)
-+++++++++++++++++++++++++++++++++++++++
+===== Recover On Restart (Automatic Recovery)
You can set the Recover on Restart attribute through the Administration
Console or by entering the following `asadmin set` subcommand:
@@ -731,8 +702,7 @@
[[abees]][[GSPTG00125]][[keypoint-interval]]
-Keypoint Interval
-+++++++++++++++++
+===== Keypoint Interval
The keypoint interval determines how often entries for completed
transactions are removed from the log file. Keypointing prevents a
@@ -743,8 +713,7 @@
[[abeet]][[GSPTG00062]][[http-service-settings]]
-HTTP Service Settings
-~~~~~~~~~~~~~~~~~~~~~
+=== HTTP Service Settings
Tuning the monitoring and access logging settings for the HTTP server
instances that handle client requests are important parts of ensuring
@@ -757,8 +726,7 @@
[[abeeu]][[GSPTG00192]][[monitoring-the-http-service]]
-Monitoring the HTTP Service
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Monitoring the HTTP Service
Disabling the collection of monitoring statistics can increase overall
GlassFish Server performance. You can enable or disable monitoring
@@ -794,8 +762,7 @@
[[abeew]][[GSPTG00126]][[dns-cache-information-dns]]
-DNS Cache Information (dns)
-+++++++++++++++++++++++++++
+===== DNS Cache Information (dns)
The DNS cache caches IP addresses and DNS names. The DNS cache is
disabled by default. In the DNS Statistics for Process ID All page under
@@ -907,8 +874,7 @@
[[abefh]][[GSPTG00127]][[file-cache-information-file-cache]]
-File Cache Information (file-cache)
-+++++++++++++++++++++++++++++++++++
+===== File Cache Information (file-cache)
The file cache caches static content so that the server handles requests
for static content quickly. The file-cache section provides statistics
@@ -940,8 +906,7 @@
[[abefi]][[GSPTG00128]][[keep-alive-keep-alive]]
-Keep Alive (keep-alive)
-+++++++++++++++++++++++
+===== Keep Alive (keep-alive)
The following are statistics related to the Keep Alive system. The most
important settings you can tune here relate to HTTP Timeout. See
@@ -958,8 +923,7 @@
[[abefg]][[GSPTG00129]][[connection-queue]]
-Connection Queue
-++++++++++++++++
+===== Connection Queue
* Total Connections Queued: Total connections queued is the total number
of times a connection has been queued. This includes newly accepted
@@ -972,8 +936,7 @@
[[abefk]][[GSPTG00193]][[http-service-access-logging]]
-HTTP Service Access Logging
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== HTTP Service Access Logging
Accessing Logging can be tuned using several `asadmin` subcommands.
Refer to "link:../administration-guide/monitoring.html#GSADG00011[Administering the Monitoring Service]" in
@@ -994,8 +957,7 @@
[[abegk]][[GSPTG00063]][[network-listener-settings]]
-Network Listener Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Network Listener Settings
You can tune Network Listener settings from the command line by using
the instructions in "link:../administration-guide/http_https.html#GSADG00588[Administering HTTP Network
@@ -1017,8 +979,7 @@
[[abegl]][[GSPTG00194]][[general-settings-1]]
-General Settings
-^^^^^^^^^^^^^^^^
+==== General Settings
For machines with only one network interface card (NIC), set the network
address to the IP address of the machine (for example, 192.18.80.23
@@ -1030,8 +991,7 @@
[[gkxjd]][[GSPTG00195]][[http-settings]]
-HTTP Settings
-^^^^^^^^^^^^^
+==== HTTP Settings
The following settings on the HTTP tab can significantly affect
performance:
@@ -1043,8 +1003,7 @@
[[abeft]][[GSPTG00130]][[max-connections]]
-Max Connections
-+++++++++++++++
+===== Max Connections
Max Connections controls the number of requests that a particular client
can make over a keep-alive connection. The range is any positive
@@ -1061,8 +1020,7 @@
[[abegd]][[GSPTG00131]][[dns-lookup-enabled]]
-DNS Lookup Enabled
-++++++++++++++++++
+===== DNS Lookup Enabled
This setting specifies whether the server performs DNS (domain name
service) lookups on clients that access the server. When DNS lookup is
@@ -1080,8 +1038,7 @@
[[abefu]][[GSPTG00132]][[timeout]]
-Timeout
-+++++++
+===== Timeout
Timeout determines the maximum time (in seconds) that the server holds
open an HTTP keep alive connection. A client can keep a connection to
@@ -1122,8 +1079,7 @@
[[abefq]][[GSPTG00133]][[header-buffer-length]]
-Header Buffer Length
-++++++++++++++++++++
+===== Header Buffer Length
The size (in bytes) of the buffer used by each of the request processing
threads for reading the request data from the client.
@@ -1134,8 +1090,7 @@
[[gkxit]][[GSPTG00196]][[file-cache-settings]]
-File Cache Settings
-^^^^^^^^^^^^^^^^^^^
+==== File Cache Settings
The GlassFish Server uses a file cache to serve static information
faster. The file cache contains information about static files such as
@@ -1150,8 +1105,7 @@
[[abegf]][[GSPTG00134]][[max-file-count]]
-Max File Count
-++++++++++++++
+===== Max File Count
Max File Count determines how many files are in the cache. If the value
is too big, the server caches little-needed files, which wastes memory.
@@ -1161,8 +1115,7 @@
[[abegh]][[GSPTG00135]][[max-age]]
-Max Age
-+++++++
+===== Max Age
This parameter controls how long cached information is used after a file
has been cached. An entry older than the maximum age is replaced by a
@@ -1183,8 +1136,7 @@
[[gkxjt]][[GSPTG00064]][[transport-settings]]
-Transport Settings
-~~~~~~~~~~~~~~~~~~
+=== Transport Settings
The Acceptor Threads property for the Transport service specifies how
many threads you want in accept mode on a listen socket at any time. It
@@ -1205,8 +1157,7 @@
[[abehk]][[GSPTG00065]][[thread-pool-settings]]
-Thread Pool Settings
-~~~~~~~~~~~~~~~~~~~~
+=== Thread Pool Settings
You can tune thread pool settings by following the instructions in
"link:../administration-guide/threadpools.html#GSADG00008[Administering Thread Pools]" in GlassFish Server Open
@@ -1222,8 +1173,7 @@
[[abefn]][[GSPTG00197]][[max-thread-pool-size]]
-Max Thread Pool Size
-^^^^^^^^^^^^^^^^^^^^
+==== Max Thread Pool Size
The Max Thread Pool Size parameter specifies the maximum number of
simultaneous requests the server can handle. The default value is 5.
@@ -1257,8 +1207,7 @@
[[abefo]][[GSPTG00198]][[min-thread-pool-size]]
-Min Thread Pool Size
-^^^^^^^^^^^^^^^^^^^^
+==== Min Thread Pool Size
The Min Thread Pool Size property specifies the minimum number of
threads the server initiates upon startup. The default value is 2. Min
@@ -1273,8 +1222,7 @@
[[abegt]][[GSPTG00066]][[orb-settings]]
-ORB Settings
-~~~~~~~~~~~~
+=== ORB Settings
The GlassFish Server includes a high performance and scalable CORBA
Object Request Broker (ORB). The ORB is the foundation of the EJB
@@ -1299,8 +1247,7 @@
[[abegu]][[GSPTG00199]][[overview]]
-Overview
-^^^^^^^^
+==== Overview
The ORB is primarily used by EJB components via:
@@ -1322,8 +1269,7 @@
[[abegv]][[GSPTG00200]][[how-a-client-connects-to-the-orb]]
-How a Client Connects to the ORB
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How a Client Connects to the ORB
A rich client Java program performs a new `initialContext()` call which
creates a client side ORB instance. This in turn creates a socket
@@ -1345,8 +1291,7 @@
[[abegw]][[GSPTG00201]][[monitoring-the-orb]]
-Monitoring the ORB
-^^^^^^^^^^^^^^^^^^
+==== Monitoring the ORB
ORB statistics are disabled by default. To gather ORB statistics, enable
monitoring with the following `asadmin` command:
@@ -1370,8 +1315,7 @@
[[abegx]][[GSPTG00136]][[connection-statistics]]
-Connection Statistics
-+++++++++++++++++++++
+===== Connection Statistics
The following statistics are gathered on ORB connections:
@@ -1388,8 +1332,7 @@
[[abegy]][[GSPTG00137]][[thread-pools]]
-Thread Pools
-++++++++++++
+===== Thread Pools
The following statistics are gathered on ORB thread pools:
@@ -1406,8 +1349,7 @@
[[abegz]][[GSPTG00202]][[tuning-the-orb]]
-Tuning the ORB
-^^^^^^^^^^^^^^
+==== Tuning the ORB
Tune ORB performance by setting ORB parameters and ORB thread pool
parameters. You can often decrease response time by leveraging
@@ -1426,8 +1368,7 @@
[[abeha]][[GSPTG00138]][[tunable-orb-parameters]]
-Tunable ORB Parameters
-++++++++++++++++++++++
+===== Tunable ORB Parameters
You can tune ORB parameters using the instructions in
"link:../administration-guide/orb.html#GSADG00018[Administering the Object Request Broker (ORB)]" in
@@ -1463,8 +1404,7 @@
[[abehb]][[GSPTG00139]][[orb-thread-pool-parameters]]
-ORB Thread Pool Parameters
-++++++++++++++++++++++++++
+===== ORB Thread Pool Parameters
The ORB thread pool contains a task queue and a pool of threads. Tasks
or jobs are inserted into the task queue and free threads pick tasks
@@ -1502,8 +1442,7 @@
[[abehc]][[GSPTG00140]][[client-orb-properties]]
-Client ORB Properties
-+++++++++++++++++++++
+===== Client ORB Properties
Specify the following properties as command-line arguments when
launching the client program. You do this by using the following syntax
@@ -1600,8 +1539,7 @@
[[abehg]][[GSPTG00141]][[thread-pool-sizing]]
-Thread Pool Sizing
-++++++++++++++++++
+===== Thread Pool Sizing
After examining the number of inbound and outbound connections as
explained above, tune the size of the thread pool appropriately. This
@@ -1629,8 +1567,7 @@
[[abehh]][[GSPTG00142]][[examining-iiop-messages]]
-Examining IIOP Messages
-+++++++++++++++++++++++
+===== Examining IIOP Messages
It is sometimes useful to examine the IIOP messages passed by the
GlassFish Server. To make the server save IIOP messages to the
@@ -1683,8 +1620,7 @@
[[abehp]][[GSPTG00067]][[resource-settings]]
-Resource Settings
-~~~~~~~~~~~~~~~~~
+=== Resource Settings
Tuning JDBC and connector resources can significantly improve GlassFish
Server performance.
@@ -1696,8 +1632,7 @@
[[abehq]][[GSPTG00203]][[jdbc-connection-pool-settings]]
-JDBC Connection Pool Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== JDBC Connection Pool Settings
For optimum performance of database-intensive applications, tune the
JDBC Connection Pools managed by the GlassFish Server. These connection
@@ -1722,8 +1657,7 @@
[[abehr]][[GSPTG00143]][[monitoring-jdbc-connection-pools]]
-Monitoring JDBC Connection Pools
-++++++++++++++++++++++++++++++++
+===== Monitoring JDBC Connection Pools
Statistics-gathering is disabled by default for JDBC Connection Pools.
Refer to for instructions on enabling JDBC monitoring in
@@ -1757,8 +1691,7 @@
[[abehs]][[GSPTG00144]][[tuning-jdbc-connection-pools]]
-Tuning JDBC Connection Pools
-++++++++++++++++++++++++++++
+===== Tuning JDBC Connection Pools
Refer to "link:../administration-guide/jdbc.html#GSADG00015[Administering Database Connectivity]" in
GlassFish Server Open Source Edition Administration Guide for
@@ -1922,8 +1855,7 @@
[[abehy]][[GSPTG00204]][[connector-connection-pool-settings]]
-Connector Connection Pool Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Connector Connection Pool Settings
From a performance standpoint, connector connection pools are similar to
JDBC connection pools. Follow all the recommendations in the previous
@@ -1931,8 +1863,7 @@
[[abehz]][[GSPTG00145]][[transaction-support]]
-Transaction Support
-+++++++++++++++++++
+===== Transaction Support
You may be able to improve performance by overriding the default
transaction support specified for each connector connection pool.
@@ -1966,8 +1897,7 @@
[[gkxvd]][[GSPTG00068]][[load-balancer-settings]]
-Load Balancer Settings
-~~~~~~~~~~~~~~~~~~~~~~
+=== Load Balancer Settings
GlassFish Server Open Source Edition is compatible with the Apache HTTP
server `mod_jk` module for load balancing.
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/tuning-java.adoc b/docs/performance-tuning-guide/src/main/jbake/content/tuning-java.adoc
index 9b65e10..663fb8c 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/tuning-java.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/tuning-java.adoc
@@ -5,15 +5,13 @@
prev=tuning-glassfish.html
~~~~~~
-Tuning the Java Runtime System
-==============================
+= Tuning the Java Runtime System
[[GSPTG00006]][[abeia]]
[[tuning-the-java-runtime-system]]
-4 Tuning the Java Runtime System
---------------------------------
+== 4 Tuning the Java Runtime System
The following topics are addressed here:
@@ -25,8 +23,7 @@
[[abeib]][[GSPTG00069]][[java-virtual-machine-settings]]
-Java Virtual Machine Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Java Virtual Machine Settings
Java SE 7 provides two implementations of the HotSpot Java virtual
machine (JVM):
@@ -63,8 +60,7 @@
[[gfpzy]][[GSPTG00070]][[start-options]]
-Start Options
-~~~~~~~~~~~~~
+=== Start Options
In some situations, performance can be improved by using large page
sizes. For Ultrasparc CMT systems, include the `-XX:+UseLargePages` and
@@ -72,8 +68,7 @@
[[glaat]][[GSPTG00071]][[tuning-high-availability-persistence]]
-Tuning High Availability Persistence
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Tuning High Availability Persistence
If session `s1` and `s2` need to be replicated to an instance (backup
server), the replication module batches the replication messages to be
@@ -90,8 +85,7 @@
[[abeic]][[GSPTG00072]][[managing-memory-and-garbage-collection]]
-Managing Memory and Garbage Collection
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Managing Memory and Garbage Collection
The efficiency of any application depends on how well memory and garbage
collection are managed. The following sections provide information on
@@ -105,8 +99,7 @@
[[abeid]][[GSPTG00205]][[tuning-the-garbage-collector]]
-Tuning the Garbage Collector
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning the Garbage Collector
Garbage collection (GC) reclaims the heap space previously allocated to
objects no longer needed. The process of locating and removing the dead
@@ -158,8 +151,7 @@
[[abeie]][[GSPTG00146]][[choosing-the-garbage-collection-algorithm]]
-Choosing the Garbage Collection Algorithm
-+++++++++++++++++++++++++++++++++++++++++
+===== Choosing the Garbage Collection Algorithm
The default collector for Java server class machines will optimize for
throughput but be tolerant of somewhat long pause times. If you would
@@ -182,8 +174,7 @@
[[abeif]][[GSPTG00147]][[additional-information]]
-Additional Information
-++++++++++++++++++++++
+===== Additional Information
Use the `jvmstat` utility to monitor HotSpot garbage collection. (See
link:#abeiq[Further Information].)
@@ -195,8 +186,7 @@
[[abeig]][[GSPTG00206]][[tracing-garbage-collection]]
-Tracing Garbage Collection
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tracing Garbage Collection
The two primary measures of garbage collection performance are
throughput and pauses. Throughput is the percentage of the total time
@@ -246,8 +236,7 @@
[[abeih]][[GSPTG00207]][[other-garbage-collector-settings]]
-Other Garbage Collector Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Other Garbage Collector Settings
To specify the attributes for the Java virtual machine, use the
Administration Console and set the property under config-name > JVM
@@ -255,8 +244,7 @@
[[glgkm]][[GSPTG00148]][[setting-the-maximum-permanent-generation]]
-Setting the Maximum Permanent Generation
-++++++++++++++++++++++++++++++++++++++++
+===== Setting the Maximum Permanent Generation
For applications that do not dynamically generate and load classes, the
size of the permanent generation does not affect GC performance. For
@@ -268,8 +256,7 @@
[[glglk]][[GSPTG00149]][[disabling-explicit-garbage-collection]]
-Disabling Explicit Garbage Collection
-+++++++++++++++++++++++++++++++++++++
+===== Disabling Explicit Garbage Collection
Although applications can explicitly invoke GC with the `System.gc()`
method, doing so is a bad idea since this forces major collections, and
@@ -298,8 +285,7 @@
[[glglr]][[GSPTG00150]][[setting-the-frequency-of-full-garbage-collection]]
-Setting the Frequency of Full Garbage Collection
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== Setting the Frequency of Full Garbage Collection
GlassFish Server uses RMI in the Administration module for monitoring.
Garbage cannot be collected in RMI-based distributed applications
@@ -311,8 +297,7 @@
[[abeii]][[GSPTG00208]][[tuning-the-java-heap]]
-Tuning the Java Heap
-^^^^^^^^^^^^^^^^^^^^
+==== Tuning the Java Heap
This section discusses topics related to tuning the Java Heap for
performance.
@@ -322,8 +307,7 @@
[[abeij]][[GSPTG00151]][[guidelines-for-java-heap-sizing]]
-Guidelines for Java Heap Sizing
-+++++++++++++++++++++++++++++++
+===== Guidelines for Java Heap Sizing
Maximum heap size depends on maximum address space per process. The
following table shows the maximum per-process address values for various
@@ -362,8 +346,7 @@
[[abeik]][[GSPTG00152]][[heap-tuning-parameters]]
-Heap Tuning Parameters
-++++++++++++++++++++++
+===== Heap Tuning Parameters
You can control the heap size with the following JVM parameters:
@@ -458,8 +441,7 @@
[[abeio]][[GSPTG00209]][[rebasing-dlls-on-windows]]
-Rebasing DLLs on Windows
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Rebasing DLLs on Windows
When the JVM initializes, it tries to allocate its heap using the `-Xms`
setting. The base addresses of GlassFish Server DLLs can restrict the
@@ -488,8 +470,7 @@
[[gacmt]][[GSPTG00039]][[to-rebase-the-glassfish-servers-dlls]]
-To rebase the GlassFish Server's DLLs
-+++++++++++++++++++++++++++++++++++++
+===== To rebase the GlassFish Server's DLLs
[[sthref11]]
@@ -549,8 +530,7 @@
[[abeiq]][[GSPTG00073]][[further-information]]
-Further Information
-~~~~~~~~~~~~~~~~~~~
+=== Further Information
For more information on tuning the JVM, see:
diff --git a/docs/performance-tuning-guide/src/main/jbake/content/tuning-os.adoc b/docs/performance-tuning-guide/src/main/jbake/content/tuning-os.adoc
index 58ba4a2..9cf26ee 100644
--- a/docs/performance-tuning-guide/src/main/jbake/content/tuning-os.adoc
+++ b/docs/performance-tuning-guide/src/main/jbake/content/tuning-os.adoc
@@ -4,15 +4,13 @@
prev=tuning-java.html
~~~~~~
-Tuning the Operating System and Platform
-========================================
+= Tuning the Operating System and Platform
[[GSPTG00007]][[abeir]]
[[tuning-the-operating-system-and-platform]]
-5 Tuning the Operating System and Platform
-------------------------------------------
+== 5 Tuning the Operating System and Platform
This chapter discusses tuning the operating system (OS) for optimum
performance. It discusses the following topics:
@@ -26,8 +24,7 @@
[[abeis]][[GSPTG00074]][[server-scaling]]
-Server Scaling
-~~~~~~~~~~~~~~
+=== Server Scaling
This section provides recommendations for optimal performance scaling
server for the following server subsystems:
@@ -40,8 +37,7 @@
[[abeit]][[GSPTG00210]][[processors]]
-Processors
-^^^^^^^^^^
+==== Processors
The GlassFish Server automatically takes advantage of multiple CPUs. In
general, the effectiveness of multiple CPUs varies with the operating
@@ -57,8 +53,7 @@
[[abeiu]][[GSPTG00211]][[memory]]
-Memory
-^^^^^^
+==== Memory
See the section Hardware and Software Requirements in the GlassFish
Server Release Notes for specific memory recommendations for each
@@ -66,8 +61,7 @@
[[abeiv]][[GSPTG00212]][[disk-space]]
-Disk Space
-^^^^^^^^^^
+==== Disk Space
It is best to have enough disk space for the OS, document tree, and log
files. In most cases 2GB total is sufficient.
@@ -84,8 +78,7 @@
[[abeiw]][[GSPTG00213]][[networking]]
-Networking
-^^^^^^^^^^
+==== Networking
To determine the bandwidth the application needs, determine the
following values:
@@ -116,8 +109,7 @@
[[glglf]][[GSPTG00214]][[udp-buffer-sizes]]
-UDP Buffer Sizes
-^^^^^^^^^^^^^^^^
+==== UDP Buffer Sizes
GlassFish Server uses User Datagram Protocol (UDP) for the transmission
of multicast messages to GlassFish Server instances in a cluster. For
@@ -128,8 +120,7 @@
[[sthref13]][[to-determine-an-optimal-udp-buffer-size]]
-To Determine an Optimal UDP Buffer Size
-+++++++++++++++++++++++++++++++++++++++
+===== To Determine an Optimal UDP Buffer Size
The size of UDP buffer that is required to prevent excessive UDP
datagram loss depends on many factors, such as:
@@ -188,8 +179,7 @@
[[glglz]][[GSPTG00040]][[to-set-the-udp-buffer-size-on-linux-systems]]
-To Set the UDP Buffer Size on Linux Systems
-+++++++++++++++++++++++++++++++++++++++++++
+===== To Set the UDP Buffer Size on Linux Systems
On Linux systems, a default UDP buffer size is set for the client, but
not for the server. Therefore, on Linux systems, the UDP buffer size
@@ -262,8 +252,7 @@
[[gfpzp]][[GSPTG00075]][[solaris-10-platform-specific-tuning-information]]
-Solaris 10 Platform-Specific Tuning Information
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Solaris 10 Platform-Specific Tuning Information
Solaris Dynamic Tracing (DTrace) is a comprehensive dynamic tracing
framework for the Solaris Operating System (OS). You can use the DTrace
@@ -275,16 +264,14 @@
[[abeix]][[GSPTG00076]][[tuning-for-the-solaris-os]]
-Tuning for the Solaris OS
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Tuning for the Solaris OS
* link:#abeiy[Tuning Parameters]
* link:#abeja[File Descriptor Setting]
[[abeiy]][[GSPTG00215]][[tuning-parameters]]
-Tuning Parameters
-^^^^^^^^^^^^^^^^^
+==== Tuning Parameters
Tuning Solaris TCP/IP settings benefits programs that open and close
many sockets. Since the GlassFish Server operates with a small fixed set
@@ -414,8 +401,7 @@
[[abeiz]][[GSPTG00153]][[sizing-the-connection-hash-table]]
-Sizing the Connection Hash Table
-++++++++++++++++++++++++++++++++
+===== Sizing the Connection Hash Table
The connection hash table keeps all the information for active TCP
connections. Use the following command to get the size of the connection
@@ -442,8 +428,7 @@
[[abeja]][[GSPTG00216]][[file-descriptor-setting]]
-File Descriptor Setting
-^^^^^^^^^^^^^^^^^^^^^^^
+==== File Descriptor Setting
On the Solaris OS, setting the maximum number of open files property
using `ulimit` has the biggest impact on efforts to support the maximum
@@ -489,8 +474,7 @@
[[abeje]][[GSPTG00077]][[tuning-for-solaris-on-x86]]
-Tuning for Solaris on x86
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Tuning for Solaris on x86
The following are some options to consider when tuning Solaris on x86
for GlassFish Server:
@@ -503,8 +487,7 @@
[[abejg]][[GSPTG00217]][[file-descriptors]]
-File Descriptors
-^^^^^^^^^^^^^^^^
+==== File Descriptors
Add (or edit) the following lines in the `/etc/system` file:
@@ -522,8 +505,7 @@
[[abejh]][[GSPTG00218]][[ip-stack-settings]]
-IP Stack Settings
-^^^^^^^^^^^^^^^^^
+==== IP Stack Settings
Add (or edit) the following lines in the `/etc/system` file:
@@ -560,8 +542,7 @@
[[abeji]][[GSPTG00078]][[tuning-for-linux-platforms]]
-Tuning for Linux platforms
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Tuning for Linux platforms
To tune for maximum performance on Linux, you need to make adjustments
to the following:
@@ -575,8 +556,7 @@
[[gkvjl]][[GSPTG00219]][[startup-files]]
-Startup Files
-^^^^^^^^^^^^^
+==== Startup Files
The following parameters must be added to the `/etc/rc.d/rc.local` file
that gets executed during system startup.
@@ -636,8 +616,7 @@
[[abejj]][[GSPTG00220]][[file-descriptors-1]]
-File Descriptors
-^^^^^^^^^^^^^^^^
+==== File Descriptors
You may need to increase the number of file descriptors from the
default. Having a higher number of file descriptors ensures that the
@@ -744,8 +723,7 @@
[[abejk]][[GSPTG00221]][[virtual-memory]]
-Virtual Memory
-^^^^^^^^^^^^^^
+==== Virtual Memory
To change virtual memory settings, add the following to `/etc/rc.local`:
@@ -758,8 +736,7 @@
[[abejl]][[GSPTG00222]][[network-interface]]
-Network Interface
-^^^^^^^^^^^^^^^^^
+==== Network Interface
To ensure that the network interface is operating in full duplex mode,
add the following entry into `/etc/rc.local`:
@@ -773,15 +750,13 @@
[[abejm]][[GSPTG00223]][[disk-io-settings]]
-Disk I/O Settings
-^^^^^^^^^^^^^^^^^
+==== Disk I/O Settings
[[gaclw]][[GSPTG00041]][[to-tune-disk-io-performance-for-non-scsi-disks]]
-To tune disk I/O performance for non SCSI disks
-+++++++++++++++++++++++++++++++++++++++++++++++
+===== To tune disk I/O performance for non SCSI disks
1. Test the disk speed.
+
@@ -815,15 +790,13 @@
[[abejn]][[GSPTG00224]][[tcpip-settings]]
-TCP/IP Settings
-^^^^^^^^^^^^^^^
+==== TCP/IP Settings
[[gacmd]][[GSPTG00042]][[to-tune-the-tcpip-settings]]
-To tune the TCP/IP settings
-+++++++++++++++++++++++++++
+===== To tune the TCP/IP settings
1. Add the following entry to `/etc/rc.local`
+
@@ -875,8 +848,7 @@
[[gfpzh]][[GSPTG00079]][[tuning-ultrasparc-cmt-based-systems]]
-Tuning UltraSPARC CMT-Based Systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Tuning UltraSPARC CMT-Based Systems
Use a combination of tunable parameters and other parameters to tune
UltraSPARC CMT-based systems. These values are an example of how you
@@ -884,8 +856,7 @@
[[gfpzv]][[GSPTG00225]][[tuning-operating-system-and-tcp-settings]]
-Tuning Operating System and TCP Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tuning Operating System and TCP Settings
The following table shows the operating system tuning for Solaris 10
used when benchmarking for performance and scalability on UtraSPARC
@@ -1013,8 +984,7 @@
[[gfpzm]][[GSPTG00226]][[disk-configuration]]
-Disk Configuration
-^^^^^^^^^^^^^^^^^^
+==== Disk Configuration
If HTTP access is logged, follow these guidelines for the disk:
@@ -1028,8 +998,7 @@
[[gfpzk]][[GSPTG00227]][[network-configuration]]
-Network Configuration
-^^^^^^^^^^^^^^^^^^^^^
+==== Network Configuration
If more than one network interface card is used, make sure the network
interrupts are not all going to the same core. Run the following script
diff --git a/docs/quick-start-guide/src/main/jbake/content/basic-features.adoc b/docs/quick-start-guide/src/main/jbake/content/basic-features.adoc
index aa2a17a..01a7dc5 100644
--- a/docs/quick-start-guide/src/main/jbake/content/basic-features.adoc
+++ b/docs/quick-start-guide/src/main/jbake/content/basic-features.adoc
@@ -4,15 +4,13 @@
prev=preface.html
~~~~~~
-Quick Start for Basic Features
-==============================
+= Quick Start for Basic Features
[[GSQSG00003]][[aboaa]]
[[quick-start-for-basic-features]]
-1 Quick Start for Basic Features
---------------------------------
+== 1 Quick Start for Basic Features
Eclipse GlassFish Server provides a server for the
development and deployment of Java Platform, Enterprise Edition (Jakarta EE
@@ -39,8 +37,7 @@
[[ghgpe]][[GSQSG00030]][[about-this-quick-start-guide]]
-About This Quick Start Guide
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About This Quick Start Guide
Eclipse GlassFish Server 7 Quick Start Guide demonstrates
key features of the GlassFish Server product and enables you to quickly
@@ -75,8 +72,7 @@
[[ghpfg]][[GSQSG00031]][[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
@@ -127,8 +123,7 @@
[[gixue]][[GSQSG00032]][[default-administration-values]]
-Default Administration Values
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Administration Values
The following table lists default administration values for GlassFish
Server. See link:#ghpfg[Default Paths and File Names] for more
@@ -173,8 +168,7 @@
[[gglog]][[GSQSG00033]][[starting-and-stopping-the-default-domain]]
-Starting and Stopping the Default Domain
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Starting and Stopping the Default Domain
When you install GlassFish Server, a default domain named `domain1` is
created. The following procedures describe how to start and stop
@@ -185,8 +179,7 @@
[[ggmpd]][[GSQSG00005]][[to-start-the-default-domain]]
-To Start the Default Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start the Default Domain
[[sthref6]]
@@ -205,8 +198,7 @@
[[ggmsx]][[GSQSG00006]][[to-stop-the-default-domain]]
-To Stop the Default Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop the Default Domain
Run the `asadmin stop-domain` command without an operand:
@@ -232,8 +224,7 @@
[[gglmh]][[GSQSG00034]][[starting-and-stopping-the-database-server]]
-Starting and Stopping the Database Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Starting and Stopping the Database Server
A database server is not started by default when you start the GlassFish
Server domain. If your applications require a database back end, you
@@ -254,8 +245,7 @@
[[ggncr]][[GSQSG00007]][[to-start-the-apache-derby-server]]
-To Start the Apache Derby Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start the Apache Derby Server
[[sthref7]]
@@ -282,8 +272,7 @@
[[ggnez]][[GSQSG00008]][[to-stop-the-apache-derby-server]]
-To Stop the Apache Derby Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Stop the Apache Derby Server
Run the `asadmin stop-database` command:
@@ -294,16 +283,14 @@
[[ggllq]][[GSQSG00035]][[starting-the-administration-console]]
-Starting the Administration Console
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Starting the Administration Console
The GlassFish Server Administration Console provides a browser interface
for configuring, administering, and monitoring GlassFish Server.
[[ggnbp]][[GSQSG00009]][[to-start-the-administration-console]]
-To Start the Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Start the Administration Console
[[sthref8]]
@@ -333,8 +320,7 @@
[[geyvr]][[GSQSG00036]][[deploying-and-undeploying-applications]]
-Deploying and Undeploying Applications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Deploying and Undeploying Applications
The process of configuring and enabling applications to run within the
GlassFish Server framework is referred to as deployment.
@@ -350,8 +336,7 @@
[[ghgis]][[GSQSG00010]][[to-obtain-the-sample-application]]
-To Obtain the Sample Application
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Obtain the Sample Application
1. Download a copy of the `hello.war` sample application from
`https://github.com/eclipse-ee4j/glassfishdownloads/quickstart/hello.war`.
@@ -362,8 +347,7 @@
[[gkpao]][[GSQSG00044]][[deploying-and-undeploying-the-sample-application-from-the-command-line]]
-Deploying and Undeploying the Sample Application From the Command Line
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying and Undeploying the Sample Application From the Command Line
GlassFish Server provides `asadmin` subcommands for performing the
following deployment-related tasks:
@@ -374,8 +358,7 @@
[[ggndq]][[GSQSG00011]][[to-deploy-the-sample-application-from-the-command-line]]
-To Deploy the Sample Application From the Command Line
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Deploy the Sample Application From the Command Line
[[sthref10]]
@@ -434,8 +417,7 @@
[[ggnco]][[GSQSG00012]][[to-list-deployed-applications-from-the-command-line]]
-To List Deployed Applications From the Command Line
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To List Deployed Applications From the Command Line
Run the `asadmin list-applications` command:
@@ -446,8 +428,7 @@
[[ggnbm]][[GSQSG00013]][[to-undeploy-the-sample-application-from-the-command-line]]
-To Undeploy the Sample Application From the Command Line
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Undeploy the Sample Application From the Command Line
Run the `asadmin undeploy` command.
@@ -476,8 +457,7 @@
[[gkpau]][[GSQSG00045]][[deploying-and-undeploying-applications-by-using-the-administration-console]]
-Deploying and Undeploying Applications by Using the Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying and Undeploying Applications by Using the Administration Console
The graphical Administration Console of GlassFish Server enables you to
perform the following deployment-related tasks:
@@ -488,8 +468,7 @@
[[ggnbn]][[GSQSG00014]][[to-deploy-the-sample-application-by-using-the-administration-console]]
-To Deploy the Sample Application by Using the Administration Console
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Deploy the Sample Application by Using the Administration Console
[[sthref13]]
@@ -549,8 +528,7 @@
[[ggncd]][[GSQSG00015]][[to-view-deployed-applications-in-the-administration-console]]
-To View Deployed Applications in the Administration Console
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To View Deployed Applications in the Administration Console
1. Launch the Administration Console by typing the following URL in
your browser:
@@ -567,8 +545,7 @@
[[ggneh]][[GSQSG00016]][[to-undeploy-the-sample-application-by-using-the-administration-console]]
-To Undeploy the Sample Application by Using the Administration Console
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Undeploy the Sample Application by Using the Administration Console
1. Launch the Administration Console by typing the following URL in your browser:
+
@@ -595,8 +572,7 @@
[[gkpaa]][[GSQSG00046]][[deploying-and-undeploying-the-sample-application-automatically]]
-Deploying and Undeploying the Sample Application Automatically
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deploying and Undeploying the Sample Application Automatically
GlassFish Server enables you to performing the following
deployment-related tasks automatically:
@@ -606,8 +582,7 @@
[[geyvj]][[GSQSG00017]][[to-deploy-the-sample-application-automatically]]
-To Deploy the Sample Application Automatically
-++++++++++++++++++++++++++++++++++++++++++++++
+===== To Deploy the Sample Application Automatically
You can deploy applications automatically by placing them in the
domain-dir`/autodeploy` directory, where domain-dir is the directory of
@@ -652,8 +627,7 @@
[[ggncw]][[GSQSG00018]][[to-undeploy-the-sample-application-automatically]]
-To Undeploy the Sample Application Automatically
-++++++++++++++++++++++++++++++++++++++++++++++++
+===== To Undeploy the Sample Application Automatically
1. Change to the domain's `autodeploy` directory.
+
@@ -678,8 +652,7 @@
[[gktqx]][[GSQSG00037]][[high-availability-clustering-and-load-balancing]]
-High Availability Clustering and Load Balancing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== High Availability Clustering and Load Balancing
GlassFish Server enables multiple GlassFish Server instances to be
clustered to provide high availability through failure protection,
@@ -689,8 +662,7 @@
[[gktob]][[GSQSG00047]][[clusters-of-glassfish-server-instances]]
-Clusters of GlassFish Server Instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Clusters of GlassFish Server Instances
A cluster is a collection of GlassFish Server instances that work
together as one logical entity. A cluster provides a runtime environment
@@ -722,8 +694,7 @@
[[gktpt]][[GSQSG00048]][[session-persistence-and-failover]]
-Session Persistence and Failover
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Session Persistence and Failover
Storing session state data enables the session state to be recovered
after the failover of an instance in a cluster. Recovering the session
@@ -737,8 +708,7 @@
[[gksbz]][[GSQSG00049]][[load-balancing-for-clustered-configurations]]
-Load Balancing for Clustered Configurations
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Load Balancing for Clustered Configurations
GlassFish Server supports web server and hardware-based load balancing
for clustered configurations. A load balancer is deployed with a
@@ -767,8 +737,7 @@
[[ggkzh]][[GSQSG00040]][[for-more-information]]
-For More Information
-~~~~~~~~~~~~~~~~~~~~
+=== For More Information
Additional resources are available to help you learn more about
GlassFish Server 7 and related technologies.
@@ -781,8 +750,7 @@
[[ghhir]][[GSQSG00050]][[product-documentation]]
-Product Documentation
-^^^^^^^^^^^^^^^^^^^^^
+==== Product Documentation
Comprehensive product documentation is available and includes the
following.
@@ -794,8 +762,7 @@
[[giyjo]][[GSQSG00052]][[tutorials]]
-Tutorials
-^^^^^^^^^
+==== Tutorials
The following tutorials provide working examples and detailed
instructions for creating enterprise applications for the Jakarta EE platform.
diff --git a/docs/quick-start-guide/src/main/jbake/content/preface.adoc b/docs/quick-start-guide/src/main/jbake/content/preface.adoc
index 523d348..0559df4 100644
--- a/docs/quick-start-guide/src/main/jbake/content/preface.adoc
+++ b/docs/quick-start-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[gkamj]][[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -53,8 +51,7 @@
[[ghpbz]][[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -156,8 +153,7 @@
[[fwbkx]][[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -194,8 +190,7 @@
[[fquvc]][[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
diff --git a/docs/quick-start-guide/src/main/jbake/content/title.adoc b/docs/quick-start-guide/src/main/jbake/content/title.adoc
index 1a5b9a9..a5423a4 100644
--- a/docs/quick-start-guide/src/main/jbake/content/title.adoc
+++ b/docs/quick-start-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-Eclipse GlassFish Server Quick Start Guide, Release 7
-=====================================================
+= Eclipse GlassFish Server Quick Start Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Quick Start Guide
diff --git a/docs/quick-start-guide/src/main/jbake/content/toc.adoc b/docs/quick-start-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..94695ad
--- /dev/null
+++ b/docs/quick-start-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,44 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Quick Start Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Quick Start Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#ghpbz[GlassFish Server Documentation Set]
+** link:preface.html#fwbkx[Typographic Conventions]
+** link:preface.html#fquvc[Symbol Conventions]
+
+[[quick-start-for-basic-features]]
+=== link:basic-features.html#GSQSG00003[1 Quick Start for Basic Features]
+
+** link:basic-features.html#GSQSG00030[About This Quick Start Guide]
+** link:basic-features.html#GSQSG00031[Default Paths and File Names]
+** link:basic-features.html#GSQSG00032[Default Administration Values]
+** link:basic-features.html#GSQSG00033[Starting and Stopping the Default Domain]
+*** link:basic-features.html#GSQSG00005[To Start the Default Domain]
+*** link:basic-features.html#GSQSG00006[To Stop the Default Domain]
+** link:basic-features.html#GSQSG00034[Starting and Stopping the Database Server]
+*** link:basic-features.html#GSQSG00007[To Start the Apache Derby Server]
+*** link:basic-features.html#GSQSG00008[To Stop the Apache Derby Server]
+** link:basic-features.html#GSQSG00035[Starting the Administration Console]
+*** link:basic-features.html#GSQSG00009[To Start the Administration Console]
+** link:basic-features.html#GSQSG00036[Deploying and Undeploying Applications]
+*** link:basic-features.html#GSQSG00010[To Obtain the Sample Application]
+*** link:basic-features.html#GSQSG00044[Deploying and Undeploying the Sample Application From the Command Line]
+*** link:basic-features.html#GSQSG00045[Deploying and Undeploying Applications by Using the Administration Console]
+*** link:basic-features.html#GSQSG00046[Deploying and Undeploying the Sample Application Automatically]
+** link:basic-features.html#GSQSG00037[High Availability Clustering and Load Balancing]
+*** link:basic-features.html#GSQSG00047[Clusters of GlassFish Server Instances]
+*** link:basic-features.html#GSQSG00048[Session Persistence and Failover]
+*** link:basic-features.html#GSQSG00049[Load Balancing for Clustered Configurations]
+** link:basic-features.html#GSQSG00040[For More Information]
+*** link:basic-features.html#GSQSG00050[Product Documentation]
+*** link:basic-features.html#GSQSG00052[Tutorials]
diff --git a/docs/reference-manual/src/main/jbake/content/add-library.adoc b/docs/reference-manual/src/main/jbake/content/add-library.adoc
index 4f59c16..fdc93c7 100644
--- a/docs/reference-manual/src/main/jbake/content/add-library.adoc
+++ b/docs/reference-manual/src/main/jbake/content/add-library.adoc
@@ -5,13 +5,11 @@
prev=manvol1.html
~~~~~~
-add-library
-===========
+= add-library
[[add-library-1]][[GSRFM00818]][[add-library]]
-add-library
------------
+== add-library
Adds one or more library JAR files to {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/add-resources.adoc b/docs/reference-manual/src/main/jbake/content/add-resources.adoc
index 8417758..e286cbd 100644
--- a/docs/reference-manual/src/main/jbake/content/add-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/add-resources.adoc
@@ -5,13 +5,11 @@
prev=add-library.html
~~~~~~
-add-resources
-=============
+= add-resources
[[add-resources-1]][[GSRFM00001]][[add-resources]]
-add-resources
--------------
+== add-resources
Creates the resources specified in an XML file
diff --git a/docs/reference-manual/src/main/jbake/content/appclient.adoc b/docs/reference-manual/src/main/jbake/content/appclient.adoc
index 1f5757e..63abdc5 100644
--- a/docs/reference-manual/src/main/jbake/content/appclient.adoc
+++ b/docs/reference-manual/src/main/jbake/content/appclient.adoc
@@ -5,13 +5,11 @@
prev=manvol1m.html
~~~~~~
-appclient
-=========
+= appclient
[[appclient-1m]][[GSRFM00262]][[appclient]]
-appclient
----------
+== appclient
Launches the Application Client Container and invokes the client
application typically packaged in the application JAR file
diff --git a/docs/reference-manual/src/main/jbake/content/application.adoc b/docs/reference-manual/src/main/jbake/content/application.adoc
index d407e24..d212e1c 100644
--- a/docs/reference-manual/src/main/jbake/content/application.adoc
+++ b/docs/reference-manual/src/main/jbake/content/application.adoc
@@ -5,13 +5,11 @@
prev=manvol5asc.html
~~~~~~
-application
-===========
+= application
[[application-5asc]][[GSRFM00265]][[application]]
-application
------------
+== application
Server-side Java applications and web services
diff --git a/docs/reference-manual/src/main/jbake/content/apply-http-lb-changes.adoc b/docs/reference-manual/src/main/jbake/content/apply-http-lb-changes.adoc
index 04bd5ad..da35107 100644
--- a/docs/reference-manual/src/main/jbake/content/apply-http-lb-changes.adoc
+++ b/docs/reference-manual/src/main/jbake/content/apply-http-lb-changes.adoc
@@ -5,13 +5,11 @@
prev=add-resources.html
~~~~~~
-apply-http-lb-changes
-=====================
+= apply-http-lb-changes
[[apply-http-lb-changes-1]][[GSRFM00002]][[apply-http-lb-changes]]
-apply-http-lb-changes
----------------------
+== apply-http-lb-changes
Applies load balancer configuration changes to the load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/asadmin.adoc b/docs/reference-manual/src/main/jbake/content/asadmin.adoc
index 16054f6..6ca0c86 100644
--- a/docs/reference-manual/src/main/jbake/content/asadmin.adoc
+++ b/docs/reference-manual/src/main/jbake/content/asadmin.adoc
@@ -5,16 +5,14 @@
prev=appclient.html
~~~~~~
-asadmin
-=======
+= asadmin
The script content on this page is for navigation purposes only and does
not alter the content in any way.
[[asadmin-1m]][[GSRFM00263]][[asadmin]]
-asadmin
--------
+== asadmin
Utility for performing administrative tasks for Oracle {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/attach.adoc b/docs/reference-manual/src/main/jbake/content/attach.adoc
index 7d5b711..21f2694 100644
--- a/docs/reference-manual/src/main/jbake/content/attach.adoc
+++ b/docs/reference-manual/src/main/jbake/content/attach.adoc
@@ -5,13 +5,11 @@
prev=apply-http-lb-changes.html
~~~~~~
-attach
-======
+= attach
[[attach-1]][[GSRFM825]][[attach]]
-attach
-------
+== attach
Attaches to subcommands that were started using `asadmin --detach` or
that contain progress information
diff --git a/docs/reference-manual/src/main/jbake/content/backup-domain.adoc b/docs/reference-manual/src/main/jbake/content/backup-domain.adoc
index 77cb917..f1dee82 100644
--- a/docs/reference-manual/src/main/jbake/content/backup-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/backup-domain.adoc
@@ -5,13 +5,11 @@
prev=attach.html
~~~~~~
-backup-domain
-=============
+= backup-domain
[[backup-domain-1]][[GSRFM00003]][[backup-domain]]
-backup-domain
--------------
+== backup-domain
Performs a backup on the domain
diff --git a/docs/reference-manual/src/main/jbake/content/capture-schema.adoc b/docs/reference-manual/src/main/jbake/content/capture-schema.adoc
index 28c89c0..2e86d21 100644
--- a/docs/reference-manual/src/main/jbake/content/capture-schema.adoc
+++ b/docs/reference-manual/src/main/jbake/content/capture-schema.adoc
@@ -5,13 +5,11 @@
prev=asadmin.html
~~~~~~
-capture-schema
-==============
+= capture-schema
[[capture-schema-1m]][[GSRFM00821]][[capture-schema]]
-capture-schema
---------------
+== capture-schema
Stores the database metadata (schema) in a file for use in mapping and execution
diff --git a/docs/reference-manual/src/main/jbake/content/change-admin-password.adoc b/docs/reference-manual/src/main/jbake/content/change-admin-password.adoc
index e14ea8d..7354e61 100644
--- a/docs/reference-manual/src/main/jbake/content/change-admin-password.adoc
+++ b/docs/reference-manual/src/main/jbake/content/change-admin-password.adoc
@@ -5,13 +5,11 @@
prev=backup-domain.html
~~~~~~
-change-admin-password
-=====================
+= change-admin-password
[[change-admin-password-1]][[GSRFM00004]][[change-admin-password]]
-change-admin-password
----------------------
+== change-admin-password
Changes the administrator password
diff --git a/docs/reference-manual/src/main/jbake/content/change-master-broker.adoc b/docs/reference-manual/src/main/jbake/content/change-master-broker.adoc
index 5864c5a..11bd4b3 100644
--- a/docs/reference-manual/src/main/jbake/content/change-master-broker.adoc
+++ b/docs/reference-manual/src/main/jbake/content/change-master-broker.adoc
@@ -5,13 +5,11 @@
prev=change-admin-password.html
~~~~~~
-change-master-broker
-====================
+= change-master-broker
[[change-master-broker-1]][[GSRFM00005]][[change-master-broker]]
-change-master-broker
---------------------
+== change-master-broker
Changes the master broker in a Message Queue cluster providing JMS
services for a {productName} cluster.
diff --git a/docs/reference-manual/src/main/jbake/content/change-master-password.adoc b/docs/reference-manual/src/main/jbake/content/change-master-password.adoc
index e3e2450..f45cb97 100644
--- a/docs/reference-manual/src/main/jbake/content/change-master-password.adoc
+++ b/docs/reference-manual/src/main/jbake/content/change-master-password.adoc
@@ -5,13 +5,11 @@
prev=change-master-broker.html
~~~~~~
-change-master-password
-======================
+= change-master-password
[[change-master-password-1]][[GSRFM00006]][[change-master-password]]
-change-master-password
-----------------------
+== change-master-password
Changes the master password
diff --git a/docs/reference-manual/src/main/jbake/content/collect-log-files.adoc b/docs/reference-manual/src/main/jbake/content/collect-log-files.adoc
index 95ddc97..5c3fcea 100644
--- a/docs/reference-manual/src/main/jbake/content/collect-log-files.adoc
+++ b/docs/reference-manual/src/main/jbake/content/collect-log-files.adoc
@@ -5,13 +5,11 @@
prev=change-master-password.html
~~~~~~
-collect-log-files
-=================
+= collect-log-files
[[collect-log-files-1]][[GSRFM00007]][[collect-log-files]]
-collect-log-files
------------------
+== collect-log-files
Creates a ZIP archive of all available log files
diff --git a/docs/reference-manual/src/main/jbake/content/configuration.adoc b/docs/reference-manual/src/main/jbake/content/configuration.adoc
index ee1376d..8d29c88 100644
--- a/docs/reference-manual/src/main/jbake/content/configuration.adoc
+++ b/docs/reference-manual/src/main/jbake/content/configuration.adoc
@@ -5,13 +5,11 @@
prev=application.html
~~~~~~
-configuration
-=============
+= configuration
[[configuration-5asc]][[GSRFM00266]][[configuration]]
-configuration
--------------
+== configuration
The data set that determines how {productName} operates
diff --git a/docs/reference-manual/src/main/jbake/content/configure-jms-cluster.adoc b/docs/reference-manual/src/main/jbake/content/configure-jms-cluster.adoc
index 05778e5..6545e8d 100644
--- a/docs/reference-manual/src/main/jbake/content/configure-jms-cluster.adoc
+++ b/docs/reference-manual/src/main/jbake/content/configure-jms-cluster.adoc
@@ -5,13 +5,11 @@
prev=collect-log-files.html
~~~~~~
-configure-jms-cluster
-=====================
+= configure-jms-cluster
[[configure-jms-cluster-1]][[GSRFM00008]][[configure-jms-cluster]]
-configure-jms-cluster
----------------------
+== configure-jms-cluster
Configures the Message Queue cluster providing JMS services to a
{productName} cluster
diff --git a/docs/reference-manual/src/main/jbake/content/configure-lb-weight.adoc b/docs/reference-manual/src/main/jbake/content/configure-lb-weight.adoc
index 8b4924f..0ad3615 100644
--- a/docs/reference-manual/src/main/jbake/content/configure-lb-weight.adoc
+++ b/docs/reference-manual/src/main/jbake/content/configure-lb-weight.adoc
@@ -5,13 +5,11 @@
prev=configure-jms-cluster.html
~~~~~~
-configure-lb-weight
-===================
+= configure-lb-weight
[[configure-lb-weight-1]][[GSRFM00009]][[configure-lb-weight]]
-configure-lb-weight
--------------------
+== configure-lb-weight
Sets load balancing weights for clustered instances
diff --git a/docs/reference-manual/src/main/jbake/content/configure-ldap-for-admin.adoc b/docs/reference-manual/src/main/jbake/content/configure-ldap-for-admin.adoc
index 39f1baf..6204cc0 100644
--- a/docs/reference-manual/src/main/jbake/content/configure-ldap-for-admin.adoc
+++ b/docs/reference-manual/src/main/jbake/content/configure-ldap-for-admin.adoc
@@ -5,13 +5,11 @@
prev=configure-lb-weight.html
~~~~~~
-configure-ldap-for-admin
-========================
+= configure-ldap-for-admin
[[configure-ldap-for-admin-1]][[GSRFM00010]][[configure-ldap-for-admin]]
-configure-ldap-for-admin
-------------------------
+== configure-ldap-for-admin
Configures the authentication realm named admin-realm for the given LDAP
diff --git a/docs/reference-manual/src/main/jbake/content/configure-managed-jobs.adoc b/docs/reference-manual/src/main/jbake/content/configure-managed-jobs.adoc
index 5e99e6d..c4397b4 100644
--- a/docs/reference-manual/src/main/jbake/content/configure-managed-jobs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/configure-managed-jobs.adoc
@@ -5,13 +5,11 @@
prev=configure-ldap-for-admin.html
~~~~~~
-configure-managed-jobs
-======================
+= configure-managed-jobs
[[configure-managed-jobs-1]][[GSRFM836]][[configure-managed-jobs]]
-configure-managed-jobs
-----------------------
+== configure-managed-jobs
Configures how long information about subcommands that were started
using `asadmin --detach` or that contain progress information is kept
diff --git a/docs/reference-manual/src/main/jbake/content/copy-config.adoc b/docs/reference-manual/src/main/jbake/content/copy-config.adoc
index 0dd4bd6..f68f052 100644
--- a/docs/reference-manual/src/main/jbake/content/copy-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/copy-config.adoc
@@ -5,13 +5,11 @@
prev=configure-managed-jobs.html
~~~~~~
-copy-config
-===========
+= copy-config
[[copy-config-1]][[GSRFM00011]][[copy-config]]
-copy-config
------------
+== copy-config
Copies an existing named configuration to create another configuration
diff --git a/docs/reference-manual/src/main/jbake/content/create-admin-object.adoc b/docs/reference-manual/src/main/jbake/content/create-admin-object.adoc
index ca9aa9d..c9dd51a 100644
--- a/docs/reference-manual/src/main/jbake/content/create-admin-object.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-admin-object.adoc
@@ -5,13 +5,11 @@
prev=copy-config.html
~~~~~~
-create-admin-object
-===================
+= create-admin-object
[[create-admin-object-1]][[GSRFM00012]][[create-admin-object]]
-create-admin-object
--------------------
+== create-admin-object
Adds the administered object with the specified JNDI name for a resource adapter
diff --git a/docs/reference-manual/src/main/jbake/content/create-application-ref.adoc b/docs/reference-manual/src/main/jbake/content/create-application-ref.adoc
index 0c905fb..034eb15 100644
--- a/docs/reference-manual/src/main/jbake/content/create-application-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-application-ref.adoc
@@ -5,13 +5,11 @@
prev=create-admin-object.html
~~~~~~
-create-application-ref
-======================
+= create-application-ref
[[create-application-ref-1]][[GSRFM00013]][[create-application-ref]]
-create-application-ref
-----------------------
+== create-application-ref
Creates a reference to an application
diff --git a/docs/reference-manual/src/main/jbake/content/create-audit-module.adoc b/docs/reference-manual/src/main/jbake/content/create-audit-module.adoc
index 5b3a43c..a85523c 100644
--- a/docs/reference-manual/src/main/jbake/content/create-audit-module.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-audit-module.adoc
@@ -5,13 +5,11 @@
prev=create-application-ref.html
~~~~~~
-create-audit-module
-===================
+= create-audit-module
[[create-audit-module-1]][[GSRFM00014]][[create-audit-module]]
-create-audit-module
--------------------
+== create-audit-module
Adds an audit module
diff --git a/docs/reference-manual/src/main/jbake/content/create-auth-realm.adoc b/docs/reference-manual/src/main/jbake/content/create-auth-realm.adoc
index c66dfc4..778c7b3 100644
--- a/docs/reference-manual/src/main/jbake/content/create-auth-realm.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-auth-realm.adoc
@@ -5,13 +5,11 @@
prev=create-audit-module.html
~~~~~~
-create-auth-realm
-=================
+= create-auth-realm
[[create-auth-realm-1]][[GSRFM00015]][[create-auth-realm]]
-create-auth-realm
------------------
+== create-auth-realm
Adds the named authentication realm
diff --git a/docs/reference-manual/src/main/jbake/content/create-cluster.adoc b/docs/reference-manual/src/main/jbake/content/create-cluster.adoc
index 4cbdbb6..5b4a334 100644
--- a/docs/reference-manual/src/main/jbake/content/create-cluster.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-cluster.adoc
@@ -5,13 +5,11 @@
prev=create-auth-realm.html
~~~~~~
-create-cluster
-==============
+= create-cluster
[[create-cluster-1]][[GSRFM00017]][[create-cluster]]
-create-cluster
---------------
+== create-cluster
Creates a {productName} cluster
diff --git a/docs/reference-manual/src/main/jbake/content/create-connector-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/create-connector-connection-pool.adoc
index d66361e..a1434cb 100644
--- a/docs/reference-manual/src/main/jbake/content/create-connector-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-connector-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=create-cluster.html
~~~~~~
-create-connector-connection-pool
-================================
+= create-connector-connection-pool
[[create-connector-connection-pool-1]][[GSRFM00018]][[create-connector-connection-pool]]
-create-connector-connection-pool
---------------------------------
+== create-connector-connection-pool
Adds a connection pool with the specified connection pool name
diff --git a/docs/reference-manual/src/main/jbake/content/create-connector-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-connector-resource.adoc
index b1c2de1..0c48c18 100644
--- a/docs/reference-manual/src/main/jbake/content/create-connector-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-connector-resource.adoc
@@ -5,13 +5,11 @@
prev=create-connector-connection-pool.html
~~~~~~
-create-connector-resource
-=========================
+= create-connector-resource
[[create-connector-resource-1]][[GSRFM00019]][[create-connector-resource]]
-create-connector-resource
--------------------------
+== create-connector-resource
Registers the connector resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/create-connector-security-map.adoc b/docs/reference-manual/src/main/jbake/content/create-connector-security-map.adoc
index 2ddaa48..9c6e376 100644
--- a/docs/reference-manual/src/main/jbake/content/create-connector-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-connector-security-map.adoc
@@ -5,13 +5,11 @@
prev=create-connector-resource.html
~~~~~~
-create-connector-security-map
-=============================
+= create-connector-security-map
[[create-connector-security-map-1]][[GSRFM00020]][[create-connector-security-map]]
-create-connector-security-map
------------------------------
+== create-connector-security-map
Creates a security map for the specified connector connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/create-connector-work-security-map.adoc b/docs/reference-manual/src/main/jbake/content/create-connector-work-security-map.adoc
index 77f1098..dc842ec 100644
--- a/docs/reference-manual/src/main/jbake/content/create-connector-work-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-connector-work-security-map.adoc
@@ -5,13 +5,11 @@
prev=create-connector-security-map.html
~~~~~~
-create-connector-work-security-map
-==================================
+= create-connector-work-security-map
[[create-connector-work-security-map-1]][[GSRFM00021]][[create-connector-work-security-map]]
-create-connector-work-security-map
-----------------------------------
+== create-connector-work-security-map
Creates a work security map for the specified resource adapter
diff --git a/docs/reference-manual/src/main/jbake/content/create-context-service.adoc b/docs/reference-manual/src/main/jbake/content/create-context-service.adoc
index 897e7d8..35bb175 100644
--- a/docs/reference-manual/src/main/jbake/content/create-context-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-context-service.adoc
@@ -5,13 +5,11 @@
prev=create-connector-work-security-map.html
~~~~~~
-create-context-service
-======================
+= create-context-service
[[create-context-service-1]][[GSRFM838]][[create-context-service]]
-create-context-service
-----------------------
+== create-context-service
Creates a context service resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-custom-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-custom-resource.adoc
index 82919fc..0b74049 100644
--- a/docs/reference-manual/src/main/jbake/content/create-custom-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-custom-resource.adoc
@@ -5,13 +5,11 @@
prev=create-context-service.html
~~~~~~
-create-custom-resource
-======================
+= create-custom-resource
[[create-custom-resource-1]][[GSRFM00022]][[create-custom-resource]]
-create-custom-resource
-----------------------
+== create-custom-resource
Creates a custom resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-domain.adoc b/docs/reference-manual/src/main/jbake/content/create-domain.adoc
index 96bb771..fdc9c90 100644
--- a/docs/reference-manual/src/main/jbake/content/create-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-domain.adoc
@@ -5,13 +5,11 @@
prev=create-custom-resource.html
~~~~~~
-create-domain
-=============
+= create-domain
[[create-domain-1]][[GSRFM00023]][[create-domain]]
-create-domain
--------------
+== create-domain
Creates a domain
diff --git a/docs/reference-manual/src/main/jbake/content/create-file-user.adoc b/docs/reference-manual/src/main/jbake/content/create-file-user.adoc
index 33d8f05..7ea76ea 100644
--- a/docs/reference-manual/src/main/jbake/content/create-file-user.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-file-user.adoc
@@ -5,13 +5,11 @@
prev=create-domain.html
~~~~~~
-create-file-user
-================
+= create-file-user
[[create-file-user-1]][[GSRFM00024]][[create-file-user]]
-create-file-user
-----------------
+== create-file-user
Creates a new file user
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-health-checker.adoc b/docs/reference-manual/src/main/jbake/content/create-http-health-checker.adoc
index 2f640eb..b961818 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-health-checker.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-health-checker.adoc
@@ -5,13 +5,11 @@
prev=create-http.html
~~~~~~
-create-http-health-checker
-==========================
+= create-http-health-checker
[[create-http-health-checker-1]][[GSRFM00026]][[create-http-health-checker]]
-create-http-health-checker
---------------------------
+== create-http-health-checker
Creates a health-checker for a specified load balancer configuration
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-lb-config.adoc b/docs/reference-manual/src/main/jbake/content/create-http-lb-config.adoc
index ff549a8..b92e647 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-lb-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-lb-config.adoc
@@ -5,13 +5,11 @@
prev=create-http-lb.html
~~~~~~
-create-http-lb-config
-=====================
+= create-http-lb-config
[[create-http-lb-config-1]][[GSRFM00028]][[create-http-lb-config]]
-create-http-lb-config
----------------------
+== create-http-lb-config
Creates a configuration for the load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-lb-ref.adoc b/docs/reference-manual/src/main/jbake/content/create-http-lb-ref.adoc
index c18470d..f33ab3f 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-lb-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-lb-ref.adoc
@@ -5,13 +5,11 @@
prev=create-http-lb-config.html
~~~~~~
-create-http-lb-ref
-==================
+= create-http-lb-ref
[[create-http-lb-ref-1]][[GSRFM00029]][[create-http-lb-ref]]
-create-http-lb-ref
-------------------
+== create-http-lb-ref
Adds an existing cluster or server instance to an existing load balancer
configuration or load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-lb.adoc b/docs/reference-manual/src/main/jbake/content/create-http-lb.adoc
index 24a41bb..74dbbbf 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-lb.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-lb.adoc
@@ -5,13 +5,11 @@
prev=create-http-health-checker.html
~~~~~~
-create-http-lb
-==============
+= create-http-lb
[[create-http-lb-1]][[GSRFM00027]][[create-http-lb]]
-create-http-lb
---------------
+== create-http-lb
Creates a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-listener.adoc b/docs/reference-manual/src/main/jbake/content/create-http-listener.adoc
index 992d8d3..2f8f4d1 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-listener.adoc
@@ -5,13 +5,11 @@
prev=create-http-lb-ref.html
~~~~~~
-create-http-listener
-====================
+= create-http-listener
[[create-http-listener-1]][[GSRFM00030]][[create-http-listener]]
-create-http-listener
---------------------
+== create-http-listener
Adds a new HTTP network listener socket
diff --git a/docs/reference-manual/src/main/jbake/content/create-http-redirect.adoc b/docs/reference-manual/src/main/jbake/content/create-http-redirect.adoc
index a0966a6..acb3587 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http-redirect.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http-redirect.adoc
@@ -5,13 +5,11 @@
prev=create-http-listener.html
~~~~~~
-create-http-redirect
-====================
+= create-http-redirect
[[create-http-redirect-1]][[GSRFM00031]][[create-http-redirect]]
-create-http-redirect
---------------------
+== create-http-redirect
Adds a new HTTP redirect
diff --git a/docs/reference-manual/src/main/jbake/content/create-http.adoc b/docs/reference-manual/src/main/jbake/content/create-http.adoc
index 0f4e944..bdb294f 100644
--- a/docs/reference-manual/src/main/jbake/content/create-http.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-http.adoc
@@ -5,13 +5,11 @@
prev=create-file-user.html
~~~~~~
-create-http
-===========
+= create-http
[[create-http-1]][[GSRFM00025]][[create-http]]
-create-http
------------
+== create-http
Sets HTTP parameters for a protocol
diff --git a/docs/reference-manual/src/main/jbake/content/create-iiop-listener.adoc b/docs/reference-manual/src/main/jbake/content/create-iiop-listener.adoc
index 884974e..e0aa371 100644
--- a/docs/reference-manual/src/main/jbake/content/create-iiop-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-iiop-listener.adoc
@@ -5,13 +5,11 @@
prev=create-http-redirect.html
~~~~~~
-create-iiop-listener
-====================
+= create-iiop-listener
[[create-iiop-listener-1]][[GSRFM00032]][[create-iiop-listener]]
-create-iiop-listener
---------------------
+== create-iiop-listener
Adds an IIOP listener
diff --git a/docs/reference-manual/src/main/jbake/content/create-instance.adoc b/docs/reference-manual/src/main/jbake/content/create-instance.adoc
index cc5d3af..e71f6bf 100644
--- a/docs/reference-manual/src/main/jbake/content/create-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-instance.adoc
@@ -5,13 +5,11 @@
prev=create-iiop-listener.html
~~~~~~
-create-instance
-===============
+= create-instance
[[create-instance-1]][[GSRFM00033]][[create-instance]]
-create-instance
----------------
+== create-instance
Creates a {productName} instance
diff --git a/docs/reference-manual/src/main/jbake/content/create-jacc-provider.adoc b/docs/reference-manual/src/main/jbake/content/create-jacc-provider.adoc
index 616d16f..baca7e9 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jacc-provider.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jacc-provider.adoc
@@ -5,13 +5,11 @@
prev=create-instance.html
~~~~~~
-create-jacc-provider
-====================
+= create-jacc-provider
[[create-jacc-provider-1]][[GSRFM00034]][[create-jacc-provider]]
-create-jacc-provider
---------------------
+== create-jacc-provider
Enables administrators to create a JACC provider that can be used by
third-party authorization modules for applications running in
diff --git a/docs/reference-manual/src/main/jbake/content/create-javamail-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-javamail-resource.adoc
index 611f111..4c3abe9 100644
--- a/docs/reference-manual/src/main/jbake/content/create-javamail-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-javamail-resource.adoc
@@ -5,13 +5,11 @@
prev=create-jacc-provider.html
~~~~~~
-create-javamail-resource
-========================
+= create-javamail-resource
[[create-javamail-resource-1]][[GSRFM00035]][[create-javamail-resource]]
-create-javamail-resource
-------------------------
+== create-javamail-resource
Creates a JavaMail session resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-jdbc-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/create-jdbc-connection-pool.adoc
index 365e802..ff10f2d 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jdbc-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jdbc-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=create-javamail-resource.html
~~~~~~
-create-jdbc-connection-pool
-===========================
+= create-jdbc-connection-pool
[[create-jdbc-connection-pool-1]][[GSRFM00036]][[create-jdbc-connection-pool]]
-create-jdbc-connection-pool
----------------------------
+== create-jdbc-connection-pool
Registers a JDBC connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/create-jdbc-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-jdbc-resource.adoc
index b3e8041..0f6c2b3 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jdbc-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jdbc-resource.adoc
@@ -5,13 +5,11 @@
prev=create-jdbc-connection-pool.html
~~~~~~
-create-jdbc-resource
-====================
+= create-jdbc-resource
[[create-jdbc-resource-1]][[GSRFM00037]][[create-jdbc-resource]]
-create-jdbc-resource
---------------------
+== create-jdbc-resource
Creates a JDBC resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/create-jms-host.adoc b/docs/reference-manual/src/main/jbake/content/create-jms-host.adoc
index 37f2b36..696d0fe 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jms-host.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jms-host.adoc
@@ -5,13 +5,11 @@
prev=create-jmsdest.html
~~~~~~
-create-jms-host
-===============
+= create-jms-host
[[create-jms-host-1]][[GSRFM00039]][[create-jms-host]]
-create-jms-host
----------------
+== create-jms-host
Creates a JMS host
diff --git a/docs/reference-manual/src/main/jbake/content/create-jms-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-jms-resource.adoc
index e9ca842..25f05b9 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jms-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jms-resource.adoc
@@ -5,13 +5,11 @@
prev=create-jms-host.html
~~~~~~
-create-jms-resource
-===================
+= create-jms-resource
[[create-jms-resource-1]][[GSRFM00040]][[create-jms-resource]]
-create-jms-resource
--------------------
+== create-jms-resource
Creates a JMS resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-jmsdest.adoc b/docs/reference-manual/src/main/jbake/content/create-jmsdest.adoc
index d78cdb3..0745013 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jmsdest.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jmsdest.adoc
@@ -5,13 +5,11 @@
prev=create-jdbc-resource.html
~~~~~~
-create-jmsdest
-==============
+= create-jmsdest
[[create-jmsdest-1]][[GSRFM00038]][[create-jmsdest]]
-create-jmsdest
---------------
+== create-jmsdest
Creates a JMS physical destination
diff --git a/docs/reference-manual/src/main/jbake/content/create-jndi-resource.adoc b/docs/reference-manual/src/main/jbake/content/create-jndi-resource.adoc
index 9104120..94ce5b6 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jndi-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jndi-resource.adoc
@@ -5,13 +5,11 @@
prev=create-jms-resource.html
~~~~~~
-create-jndi-resource
-====================
+= create-jndi-resource
[[create-jndi-resource-1]][[GSRFM00041]][[create-jndi-resource]]
-create-jndi-resource
---------------------
+== create-jndi-resource
Registers a JNDI resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-jvm-options.adoc b/docs/reference-manual/src/main/jbake/content/create-jvm-options.adoc
index 77e44ad..dcc076d 100644
--- a/docs/reference-manual/src/main/jbake/content/create-jvm-options.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-jvm-options.adoc
@@ -5,13 +5,11 @@
prev=create-jndi-resource.html
~~~~~~
-create-jvm-options
-==================
+= create-jvm-options
[[create-jvm-options-1]][[GSRFM00042]][[create-jvm-options]]
-create-jvm-options
-------------------
+== create-jvm-options
Creates options for the Java application launcher
diff --git a/docs/reference-manual/src/main/jbake/content/create-lifecycle-module.adoc b/docs/reference-manual/src/main/jbake/content/create-lifecycle-module.adoc
index abe7eb8..3d1f586 100644
--- a/docs/reference-manual/src/main/jbake/content/create-lifecycle-module.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-lifecycle-module.adoc
@@ -5,13 +5,11 @@
prev=create-jvm-options.html
~~~~~~
-create-lifecycle-module
-=======================
+= create-lifecycle-module
[[create-lifecycle-module-1]][[GSRFM00043]][[create-lifecycle-module]]
-create-lifecycle-module
------------------------
+== create-lifecycle-module
Creates a lifecycle module
diff --git a/docs/reference-manual/src/main/jbake/content/create-local-instance.adoc b/docs/reference-manual/src/main/jbake/content/create-local-instance.adoc
index 9c3c2b9..4e7e8c6 100644
--- a/docs/reference-manual/src/main/jbake/content/create-local-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-local-instance.adoc
@@ -5,13 +5,11 @@
prev=create-lifecycle-module.html
~~~~~~
-create-local-instance
-=====================
+= create-local-instance
[[create-local-instance-1]][[GSRFM00044]][[create-local-instance]]
-create-local-instance
----------------------
+== create-local-instance
Creates a {productName} instance on the host where the subcommand is
run
diff --git a/docs/reference-manual/src/main/jbake/content/create-managed-executor-service.adoc b/docs/reference-manual/src/main/jbake/content/create-managed-executor-service.adoc
index 2535bb8..2b4be15 100644
--- a/docs/reference-manual/src/main/jbake/content/create-managed-executor-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-managed-executor-service.adoc
@@ -5,13 +5,11 @@
prev=create-local-instance.html
~~~~~~
-create-managed-executor-service
-===============================
+= create-managed-executor-service
[[create-managed-executor-service-1]][[GSRFM840]][[create-managed-executor-service]]
-create-managed-executor-service
--------------------------------
+== create-managed-executor-service
Creates a managed executor service resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-managed-scheduled-executor-service.adoc b/docs/reference-manual/src/main/jbake/content/create-managed-scheduled-executor-service.adoc
index 016701b..45f8bf5 100644
--- a/docs/reference-manual/src/main/jbake/content/create-managed-scheduled-executor-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-managed-scheduled-executor-service.adoc
@@ -5,13 +5,11 @@
prev=create-managed-executor-service.html
~~~~~~
-create-managed-scheduled-executor-service
-=========================================
+= create-managed-scheduled-executor-service
[[create-managed-scheduled-executor-service-1]][[GSRFM680]][[create-managed-scheduled-executor-service]]
-create-managed-scheduled-executor-service
------------------------------------------
+== create-managed-scheduled-executor-service
Creates a managed scheduled executor service resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-managed-thread-factory.adoc b/docs/reference-manual/src/main/jbake/content/create-managed-thread-factory.adoc
index 8140e7a..7544c8a 100644
--- a/docs/reference-manual/src/main/jbake/content/create-managed-thread-factory.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-managed-thread-factory.adoc
@@ -5,13 +5,11 @@
prev=create-managed-scheduled-executor-service.html
~~~~~~
-create-managed-thread-factory
-=============================
+= create-managed-thread-factory
[[create-managed-thread-factory-1]][[GSRFM842]][[create-managed-thread-factory]]
-create-managed-thread-factory
------------------------------
+== create-managed-thread-factory
Creates a managed thread factory resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-message-security-provider.adoc b/docs/reference-manual/src/main/jbake/content/create-message-security-provider.adoc
index b6381b8..1f51838 100644
--- a/docs/reference-manual/src/main/jbake/content/create-message-security-provider.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-message-security-provider.adoc
@@ -5,13 +5,11 @@
prev=create-managed-thread-factory.html
~~~~~~
-create-message-security-provider
-================================
+= create-message-security-provider
[[create-message-security-provider-1]][[GSRFM00045]][[create-message-security-provider]]
-create-message-security-provider
---------------------------------
+== create-message-security-provider
Enables administrators to create a message security provider, which
specifies how SOAP messages will be secured.
diff --git a/docs/reference-manual/src/main/jbake/content/create-module-config.adoc b/docs/reference-manual/src/main/jbake/content/create-module-config.adoc
index d4e6662..962bc28 100644
--- a/docs/reference-manual/src/main/jbake/content/create-module-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-module-config.adoc
@@ -5,13 +5,11 @@
prev=create-message-security-provider.html
~~~~~~
-create-module-config
-====================
+= create-module-config
[[create-module-config-1]][[GSRFM844]][[create-module-config]]
-create-module-config
---------------------
+== create-module-config
Adds the default configuration of a module to `domain.xml`
diff --git a/docs/reference-manual/src/main/jbake/content/create-network-listener.adoc b/docs/reference-manual/src/main/jbake/content/create-network-listener.adoc
index b310d96..90e1ff5 100644
--- a/docs/reference-manual/src/main/jbake/content/create-network-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-network-listener.adoc
@@ -5,13 +5,11 @@
prev=create-module-config.html
~~~~~~
-create-network-listener
-=======================
+= create-network-listener
[[create-network-listener-1]][[GSRFM00046]][[create-network-listener]]
-create-network-listener
------------------------
+== create-network-listener
Adds a new network listener socket
diff --git a/docs/reference-manual/src/main/jbake/content/create-node-config.adoc b/docs/reference-manual/src/main/jbake/content/create-node-config.adoc
index cab2126..1957e4d 100644
--- a/docs/reference-manual/src/main/jbake/content/create-node-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-node-config.adoc
@@ -5,13 +5,11 @@
prev=create-network-listener.html
~~~~~~
-create-node-config
-==================
+= create-node-config
[[create-node-config-1]][[GSRFM00047]][[create-node-config]]
-create-node-config
-------------------
+== create-node-config
Creates a node that is not enabled for remote communication
diff --git a/docs/reference-manual/src/main/jbake/content/create-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/create-node-dcom.adoc
index cb14591..5bf221b 100644
--- a/docs/reference-manual/src/main/jbake/content/create-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=create-node-config.html
~~~~~~
-create-node-dcom
-================
+= create-node-dcom
[[create-node-dcom-1]][[GSRFM510]][[create-node-dcom]]
-create-node-dcom
-----------------
+== create-node-dcom
Creates a node that is enabled for communication over DCOM
diff --git a/docs/reference-manual/src/main/jbake/content/create-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/create-node-ssh.adoc
index df91d2a..b3e3d1d 100644
--- a/docs/reference-manual/src/main/jbake/content/create-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=create-node-dcom.html
~~~~~~
-create-node-ssh
-===============
+= create-node-ssh
[[create-node-ssh-1]][[GSRFM00048]][[create-node-ssh]]
-create-node-ssh
----------------
+== create-node-ssh
Creates a node that is enabled for communication over SSH
diff --git a/docs/reference-manual/src/main/jbake/content/create-password-alias.adoc b/docs/reference-manual/src/main/jbake/content/create-password-alias.adoc
index 6db2292..8ee8b86 100644
--- a/docs/reference-manual/src/main/jbake/content/create-password-alias.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-password-alias.adoc
@@ -5,13 +5,11 @@
prev=create-node-ssh.html
~~~~~~
-create-password-alias
-=====================
+= create-password-alias
[[create-password-alias-1]][[GSRFM00049]][[create-password-alias]]
-create-password-alias
----------------------
+== create-password-alias
Creates a password alias
diff --git a/docs/reference-manual/src/main/jbake/content/create-profiler.adoc b/docs/reference-manual/src/main/jbake/content/create-profiler.adoc
index cde441d..a8007c5 100644
--- a/docs/reference-manual/src/main/jbake/content/create-profiler.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-profiler.adoc
@@ -5,13 +5,11 @@
prev=create-password-alias.html
~~~~~~
-create-profiler
-===============
+= create-profiler
[[create-profiler-1]][[GSRFM00050]][[create-profiler]]
-create-profiler
----------------
+== create-profiler
Creates the profiler element
diff --git a/docs/reference-manual/src/main/jbake/content/create-protocol-filter.adoc b/docs/reference-manual/src/main/jbake/content/create-protocol-filter.adoc
index 8190cce..7fff332 100644
--- a/docs/reference-manual/src/main/jbake/content/create-protocol-filter.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-protocol-filter.adoc
@@ -5,13 +5,11 @@
prev=create-protocol.html
~~~~~~
-create-protocol-filter
-======================
+= create-protocol-filter
[[create-protocol-filter-1]][[GSRFM00052]][[create-protocol-filter]]
-create-protocol-filter
-----------------------
+== create-protocol-filter
Adds a new protocol filter
diff --git a/docs/reference-manual/src/main/jbake/content/create-protocol-finder.adoc b/docs/reference-manual/src/main/jbake/content/create-protocol-finder.adoc
index 8f418c7..1f5b06f 100644
--- a/docs/reference-manual/src/main/jbake/content/create-protocol-finder.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-protocol-finder.adoc
@@ -5,13 +5,11 @@
prev=create-protocol-filter.html
~~~~~~
-create-protocol-finder
-======================
+= create-protocol-finder
[[create-protocol-finder-1]][[GSRFM00053]][[create-protocol-finder]]
-create-protocol-finder
-----------------------
+== create-protocol-finder
Adds a new protocol finder
diff --git a/docs/reference-manual/src/main/jbake/content/create-protocol.adoc b/docs/reference-manual/src/main/jbake/content/create-protocol.adoc
index 4c38643..e840e46 100644
--- a/docs/reference-manual/src/main/jbake/content/create-protocol.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-protocol.adoc
@@ -5,13 +5,11 @@
prev=create-profiler.html
~~~~~~
-create-protocol
-===============
+= create-protocol
[[create-protocol-1]][[GSRFM00051]][[create-protocol]]
-create-protocol
----------------
+== create-protocol
Adds a new protocol
diff --git a/docs/reference-manual/src/main/jbake/content/create-resource-adapter-config.adoc b/docs/reference-manual/src/main/jbake/content/create-resource-adapter-config.adoc
index 10cfc41..9afc2ba 100644
--- a/docs/reference-manual/src/main/jbake/content/create-resource-adapter-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-resource-adapter-config.adoc
@@ -5,13 +5,11 @@
prev=create-protocol-finder.html
~~~~~~
-create-resource-adapter-config
-==============================
+= create-resource-adapter-config
[[create-resource-adapter-config-1]][[GSRFM00054]][[create-resource-adapter-config]]
-create-resource-adapter-config
-------------------------------
+== create-resource-adapter-config
Creates the configuration information for the connector module
diff --git a/docs/reference-manual/src/main/jbake/content/create-resource-ref.adoc b/docs/reference-manual/src/main/jbake/content/create-resource-ref.adoc
index 836d4f6..10b550d 100644
--- a/docs/reference-manual/src/main/jbake/content/create-resource-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-resource-ref.adoc
@@ -5,13 +5,11 @@
prev=create-resource-adapter-config.html
~~~~~~
-create-resource-ref
-===================
+= create-resource-ref
[[create-resource-ref-1]][[GSRFM00055]][[create-resource-ref]]
-create-resource-ref
--------------------
+== create-resource-ref
Creates a reference to a resource
diff --git a/docs/reference-manual/src/main/jbake/content/create-service.adoc b/docs/reference-manual/src/main/jbake/content/create-service.adoc
index ff672d9..994cba3 100644
--- a/docs/reference-manual/src/main/jbake/content/create-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-service.adoc
@@ -5,13 +5,11 @@
prev=create-resource-ref.html
~~~~~~
-create-service
-==============
+= create-service
[[create-service-1]][[GSRFM00057]][[create-service]]
-create-service
---------------
+== create-service
Configures the starting of a DAS or a {productName} instance on an
unattended boot
diff --git a/docs/reference-manual/src/main/jbake/content/create-ssl.adoc b/docs/reference-manual/src/main/jbake/content/create-ssl.adoc
index 8f035d2..705d547 100644
--- a/docs/reference-manual/src/main/jbake/content/create-ssl.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-ssl.adoc
@@ -5,13 +5,11 @@
prev=create-service.html
~~~~~~
-create-ssl
-==========
+= create-ssl
[[create-ssl-1]][[GSRFM00058]][[create-ssl]]
-create-ssl
-----------
+== create-ssl
Creates and configures the SSL element in the selected HTTP listener,
IIOP listener, or IIOP service
diff --git a/docs/reference-manual/src/main/jbake/content/create-system-properties.adoc b/docs/reference-manual/src/main/jbake/content/create-system-properties.adoc
index 1ce2b94..bb7a5af 100644
--- a/docs/reference-manual/src/main/jbake/content/create-system-properties.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-system-properties.adoc
@@ -5,13 +5,11 @@
prev=create-ssl.html
~~~~~~
-create-system-properties
-========================
+= create-system-properties
[[create-system-properties-1]][[GSRFM00059]][[create-system-properties]]
-create-system-properties
-------------------------
+== create-system-properties
Adds one or more system property elements that can be referenced
elsewhere in the configuration.
diff --git a/docs/reference-manual/src/main/jbake/content/create-threadpool.adoc b/docs/reference-manual/src/main/jbake/content/create-threadpool.adoc
index cd708dd..2f906f1 100644
--- a/docs/reference-manual/src/main/jbake/content/create-threadpool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-threadpool.adoc
@@ -5,13 +5,11 @@
prev=create-system-properties.html
~~~~~~
-create-threadpool
-=================
+= create-threadpool
[[create-threadpool-1]][[GSRFM00060]][[create-threadpool]]
-create-threadpool
------------------
+== create-threadpool
Adds a thread pool
diff --git a/docs/reference-manual/src/main/jbake/content/create-transport.adoc b/docs/reference-manual/src/main/jbake/content/create-transport.adoc
index 37ebf1f..63cf813 100644
--- a/docs/reference-manual/src/main/jbake/content/create-transport.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-transport.adoc
@@ -5,13 +5,11 @@
prev=create-threadpool.html
~~~~~~
-create-transport
-================
+= create-transport
[[create-transport-1]][[GSRFM00061]][[create-transport]]
-create-transport
-----------------
+== create-transport
Adds a new transport
diff --git a/docs/reference-manual/src/main/jbake/content/create-virtual-server.adoc b/docs/reference-manual/src/main/jbake/content/create-virtual-server.adoc
index 3256871..035ee32 100644
--- a/docs/reference-manual/src/main/jbake/content/create-virtual-server.adoc
+++ b/docs/reference-manual/src/main/jbake/content/create-virtual-server.adoc
@@ -5,13 +5,11 @@
prev=create-transport.html
~~~~~~
-create-virtual-server
-=====================
+= create-virtual-server
[[create-virtual-server-1]][[GSRFM00062]][[create-virtual-server]]
-create-virtual-server
----------------------
+== create-virtual-server
Creates the named virtual server
diff --git a/docs/reference-manual/src/main/jbake/content/debug-asadmin.adoc b/docs/reference-manual/src/main/jbake/content/debug-asadmin.adoc
index 1abddf6..f6fdfb0 100644
--- a/docs/reference-manual/src/main/jbake/content/debug-asadmin.adoc
+++ b/docs/reference-manual/src/main/jbake/content/debug-asadmin.adoc
@@ -5,16 +5,14 @@
prev=asadmin.html
~~~~~~
-debug-asadmin
-=============
+= debug-asadmin
The script content on this page is for navigation purposes only and does
not alter the content in any way.
[[debug-asadmin-1m]][[GSRFM00263]][[debug-asadmin]]
-debug-asadmin
--------------
+== debug-asadmin
Variant of the `asadmin` utility for performing administrative tasks for Oracle {productName}. This variant
is useful for debugging local admin commands the launching of {productName}. It suspends immediately
diff --git a/docs/reference-manual/src/main/jbake/content/delete-admin-object.adoc b/docs/reference-manual/src/main/jbake/content/delete-admin-object.adoc
index 0e24a09..50a46a9 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-admin-object.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-admin-object.adoc
@@ -5,13 +5,11 @@
prev=create-virtual-server.html
~~~~~~
-delete-admin-object
-===================
+= delete-admin-object
[[delete-admin-object-1]][[GSRFM00063]][[delete-admin-object]]
-delete-admin-object
--------------------
+== delete-admin-object
Removes the administered object with the specified JNDI name.
diff --git a/docs/reference-manual/src/main/jbake/content/delete-application-ref.adoc b/docs/reference-manual/src/main/jbake/content/delete-application-ref.adoc
index cf2959b..2b00812 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-application-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-application-ref.adoc
@@ -5,13 +5,11 @@
prev=delete-admin-object.html
~~~~~~
-delete-application-ref
-======================
+= delete-application-ref
[[delete-application-ref-1]][[GSRFM00064]][[delete-application-ref]]
-delete-application-ref
-----------------------
+== delete-application-ref
Removes a reference to an application
diff --git a/docs/reference-manual/src/main/jbake/content/delete-audit-module.adoc b/docs/reference-manual/src/main/jbake/content/delete-audit-module.adoc
index bf05616..c25f7f4 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-audit-module.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-audit-module.adoc
@@ -5,13 +5,11 @@
prev=delete-application-ref.html
~~~~~~
-delete-audit-module
-===================
+= delete-audit-module
[[delete-audit-module-1]][[GSRFM00065]][[delete-audit-module]]
-delete-audit-module
--------------------
+== delete-audit-module
Removes the named audit-module
diff --git a/docs/reference-manual/src/main/jbake/content/delete-auth-realm.adoc b/docs/reference-manual/src/main/jbake/content/delete-auth-realm.adoc
index ece3443..64c9108 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-auth-realm.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-auth-realm.adoc
@@ -5,13 +5,11 @@
prev=delete-audit-module.html
~~~~~~
-delete-auth-realm
-=================
+= delete-auth-realm
[[delete-auth-realm-1]][[GSRFM00066]][[delete-auth-realm]]
-delete-auth-realm
------------------
+== delete-auth-realm
Removes the named authentication realm
diff --git a/docs/reference-manual/src/main/jbake/content/delete-cluster.adoc b/docs/reference-manual/src/main/jbake/content/delete-cluster.adoc
index e1d0451..5678bf5 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-cluster.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-cluster.adoc
@@ -5,13 +5,11 @@
prev=delete-auth-realm.html
~~~~~~
-delete-cluster
-==============
+= delete-cluster
[[delete-cluster-1]][[GSRFM00068]][[delete-cluster]]
-delete-cluster
---------------
+== delete-cluster
Deletes a {productName} cluster
diff --git a/docs/reference-manual/src/main/jbake/content/delete-config.adoc b/docs/reference-manual/src/main/jbake/content/delete-config.adoc
index 0ed6ae4..a6530de 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-config.adoc
@@ -5,13 +5,11 @@
prev=delete-cluster.html
~~~~~~
-delete-config
-=============
+= delete-config
[[delete-config-1]][[GSRFM00069]][[delete-config]]
-delete-config
--------------
+== delete-config
Deletes an existing named configuration
diff --git a/docs/reference-manual/src/main/jbake/content/delete-connector-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/delete-connector-connection-pool.adoc
index c4e90d0..f9ee992 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-connector-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-connector-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=delete-config.html
~~~~~~
-delete-connector-connection-pool
-================================
+= delete-connector-connection-pool
[[delete-connector-connection-pool-1]][[GSRFM00070]][[delete-connector-connection-pool]]
-delete-connector-connection-pool
---------------------------------
+== delete-connector-connection-pool
Removes the specified connector connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/delete-connector-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-connector-resource.adoc
index 2b77a43..4a3a3bb 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-connector-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-connector-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-connector-connection-pool.html
~~~~~~
-delete-connector-resource
-=========================
+= delete-connector-resource
[[delete-connector-resource-1]][[GSRFM00071]][[delete-connector-resource]]
-delete-connector-resource
--------------------------
+== delete-connector-resource
Removes the connector resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-connector-security-map.adoc b/docs/reference-manual/src/main/jbake/content/delete-connector-security-map.adoc
index 8685af6..c174d91 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-connector-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-connector-security-map.adoc
@@ -5,13 +5,11 @@
prev=delete-connector-resource.html
~~~~~~
-delete-connector-security-map
-=============================
+= delete-connector-security-map
[[delete-connector-security-map-1]][[GSRFM00072]][[delete-connector-security-map]]
-delete-connector-security-map
------------------------------
+== delete-connector-security-map
Deletes a security map for the specified connector connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/delete-connector-work-security-map.adoc b/docs/reference-manual/src/main/jbake/content/delete-connector-work-security-map.adoc
index 68044b6..7b1d009 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-connector-work-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-connector-work-security-map.adoc
@@ -5,13 +5,11 @@
prev=delete-connector-security-map.html
~~~~~~
-delete-connector-work-security-map
-==================================
+= delete-connector-work-security-map
[[delete-connector-work-security-map-1]][[GSRFM00073]][[delete-connector-work-security-map]]
-delete-connector-work-security-map
-----------------------------------
+== delete-connector-work-security-map
Deletes a work security map for the specified resource adapter
diff --git a/docs/reference-manual/src/main/jbake/content/delete-context-service.adoc b/docs/reference-manual/src/main/jbake/content/delete-context-service.adoc
index a7380dd..7a9ff97 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-context-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-context-service.adoc
@@ -5,13 +5,11 @@
prev=delete-connector-work-security-map.html
~~~~~~
-delete-context-service
-======================
+= delete-context-service
[[delete-context-service-1]][[GSRFM846]][[delete-context-service]]
-delete-context-service
-----------------------
+== delete-context-service
Removes a context service resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-custom-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-custom-resource.adoc
index 4cceffd..d93fdd5 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-custom-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-custom-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-context-service.html
~~~~~~
-delete-custom-resource
-======================
+= delete-custom-resource
[[delete-custom-resource-1]][[GSRFM00074]][[delete-custom-resource]]
-delete-custom-resource
-----------------------
+== delete-custom-resource
Removes a custom resource
diff --git a/docs/reference-manual/src/main/jbake/content/delete-domain.adoc b/docs/reference-manual/src/main/jbake/content/delete-domain.adoc
index b216c6b..26fb265 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-domain.adoc
@@ -5,13 +5,11 @@
prev=delete-custom-resource.html
~~~~~~
-delete-domain
-=============
+= delete-domain
[[delete-domain-1]][[GSRFM00075]][[delete-domain]]
-delete-domain
--------------
+== delete-domain
Deletes a domain
diff --git a/docs/reference-manual/src/main/jbake/content/delete-file-user.adoc b/docs/reference-manual/src/main/jbake/content/delete-file-user.adoc
index 9591af3..23fe546 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-file-user.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-file-user.adoc
@@ -5,13 +5,11 @@
prev=delete-domain.html
~~~~~~
-delete-file-user
-================
+= delete-file-user
[[delete-file-user-1]][[GSRFM00076]][[delete-file-user]]
-delete-file-user
-----------------
+== delete-file-user
Removes the named file user
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-health-checker.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-health-checker.adoc
index 708a31b..4c36a6d 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-health-checker.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-health-checker.adoc
@@ -5,13 +5,11 @@
prev=delete-http.html
~~~~~~
-delete-http-health-checker
-==========================
+= delete-http-health-checker
[[delete-http-health-checker-1]][[GSRFM00078]][[delete-http-health-checker]]
-delete-http-health-checker
---------------------------
+== delete-http-health-checker
Deletes the health-checker for a specified load balancer configuration
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-lb-config.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-lb-config.adoc
index d26bc08..9c0901a 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-lb-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-lb-config.adoc
@@ -5,13 +5,11 @@
prev=delete-http-lb.html
~~~~~~
-delete-http-lb-config
-=====================
+= delete-http-lb-config
[[delete-http-lb-config-1]][[GSRFM00080]][[delete-http-lb-config]]
-delete-http-lb-config
----------------------
+== delete-http-lb-config
Deletes a load balancer configuration
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-lb-ref.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-lb-ref.adoc
index d7e53a6..54655b7 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-lb-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-lb-ref.adoc
@@ -5,13 +5,11 @@
prev=delete-http-lb-config.html
~~~~~~
-delete-http-lb-ref
-==================
+= delete-http-lb-ref
[[delete-http-lb-ref-1]][[GSRFM00081]][[delete-http-lb-ref]]
-delete-http-lb-ref
-------------------
+== delete-http-lb-ref
Deletes the cluster or server instance from a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-lb.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-lb.adoc
index 5db04b9..ffea7df 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-lb.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-lb.adoc
@@ -5,13 +5,11 @@
prev=delete-http-health-checker.html
~~~~~~
-delete-http-lb
-==============
+= delete-http-lb
[[delete-http-lb-1]][[GSRFM00079]][[delete-http-lb]]
-delete-http-lb
---------------
+== delete-http-lb
Deletes a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-listener.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-listener.adoc
index c2def02..e5f860f 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-listener.adoc
@@ -5,13 +5,11 @@
prev=delete-http-lb-ref.html
~~~~~~
-delete-http-listener
-====================
+= delete-http-listener
[[delete-http-listener-1]][[GSRFM00082]][[delete-http-listener]]
-delete-http-listener
---------------------
+== delete-http-listener
Removes a network listener
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http-redirect.adoc b/docs/reference-manual/src/main/jbake/content/delete-http-redirect.adoc
index 688d389..bbb3ec3 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http-redirect.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http-redirect.adoc
@@ -5,13 +5,11 @@
prev=delete-http-listener.html
~~~~~~
-delete-http-redirect
-====================
+= delete-http-redirect
[[delete-http-redirect-1]][[GSRFM00083]][[delete-http-redirect]]
-delete-http-redirect
---------------------
+== delete-http-redirect
Removes an HTTP redirect
diff --git a/docs/reference-manual/src/main/jbake/content/delete-http.adoc b/docs/reference-manual/src/main/jbake/content/delete-http.adoc
index 0de8408..f92940b 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-http.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-http.adoc
@@ -5,13 +5,11 @@
prev=delete-file-user.html
~~~~~~
-delete-http
-===========
+= delete-http
[[delete-http-1]][[GSRFM00077]][[delete-http]]
-delete-http
------------
+== delete-http
Removes HTTP parameters from a protocol
diff --git a/docs/reference-manual/src/main/jbake/content/delete-iiop-listener.adoc b/docs/reference-manual/src/main/jbake/content/delete-iiop-listener.adoc
index 70a0ac7..ffe2d4b 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-iiop-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-iiop-listener.adoc
@@ -5,13 +5,11 @@
prev=delete-http-redirect.html
~~~~~~
-delete-iiop-listener
-====================
+= delete-iiop-listener
[[delete-iiop-listener-1]][[GSRFM00084]][[delete-iiop-listener]]
-delete-iiop-listener
---------------------
+== delete-iiop-listener
Removes an IIOP listener
diff --git a/docs/reference-manual/src/main/jbake/content/delete-instance.adoc b/docs/reference-manual/src/main/jbake/content/delete-instance.adoc
index d37dc0a..672bcc1 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-instance.adoc
@@ -5,13 +5,11 @@
prev=delete-iiop-listener.html
~~~~~~
-delete-instance
-===============
+= delete-instance
[[delete-instance-1]][[GSRFM00085]][[delete-instance]]
-delete-instance
----------------
+== delete-instance
Deletes a {productName} instance
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jacc-provider.adoc b/docs/reference-manual/src/main/jbake/content/delete-jacc-provider.adoc
index 01891fc..26d778e 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jacc-provider.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jacc-provider.adoc
@@ -5,13 +5,11 @@
prev=delete-instance.html
~~~~~~
-delete-jacc-provider
-====================
+= delete-jacc-provider
[[delete-jacc-provider-1]][[GSRFM00086]][[delete-jacc-provider]]
-delete-jacc-provider
---------------------
+== delete-jacc-provider
Enables administrators to delete JACC providers defined for a domain
diff --git a/docs/reference-manual/src/main/jbake/content/delete-javamail-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-javamail-resource.adoc
index 4b227aa..5c6c4c6 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-javamail-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-javamail-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-jacc-provider.html
~~~~~~
-delete-javamail-resource
-========================
+= delete-javamail-resource
[[delete-javamail-resource-1]][[GSRFM00087]][[delete-javamail-resource]]
-delete-javamail-resource
-------------------------
+== delete-javamail-resource
Removes a JavaMail session resource
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jdbc-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/delete-jdbc-connection-pool.adoc
index 86a173f..e2df718 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jdbc-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jdbc-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=delete-javamail-resource.html
~~~~~~
-delete-jdbc-connection-pool
-===========================
+= delete-jdbc-connection-pool
[[delete-jdbc-connection-pool-1]][[GSRFM00088]][[delete-jdbc-connection-pool]]
-delete-jdbc-connection-pool
----------------------------
+== delete-jdbc-connection-pool
Removes the specified JDBC connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jdbc-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-jdbc-resource.adoc
index f30fad1..faa128e 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jdbc-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jdbc-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-jdbc-connection-pool.html
~~~~~~
-delete-jdbc-resource
-====================
+= delete-jdbc-resource
[[delete-jdbc-resource-1]][[GSRFM00089]][[delete-jdbc-resource]]
-delete-jdbc-resource
---------------------
+== delete-jdbc-resource
Removes a JDBC resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jms-host.adoc b/docs/reference-manual/src/main/jbake/content/delete-jms-host.adoc
index 5ba81fd..b2d22fa 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jms-host.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jms-host.adoc
@@ -5,13 +5,11 @@
prev=delete-jmsdest.html
~~~~~~
-delete-jms-host
-===============
+= delete-jms-host
[[delete-jms-host-1]][[GSRFM00091]][[delete-jms-host]]
-delete-jms-host
----------------
+== delete-jms-host
Removes a JMS host
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jms-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-jms-resource.adoc
index 300effb..430a7c0 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jms-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jms-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-jms-host.html
~~~~~~
-delete-jms-resource
-===================
+= delete-jms-resource
[[delete-jms-resource-1]][[GSRFM00092]][[delete-jms-resource]]
-delete-jms-resource
--------------------
+== delete-jms-resource
Removes a JMS resource
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jmsdest.adoc b/docs/reference-manual/src/main/jbake/content/delete-jmsdest.adoc
index 2e81a55..a83d400 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jmsdest.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jmsdest.adoc
@@ -5,13 +5,11 @@
prev=delete-jdbc-resource.html
~~~~~~
-delete-jmsdest
-==============
+= delete-jmsdest
[[delete-jmsdest-1]][[GSRFM00090]][[delete-jmsdest]]
-delete-jmsdest
---------------
+== delete-jmsdest
Removes a JMS physical destination
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jndi-resource.adoc b/docs/reference-manual/src/main/jbake/content/delete-jndi-resource.adoc
index 81b99c4..2cda1d5 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jndi-resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jndi-resource.adoc
@@ -5,13 +5,11 @@
prev=delete-jms-resource.html
~~~~~~
-delete-jndi-resource
-====================
+= delete-jndi-resource
[[delete-jndi-resource-1]][[GSRFM00093]][[delete-jndi-resource]]
-delete-jndi-resource
---------------------
+== delete-jndi-resource
Removes a JNDI resource
diff --git a/docs/reference-manual/src/main/jbake/content/delete-jvm-options.adoc b/docs/reference-manual/src/main/jbake/content/delete-jvm-options.adoc
index ba411d6..3ab2c99 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-jvm-options.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-jvm-options.adoc
@@ -5,13 +5,11 @@
prev=delete-jndi-resource.html
~~~~~~
-delete-jvm-options
-==================
+= delete-jvm-options
[[delete-jvm-options-1]][[GSRFM00094]][[delete-jvm-options]]
-delete-jvm-options
-------------------
+== delete-jvm-options
Removes one or more options for the Java application launcher
diff --git a/docs/reference-manual/src/main/jbake/content/delete-lifecycle-module.adoc b/docs/reference-manual/src/main/jbake/content/delete-lifecycle-module.adoc
index e3e0b54..6bfed2e 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-lifecycle-module.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-lifecycle-module.adoc
@@ -5,13 +5,11 @@
prev=delete-jvm-options.html
~~~~~~
-delete-lifecycle-module
-=======================
+= delete-lifecycle-module
[[delete-lifecycle-module-1]][[GSRFM00095]][[delete-lifecycle-module]]
-delete-lifecycle-module
------------------------
+== delete-lifecycle-module
Removes the lifecycle module
diff --git a/docs/reference-manual/src/main/jbake/content/delete-local-instance.adoc b/docs/reference-manual/src/main/jbake/content/delete-local-instance.adoc
index c07d8ba..faa6cee 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-local-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-local-instance.adoc
@@ -5,13 +5,11 @@
prev=delete-lifecycle-module.html
~~~~~~
-delete-local-instance
-=====================
+= delete-local-instance
[[delete-local-instance-1]][[GSRFM00096]][[delete-local-instance]]
-delete-local-instance
----------------------
+== delete-local-instance
Deletes a {productName} instance on the machine where the subcommand is run
diff --git a/docs/reference-manual/src/main/jbake/content/delete-managed-executor-service.adoc b/docs/reference-manual/src/main/jbake/content/delete-managed-executor-service.adoc
index e55d1db..488dced 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-managed-executor-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-managed-executor-service.adoc
@@ -5,13 +5,11 @@
prev=delete-local-instance.html
~~~~~~
-delete-managed-executor-service
-===============================
+= delete-managed-executor-service
[[delete-managed-executor-service-1]][[GSRFM848]][[delete-managed-executor-service]]
-delete-managed-executor-service
--------------------------------
+== delete-managed-executor-service
Removes a managed executor service resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-managed-scheduled-executor-service.adoc b/docs/reference-manual/src/main/jbake/content/delete-managed-scheduled-executor-service.adoc
index 3b4bf9a..4a45426 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-managed-scheduled-executor-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-managed-scheduled-executor-service.adoc
@@ -5,13 +5,11 @@
prev=delete-managed-executor-service.html
~~~~~~
-delete-managed-scheduled-executor-service
-=========================================
+= delete-managed-scheduled-executor-service
[[delete-managed-scheduled-executor-service-1]][[GSRFM850]][[delete-managed-scheduled-executor-service]]
-delete-managed-scheduled-executor-service
------------------------------------------
+== delete-managed-scheduled-executor-service
Removes a managed scheduled executor service resource with the specified
JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-managed-thread-factory.adoc b/docs/reference-manual/src/main/jbake/content/delete-managed-thread-factory.adoc
index 5acd4c8..b42d02a 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-managed-thread-factory.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-managed-thread-factory.adoc
@@ -5,13 +5,11 @@
prev=delete-managed-scheduled-executor-service.html
~~~~~~
-delete-managed-thread-factory
-=============================
+= delete-managed-thread-factory
[[delete-managed-thread-factory-1]][[GSRFM852]][[delete-managed-thread-factory]]
-delete-managed-thread-factory
------------------------------
+== delete-managed-thread-factory
Removes a managed thread factory resource with the specified JNDI name
diff --git a/docs/reference-manual/src/main/jbake/content/delete-message-security-provider.adoc b/docs/reference-manual/src/main/jbake/content/delete-message-security-provider.adoc
index bbc99d2..6631aec 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-message-security-provider.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-message-security-provider.adoc
@@ -5,13 +5,11 @@
prev=delete-managed-thread-factory.html
~~~~~~
-delete-message-security-provider
-================================
+= delete-message-security-provider
[[delete-message-security-provider-1]][[GSRFM00097]][[delete-message-security-provider]]
-delete-message-security-provider
---------------------------------
+== delete-message-security-provider
Enables administrators to delete a message security provider
diff --git a/docs/reference-manual/src/main/jbake/content/delete-module-config.adoc b/docs/reference-manual/src/main/jbake/content/delete-module-config.adoc
index 5f0f5b2..79edbbf 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-module-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-module-config.adoc
@@ -5,13 +5,11 @@
prev=delete-message-security-provider.html
~~~~~~
-delete-module-config
-====================
+= delete-module-config
[[delete-module-config-1]][[GSRFM854]][[delete-module-config]]
-delete-module-config
---------------------
+== delete-module-config
Removes the configuration of a module from `domain.xml`
diff --git a/docs/reference-manual/src/main/jbake/content/delete-network-listener.adoc b/docs/reference-manual/src/main/jbake/content/delete-network-listener.adoc
index eafbc63..593cec9 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-network-listener.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-network-listener.adoc
@@ -5,13 +5,11 @@
prev=delete-module-config.html
~~~~~~
-delete-network-listener
-=======================
+= delete-network-listener
[[delete-network-listener-1]][[GSRFM00098]][[delete-network-listener]]
-delete-network-listener
------------------------
+== delete-network-listener
Removes a network listener
diff --git a/docs/reference-manual/src/main/jbake/content/delete-node-config.adoc b/docs/reference-manual/src/main/jbake/content/delete-node-config.adoc
index 79d9801..d7df10b 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-node-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-node-config.adoc
@@ -5,13 +5,11 @@
prev=delete-network-listener.html
~~~~~~
-delete-node-config
-==================
+= delete-node-config
[[delete-node-config-1]][[GSRFM00099]][[delete-node-config]]
-delete-node-config
-------------------
+== delete-node-config
Deletes a node that is not enabled for remote communication
diff --git a/docs/reference-manual/src/main/jbake/content/delete-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/delete-node-dcom.adoc
index 825245e..8056baf 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=delete-node-config.html
~~~~~~
-delete-node-dcom
-================
+= delete-node-dcom
[[delete-node-dcom-1]][[GSRFM569]][[delete-node-dcom]]
-delete-node-dcom
-----------------
+== delete-node-dcom
Deletes a node that is enabled for communication over DCOM
diff --git a/docs/reference-manual/src/main/jbake/content/delete-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/delete-node-ssh.adoc
index 09d2662..e9c3020 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=delete-node-dcom.html
~~~~~~
-delete-node-ssh
-===============
+= delete-node-ssh
[[delete-node-ssh-1]][[GSRFM00100]][[delete-node-ssh]]
-delete-node-ssh
----------------
+== delete-node-ssh
Deletes a node that is enabled for communication over SSH
diff --git a/docs/reference-manual/src/main/jbake/content/delete-password-alias.adoc b/docs/reference-manual/src/main/jbake/content/delete-password-alias.adoc
index 26aa1d9..ee75600 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-password-alias.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-password-alias.adoc
@@ -5,13 +5,11 @@
prev=delete-node-ssh.html
~~~~~~
-delete-password-alias
-=====================
+= delete-password-alias
[[delete-password-alias-1]][[GSRFM00101]][[delete-password-alias]]
-delete-password-alias
----------------------
+== delete-password-alias
Deletes a password alias
diff --git a/docs/reference-manual/src/main/jbake/content/delete-profiler.adoc b/docs/reference-manual/src/main/jbake/content/delete-profiler.adoc
index b872ead..a220eb2 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-profiler.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-profiler.adoc
@@ -5,13 +5,11 @@
prev=delete-password-alias.html
~~~~~~
-delete-profiler
-===============
+= delete-profiler
[[delete-profiler-1]][[GSRFM00102]][[delete-profiler]]
-delete-profiler
----------------
+== delete-profiler
Removes the profiler element
diff --git a/docs/reference-manual/src/main/jbake/content/delete-protocol-filter.adoc b/docs/reference-manual/src/main/jbake/content/delete-protocol-filter.adoc
index ab5c92f..ef11c25 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-protocol-filter.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-protocol-filter.adoc
@@ -5,13 +5,11 @@
prev=delete-protocol.html
~~~~~~
-delete-protocol-filter
-======================
+= delete-protocol-filter
[[delete-protocol-filter-1]][[GSRFM00104]][[delete-protocol-filter]]
-delete-protocol-filter
-----------------------
+== delete-protocol-filter
Removes a protocol filter
diff --git a/docs/reference-manual/src/main/jbake/content/delete-protocol-finder.adoc b/docs/reference-manual/src/main/jbake/content/delete-protocol-finder.adoc
index ed5d9ef..48ecb61 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-protocol-finder.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-protocol-finder.adoc
@@ -5,13 +5,11 @@
prev=delete-protocol-filter.html
~~~~~~
-delete-protocol-finder
-======================
+= delete-protocol-finder
[[delete-protocol-finder-1]][[GSRFM00105]][[delete-protocol-finder]]
-delete-protocol-finder
-----------------------
+== delete-protocol-finder
Removes a protocol finder
diff --git a/docs/reference-manual/src/main/jbake/content/delete-protocol.adoc b/docs/reference-manual/src/main/jbake/content/delete-protocol.adoc
index e24c1f4..e429423 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-protocol.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-protocol.adoc
@@ -5,13 +5,11 @@
prev=delete-profiler.html
~~~~~~
-delete-protocol
-===============
+= delete-protocol
[[delete-protocol-1]][[GSRFM00103]][[delete-protocol]]
-delete-protocol
----------------
+== delete-protocol
Removes a protocol
diff --git a/docs/reference-manual/src/main/jbake/content/delete-resource-adapter-config.adoc b/docs/reference-manual/src/main/jbake/content/delete-resource-adapter-config.adoc
index 48621b3..c48da2a 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-resource-adapter-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-resource-adapter-config.adoc
@@ -5,13 +5,11 @@
prev=delete-protocol-finder.html
~~~~~~
-delete-resource-adapter-config
-==============================
+= delete-resource-adapter-config
[[delete-resource-adapter-config-1]][[GSRFM00106]][[delete-resource-adapter-config]]
-delete-resource-adapter-config
-------------------------------
+== delete-resource-adapter-config
Deletes the resource adapter configuration
diff --git a/docs/reference-manual/src/main/jbake/content/delete-resource-ref.adoc b/docs/reference-manual/src/main/jbake/content/delete-resource-ref.adoc
index 566bf18..99004c3 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-resource-ref.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-resource-ref.adoc
@@ -5,13 +5,11 @@
prev=delete-resource-adapter-config.html
~~~~~~
-delete-resource-ref
-===================
+= delete-resource-ref
[[delete-resource-ref-1]][[GSRFM00107]][[delete-resource-ref]]
-delete-resource-ref
--------------------
+== delete-resource-ref
Removes a reference to a resource
diff --git a/docs/reference-manual/src/main/jbake/content/delete-ssl.adoc b/docs/reference-manual/src/main/jbake/content/delete-ssl.adoc
index e560cf3..bd71904 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-ssl.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-ssl.adoc
@@ -5,13 +5,11 @@
prev=delete-resource-ref.html
~~~~~~
-delete-ssl
-==========
+= delete-ssl
[[delete-ssl-1]][[GSRFM00109]][[delete-ssl]]
-delete-ssl
-----------
+== delete-ssl
Deletes the SSL element in the selected HTTP listener, IIOP listener, or
IIOP service
diff --git a/docs/reference-manual/src/main/jbake/content/delete-system-property.adoc b/docs/reference-manual/src/main/jbake/content/delete-system-property.adoc
index 3506709..ff68a3b 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-system-property.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-system-property.adoc
@@ -5,13 +5,11 @@
prev=delete-ssl.html
~~~~~~
-delete-system-property
-======================
+= delete-system-property
[[delete-system-property-1]][[GSRFM00110]][[delete-system-property]]
-delete-system-property
-----------------------
+== delete-system-property
Removes a system property of the domain, configuration, cluster, or
server instance, one at a time
diff --git a/docs/reference-manual/src/main/jbake/content/delete-threadpool.adoc b/docs/reference-manual/src/main/jbake/content/delete-threadpool.adoc
index 65d811f..b512bed 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-threadpool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-threadpool.adoc
@@ -5,13 +5,11 @@
prev=delete-system-property.html
~~~~~~
-delete-threadpool
-=================
+= delete-threadpool
[[delete-threadpool-1]][[GSRFM00111]][[delete-threadpool]]
-delete-threadpool
------------------
+== delete-threadpool
Removes a thread pool
diff --git a/docs/reference-manual/src/main/jbake/content/delete-transport.adoc b/docs/reference-manual/src/main/jbake/content/delete-transport.adoc
index a58ddbd..c0ce1c7 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-transport.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-transport.adoc
@@ -5,13 +5,11 @@
prev=delete-threadpool.html
~~~~~~
-delete-transport
-================
+= delete-transport
[[delete-transport-1]][[GSRFM00112]][[delete-transport]]
-delete-transport
-----------------
+== delete-transport
Removes a transport
diff --git a/docs/reference-manual/src/main/jbake/content/delete-virtual-server.adoc b/docs/reference-manual/src/main/jbake/content/delete-virtual-server.adoc
index 73accc7..62d6d5d 100644
--- a/docs/reference-manual/src/main/jbake/content/delete-virtual-server.adoc
+++ b/docs/reference-manual/src/main/jbake/content/delete-virtual-server.adoc
@@ -5,13 +5,11 @@
prev=delete-transport.html
~~~~~~
-delete-virtual-server
-=====================
+= delete-virtual-server
[[delete-virtual-server-1]][[GSRFM00113]][[delete-virtual-server]]
-delete-virtual-server
----------------------
+== delete-virtual-server
Removes a virtual server
diff --git a/docs/reference-manual/src/main/jbake/content/deploy.adoc b/docs/reference-manual/src/main/jbake/content/deploy.adoc
index fac0db0..3a6c249 100644
--- a/docs/reference-manual/src/main/jbake/content/deploy.adoc
+++ b/docs/reference-manual/src/main/jbake/content/deploy.adoc
@@ -5,13 +5,11 @@
prev=delete-virtual-server.html
~~~~~~
-deploy
-======
+= deploy
[[deploy-1]][[GSRFM00114]][[deploy]]
-deploy
-------
+== deploy
Deploys the specified component
diff --git a/docs/reference-manual/src/main/jbake/content/deploydir.adoc b/docs/reference-manual/src/main/jbake/content/deploydir.adoc
index 497fb84..4245626 100644
--- a/docs/reference-manual/src/main/jbake/content/deploydir.adoc
+++ b/docs/reference-manual/src/main/jbake/content/deploydir.adoc
@@ -5,13 +5,11 @@
prev=deploy.html
~~~~~~
-deploydir
-=========
+= deploydir
[[deploydir-1]][[GSRFM00115]][[deploydir]]
-deploydir
----------
+== deploydir
Deploys an exploded format of application archive
diff --git a/docs/reference-manual/src/main/jbake/content/disable-http-lb-application.adoc b/docs/reference-manual/src/main/jbake/content/disable-http-lb-application.adoc
index 33957a4..c781fa9 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-http-lb-application.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-http-lb-application.adoc
@@ -5,13 +5,11 @@
prev=disable.html
~~~~~~
-disable-http-lb-application
-===========================
+= disable-http-lb-application
[[disable-http-lb-application-1]][[GSRFM00118]][[disable-http-lb-application]]
-disable-http-lb-application
----------------------------
+== disable-http-lb-application
Disables an application managed by a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/disable-http-lb-server.adoc b/docs/reference-manual/src/main/jbake/content/disable-http-lb-server.adoc
index 0a94e4b..7d8d8c7 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-http-lb-server.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-http-lb-server.adoc
@@ -5,13 +5,11 @@
prev=disable-http-lb-application.html
~~~~~~
-disable-http-lb-server
-======================
+= disable-http-lb-server
[[disable-http-lb-server-1]][[GSRFM00119]][[disable-http-lb-server]]
-disable-http-lb-server
-----------------------
+== disable-http-lb-server
Disables a sever or cluster managed by a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/disable-monitoring.adoc b/docs/reference-manual/src/main/jbake/content/disable-monitoring.adoc
index 7efc6e4..bcef4fb 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-monitoring.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-monitoring.adoc
@@ -5,13 +5,11 @@
prev=disable-http-lb-server.html
~~~~~~
-disable-monitoring
-==================
+= disable-monitoring
[[disable-monitoring-1]][[GSRFM00120]][[disable-monitoring]]
-disable-monitoring
-------------------
+== disable-monitoring
Disables monitoring for the server or for specific monitorable modules
diff --git a/docs/reference-manual/src/main/jbake/content/disable-secure-admin-internal-user.adoc b/docs/reference-manual/src/main/jbake/content/disable-secure-admin-internal-user.adoc
index 665928b..8be647a 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-secure-admin-internal-user.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-secure-admin-internal-user.adoc
@@ -5,13 +5,11 @@
prev=disable-secure-admin.html
~~~~~~
-disable-secure-admin-internal-user
-==================================
+= disable-secure-admin-internal-user
[[disable-secure-admin-internal-user-1]][[GSRFM00122]][[disable-secure-admin-internal-user]]
-disable-secure-admin-internal-user
-----------------------------------
+== disable-secure-admin-internal-user
Instructs the {productName} DAS and instances to not use the
specified admin user to authenticate with each other and to authorize
diff --git a/docs/reference-manual/src/main/jbake/content/disable-secure-admin-principal.adoc b/docs/reference-manual/src/main/jbake/content/disable-secure-admin-principal.adoc
index 7be407a..400bb67 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-secure-admin-principal.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-secure-admin-principal.adoc
@@ -5,13 +5,11 @@
prev=disable-secure-admin-internal-user.html
~~~~~~
-disable-secure-admin-principal
-==============================
+= disable-secure-admin-principal
[[disable-secure-admin-principal-1]][[GSRFM00123]][[disable-secure-admin-principal]]
-disable-secure-admin-principal
-------------------------------
+== disable-secure-admin-principal
Disables the certificate for authorizing access in secure
administration.
diff --git a/docs/reference-manual/src/main/jbake/content/disable-secure-admin.adoc b/docs/reference-manual/src/main/jbake/content/disable-secure-admin.adoc
index b002c14..b58236a 100644
--- a/docs/reference-manual/src/main/jbake/content/disable-secure-admin.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable-secure-admin.adoc
@@ -5,13 +5,11 @@
prev=disable-monitoring.html
~~~~~~
-disable-secure-admin
-====================
+= disable-secure-admin
[[disable-secure-admin-1]][[GSRFM00121]][[disable-secure-admin]]
-disable-secure-admin
---------------------
+== disable-secure-admin
Disables secure admin if it is already enabled.
diff --git a/docs/reference-manual/src/main/jbake/content/disable.adoc b/docs/reference-manual/src/main/jbake/content/disable.adoc
index 74fa71f..8b39903 100644
--- a/docs/reference-manual/src/main/jbake/content/disable.adoc
+++ b/docs/reference-manual/src/main/jbake/content/disable.adoc
@@ -5,13 +5,11 @@
prev=deploydir.html
~~~~~~
-disable
-=======
+= disable
[[disable-1]][[GSRFM00116]][[disable]]
-disable
--------
+== disable
Disables the component
diff --git a/docs/reference-manual/src/main/jbake/content/domain.adoc b/docs/reference-manual/src/main/jbake/content/domain.adoc
index 5baeefa..829aa60 100644
--- a/docs/reference-manual/src/main/jbake/content/domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/domain.adoc
@@ -5,13 +5,11 @@
prev=configuration.html
~~~~~~
-domain
-======
+= domain
[[domain-5asc]][[GSRFM00267]][[domain]]
-domain
-------
+== domain
Domains have their own configurations.
diff --git a/docs/reference-manual/src/main/jbake/content/dotted-names.adoc b/docs/reference-manual/src/main/jbake/content/dotted-names.adoc
index e0e02b3..41da17a 100644
--- a/docs/reference-manual/src/main/jbake/content/dotted-names.adoc
+++ b/docs/reference-manual/src/main/jbake/content/dotted-names.adoc
@@ -5,13 +5,11 @@
prev=domain.html
~~~~~~
-dotted-names
-============
+= dotted-names
[[dotted-names-5asc]][[GSRFM00268]][[dotted-names]]
-dotted-names
-------------
+== dotted-names
Syntax for using periods to separate name elements
diff --git a/docs/reference-manual/src/main/jbake/content/enable-http-lb-application.adoc b/docs/reference-manual/src/main/jbake/content/enable-http-lb-application.adoc
index 54c9586..21e20e3 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-http-lb-application.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-http-lb-application.adoc
@@ -5,13 +5,11 @@
prev=enable.html
~~~~~~
-enable-http-lb-application
-==========================
+= enable-http-lb-application
[[enable-http-lb-application-1]][[GSRFM00126]][[enable-http-lb-application]]
-enable-http-lb-application
---------------------------
+== enable-http-lb-application
Enables a previously-disabled application managed by a load balancer
diff --git a/docs/reference-manual/src/main/jbake/content/enable-http-lb-server.adoc b/docs/reference-manual/src/main/jbake/content/enable-http-lb-server.adoc
index 045dd53..04b8a96 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-http-lb-server.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-http-lb-server.adoc
@@ -5,13 +5,11 @@
prev=enable-http-lb-application.html
~~~~~~
-enable-http-lb-server
-=====================
+= enable-http-lb-server
[[enable-http-lb-server-1]][[GSRFM00127]][[enable-http-lb-server]]
-enable-http-lb-server
----------------------
+== enable-http-lb-server
Enables a previously disabled sever or cluster managed by a load
balancer
diff --git a/docs/reference-manual/src/main/jbake/content/enable-monitoring.adoc b/docs/reference-manual/src/main/jbake/content/enable-monitoring.adoc
index f2fd42e..43afd68 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-monitoring.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-monitoring.adoc
@@ -5,13 +5,11 @@
prev=enable-http-lb-server.html
~~~~~~
-enable-monitoring
-=================
+= enable-monitoring
[[enable-monitoring-1]][[GSRFM00128]][[enable-monitoring]]
-enable-monitoring
------------------
+== enable-monitoring
Enables monitoring for the server or for specific monitorable modules
diff --git a/docs/reference-manual/src/main/jbake/content/enable-secure-admin-internal-user.adoc b/docs/reference-manual/src/main/jbake/content/enable-secure-admin-internal-user.adoc
index a5efb63..af9d96b 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-secure-admin-internal-user.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-secure-admin-internal-user.adoc
@@ -5,13 +5,11 @@
prev=enable-secure-admin.html
~~~~~~
-enable-secure-admin-internal-user
-=================================
+= enable-secure-admin-internal-user
[[enable-secure-admin-internal-user-1]][[GSRFM00130]][[enable-secure-admin-internal-user]]
-enable-secure-admin-internal-user
----------------------------------
+== enable-secure-admin-internal-user
Instructs the {productName} DAS and instances to use the specified
admin user and the password associated with the password alias to
diff --git a/docs/reference-manual/src/main/jbake/content/enable-secure-admin-principal.adoc b/docs/reference-manual/src/main/jbake/content/enable-secure-admin-principal.adoc
index 96d9a18..ff23bd5 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-secure-admin-principal.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-secure-admin-principal.adoc
@@ -5,13 +5,11 @@
prev=enable-secure-admin-internal-user.html
~~~~~~
-enable-secure-admin-principal
-=============================
+= enable-secure-admin-principal
[[enable-secure-admin-principal-1]][[GSRFM00131]][[enable-secure-admin-principal]]
-enable-secure-admin-principal
------------------------------
+== enable-secure-admin-principal
Instructs {productName}, when secure admin is enabled, to accept
admin requests from clients identified by the specified SSL certificate.
diff --git a/docs/reference-manual/src/main/jbake/content/enable-secure-admin.adoc b/docs/reference-manual/src/main/jbake/content/enable-secure-admin.adoc
index 447abb3..105f098 100644
--- a/docs/reference-manual/src/main/jbake/content/enable-secure-admin.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable-secure-admin.adoc
@@ -5,13 +5,11 @@
prev=enable-monitoring.html
~~~~~~
-enable-secure-admin
-===================
+= enable-secure-admin
[[enable-secure-admin-1]][[GSRFM00129]][[enable-secure-admin]]
-enable-secure-admin
--------------------
+== enable-secure-admin
Enables secure admin (if it is not already enabled), optionally changing
the alias used for DAS-to-instance admin messages or the alias used for
diff --git a/docs/reference-manual/src/main/jbake/content/enable.adoc b/docs/reference-manual/src/main/jbake/content/enable.adoc
index 87c82c2..8d8fddc 100644
--- a/docs/reference-manual/src/main/jbake/content/enable.adoc
+++ b/docs/reference-manual/src/main/jbake/content/enable.adoc
@@ -5,13 +5,11 @@
prev=disable-secure-admin-principal.html
~~~~~~
-enable
-======
+= enable
[[enable-1]][[GSRFM00124]][[enable]]
-enable
-------
+== enable
Enables the component
diff --git a/docs/reference-manual/src/main/jbake/content/export-http-lb-config.adoc b/docs/reference-manual/src/main/jbake/content/export-http-lb-config.adoc
index ff0e1e7..6ee6fb0 100644
--- a/docs/reference-manual/src/main/jbake/content/export-http-lb-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/export-http-lb-config.adoc
@@ -5,13 +5,11 @@
prev=export.html
~~~~~~
-export-http-lb-config
-=====================
+= export-http-lb-config
[[export-http-lb-config-1]][[GSRFM00133]][[export-http-lb-config]]
-export-http-lb-config
----------------------
+== export-http-lb-config
Exports the load balancer configuration or load balancer to a file
diff --git a/docs/reference-manual/src/main/jbake/content/export-sync-bundle.adoc b/docs/reference-manual/src/main/jbake/content/export-sync-bundle.adoc
index 551a9e1..1f7bfb1 100644
--- a/docs/reference-manual/src/main/jbake/content/export-sync-bundle.adoc
+++ b/docs/reference-manual/src/main/jbake/content/export-sync-bundle.adoc
@@ -5,13 +5,11 @@
prev=export-http-lb-config.html
~~~~~~
-export-sync-bundle
-==================
+= export-sync-bundle
[[export-sync-bundle-1]][[GSRFM00134]][[export-sync-bundle]]
-export-sync-bundle
-------------------
+== export-sync-bundle
Exports the configuration data of a cluster or standalone instance to an
archive file
diff --git a/docs/reference-manual/src/main/jbake/content/export.adoc b/docs/reference-manual/src/main/jbake/content/export.adoc
index f101bc9..84f5735 100644
--- a/docs/reference-manual/src/main/jbake/content/export.adoc
+++ b/docs/reference-manual/src/main/jbake/content/export.adoc
@@ -5,13 +5,11 @@
prev=enable-secure-admin-principal.html
~~~~~~
-export
-======
+= export
[[export-1]][[GSRFM00132]][[export]]
-export
-------
+== export
Marks a variable name for automatic export to the environment of
subsequent commands in multimode
diff --git a/docs/reference-manual/src/main/jbake/content/flush-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/flush-connection-pool.adoc
index 84a434c..652e0ce 100644
--- a/docs/reference-manual/src/main/jbake/content/flush-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/flush-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=export-sync-bundle.html
~~~~~~
-flush-connection-pool
-=====================
+= flush-connection-pool
[[flush-connection-pool-1]][[GSRFM00135]][[flush-connection-pool]]
-flush-connection-pool
----------------------
+== flush-connection-pool
Reintializes all connections established in the specified connection
pool
diff --git a/docs/reference-manual/src/main/jbake/content/flush-jmsdest.adoc b/docs/reference-manual/src/main/jbake/content/flush-jmsdest.adoc
index d82b143..1ff8d33 100644
--- a/docs/reference-manual/src/main/jbake/content/flush-jmsdest.adoc
+++ b/docs/reference-manual/src/main/jbake/content/flush-jmsdest.adoc
@@ -5,13 +5,11 @@
prev=flush-connection-pool.html
~~~~~~
-flush-jmsdest
-=============
+= flush-jmsdest
[[flush-jmsdest-1]][[GSRFM00136]][[flush-jmsdest]]
-flush-jmsdest
--------------
+== flush-jmsdest
Purges messages in a JMS destination.
diff --git a/docs/reference-manual/src/main/jbake/content/freeze-transaction-service.adoc b/docs/reference-manual/src/main/jbake/content/freeze-transaction-service.adoc
index 7be54a8..a508f08 100644
--- a/docs/reference-manual/src/main/jbake/content/freeze-transaction-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/freeze-transaction-service.adoc
@@ -5,13 +5,11 @@
prev=flush-jmsdest.html
~~~~~~
-freeze-transaction-service
-==========================
+= freeze-transaction-service
[[freeze-transaction-service-1]][[GSRFM00137]][[freeze-transaction-service]]
-freeze-transaction-service
---------------------------
+== freeze-transaction-service
Freezes the transaction subsystem
diff --git a/docs/reference-manual/src/main/jbake/content/generate-jvm-report.adoc b/docs/reference-manual/src/main/jbake/content/generate-jvm-report.adoc
index 3ac4d1d..e2a4252 100644
--- a/docs/reference-manual/src/main/jbake/content/generate-jvm-report.adoc
+++ b/docs/reference-manual/src/main/jbake/content/generate-jvm-report.adoc
@@ -5,16 +5,14 @@
prev=freeze-transaction-service.html
~~~~~~
-generate-jvm-report
-===================
+= generate-jvm-report
The script content on this page is for navigation purposes only and does
not alter the content in any way.
[[generate-jvm-report-1]][[GSRFM00138]][[generate-jvm-report]]
-generate-jvm-report
--------------------
+== generate-jvm-report
Shows the JVM machine statistics for a given target instance
diff --git a/docs/reference-manual/src/main/jbake/content/get-active-module-config.adoc b/docs/reference-manual/src/main/jbake/content/get-active-module-config.adoc
index f03d174..106d43a 100644
--- a/docs/reference-manual/src/main/jbake/content/get-active-module-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/get-active-module-config.adoc
@@ -5,13 +5,11 @@
prev=get.html
~~~~~~
-get-active-module-config
-========================
+= get-active-module-config
[[get-active-module-config-1]][[GSRFM859]][[get-active-module-config]]
-get-active-module-config
-------------------------
+== get-active-module-config
Displays the current active configuration of a service or instance
diff --git a/docs/reference-manual/src/main/jbake/content/get-client-stubs.adoc b/docs/reference-manual/src/main/jbake/content/get-client-stubs.adoc
index a0d183d..537c927 100644
--- a/docs/reference-manual/src/main/jbake/content/get-client-stubs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/get-client-stubs.adoc
@@ -5,13 +5,11 @@
prev=get-active-module-config.html
~~~~~~
-get-client-stubs
-================
+= get-client-stubs
[[get-client-stubs-1]][[GSRFM00140]][[get-client-stubs]]
-get-client-stubs
-----------------
+== get-client-stubs
Retrieves the application JAR files needed to launch the application
client.
diff --git a/docs/reference-manual/src/main/jbake/content/get-health.adoc b/docs/reference-manual/src/main/jbake/content/get-health.adoc
index fc27adb..ffeed0e 100644
--- a/docs/reference-manual/src/main/jbake/content/get-health.adoc
+++ b/docs/reference-manual/src/main/jbake/content/get-health.adoc
@@ -5,13 +5,11 @@
prev=get-client-stubs.html
~~~~~~
-get-health
-==========
+= get-health
[[get-health-1]][[GSRFM00141]][[get-health]]
-get-health
-----------
+== get-health
Provides information on the cluster health
diff --git a/docs/reference-manual/src/main/jbake/content/import-sync-bundle.adoc b/docs/reference-manual/src/main/jbake/content/import-sync-bundle.adoc
index 8b8680e..4b30cde 100644
--- a/docs/reference-manual/src/main/jbake/content/import-sync-bundle.adoc
+++ b/docs/reference-manual/src/main/jbake/content/import-sync-bundle.adoc
@@ -5,13 +5,11 @@
prev=get-health.html
~~~~~~
-import-sync-bundle
-==================
+= import-sync-bundle
[[import-sync-bundle-1]][[GSRFM00142]][[import-sync-bundle]]
-import-sync-bundle
-------------------
+== import-sync-bundle
Imports the configuration data of a clustered instance or standalone
instance from an archive file
diff --git a/docs/reference-manual/src/main/jbake/content/install-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/install-node-dcom.adoc
index c8109f0..64aed31 100644
--- a/docs/reference-manual/src/main/jbake/content/install-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/install-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=install-node.html
~~~~~~
-install-node-dcom
-=================
+= install-node-dcom
[[install-node-dcom-1]][[GSRFM626]][[install-node-dcom]]
-install-node-dcom
------------------
+== install-node-dcom
Installs {productName} software on specified DCOM-enabled hosts
diff --git a/docs/reference-manual/src/main/jbake/content/install-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/install-node-ssh.adoc
index 14962d6..6f2b2b3 100644
--- a/docs/reference-manual/src/main/jbake/content/install-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/install-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=install-node-dcom.html
~~~~~~
-install-node-ssh
-================
+= install-node-ssh
[[install-node-ssh-1]][[GSRFM628]][[install-node-ssh]]
-install-node-ssh
-----------------
+== install-node-ssh
Installs {productName} software on specified SSH-enabled hosts
diff --git a/docs/reference-manual/src/main/jbake/content/install-node.adoc b/docs/reference-manual/src/main/jbake/content/install-node.adoc
index 75fef4c..08655b9 100644
--- a/docs/reference-manual/src/main/jbake/content/install-node.adoc
+++ b/docs/reference-manual/src/main/jbake/content/install-node.adoc
@@ -5,13 +5,11 @@
prev=import-sync-bundle.html
~~~~~~
-install-node
-============
+= install-node
[[install-node-1]][[GSRFM00143]][[install-node]]
-install-node
-------------
+== install-node
Installs {productName} software on specified SSH-enabled hosts
diff --git a/docs/reference-manual/src/main/jbake/content/instance.adoc b/docs/reference-manual/src/main/jbake/content/instance.adoc
index a2e3449..ebfb624 100644
--- a/docs/reference-manual/src/main/jbake/content/instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/instance.adoc
@@ -5,13 +5,11 @@
prev=dotted-names.html
~~~~~~
-instance
-========
+= instance
[[instance-5asc]][[GSRFM00269]][[instance]]
-instance
---------
+== instance
An instance in {productName} has its own Jakarta EE configuration, Java
EE resources, application deployment areas, and server configuration
diff --git a/docs/reference-manual/src/main/jbake/content/jms-ping.adoc b/docs/reference-manual/src/main/jbake/content/jms-ping.adoc
index aa328d8..11d37af 100644
--- a/docs/reference-manual/src/main/jbake/content/jms-ping.adoc
+++ b/docs/reference-manual/src/main/jbake/content/jms-ping.adoc
@@ -5,13 +5,11 @@
prev=install-node-ssh.html
~~~~~~
-jms-ping
-========
+= jms-ping
[[jms-ping-1]][[GSRFM00144]][[jms-ping]]
-jms-ping
---------
+== jms-ping
Checks if the JMS service is up and running
diff --git a/docs/reference-manual/src/main/jbake/content/list-admin-objects.adoc b/docs/reference-manual/src/main/jbake/content/list-admin-objects.adoc
index 2ecbc0b..0389e80 100644
--- a/docs/reference-manual/src/main/jbake/content/list-admin-objects.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-admin-objects.adoc
@@ -5,13 +5,11 @@
prev=list.html
~~~~~~
-list-admin-objects
-==================
+= list-admin-objects
[[list-admin-objects-1]][[GSRFM00146]][[list-admin-objects]]
-list-admin-objects
-------------------
+== list-admin-objects
Gets all the administered objects
diff --git a/docs/reference-manual/src/main/jbake/content/list-application-refs.adoc b/docs/reference-manual/src/main/jbake/content/list-application-refs.adoc
index 6187fbf..702ae59 100644
--- a/docs/reference-manual/src/main/jbake/content/list-application-refs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-application-refs.adoc
@@ -5,13 +5,11 @@
prev=list-admin-objects.html
~~~~~~
-list-application-refs
-=====================
+= list-application-refs
[[list-application-refs-1]][[GSRFM00147]][[list-application-refs]]
-list-application-refs
----------------------
+== list-application-refs
Lists the existing application references
diff --git a/docs/reference-manual/src/main/jbake/content/list-applications.adoc b/docs/reference-manual/src/main/jbake/content/list-applications.adoc
index 9d2c614..3047118 100644
--- a/docs/reference-manual/src/main/jbake/content/list-applications.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-applications.adoc
@@ -5,13 +5,11 @@
prev=list-application-refs.html
~~~~~~
-list-applications
-=================
+= list-applications
[[list-applications-1]][[GSRFM00148]][[list-applications]]
-list-applications
------------------
+== list-applications
Lists deployed applications
diff --git a/docs/reference-manual/src/main/jbake/content/list-audit-modules.adoc b/docs/reference-manual/src/main/jbake/content/list-audit-modules.adoc
index 4313808..99eb57a 100644
--- a/docs/reference-manual/src/main/jbake/content/list-audit-modules.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-audit-modules.adoc
@@ -5,13 +5,11 @@
prev=list-applications.html
~~~~~~
-list-audit-modules
-==================
+= list-audit-modules
[[list-audit-modules-1]][[GSRFM00149]][[list-audit-modules]]
-list-audit-modules
-------------------
+== list-audit-modules
Gets all audit modules and displays them
diff --git a/docs/reference-manual/src/main/jbake/content/list-auth-realms.adoc b/docs/reference-manual/src/main/jbake/content/list-auth-realms.adoc
index d509642..1b08ff2 100644
--- a/docs/reference-manual/src/main/jbake/content/list-auth-realms.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-auth-realms.adoc
@@ -5,13 +5,11 @@
prev=list-audit-modules.html
~~~~~~
-list-auth-realms
-================
+= list-auth-realms
[[list-auth-realms-1]][[GSRFM00150]][[list-auth-realms]]
-list-auth-realms
-----------------
+== list-auth-realms
Lists the authentication realms
diff --git a/docs/reference-manual/src/main/jbake/content/list-backups.adoc b/docs/reference-manual/src/main/jbake/content/list-backups.adoc
index 46da56c..d1f514b 100644
--- a/docs/reference-manual/src/main/jbake/content/list-backups.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-backups.adoc
@@ -5,13 +5,11 @@
prev=list-auth-realms.html
~~~~~~
-list-backups
-============
+= list-backups
[[list-backups-1]][[GSRFM00152]][[list-backups]]
-list-backups
-------------
+== list-backups
Lists all backups
diff --git a/docs/reference-manual/src/main/jbake/content/list-batch-job-executions.adoc b/docs/reference-manual/src/main/jbake/content/list-batch-job-executions.adoc
index ed07fa8..81890b0 100644
--- a/docs/reference-manual/src/main/jbake/content/list-batch-job-executions.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-batch-job-executions.adoc
@@ -5,13 +5,11 @@
prev=list-backups.html
~~~~~~
-list-batch-job-executions
-=========================
+= list-batch-job-executions
[[list-batch-job-executions-1]][[GSRFM884]][[list-batch-job-executions]]
-list-batch-job-executions
--------------------------
+== list-batch-job-executions
Lists batch job executions and execution details
diff --git a/docs/reference-manual/src/main/jbake/content/list-batch-job-steps.adoc b/docs/reference-manual/src/main/jbake/content/list-batch-job-steps.adoc
index e60e232..5311502 100644
--- a/docs/reference-manual/src/main/jbake/content/list-batch-job-steps.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-batch-job-steps.adoc
@@ -5,13 +5,11 @@
prev=list-batch-jobs.html
~~~~~~
-list-batch-job-steps
-====================
+= list-batch-job-steps
[[list-batch-job-steps-1]][[GSRFM895]][[list-batch-job-steps]]
-list-batch-job-steps
---------------------
+== list-batch-job-steps
Lists steps for a specific batch job execution
diff --git a/docs/reference-manual/src/main/jbake/content/list-batch-jobs.adoc b/docs/reference-manual/src/main/jbake/content/list-batch-jobs.adoc
index 26f5591..3eb9b8d 100644
--- a/docs/reference-manual/src/main/jbake/content/list-batch-jobs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-batch-jobs.adoc
@@ -5,13 +5,11 @@
prev=list-batch-job-executions.html
~~~~~~
-list-batch-jobs
-===============
+= list-batch-jobs
[[list-batch-jobs-1]][[GSRFM861]][[list-batch-jobs]]
-list-batch-jobs
----------------
+== list-batch-jobs
Lists batch jobs
diff --git a/docs/reference-manual/src/main/jbake/content/list-batch-runtime-configuration.adoc b/docs/reference-manual/src/main/jbake/content/list-batch-runtime-configuration.adoc
index 57290ca..419eb53 100644
--- a/docs/reference-manual/src/main/jbake/content/list-batch-runtime-configuration.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-batch-runtime-configuration.adoc
@@ -5,13 +5,11 @@
prev=list-batch-job-steps.html
~~~~~~
-list-batch-runtime-configuration
-================================
+= list-batch-runtime-configuration
[[list-batch-runtime-configuration-1]][[GSRFM863]][[list-batch-runtime-configuration]]
-list-batch-runtime-configuration
---------------------------------
+== list-batch-runtime-configuration
Displays the configuration of the batch runtime
diff --git a/docs/reference-manual/src/main/jbake/content/list-clusters.adoc b/docs/reference-manual/src/main/jbake/content/list-clusters.adoc
index f39ee3b..4d40ca5 100644
--- a/docs/reference-manual/src/main/jbake/content/list-clusters.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-clusters.adoc
@@ -5,13 +5,11 @@
prev=list-batch-runtime-configuration.html
~~~~~~
-list-clusters
-=============
+= list-clusters
[[list-clusters-1]][[GSRFM00153]][[list-clusters]]
-list-clusters
--------------
+== list-clusters
Lists existing clusters in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-commands.adoc b/docs/reference-manual/src/main/jbake/content/list-commands.adoc
index b0e24c5..a1b8806 100644
--- a/docs/reference-manual/src/main/jbake/content/list-commands.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-commands.adoc
@@ -5,13 +5,11 @@
prev=list-clusters.html
~~~~~~
-list-commands
-=============
+= list-commands
[[list-commands-1]][[GSRFM00154]][[list-commands]]
-list-commands
--------------
+== list-commands
Lists available commands
diff --git a/docs/reference-manual/src/main/jbake/content/list-components.adoc b/docs/reference-manual/src/main/jbake/content/list-components.adoc
index 170a027..01c2bd0 100644
--- a/docs/reference-manual/src/main/jbake/content/list-components.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-components.adoc
@@ -5,13 +5,11 @@
prev=list-commands.html
~~~~~~
-list-components
-===============
+= list-components
[[list-components-1]][[GSRFM00155]][[list-components]]
-list-components
----------------
+== list-components
Lists deployed components
diff --git a/docs/reference-manual/src/main/jbake/content/list-configs.adoc b/docs/reference-manual/src/main/jbake/content/list-configs.adoc
index f229af2..062379a 100644
--- a/docs/reference-manual/src/main/jbake/content/list-configs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-configs.adoc
@@ -5,13 +5,11 @@
prev=list-components.html
~~~~~~
-list-configs
-============
+= list-configs
[[list-configs-1]][[GSRFM00156]][[list-configs]]
-list-configs
-------------
+== list-configs
Lists named configurations
diff --git a/docs/reference-manual/src/main/jbake/content/list-connector-connection-pools.adoc b/docs/reference-manual/src/main/jbake/content/list-connector-connection-pools.adoc
index ed20c6f..ba78cf0 100644
--- a/docs/reference-manual/src/main/jbake/content/list-connector-connection-pools.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-connector-connection-pools.adoc
@@ -5,13 +5,11 @@
prev=list-configs.html
~~~~~~
-list-connector-connection-pools
-===============================
+= list-connector-connection-pools
[[list-connector-connection-pools-1]][[GSRFM00157]][[list-connector-connection-pools]]
-list-connector-connection-pools
--------------------------------
+== list-connector-connection-pools
Lists the existing connector connection pools
diff --git a/docs/reference-manual/src/main/jbake/content/list-connector-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-connector-resources.adoc
index 0977448..11e6fd0 100644
--- a/docs/reference-manual/src/main/jbake/content/list-connector-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-connector-resources.adoc
@@ -5,13 +5,11 @@
prev=list-connector-connection-pools.html
~~~~~~
-list-connector-resources
-========================
+= list-connector-resources
[[list-connector-resources-1]][[GSRFM00158]][[list-connector-resources]]
-list-connector-resources
-------------------------
+== list-connector-resources
Lists all connector resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-connector-security-maps.adoc b/docs/reference-manual/src/main/jbake/content/list-connector-security-maps.adoc
index eea705e..6692599 100644
--- a/docs/reference-manual/src/main/jbake/content/list-connector-security-maps.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-connector-security-maps.adoc
@@ -5,13 +5,11 @@
prev=list-connector-resources.html
~~~~~~
-list-connector-security-maps
-============================
+= list-connector-security-maps
[[list-connector-security-maps-1]][[GSRFM00159]][[list-connector-security-maps]]
-list-connector-security-maps
-----------------------------
+== list-connector-security-maps
Lists the security maps belonging to the specified connector connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/list-connector-work-security-maps.adoc b/docs/reference-manual/src/main/jbake/content/list-connector-work-security-maps.adoc
index dc03ed6..59d31fc 100644
--- a/docs/reference-manual/src/main/jbake/content/list-connector-work-security-maps.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-connector-work-security-maps.adoc
@@ -5,13 +5,11 @@
prev=list-connector-security-maps.html
~~~~~~
-list-connector-work-security-maps
-=================================
+= list-connector-work-security-maps
[[list-connector-work-security-maps-1]][[GSRFM00160]][[list-connector-work-security-maps]]
-list-connector-work-security-maps
----------------------------------
+== list-connector-work-security-maps
Lists the work security maps belonging to the specified resource adapter
diff --git a/docs/reference-manual/src/main/jbake/content/list-containers.adoc b/docs/reference-manual/src/main/jbake/content/list-containers.adoc
index 8f46732..beace68 100644
--- a/docs/reference-manual/src/main/jbake/content/list-containers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-containers.adoc
@@ -5,13 +5,11 @@
prev=list-connector-work-security-maps.html
~~~~~~
-list-containers
-===============
+= list-containers
[[list-containers-1]][[GSRFM00161]][[list-containers]]
-list-containers
----------------
+== list-containers
Lists application containers
diff --git a/docs/reference-manual/src/main/jbake/content/list-context-services.adoc b/docs/reference-manual/src/main/jbake/content/list-context-services.adoc
index affa22b..ca7ecd0 100644
--- a/docs/reference-manual/src/main/jbake/content/list-context-services.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-context-services.adoc
@@ -5,13 +5,11 @@
prev=list-containers.html
~~~~~~
-list-context-services
-=====================
+= list-context-services
[[list-context-services-1]][[GSRFM865]][[list-context-services]]
-list-context-services
----------------------
+== list-context-services
Lists context service resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-custom-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-custom-resources.adoc
index 0157cf7..48326e2 100644
--- a/docs/reference-manual/src/main/jbake/content/list-custom-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-custom-resources.adoc
@@ -5,13 +5,11 @@
prev=list-context-services.html
~~~~~~
-list-custom-resources
-=====================
+= list-custom-resources
[[list-custom-resources-1]][[GSRFM00162]][[list-custom-resources]]
-list-custom-resources
----------------------
+== list-custom-resources
Gets all custom resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-domains.adoc b/docs/reference-manual/src/main/jbake/content/list-domains.adoc
index 2f4b99f..e6aeb8d 100644
--- a/docs/reference-manual/src/main/jbake/content/list-domains.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-domains.adoc
@@ -5,13 +5,11 @@
prev=list-custom-resources.html
~~~~~~
-list-domains
-============
+= list-domains
[[list-domains-1]][[GSRFM00163]][[list-domains]]
-list-domains
-------------
+== list-domains
Lists the domains in the specified directory
diff --git a/docs/reference-manual/src/main/jbake/content/list-file-groups.adoc b/docs/reference-manual/src/main/jbake/content/list-file-groups.adoc
index 5f9e2b7..96ce651 100644
--- a/docs/reference-manual/src/main/jbake/content/list-file-groups.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-file-groups.adoc
@@ -5,13 +5,11 @@
prev=list-domains.html
~~~~~~
-list-file-groups
-================
+= list-file-groups
[[list-file-groups-1]][[GSRFM00164]][[list-file-groups]]
-list-file-groups
-----------------
+== list-file-groups
Lists file groups
diff --git a/docs/reference-manual/src/main/jbake/content/list-file-users.adoc b/docs/reference-manual/src/main/jbake/content/list-file-users.adoc
index 9be2665..380e9b5 100644
--- a/docs/reference-manual/src/main/jbake/content/list-file-users.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-file-users.adoc
@@ -5,13 +5,11 @@
prev=list-file-groups.html
~~~~~~
-list-file-users
-===============
+= list-file-users
[[list-file-users-1]][[GSRFM00165]][[list-file-users]]
-list-file-users
----------------
+== list-file-users
Lists the file users
diff --git a/docs/reference-manual/src/main/jbake/content/list-http-lb-configs.adoc b/docs/reference-manual/src/main/jbake/content/list-http-lb-configs.adoc
index 1a211ea..ef43ec1 100644
--- a/docs/reference-manual/src/main/jbake/content/list-http-lb-configs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-http-lb-configs.adoc
@@ -5,13 +5,11 @@
prev=list-file-users.html
~~~~~~
-list-http-lb-configs
-====================
+= list-http-lb-configs
[[list-http-lb-configs-1]][[GSRFM00166]][[list-http-lb-configs]]
-list-http-lb-configs
---------------------
+== list-http-lb-configs
Lists load balancer configurations
diff --git a/docs/reference-manual/src/main/jbake/content/list-http-lbs.adoc b/docs/reference-manual/src/main/jbake/content/list-http-lbs.adoc
index a6ba1b0..ae2ec37 100644
--- a/docs/reference-manual/src/main/jbake/content/list-http-lbs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-http-lbs.adoc
@@ -5,13 +5,11 @@
prev=list-http-lb-configs.html
~~~~~~
-list-http-lbs
-=============
+= list-http-lbs
[[list-http-lbs-1]][[GSRFM00167]][[list-http-lbs]]
-list-http-lbs
--------------
+== list-http-lbs
Lists load balancers
diff --git a/docs/reference-manual/src/main/jbake/content/list-http-listeners.adoc b/docs/reference-manual/src/main/jbake/content/list-http-listeners.adoc
index ffe57ef..aa216b8 100644
--- a/docs/reference-manual/src/main/jbake/content/list-http-listeners.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-http-listeners.adoc
@@ -5,13 +5,11 @@
prev=list-http-lbs.html
~~~~~~
-list-http-listeners
-===================
+= list-http-listeners
[[list-http-listeners-1]][[GSRFM00168]][[list-http-listeners]]
-list-http-listeners
--------------------
+== list-http-listeners
Lists the existing network listeners
diff --git a/docs/reference-manual/src/main/jbake/content/list-iiop-listeners.adoc b/docs/reference-manual/src/main/jbake/content/list-iiop-listeners.adoc
index 2e1007f..c762267 100644
--- a/docs/reference-manual/src/main/jbake/content/list-iiop-listeners.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-iiop-listeners.adoc
@@ -5,13 +5,11 @@
prev=list-http-listeners.html
~~~~~~
-list-iiop-listeners
-===================
+= list-iiop-listeners
[[list-iiop-listeners-1]][[GSRFM00169]][[list-iiop-listeners]]
-list-iiop-listeners
--------------------
+== list-iiop-listeners
Lists the existing IIOP listeners
diff --git a/docs/reference-manual/src/main/jbake/content/list-instances.adoc b/docs/reference-manual/src/main/jbake/content/list-instances.adoc
index 1805514..4d95139 100644
--- a/docs/reference-manual/src/main/jbake/content/list-instances.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-instances.adoc
@@ -5,13 +5,11 @@
prev=list-iiop-listeners.html
~~~~~~
-list-instances
-==============
+= list-instances
[[list-instances-1]][[GSRFM00170]][[list-instances]]
-list-instances
---------------
+== list-instances
Lists {productName} instances in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-jacc-providers.adoc b/docs/reference-manual/src/main/jbake/content/list-jacc-providers.adoc
index 5394389..c5b2fe6 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jacc-providers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jacc-providers.adoc
@@ -5,13 +5,11 @@
prev=list-instances.html
~~~~~~
-list-jacc-providers
-===================
+= list-jacc-providers
[[list-jacc-providers-1]][[GSRFM00171]][[list-jacc-providers]]
-list-jacc-providers
--------------------
+== list-jacc-providers
Enables administrators to list JACC providers defined for a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-javamail-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-javamail-resources.adoc
index 8a50d45..661ba76 100644
--- a/docs/reference-manual/src/main/jbake/content/list-javamail-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-javamail-resources.adoc
@@ -5,13 +5,11 @@
prev=list-jacc-providers.html
~~~~~~
-list-javamail-resources
-=======================
+= list-javamail-resources
[[list-javamail-resources-1]][[GSRFM00172]][[list-javamail-resources]]
-list-javamail-resources
------------------------
+== list-javamail-resources
Lists the existing JavaMail session resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-jdbc-connection-pools.adoc b/docs/reference-manual/src/main/jbake/content/list-jdbc-connection-pools.adoc
index 58e17b2..5bfef3a 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jdbc-connection-pools.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jdbc-connection-pools.adoc
@@ -5,13 +5,11 @@
prev=list-javamail-resources.html
~~~~~~
-list-jdbc-connection-pools
-==========================
+= list-jdbc-connection-pools
[[list-jdbc-connection-pools-1]][[GSRFM00173]][[list-jdbc-connection-pools]]
-list-jdbc-connection-pools
---------------------------
+== list-jdbc-connection-pools
Lists all JDBC connection pools
diff --git a/docs/reference-manual/src/main/jbake/content/list-jdbc-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-jdbc-resources.adoc
index 5850386..e3e473d 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jdbc-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jdbc-resources.adoc
@@ -5,13 +5,11 @@
prev=list-jdbc-connection-pools.html
~~~~~~
-list-jdbc-resources
-===================
+= list-jdbc-resources
[[list-jdbc-resources-1]][[GSRFM00174]][[list-jdbc-resources]]
-list-jdbc-resources
--------------------
+== list-jdbc-resources
Lists all JDBC resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-jms-hosts.adoc b/docs/reference-manual/src/main/jbake/content/list-jms-hosts.adoc
index cf9b517..055ce1f 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jms-hosts.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jms-hosts.adoc
@@ -5,13 +5,11 @@
prev=list-jmsdest.html
~~~~~~
-list-jms-hosts
-==============
+= list-jms-hosts
[[list-jms-hosts-1]][[GSRFM00176]][[list-jms-hosts]]
-list-jms-hosts
---------------
+== list-jms-hosts
Lists the existing JMS hosts
diff --git a/docs/reference-manual/src/main/jbake/content/list-jms-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-jms-resources.adoc
index 3d7ff06..120ff3e 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jms-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jms-resources.adoc
@@ -5,13 +5,11 @@
prev=list-jms-hosts.html
~~~~~~
-list-jms-resources
-==================
+= list-jms-resources
[[list-jms-resources-1]][[GSRFM00177]][[list-jms-resources]]
-list-jms-resources
-------------------
+== list-jms-resources
Lists the JMS resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-jmsdest.adoc b/docs/reference-manual/src/main/jbake/content/list-jmsdest.adoc
index 3bd16de..42a5461 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jmsdest.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jmsdest.adoc
@@ -5,13 +5,11 @@
prev=list-jdbc-resources.html
~~~~~~
-list-jmsdest
-============
+= list-jmsdest
[[list-jmsdest-1]][[GSRFM00175]][[list-jmsdest]]
-list-jmsdest
-------------
+== list-jmsdest
Lists the existing JMS physical destinations
diff --git a/docs/reference-manual/src/main/jbake/content/list-jndi-entries.adoc b/docs/reference-manual/src/main/jbake/content/list-jndi-entries.adoc
index e6e5bf8..25b94e4 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jndi-entries.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jndi-entries.adoc
@@ -5,13 +5,11 @@
prev=list-jms-resources.html
~~~~~~
-list-jndi-entries
-=================
+= list-jndi-entries
[[list-jndi-entries-1]][[GSRFM00178]][[list-jndi-entries]]
-list-jndi-entries
------------------
+== list-jndi-entries
Browses and queries the JNDI tree
diff --git a/docs/reference-manual/src/main/jbake/content/list-jndi-resources.adoc b/docs/reference-manual/src/main/jbake/content/list-jndi-resources.adoc
index e022079..3fa2658 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jndi-resources.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jndi-resources.adoc
@@ -5,13 +5,11 @@
prev=list-jndi-entries.html
~~~~~~
-list-jndi-resources
-===================
+= list-jndi-resources
[[list-jndi-resources-1]][[GSRFM00179]][[list-jndi-resources]]
-list-jndi-resources
--------------------
+== list-jndi-resources
Lists all existing JNDI resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-jobs.adoc b/docs/reference-manual/src/main/jbake/content/list-jobs.adoc
index fd71b47..c6da9f4 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jobs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jobs.adoc
@@ -5,13 +5,11 @@
prev=list-jndi-resources.html
~~~~~~
-list-jobs
-=========
+= list-jobs
[[list-jobs-1]][[GSRFM867]][[list-jobs]]
-list-jobs
----------
+== list-jobs
Lists information about subcommands that were started using
`asadmin --detach` or that contain progress information
diff --git a/docs/reference-manual/src/main/jbake/content/list-jvm-options.adoc b/docs/reference-manual/src/main/jbake/content/list-jvm-options.adoc
index 18f6ba3..33e4a06 100644
--- a/docs/reference-manual/src/main/jbake/content/list-jvm-options.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-jvm-options.adoc
@@ -5,13 +5,11 @@
prev=list-jobs.html
~~~~~~
-list-jvm-options
-================
+= list-jvm-options
[[list-jvm-options-1]][[GSRFM00180]][[list-jvm-options]]
-list-jvm-options
-----------------
+== list-jvm-options
Lists options for the Java application launcher
diff --git a/docs/reference-manual/src/main/jbake/content/list-libraries.adoc b/docs/reference-manual/src/main/jbake/content/list-libraries.adoc
index 37078d7..7fa51d6 100644
--- a/docs/reference-manual/src/main/jbake/content/list-libraries.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-libraries.adoc
@@ -5,13 +5,11 @@
prev=list-jvm-options.html
~~~~~~
-list-libraries
-==============
+= list-libraries
[[list-libraries-1]][[GSRFM00819]][[list-libraries]]
-list-libraries
---------------
+== list-libraries
Lists library JAR files on {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/list-lifecycle-modules.adoc b/docs/reference-manual/src/main/jbake/content/list-lifecycle-modules.adoc
index 1693d42..99bac82 100644
--- a/docs/reference-manual/src/main/jbake/content/list-lifecycle-modules.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-lifecycle-modules.adoc
@@ -5,13 +5,11 @@
prev=list-libraries.html
~~~~~~
-list-lifecycle-modules
-======================
+= list-lifecycle-modules
[[list-lifecycle-modules-1]][[GSRFM00181]][[list-lifecycle-modules]]
-list-lifecycle-modules
-----------------------
+== list-lifecycle-modules
Lists the lifecycle modules
diff --git a/docs/reference-manual/src/main/jbake/content/list-log-attributes.adoc b/docs/reference-manual/src/main/jbake/content/list-log-attributes.adoc
index b3fafb1..9e0820b 100644
--- a/docs/reference-manual/src/main/jbake/content/list-log-attributes.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-log-attributes.adoc
@@ -5,13 +5,11 @@
prev=list-lifecycle-modules.html
~~~~~~
-list-log-attributes
-===================
+= list-log-attributes
[[list-log-attributes-1]][[GSRFM00182]][[list-log-attributes]]
-list-log-attributes
--------------------
+== list-log-attributes
Lists all logging attributes defined for a specified target in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-log-levels.adoc b/docs/reference-manual/src/main/jbake/content/list-log-levels.adoc
index 980dd8f..68d11b5 100644
--- a/docs/reference-manual/src/main/jbake/content/list-log-levels.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-log-levels.adoc
@@ -5,13 +5,11 @@
prev=list-loggers.html
~~~~~~
-list-log-levels
-===============
+= list-log-levels
[[list-log-levels-1]][[GSRFM00183]][[list-log-levels]]
-list-log-levels
----------------
+== list-log-levels
Lists the loggers and their log levels
diff --git a/docs/reference-manual/src/main/jbake/content/list-loggers.adoc b/docs/reference-manual/src/main/jbake/content/list-loggers.adoc
index 6c00ce7..f8ec3f9 100644
--- a/docs/reference-manual/src/main/jbake/content/list-loggers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-loggers.adoc
@@ -5,13 +5,11 @@
prev=list-log-attributes.html
~~~~~~
-list-loggers
-============
+= list-loggers
[[list-loggers-1]][[GSRFM869]][[list-loggers]]
-list-loggers
-------------
+== list-loggers
Lists existing loggers
diff --git a/docs/reference-manual/src/main/jbake/content/list-managed-executor-services.adoc b/docs/reference-manual/src/main/jbake/content/list-managed-executor-services.adoc
index e65a038..aa56fa9 100644
--- a/docs/reference-manual/src/main/jbake/content/list-managed-executor-services.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-managed-executor-services.adoc
@@ -5,13 +5,11 @@
prev=list-log-levels.html
~~~~~~
-list-managed-executor-services
-==============================
+= list-managed-executor-services
[[list-managed-executor-services-1]][[GSRFM871]][[list-managed-executor-services]]
-list-managed-executor-services
-------------------------------
+== list-managed-executor-services
Lists managed executor service resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-managed-scheduled-executor-services.adoc b/docs/reference-manual/src/main/jbake/content/list-managed-scheduled-executor-services.adoc
index dfd8eff..dd379e5 100644
--- a/docs/reference-manual/src/main/jbake/content/list-managed-scheduled-executor-services.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-managed-scheduled-executor-services.adoc
@@ -5,13 +5,11 @@
prev=list-managed-executor-services.html
~~~~~~
-list-managed-scheduled-executor-services
-========================================
+= list-managed-scheduled-executor-services
[[list-managed-scheduled-executor-services-1]][[GSRFM873]][[list-managed-scheduled-executor-services]]
-list-managed-scheduled-executor-services
-----------------------------------------
+== list-managed-scheduled-executor-services
Lists managed scheduled executor service resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-managed-thread-factories.adoc b/docs/reference-manual/src/main/jbake/content/list-managed-thread-factories.adoc
index a4ec7ba..1ab7425 100644
--- a/docs/reference-manual/src/main/jbake/content/list-managed-thread-factories.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-managed-thread-factories.adoc
@@ -5,13 +5,11 @@
prev=list-managed-scheduled-executor-services.html
~~~~~~
-list-managed-thread-factories
-=============================
+= list-managed-thread-factories
[[list-managed-thread-factories-1]][[GSRFM875]][[list-managed-thread-factories]]
-list-managed-thread-factories
------------------------------
+== list-managed-thread-factories
Lists managed thread factory resources
diff --git a/docs/reference-manual/src/main/jbake/content/list-message-security-providers.adoc b/docs/reference-manual/src/main/jbake/content/list-message-security-providers.adoc
index aa71bbe..0668ce9 100644
--- a/docs/reference-manual/src/main/jbake/content/list-message-security-providers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-message-security-providers.adoc
@@ -5,13 +5,11 @@
prev=list-managed-thread-factories.html
~~~~~~
-list-message-security-providers
-===============================
+= list-message-security-providers
[[list-message-security-providers-1]][[GSRFM00184]][[list-message-security-providers]]
-list-message-security-providers
--------------------------------
+== list-message-security-providers
Lists all security message providers for the given message layer
diff --git a/docs/reference-manual/src/main/jbake/content/list-modules.adoc b/docs/reference-manual/src/main/jbake/content/list-modules.adoc
index 7c2cfaf..4b4768c 100644
--- a/docs/reference-manual/src/main/jbake/content/list-modules.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-modules.adoc
@@ -5,13 +5,11 @@
prev=list-message-security-providers.html
~~~~~~
-list-modules
-============
+= list-modules
[[list-modules-1]][[GSRFM00185]][[list-modules]]
-list-modules
-------------
+== list-modules
Lists {productName} modules
diff --git a/docs/reference-manual/src/main/jbake/content/list-network-listeners.adoc b/docs/reference-manual/src/main/jbake/content/list-network-listeners.adoc
index a47d87b..4ef1fc2 100644
--- a/docs/reference-manual/src/main/jbake/content/list-network-listeners.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-network-listeners.adoc
@@ -5,13 +5,11 @@
prev=list-modules.html
~~~~~~
-list-network-listeners
-======================
+= list-network-listeners
[[list-network-listeners-1]][[GSRFM00186]][[list-network-listeners]]
-list-network-listeners
-----------------------
+== list-network-listeners
Lists the existing network listeners
diff --git a/docs/reference-manual/src/main/jbake/content/list-nodes-config.adoc b/docs/reference-manual/src/main/jbake/content/list-nodes-config.adoc
index 1523e5a..2052211 100644
--- a/docs/reference-manual/src/main/jbake/content/list-nodes-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-nodes-config.adoc
@@ -5,13 +5,11 @@
prev=list-nodes.html
~~~~~~
-list-nodes-config
-=================
+= list-nodes-config
[[list-nodes-config-1]][[GSRFM00188]][[list-nodes-config]]
-list-nodes-config
------------------
+== list-nodes-config
Lists all {productName} nodes that do not support remote
communication in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-nodes-dcom.adoc b/docs/reference-manual/src/main/jbake/content/list-nodes-dcom.adoc
index c43e1f7..b25c0d6 100644
--- a/docs/reference-manual/src/main/jbake/content/list-nodes-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-nodes-dcom.adoc
@@ -5,13 +5,11 @@
prev=list-nodes-config.html
~~~~~~
-list-nodes-dcom
-===============
+= list-nodes-dcom
[[list-nodes-dcom-1]][[GSRFM693]][[list-nodes-dcom]]
-list-nodes-dcom
----------------
+== list-nodes-dcom
Lists all {productName} nodes that support communication over DCOM
in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-nodes-ssh.adoc b/docs/reference-manual/src/main/jbake/content/list-nodes-ssh.adoc
index a2fdb4e..8117949 100644
--- a/docs/reference-manual/src/main/jbake/content/list-nodes-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-nodes-ssh.adoc
@@ -5,13 +5,11 @@
prev=list-nodes-dcom.html
~~~~~~
-list-nodes-ssh
-==============
+= list-nodes-ssh
[[list-nodes-ssh-1]][[GSRFM00189]][[list-nodes-ssh]]
-list-nodes-ssh
---------------
+== list-nodes-ssh
Lists all {productName} nodes that support communication over SSH in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-nodes.adoc b/docs/reference-manual/src/main/jbake/content/list-nodes.adoc
index b20da9f..0a8be38 100644
--- a/docs/reference-manual/src/main/jbake/content/list-nodes.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-nodes.adoc
@@ -5,13 +5,11 @@
prev=list-network-listeners.html
~~~~~~
-list-nodes
-==========
+= list-nodes
[[list-nodes-1]][[GSRFM00187]][[list-nodes]]
-list-nodes
-----------
+== list-nodes
Lists all {productName} nodes in a domain
diff --git a/docs/reference-manual/src/main/jbake/content/list-password-aliases.adoc b/docs/reference-manual/src/main/jbake/content/list-password-aliases.adoc
index 8ccfcf6..92aca6e 100644
--- a/docs/reference-manual/src/main/jbake/content/list-password-aliases.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-password-aliases.adoc
@@ -5,13 +5,11 @@
prev=list-nodes-ssh.html
~~~~~~
-list-password-aliases
-=====================
+= list-password-aliases
[[list-password-aliases-1]][[GSRFM00190]][[list-password-aliases]]
-list-password-aliases
----------------------
+== list-password-aliases
Lists all password aliases
diff --git a/docs/reference-manual/src/main/jbake/content/list-persistence-types.adoc b/docs/reference-manual/src/main/jbake/content/list-persistence-types.adoc
index d453332..44f5f54 100644
--- a/docs/reference-manual/src/main/jbake/content/list-persistence-types.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-persistence-types.adoc
@@ -5,13 +5,11 @@
prev=list-password-aliases.html
~~~~~~
-list-persistence-types
-======================
+= list-persistence-types
[[list-persistence-types-1]][[GSRFM00191]][[list-persistence-types]]
-list-persistence-types
-----------------------
+== list-persistence-types
Lists registered persistence types for HTTP sessions and SFSB instances
diff --git a/docs/reference-manual/src/main/jbake/content/list-protocol-filters.adoc b/docs/reference-manual/src/main/jbake/content/list-protocol-filters.adoc
index 846bc06..57106bc 100644
--- a/docs/reference-manual/src/main/jbake/content/list-protocol-filters.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-protocol-filters.adoc
@@ -5,13 +5,11 @@
prev=list-persistence-types.html
~~~~~~
-list-protocol-filters
-=====================
+= list-protocol-filters
[[list-protocol-filters-1]][[GSRFM00193]][[list-protocol-filters]]
-list-protocol-filters
----------------------
+== list-protocol-filters
Lists the existing protocol filters
diff --git a/docs/reference-manual/src/main/jbake/content/list-protocol-finders.adoc b/docs/reference-manual/src/main/jbake/content/list-protocol-finders.adoc
index eda58ae..8026d9b 100644
--- a/docs/reference-manual/src/main/jbake/content/list-protocol-finders.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-protocol-finders.adoc
@@ -5,13 +5,11 @@
prev=list-protocol-filters.html
~~~~~~
-list-protocol-finders
-=====================
+= list-protocol-finders
[[list-protocol-finders-1]][[GSRFM00194]][[list-protocol-finders]]
-list-protocol-finders
----------------------
+== list-protocol-finders
Lists the existing protocol finders
diff --git a/docs/reference-manual/src/main/jbake/content/list-protocols.adoc b/docs/reference-manual/src/main/jbake/content/list-protocols.adoc
index dd16d8d..5ad43cb 100644
--- a/docs/reference-manual/src/main/jbake/content/list-protocols.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-protocols.adoc
@@ -5,13 +5,11 @@
prev=list-protocol-finders.html
~~~~~~
-list-protocols
-==============
+= list-protocols
[[list-protocols-1]][[GSRFM00195]][[list-protocols]]
-list-protocols
---------------
+== list-protocols
Lists the existing protocols
diff --git a/docs/reference-manual/src/main/jbake/content/list-resource-adapter-configs.adoc b/docs/reference-manual/src/main/jbake/content/list-resource-adapter-configs.adoc
index e2f3a64..dd853eb 100644
--- a/docs/reference-manual/src/main/jbake/content/list-resource-adapter-configs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-resource-adapter-configs.adoc
@@ -5,13 +5,11 @@
prev=list-protocols.html
~~~~~~
-list-resource-adapter-configs
-=============================
+= list-resource-adapter-configs
[[list-resource-adapter-configs-1]][[GSRFM00196]][[list-resource-adapter-configs]]
-list-resource-adapter-configs
------------------------------
+== list-resource-adapter-configs
Lists the names of the current resource adapter configurations
diff --git a/docs/reference-manual/src/main/jbake/content/list-resource-refs.adoc b/docs/reference-manual/src/main/jbake/content/list-resource-refs.adoc
index 4b299bf..5fe8b52 100644
--- a/docs/reference-manual/src/main/jbake/content/list-resource-refs.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-resource-refs.adoc
@@ -5,13 +5,11 @@
prev=list-resource-adapter-configs.html
~~~~~~
-list-resource-refs
-==================
+= list-resource-refs
[[list-resource-refs-1]][[GSRFM00197]][[list-resource-refs]]
-list-resource-refs
-------------------
+== list-resource-refs
Lists existing resource references
diff --git a/docs/reference-manual/src/main/jbake/content/list-secure-admin-internal-users.adoc b/docs/reference-manual/src/main/jbake/content/list-secure-admin-internal-users.adoc
index ff19e1c..0a35b53 100644
--- a/docs/reference-manual/src/main/jbake/content/list-secure-admin-internal-users.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-secure-admin-internal-users.adoc
@@ -5,13 +5,11 @@
prev=list-resource-refs.html
~~~~~~
-list-secure-admin-internal-users
-================================
+= list-secure-admin-internal-users
[[list-secure-admin-internal-users-1]][[GSRFM00199]][[list-secure-admin-internal-users]]
-list-secure-admin-internal-users
---------------------------------
+== list-secure-admin-internal-users
Lists the user names that the {productName} DAS and instances use to
authenticate with each other and to authorize admin operations.
diff --git a/docs/reference-manual/src/main/jbake/content/list-secure-admin-principals.adoc b/docs/reference-manual/src/main/jbake/content/list-secure-admin-principals.adoc
index 0245578..a26f433 100644
--- a/docs/reference-manual/src/main/jbake/content/list-secure-admin-principals.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-secure-admin-principals.adoc
@@ -5,13 +5,11 @@
prev=list-secure-admin-internal-users.html
~~~~~~
-list-secure-admin-principals
-============================
+= list-secure-admin-principals
[[list-secure-admin-principals-1]][[GSRFM00200]][[list-secure-admin-principals]]
-list-secure-admin-principals
-----------------------------
+== list-secure-admin-principals
Lists the certificates for which {productName} accepts admin
requests from clients.
diff --git a/docs/reference-manual/src/main/jbake/content/list-sub-components.adoc b/docs/reference-manual/src/main/jbake/content/list-sub-components.adoc
index bb51e6c..f611054 100644
--- a/docs/reference-manual/src/main/jbake/content/list-sub-components.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-sub-components.adoc
@@ -5,13 +5,11 @@
prev=list-secure-admin-principals.html
~~~~~~
-list-sub-components
-===================
+= list-sub-components
[[list-sub-components-1]][[GSRFM00201]][[list-sub-components]]
-list-sub-components
--------------------
+== list-sub-components
Lists EJB or servlet components in a deployed module or module of a
deployed application
diff --git a/docs/reference-manual/src/main/jbake/content/list-supported-cipher-suites.adoc b/docs/reference-manual/src/main/jbake/content/list-supported-cipher-suites.adoc
index 700f4f7..3520129 100644
--- a/docs/reference-manual/src/main/jbake/content/list-supported-cipher-suites.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-supported-cipher-suites.adoc
@@ -5,13 +5,11 @@
prev=list-sub-components.html
~~~~~~
-list-supported-cipher-suites
-============================
+= list-supported-cipher-suites
[[list-supported-cipher-suites-1]][[GSRFM00202]][[list-supported-cipher-suites]]
-list-supported-cipher-suites
-----------------------------
+== list-supported-cipher-suites
Enables administrators to list the cipher suites that are supported and
available to a specified {productName} target
diff --git a/docs/reference-manual/src/main/jbake/content/list-system-properties.adoc b/docs/reference-manual/src/main/jbake/content/list-system-properties.adoc
index 1129dd0..769b873 100644
--- a/docs/reference-manual/src/main/jbake/content/list-system-properties.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-system-properties.adoc
@@ -5,13 +5,11 @@
prev=list-supported-cipher-suites.html
~~~~~~
-list-system-properties
-======================
+= list-system-properties
[[list-system-properties-1]][[GSRFM00203]][[list-system-properties]]
-list-system-properties
-----------------------
+== list-system-properties
Lists the system properties of the domain, configuration, cluster, or
server instance
diff --git a/docs/reference-manual/src/main/jbake/content/list-threadpools.adoc b/docs/reference-manual/src/main/jbake/content/list-threadpools.adoc
index 2d97d18..0b30176 100644
--- a/docs/reference-manual/src/main/jbake/content/list-threadpools.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-threadpools.adoc
@@ -5,13 +5,11 @@
prev=list-system-properties.html
~~~~~~
-list-threadpools
-================
+= list-threadpools
[[list-threadpools-1]][[GSRFM00204]][[list-threadpools]]
-list-threadpools
-----------------
+== list-threadpools
Lists all the thread pools
diff --git a/docs/reference-manual/src/main/jbake/content/list-timers.adoc b/docs/reference-manual/src/main/jbake/content/list-timers.adoc
index 0dc6704..ae90259 100644
--- a/docs/reference-manual/src/main/jbake/content/list-timers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-timers.adoc
@@ -5,13 +5,11 @@
prev=list-threadpools.html
~~~~~~
-list-timers
-===========
+= list-timers
[[list-timers-1]][[GSRFM00205]][[list-timers]]
-list-timers
------------
+== list-timers
Lists all of the persistent timers owned by server instance(s)
diff --git a/docs/reference-manual/src/main/jbake/content/list-transports.adoc b/docs/reference-manual/src/main/jbake/content/list-transports.adoc
index dd7d367..9ded1e3 100644
--- a/docs/reference-manual/src/main/jbake/content/list-transports.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-transports.adoc
@@ -5,13 +5,11 @@
prev=list-timers.html
~~~~~~
-list-transports
-===============
+= list-transports
[[list-transports-1]][[GSRFM00206]][[list-transports]]
-list-transports
----------------
+== list-transports
Lists the existing transports
diff --git a/docs/reference-manual/src/main/jbake/content/list-virtual-servers.adoc b/docs/reference-manual/src/main/jbake/content/list-virtual-servers.adoc
index 308bb3a..63bfe31 100644
--- a/docs/reference-manual/src/main/jbake/content/list-virtual-servers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-virtual-servers.adoc
@@ -5,13 +5,11 @@
prev=list-transports.html
~~~~~~
-list-virtual-servers
-====================
+= list-virtual-servers
[[list-virtual-servers-1]][[GSRFM00207]][[list-virtual-servers]]
-list-virtual-servers
---------------------
+== list-virtual-servers
Lists the existing virtual servers
diff --git a/docs/reference-manual/src/main/jbake/content/list-web-context-param.adoc b/docs/reference-manual/src/main/jbake/content/list-web-context-param.adoc
index ef61ca5..e75f19e 100644
--- a/docs/reference-manual/src/main/jbake/content/list-web-context-param.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-web-context-param.adoc
@@ -5,13 +5,11 @@
prev=list-virtual-servers.html
~~~~~~
-list-web-context-param
-======================
+= list-web-context-param
[[list-web-context-param-1]][[GSRFM00208]][[list-web-context-param]]
-list-web-context-param
-----------------------
+== list-web-context-param
Lists servlet context-initialization parameters of a deployed web
application or module
diff --git a/docs/reference-manual/src/main/jbake/content/list-web-env-entry.adoc b/docs/reference-manual/src/main/jbake/content/list-web-env-entry.adoc
index 4a5fc51..3a6696b 100644
--- a/docs/reference-manual/src/main/jbake/content/list-web-env-entry.adoc
+++ b/docs/reference-manual/src/main/jbake/content/list-web-env-entry.adoc
@@ -5,13 +5,11 @@
prev=list-web-context-param.html
~~~~~~
-list-web-env-entry
-==================
+= list-web-env-entry
[[list-web-env-entry-1]][[GSRFM00209]][[list-web-env-entry]]
-list-web-env-entry
-------------------
+== list-web-env-entry
Lists environment entries for a deployed web application or module
diff --git a/docs/reference-manual/src/main/jbake/content/logging.adoc b/docs/reference-manual/src/main/jbake/content/logging.adoc
index c278265..da048a7 100644
--- a/docs/reference-manual/src/main/jbake/content/logging.adoc
+++ b/docs/reference-manual/src/main/jbake/content/logging.adoc
@@ -5,13 +5,11 @@
prev=instance.html
~~~~~~
-logging
-=======
+= logging
[[logging-5asc]][[GSRFM00270]][[logging]]
-logging
--------
+== logging
Capturing information on {productName} runtime events
diff --git a/docs/reference-manual/src/main/jbake/content/manvol1.adoc b/docs/reference-manual/src/main/jbake/content/manvol1.adoc
index a734498..4097f24 100644
--- a/docs/reference-manual/src/main/jbake/content/manvol1.adoc
+++ b/docs/reference-manual/src/main/jbake/content/manvol1.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Eclipse GlassFish Server 7 asadmin Utility Subcommands
-======================================================
+= Eclipse GlassFish Server 7 asadmin Utility Subcommands
[[GSRFM443]][[sthref6]]
[[glassfish-server-open-source-edition-5.0-asadmin-utility-subcommands]]
-1 Eclipse GlassFish Server 7 asadmin Utility Subcommands
---------------------------------------------------------
+== 1 Eclipse GlassFish Server 7 asadmin Utility Subcommands
This section describes, in alphabetical order, the subcommands of the
link:asadmin.html#asadmin-1m[`asadmin`(1M)] utility.
diff --git a/docs/reference-manual/src/main/jbake/content/manvol1m.adoc b/docs/reference-manual/src/main/jbake/content/manvol1m.adoc
index d25814d..3edfbd9 100644
--- a/docs/reference-manual/src/main/jbake/content/manvol1m.adoc
+++ b/docs/reference-manual/src/main/jbake/content/manvol1m.adoc
@@ -5,15 +5,13 @@
prev=version.html
~~~~~~
-Eclipse GlassFish Server 7 Utility Commands
-===========================================
+= Eclipse GlassFish Server 7 Utility Commands
[[GSRFM803]][[sthref2356]]
[[glassfish-server-open-source-edition-5.0-utility-commands]]
-2 Eclipse GlassFish Server 7 Utility Commands
----------------------------------------------
+== 2 Eclipse GlassFish Server 7 Utility Commands
This section describes GlassFish Server utility commands.
diff --git a/docs/reference-manual/src/main/jbake/content/manvol5asc.adoc b/docs/reference-manual/src/main/jbake/content/manvol5asc.adoc
index b16c496..4a0e48b 100644
--- a/docs/reference-manual/src/main/jbake/content/manvol5asc.adoc
+++ b/docs/reference-manual/src/main/jbake/content/manvol5asc.adoc
@@ -5,15 +5,13 @@
prev=package-appclient.html
~~~~~~
-Eclipse GlassFish Server 7 GlassFish Server Concepts
-====================================================
+= Eclipse GlassFish Server 7 GlassFish Server Concepts
[[GSRFM814]][[sthref2391]]
[[glassfish-server-open-source-edition-5.0-glassfish-server-concepts]]
-3 Eclipse GlassFish Server 7 GlassFish Server Concepts
-------------------------------------------------------
+== 3 Eclipse GlassFish Server 7 GlassFish Server Concepts
This section describes concepts that are related to GlassFish Server
administration.
diff --git a/docs/reference-manual/src/main/jbake/content/migrate-timers.adoc b/docs/reference-manual/src/main/jbake/content/migrate-timers.adoc
index abb6869..ec3dede 100644
--- a/docs/reference-manual/src/main/jbake/content/migrate-timers.adoc
+++ b/docs/reference-manual/src/main/jbake/content/migrate-timers.adoc
@@ -5,13 +5,11 @@
prev=login.html
~~~~~~
-migrate-timers
-==============
+= migrate-timers
[[migrate-timers-1]][[GSRFM00211]][[migrate-timers]]
-migrate-timers
---------------
+== migrate-timers
Moves EJB timers when a clustered instance was stopped or has crashed
diff --git a/docs/reference-manual/src/main/jbake/content/monitor.adoc b/docs/reference-manual/src/main/jbake/content/monitor.adoc
index b6f741d..a9ca982 100644
--- a/docs/reference-manual/src/main/jbake/content/monitor.adoc
+++ b/docs/reference-manual/src/main/jbake/content/monitor.adoc
@@ -5,16 +5,14 @@
prev=migrate-timers.html
~~~~~~
-monitor
-=======
+= monitor
The script content on this page is for navigation purposes only and does
not alter the content in any way.
[[monitor-1]][[GSRFM00212]][[monitor]]
-monitor
--------
+== monitor
Displays monitoring data for commonly used components and services
diff --git a/docs/reference-manual/src/main/jbake/content/monitoring.adoc b/docs/reference-manual/src/main/jbake/content/monitoring.adoc
index 806b2e0..42e7cd0 100644
--- a/docs/reference-manual/src/main/jbake/content/monitoring.adoc
+++ b/docs/reference-manual/src/main/jbake/content/monitoring.adoc
@@ -5,13 +5,11 @@
prev=logging.html
~~~~~~
-monitoring
-==========
+= monitoring
[[monitoring-5asc]][[GSRFM00271]][[monitoring]]
-monitoring
-----------
+== monitoring
Reviewing the runtime state of components and services deployed in {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/multimode.adoc b/docs/reference-manual/src/main/jbake/content/multimode.adoc
index bfc3425..5adf377 100644
--- a/docs/reference-manual/src/main/jbake/content/multimode.adoc
+++ b/docs/reference-manual/src/main/jbake/content/multimode.adoc
@@ -5,13 +5,11 @@
prev=monitor.html
~~~~~~
-multimode
-=========
+= multimode
[[multimode-1]][[GSRFM00213]][[multimode]]
-multimode
----------
+== multimode
Allows multiple subcommands to be run while preserving environment
settings and remaining in the asadmin utility
diff --git a/docs/reference-manual/src/main/jbake/content/osgi-shell.adoc b/docs/reference-manual/src/main/jbake/content/osgi-shell.adoc
index 4964a0e..b6d548e 100644
--- a/docs/reference-manual/src/main/jbake/content/osgi-shell.adoc
+++ b/docs/reference-manual/src/main/jbake/content/osgi-shell.adoc
@@ -5,13 +5,11 @@
prev=osgi.html
~~~~~~
-osgi-shell
-==========
+= osgi-shell
[[osgi-shell-1]][[GSRFM890]][[osgi-shell]]
-osgi-shell
-----------
+== osgi-shell
Provides interactive access to the Apache Felix Gogo remote shell for
the execution of OSGi shell commands
diff --git a/docs/reference-manual/src/main/jbake/content/package-appclient.adoc b/docs/reference-manual/src/main/jbake/content/package-appclient.adoc
index 3517820..acf83d5 100644
--- a/docs/reference-manual/src/main/jbake/content/package-appclient.adoc
+++ b/docs/reference-manual/src/main/jbake/content/package-appclient.adoc
@@ -5,13 +5,11 @@
prev=capture-schema.html
~~~~~~
-package-appclient
-=================
+= package-appclient
[[package-appclient-1m]][[GSRFM00264]][[package-appclient]]
-package-appclient
------------------
+== package-appclient
Packs the application client container libraries and jar files
diff --git a/docs/reference-manual/src/main/jbake/content/passwords.adoc b/docs/reference-manual/src/main/jbake/content/passwords.adoc
index 977f1ef..8613979 100644
--- a/docs/reference-manual/src/main/jbake/content/passwords.adoc
+++ b/docs/reference-manual/src/main/jbake/content/passwords.adoc
@@ -5,13 +5,11 @@
prev=monitoring.html
~~~~~~
-passwords
-=========
+= passwords
[[passwords-5asc]][[GSRFM00272]][[passwords]]
-passwords
----------
+== passwords
Securing and managing {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/ping-connection-pool.adoc b/docs/reference-manual/src/main/jbake/content/ping-connection-pool.adoc
index 73f886c..6dae88b 100644
--- a/docs/reference-manual/src/main/jbake/content/ping-connection-pool.adoc
+++ b/docs/reference-manual/src/main/jbake/content/ping-connection-pool.adoc
@@ -5,13 +5,11 @@
prev=osgi-shell.html
~~~~~~
-ping-connection-pool
-====================
+= ping-connection-pool
[[ping-connection-pool-1]][[GSRFM00214]][[ping-connection-pool]]
-ping-connection-pool
---------------------
+== ping-connection-pool
Tests if a connection pool is usable
diff --git a/docs/reference-manual/src/main/jbake/content/ping-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/ping-node-dcom.adoc
index 15afc64..10afb12 100644
--- a/docs/reference-manual/src/main/jbake/content/ping-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/ping-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=ping-connection-pool.html
~~~~~~
-ping-node-dcom
-==============
+= ping-node-dcom
[[ping-node-dcom-1]][[GSRFM728]][[ping-node-dcom]]
-ping-node-dcom
---------------
+== ping-node-dcom
Tests if a node that is enabled for communication over DCOM is usable
diff --git a/docs/reference-manual/src/main/jbake/content/ping-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/ping-node-ssh.adoc
index c75f772..edf2ee8 100644
--- a/docs/reference-manual/src/main/jbake/content/ping-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/ping-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=ping-node-dcom.html
~~~~~~
-ping-node-ssh
-=============
+= ping-node-ssh
[[ping-node-ssh-1]][[GSRFM00215]][[ping-node-ssh]]
-ping-node-ssh
--------------
+== ping-node-ssh
Tests if a node that is enabled for communication over SSH is usable
diff --git a/docs/reference-manual/src/main/jbake/content/preface.adoc b/docs/reference-manual/src/main/jbake/content/preface.adoc
index 04b252d..f03640f 100644
--- a/docs/reference-manual/src/main/jbake/content/preface.adoc
+++ b/docs/reference-manual/src/main/jbake/content/preface.adoc
@@ -5,14 +5,12 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSRFM441]][[sthref2]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -37,8 +35,7 @@
[[overview]]
-Overview
-~~~~~~~~
+=== Overview
The following contains a brief description of each man page section and
the information it references:
diff --git a/docs/reference-manual/src/main/jbake/content/recover-transactions.adoc b/docs/reference-manual/src/main/jbake/content/recover-transactions.adoc
index ea4a741..171b0c0 100644
--- a/docs/reference-manual/src/main/jbake/content/recover-transactions.adoc
+++ b/docs/reference-manual/src/main/jbake/content/recover-transactions.adoc
@@ -5,13 +5,11 @@
prev=ping-node-ssh.html
~~~~~~
-recover-transactions
-====================
+= recover-transactions
[[recover-transactions-1]][[GSRFM00216]][[recover-transactions]]
-recover-transactions
---------------------
+== recover-transactions
Manually recovers pending transactions
diff --git a/docs/reference-manual/src/main/jbake/content/redeploy.adoc b/docs/reference-manual/src/main/jbake/content/redeploy.adoc
index 88ae277..e0c712f 100644
--- a/docs/reference-manual/src/main/jbake/content/redeploy.adoc
+++ b/docs/reference-manual/src/main/jbake/content/redeploy.adoc
@@ -5,13 +5,11 @@
prev=recover-transactions.html
~~~~~~
-redeploy
-========
+= redeploy
[[redeploy-1]][[GSRFM00217]][[redeploy]]
-redeploy
---------
+== redeploy
Redeploys the specified component
diff --git a/docs/reference-manual/src/main/jbake/content/remove-library.adoc b/docs/reference-manual/src/main/jbake/content/remove-library.adoc
index 320e8ac..4ac6863 100644
--- a/docs/reference-manual/src/main/jbake/content/remove-library.adoc
+++ b/docs/reference-manual/src/main/jbake/content/remove-library.adoc
@@ -5,13 +5,11 @@
prev=redeploy.html
~~~~~~
-remove-library
-==============
+= remove-library
[[remove-library-1]][[GSRFM00820]][[remove-library]]
-remove-library
---------------
+== remove-library
Removes one or more library JAR files from {productName}
diff --git a/docs/reference-manual/src/main/jbake/content/resource.adoc b/docs/reference-manual/src/main/jbake/content/resource.adoc
index 34750fd..fd6fbe3 100644
--- a/docs/reference-manual/src/main/jbake/content/resource.adoc
+++ b/docs/reference-manual/src/main/jbake/content/resource.adoc
@@ -5,13 +5,11 @@
prev=passwords.html
~~~~~~
-resource
-========
+= resource
[[resource-5asc]][[GSRFM00273]][[resource]]
-resource
---------
+== resource
Provide connectivity to various types of EIS.
diff --git a/docs/reference-manual/src/main/jbake/content/restart-domain.adoc b/docs/reference-manual/src/main/jbake/content/restart-domain.adoc
index 025a17d..79dadae 100644
--- a/docs/reference-manual/src/main/jbake/content/restart-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/restart-domain.adoc
@@ -5,13 +5,11 @@
prev=remove-library.html
~~~~~~
-restart-domain
-==============
+= restart-domain
[[restart-domain-1]][[GSRFM00218]][[restart-domain]]
-restart-domain
---------------
+== restart-domain
Restarts the DAS of the specified domain
diff --git a/docs/reference-manual/src/main/jbake/content/restart-instance.adoc b/docs/reference-manual/src/main/jbake/content/restart-instance.adoc
index 391aab5..ff88b81 100644
--- a/docs/reference-manual/src/main/jbake/content/restart-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/restart-instance.adoc
@@ -5,13 +5,11 @@
prev=restart-domain.html
~~~~~~
-restart-instance
-================
+= restart-instance
[[restart-instance-1]][[GSRFM00219]][[restart-instance]]
-restart-instance
-----------------
+== restart-instance
Restarts a running {productName} instance
diff --git a/docs/reference-manual/src/main/jbake/content/restart-local-instance.adoc b/docs/reference-manual/src/main/jbake/content/restart-local-instance.adoc
index f34f6a8..51dbb71 100644
--- a/docs/reference-manual/src/main/jbake/content/restart-local-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/restart-local-instance.adoc
@@ -5,13 +5,11 @@
prev=restart-instance.html
~~~~~~
-restart-local-instance
-======================
+= restart-local-instance
[[restart-local-instance-1]][[GSRFM00220]][[restart-local-instance]]
-restart-local-instance
-----------------------
+== restart-local-instance
Restarts a running {productName} instance on the host where the
subcommand is run
diff --git a/docs/reference-manual/src/main/jbake/content/restore-domain.adoc b/docs/reference-manual/src/main/jbake/content/restore-domain.adoc
index 9a12a99..97e7bee 100644
--- a/docs/reference-manual/src/main/jbake/content/restore-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/restore-domain.adoc
@@ -5,13 +5,11 @@
prev=restart-local-instance.html
~~~~~~
-restore-domain
-==============
+= restore-domain
[[restore-domain-1]][[GSRFM00221]][[restore-domain]]
-restore-domain
---------------
+== restore-domain
Restores files from backup
diff --git a/docs/reference-manual/src/main/jbake/content/rollback-transaction.adoc b/docs/reference-manual/src/main/jbake/content/rollback-transaction.adoc
index 6d732d1..66ec4ee 100644
--- a/docs/reference-manual/src/main/jbake/content/rollback-transaction.adoc
+++ b/docs/reference-manual/src/main/jbake/content/rollback-transaction.adoc
@@ -5,13 +5,11 @@
prev=restore-domain.html
~~~~~~
-rollback-transaction
-====================
+= rollback-transaction
[[rollback-transaction-1]][[GSRFM00223]][[rollback-transaction]]
-rollback-transaction
---------------------
+== rollback-transaction
Rolls back the named transaction
diff --git a/docs/reference-manual/src/main/jbake/content/rotate-log.adoc b/docs/reference-manual/src/main/jbake/content/rotate-log.adoc
index 86b1c4d..f851851 100644
--- a/docs/reference-manual/src/main/jbake/content/rotate-log.adoc
+++ b/docs/reference-manual/src/main/jbake/content/rotate-log.adoc
@@ -5,13 +5,11 @@
prev=rollback-transaction.html
~~~~~~
-rotate-log
-==========
+= rotate-log
[[rotate-log-1]][[GSRFM00224]][[rotate-log]]
-rotate-log
-----------
+== rotate-log
Rotates the log file
diff --git a/docs/reference-manual/src/main/jbake/content/security.adoc b/docs/reference-manual/src/main/jbake/content/security.adoc
index 0628c15..e14c8f7 100644
--- a/docs/reference-manual/src/main/jbake/content/security.adoc
+++ b/docs/reference-manual/src/main/jbake/content/security.adoc
@@ -4,13 +4,11 @@
prev=resource.html
~~~~~~
-security
-========
+= security
[[security-5asc]][[GSRFM00274]][[security]]
-security
---------
+== security
Secure and administer {productName} applications
diff --git a/docs/reference-manual/src/main/jbake/content/set-batch-runtime-configuration.adoc b/docs/reference-manual/src/main/jbake/content/set-batch-runtime-configuration.adoc
index 36f7474..dd2f0c0 100644
--- a/docs/reference-manual/src/main/jbake/content/set-batch-runtime-configuration.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-batch-runtime-configuration.adoc
@@ -5,13 +5,11 @@
prev=set.html
~~~~~~
-set-batch-runtime-configuration
-===============================
+= set-batch-runtime-configuration
[[set-batch-runtime-configuration-1]][[GSRFM897]][[set-batch-runtime-configuration]]
-set-batch-runtime-configuration
--------------------------------
+== set-batch-runtime-configuration
Configures the batch runtime
diff --git a/docs/reference-manual/src/main/jbake/content/set-log-attributes.adoc b/docs/reference-manual/src/main/jbake/content/set-log-attributes.adoc
index 9b7de78..b314127 100644
--- a/docs/reference-manual/src/main/jbake/content/set-log-attributes.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-log-attributes.adoc
@@ -5,13 +5,11 @@
prev=set-batch-runtime-configuration.html
~~~~~~
-set-log-attributes
-==================
+= set-log-attributes
[[set-log-attributes-1]][[GSRFM00227]][[set-log-attributes]]
-set-log-attributes
-------------------
+== set-log-attributes
Sets the logging attributes for one or more loggers
diff --git a/docs/reference-manual/src/main/jbake/content/set-log-file-format.adoc b/docs/reference-manual/src/main/jbake/content/set-log-file-format.adoc
index 6acefeb..d618b8f 100644
--- a/docs/reference-manual/src/main/jbake/content/set-log-file-format.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-log-file-format.adoc
@@ -5,13 +5,11 @@
prev=set-log-attributes.html
~~~~~~
-set-log-file-format
-===================
+= set-log-file-format
[[set-log-file-format-1]][[GSRFM879]][[set-log-file-format]]
-set-log-file-format
--------------------
+== set-log-file-format
Sets the formatter to be used for the server log file
diff --git a/docs/reference-manual/src/main/jbake/content/set-log-levels.adoc b/docs/reference-manual/src/main/jbake/content/set-log-levels.adoc
index 872bae1..c62fe08 100644
--- a/docs/reference-manual/src/main/jbake/content/set-log-levels.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-log-levels.adoc
@@ -5,13 +5,11 @@
prev=set-log-file-format.html
~~~~~~
-set-log-levels
-==============
+= set-log-levels
[[set-log-levels-1]][[GSRFM00228]][[set-log-levels]]
-set-log-levels
---------------
+== set-log-levels
Sets the log level for one or more loggers
diff --git a/docs/reference-manual/src/main/jbake/content/set-web-context-param.adoc b/docs/reference-manual/src/main/jbake/content/set-web-context-param.adoc
index 063c644..8e74c56 100644
--- a/docs/reference-manual/src/main/jbake/content/set-web-context-param.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-web-context-param.adoc
@@ -5,13 +5,11 @@
prev=setup-ssh.html
~~~~~~
-set-web-context-param
-=====================
+= set-web-context-param
[[set-web-context-param-1]][[GSRFM00230]][[set-web-context-param]]
-set-web-context-param
----------------------
+== set-web-context-param
Sets a servlet context-initialization parameter of a deployed web
application or module
diff --git a/docs/reference-manual/src/main/jbake/content/set-web-env-entry.adoc b/docs/reference-manual/src/main/jbake/content/set-web-env-entry.adoc
index 03a92fe..9eecb32 100644
--- a/docs/reference-manual/src/main/jbake/content/set-web-env-entry.adoc
+++ b/docs/reference-manual/src/main/jbake/content/set-web-env-entry.adoc
@@ -5,13 +5,11 @@
prev=set-web-context-param.html
~~~~~~
-set-web-env-entry
-=================
+= set-web-env-entry
[[set-web-env-entry-1]][[GSRFM00231]][[set-web-env-entry]]
-set-web-env-entry
------------------
+== set-web-env-entry
Sets an environment entry for a deployed web application or module
diff --git a/docs/reference-manual/src/main/jbake/content/setup-local-dcom.adoc b/docs/reference-manual/src/main/jbake/content/setup-local-dcom.adoc
index 4b381ea..c1807f0 100644
--- a/docs/reference-manual/src/main/jbake/content/setup-local-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/setup-local-dcom.adoc
@@ -5,13 +5,11 @@
prev=set-log-levels.html
~~~~~~
-setup-local-dcom
-================
+= setup-local-dcom
[[setup-local-dcom-1]][[GSRFM893]][[setup-local-dcom]]
-setup-local-dcom
-----------------
+== setup-local-dcom
Sets up DCOM on a host
diff --git a/docs/reference-manual/src/main/jbake/content/setup-ssh.adoc b/docs/reference-manual/src/main/jbake/content/setup-ssh.adoc
index 6c32f95..ff41afd 100644
--- a/docs/reference-manual/src/main/jbake/content/setup-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/setup-ssh.adoc
@@ -5,13 +5,11 @@
prev=setup-local-dcom.html
~~~~~~
-setup-ssh
-=========
+= setup-ssh
[[setup-ssh-1]][[GSRFM00229]][[setup-ssh]]
-setup-ssh
----------
+== setup-ssh
Sets up an SSH key on specified hosts
diff --git a/docs/reference-manual/src/main/jbake/content/show-component-status.adoc b/docs/reference-manual/src/main/jbake/content/show-component-status.adoc
index 0b9a5bd..6b88a3c 100644
--- a/docs/reference-manual/src/main/jbake/content/show-component-status.adoc
+++ b/docs/reference-manual/src/main/jbake/content/show-component-status.adoc
@@ -5,13 +5,11 @@
prev=set-web-env-entry.html
~~~~~~
-show-component-status
-=====================
+= show-component-status
[[show-component-status-1]][[GSRFM00232]][[show-component-status]]
-show-component-status
----------------------
+== show-component-status
Displays the status of the deployed component
diff --git a/docs/reference-manual/src/main/jbake/content/start-cluster.adoc b/docs/reference-manual/src/main/jbake/content/start-cluster.adoc
index ce1762c..a614b74 100644
--- a/docs/reference-manual/src/main/jbake/content/start-cluster.adoc
+++ b/docs/reference-manual/src/main/jbake/content/start-cluster.adoc
@@ -5,13 +5,11 @@
prev=show-component-status.html
~~~~~~
-start-cluster
-=============
+= start-cluster
[[start-cluster-1]][[GSRFM00233]][[start-cluster]]
-start-cluster
--------------
+== start-cluster
Starts a cluster
diff --git a/docs/reference-manual/src/main/jbake/content/start-database.adoc b/docs/reference-manual/src/main/jbake/content/start-database.adoc
index d200124..ba146aa 100644
--- a/docs/reference-manual/src/main/jbake/content/start-database.adoc
+++ b/docs/reference-manual/src/main/jbake/content/start-database.adoc
@@ -5,13 +5,11 @@
prev=start-cluster.html
~~~~~~
-start-database
-==============
+= start-database
[[start-database-1]][[GSRFM00234]][[start-database]]
-start-database
---------------
+== start-database
Starts the Java DB
diff --git a/docs/reference-manual/src/main/jbake/content/start-domain.adoc b/docs/reference-manual/src/main/jbake/content/start-domain.adoc
index 8b4208b..c6b74c6 100644
--- a/docs/reference-manual/src/main/jbake/content/start-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/start-domain.adoc
@@ -5,13 +5,11 @@
prev=start-database.html
~~~~~~
-start-domain
-============
+= start-domain
[[start-domain-1]][[GSRFM00235]][[start-domain]]
-start-domain
-------------
+== start-domain
Starts the DAS of the specified domain
diff --git a/docs/reference-manual/src/main/jbake/content/start-instance.adoc b/docs/reference-manual/src/main/jbake/content/start-instance.adoc
index 7eac6f3..aaddcb1 100644
--- a/docs/reference-manual/src/main/jbake/content/start-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/start-instance.adoc
@@ -5,13 +5,11 @@
prev=start-domain.html
~~~~~~
-start-instance
-==============
+= start-instance
[[start-instance-1]][[GSRFM00236]][[start-instance]]
-start-instance
---------------
+== start-instance
Starts a {productName} instance
diff --git a/docs/reference-manual/src/main/jbake/content/start-local-instance.adoc b/docs/reference-manual/src/main/jbake/content/start-local-instance.adoc
index 325cd20..3f89d13 100644
--- a/docs/reference-manual/src/main/jbake/content/start-local-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/start-local-instance.adoc
@@ -5,13 +5,11 @@
prev=start-instance.html
~~~~~~
-start-local-instance
-====================
+= start-local-instance
[[start-local-instance-1]][[GSRFM00237]][[start-local-instance]]
-start-local-instance
---------------------
+== start-local-instance
Starts a {productName} instance on the host where the subcommand is run
diff --git a/docs/reference-manual/src/main/jbake/content/stop-cluster.adoc b/docs/reference-manual/src/main/jbake/content/stop-cluster.adoc
index 248a310..7b95d6e 100644
--- a/docs/reference-manual/src/main/jbake/content/stop-cluster.adoc
+++ b/docs/reference-manual/src/main/jbake/content/stop-cluster.adoc
@@ -5,13 +5,11 @@
prev=start-local-instance.html
~~~~~~
-stop-cluster
-============
+= stop-cluster
[[stop-cluster-1]][[GSRFM00238]][[stop-cluster]]
-stop-cluster
-------------
+== stop-cluster
Stops a {productName} cluster
diff --git a/docs/reference-manual/src/main/jbake/content/stop-database.adoc b/docs/reference-manual/src/main/jbake/content/stop-database.adoc
index 9ab4d4f..d718f90 100644
--- a/docs/reference-manual/src/main/jbake/content/stop-database.adoc
+++ b/docs/reference-manual/src/main/jbake/content/stop-database.adoc
@@ -5,13 +5,11 @@
prev=stop-cluster.html
~~~~~~
-stop-database
-=============
+= stop-database
[[stop-database-1]][[GSRFM00239]][[stop-database]]
-stop-database
--------------
+== stop-database
Stops the Java DB
diff --git a/docs/reference-manual/src/main/jbake/content/stop-domain.adoc b/docs/reference-manual/src/main/jbake/content/stop-domain.adoc
index da02502..2bce619 100644
--- a/docs/reference-manual/src/main/jbake/content/stop-domain.adoc
+++ b/docs/reference-manual/src/main/jbake/content/stop-domain.adoc
@@ -5,13 +5,11 @@
prev=stop-database.html
~~~~~~
-stop-domain
-===========
+= stop-domain
[[stop-domain-1]][[GSRFM00240]][[stop-domain]]
-stop-domain
------------
+== stop-domain
Stops the Domain Administration Server of the specified domain
diff --git a/docs/reference-manual/src/main/jbake/content/stop-instance.adoc b/docs/reference-manual/src/main/jbake/content/stop-instance.adoc
index bc7b8a7..0368438 100644
--- a/docs/reference-manual/src/main/jbake/content/stop-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/stop-instance.adoc
@@ -5,13 +5,11 @@
prev=stop-domain.html
~~~~~~
-stop-instance
-=============
+= stop-instance
[[stop-instance-1]][[GSRFM00241]][[stop-instance]]
-stop-instance
--------------
+== stop-instance
Stops a running {productName} instance
diff --git a/docs/reference-manual/src/main/jbake/content/stop-local-instance.adoc b/docs/reference-manual/src/main/jbake/content/stop-local-instance.adoc
index 7c09861..28941f3 100644
--- a/docs/reference-manual/src/main/jbake/content/stop-local-instance.adoc
+++ b/docs/reference-manual/src/main/jbake/content/stop-local-instance.adoc
@@ -5,13 +5,11 @@
prev=stop-instance.html
~~~~~~
-stop-local-instance
-===================
+= stop-local-instance
[[stop-local-instance-1]][[GSRFM00242]][[stop-local-instance]]
-stop-local-instance
--------------------
+== stop-local-instance
Stops a {productName} instance on the machine where the subcommand is run
diff --git a/docs/reference-manual/src/main/jbake/content/title.adoc b/docs/reference-manual/src/main/jbake/content/title.adoc
index 841edc4..dee42e2 100644
--- a/docs/reference-manual/src/main/jbake/content/title.adoc
+++ b/docs/reference-manual/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-Eclipse GlassFish Server Reference Manual, Release 7
-====================================================
+= Eclipse GlassFish Server Reference Manual, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Reference Manual
diff --git a/docs/reference-manual/src/main/jbake/content/toc.adoc b/docs/reference-manual/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..223ebea
--- /dev/null
+++ b/docs/reference-manual/src/main/jbake/content/toc.adoc
@@ -0,0 +1,323 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Reference Manual, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Reference Manual, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSRFM441[Preface]
+
+** link:preface.html#GSRFM442[Overview]
+
+=== link:manvol1.html#GSRFM443[1 Eclipse GlassFish Server 7 asadmin Utility Subcommands]
+
+* link:add-library.html#GSRFM00818[add-library]
+* link:add-resources.html#GSRFM00001[add-resources]
+* link:apply-http-lb-changes.html#GSRFM00002[apply-http-lb-changes]
+* link:attach.html#GSRFM825[attach]
+* link:backup-domain.html#GSRFM00003[backup-domain]
+* link:change-admin-password.html#GSRFM00004[change-admin-password]
+* link:change-master-broker.html#GSRFM00005[change-master-broker]
+* link:change-master-password.html#GSRFM00006[change-master-password]
+* link:collect-log-files.html#GSRFM00007[collect-log-files]
+* link:configure-jms-cluster.html#GSRFM00008[configure-jms-cluster]
+* link:configure-lb-weight.html#GSRFM00009[configure-lb-weight]
+* link:configure-ldap-for-admin.html#GSRFM00010[configure-ldap-for-admin]
+* link:configure-managed-jobs.html#GSRFM836[configure-managed-jobs]
+* link:copy-config.html#GSRFM00011[copy-config]
+* link:create-admin-object.html#GSRFM00012[create-admin-object]
+* link:create-application-ref.html#GSRFM00013[create-application-ref]
+* link:create-audit-module.html#GSRFM00014[create-audit-module]
+* link:create-auth-realm.html#GSRFM00015[create-auth-realm]
+* link:create-cluster.html#GSRFM00017[create-cluster]
+* link:create-connector-connection-pool.html#GSRFM00018[create-connector-connection-pool]
+* link:create-connector-resource.html#GSRFM00019[create-connector-resource]
+* link:create-connector-security-map.html#GSRFM00020[create-connector-security-map]
+* link:create-connector-work-security-map.html#GSRFM00021[create-connector-work-security-map]
+* link:create-context-service.html#GSRFM838[create-context-service]
+* link:create-custom-resource.html#GSRFM00022[create-custom-resource]
+* link:create-domain.html#GSRFM00023[create-domain]
+* link:create-file-user.html#GSRFM00024[create-file-user]
+* link:create-http.html#GSRFM00025[create-http]
+* link:create-http-health-checker.html#GSRFM00026[create-http-health-checker]
+* link:create-http-lb.html#GSRFM00027[create-http-lb]
+* link:create-http-lb-config.html#GSRFM00028[create-http-lb-config]
+* link:create-http-lb-ref.html#GSRFM00029[create-http-lb-ref]
+* link:create-http-listener.html#GSRFM00030[create-http-listener]
+* link:create-http-redirect.html#GSRFM00031[create-http-redirect]
+* link:create-iiop-listener.html#GSRFM00032[create-iiop-listener]
+* link:create-instance.html#GSRFM00033[create-instance]
+* link:create-jacc-provider.html#GSRFM00034[create-jacc-provider]
+* link:create-javamail-resource.html#GSRFM00035[create-javamail-resource]
+* link:create-jdbc-connection-pool.html#GSRFM00036[create-jdbc-connection-pool]
+* link:create-jdbc-resource.html#GSRFM00037[create-jdbc-resource]
+* link:create-jmsdest.html#GSRFM00038[create-jmsdest]
+* link:create-jms-host.html#GSRFM00039[create-jms-host]
+* link:create-jms-resource.html#GSRFM00040[create-jms-resource]
+* link:create-jndi-resource.html#GSRFM00041[create-jndi-resource]
+* link:create-jvm-options.html#GSRFM00042[create-jvm-options]
+* link:create-lifecycle-module.html#GSRFM00043[create-lifecycle-module]
+* link:create-local-instance.html#GSRFM00044[create-local-instance]
+* link:create-managed-executor-service.html#GSRFM840[create-managed-executor-service]
+* link:create-managed-scheduled-executor-service.html#GSRFM680[create-managed-scheduled-executor-service]
+* link:create-managed-thread-factory.html#GSRFM842[create-managed-thread-factory]
+* link:create-message-security-provider.html#GSRFM00045[create-message-security-provider]
+* link:create-module-config.html#GSRFM844[create-module-config]
+* link:create-network-listener.html#GSRFM00046[create-network-listener]
+* link:create-node-config.html#GSRFM00047[create-node-config]
+* link:create-node-dcom.html#GSRFM510[create-node-dcom]
+* link:create-node-ssh.html#GSRFM00048[create-node-ssh]
+* link:create-password-alias.html#GSRFM00049[create-password-alias]
+* link:create-profiler.html#GSRFM00050[create-profiler]
+* link:create-protocol.html#GSRFM00051[create-protocol]
+* link:create-protocol-filter.html#GSRFM00052[create-protocol-filter]
+* link:create-protocol-finder.html#GSRFM00053[create-protocol-finder]
+* link:create-resource-adapter-config.html#GSRFM00054[create-resource-adapter-config]
+* link:create-resource-ref.html#GSRFM00055[create-resource-ref]
+* link:create-service.html#GSRFM00057[create-service]
+* link:create-ssl.html#GSRFM00058[create-ssl]
+* link:create-system-properties.html#GSRFM00059[create-system-properties]
+* link:create-threadpool.html#GSRFM00060[create-threadpool]
+* link:create-transport.html#GSRFM00061[create-transport]
+* link:create-virtual-server.html#GSRFM00062[create-virtual-server]
+* link:delete-admin-object.html#GSRFM00063[delete-admin-object]
+* link:delete-application-ref.html#GSRFM00064[delete-application-ref]
+* link:delete-audit-module.html#GSRFM00065[delete-audit-module]
+* link:delete-auth-realm.html#GSRFM00066[delete-auth-realm]
+* link:delete-cluster.html#GSRFM00068[delete-cluster]
+* link:delete-config.html#GSRFM00069[delete-config]
+* link:delete-connector-connection-pool.html#GSRFM00070[delete-connector-connection-pool]
+* link:delete-connector-resource.html#GSRFM00071[delete-connector-resource]
+* link:delete-connector-security-map.html#GSRFM00072[delete-connector-security-map]
+* link:delete-connector-work-security-map.html#GSRFM00073[delete-connector-work-security-map]
+* link:delete-context-service.html#GSRFM846[delete-context-service]
+* link:delete-custom-resource.html#GSRFM00074[delete-custom-resource]
+* link:delete-domain.html#GSRFM00075[delete-domain]
+* link:delete-file-user.html#GSRFM00076[delete-file-user]
+* link:delete-http.html#GSRFM00077[delete-http]
+* link:delete-http-health-checker.html#GSRFM00078[delete-http-health-checker]
+* link:delete-http-lb.html#GSRFM00079[delete-http-lb]
+* link:delete-http-lb-config.html#GSRFM00080[delete-http-lb-config]
+* link:delete-http-lb-ref.html#GSRFM00081[delete-http-lb-ref]
+* link:delete-http-listener.html#GSRFM00082[delete-http-listener]
+* link:delete-http-redirect.html#GSRFM00083[delete-http-redirect]
+* link:delete-iiop-listener.html#GSRFM00084[delete-iiop-listener]
+* link:delete-instance.html#GSRFM00085[delete-instance]
+* link:delete-jacc-provider.html#GSRFM00086[delete-jacc-provider]
+* link:delete-javamail-resource.html#GSRFM00087[delete-javamail-resource]
+* link:delete-jdbc-connection-pool.html#GSRFM00088[delete-jdbc-connection-pool]
+* link:delete-jdbc-resource.html#GSRFM00089[delete-jdbc-resource]
+* link:delete-jmsdest.html#GSRFM00090[delete-jmsdest]
+* link:delete-jms-host.html#GSRFM00091[delete-jms-host]
+* link:delete-jms-resource.html#GSRFM00092[delete-jms-resource]
+* link:delete-jndi-resource.html#GSRFM00093[delete-jndi-resource]
+* link:delete-jvm-options.html#GSRFM00094[delete-jvm-options]
+* link:delete-lifecycle-module.html#GSRFM00095[delete-lifecycle-module]
+* link:delete-local-instance.html#GSRFM00096[delete-local-instance]
+* link:delete-managed-executor-service.html#GSRFM848[delete-managed-executor-service]
+* link:delete-managed-scheduled-executor-service.html#GSRFM850[delete-managed-scheduled-executor-service]
+* link:delete-managed-thread-factory.html#GSRFM852[delete-managed-thread-factory]
+* link:delete-message-security-provider.html#GSRFM00097[delete-message-security-provider]
+* link:delete-module-config.html#GSRFM854[delete-module-config]
+* link:delete-network-listener.html#GSRFM00098[delete-network-listener]
+* link:delete-node-config.html#GSRFM00099[delete-node-config]
+* link:delete-node-dcom.html#GSRFM569[delete-node-dcom]
+* link:delete-node-ssh.html#GSRFM00100[delete-node-ssh]
+* link:delete-password-alias.html#GSRFM00101[delete-password-alias]
+* link:delete-profiler.html#GSRFM00102[delete-profiler]
+* link:delete-protocol.html#GSRFM00103[delete-protocol]
+* link:delete-protocol-filter.html#GSRFM00104[delete-protocol-filter]
+* link:delete-protocol-finder.html#GSRFM00105[delete-protocol-finder]
+* link:delete-resource-adapter-config.html#GSRFM00106[delete-resource-adapter-config]
+* link:delete-resource-ref.html#GSRFM00107[delete-resource-ref]
+* link:delete-ssl.html#GSRFM00109[delete-ssl]
+* link:delete-system-property.html#GSRFM00110[delete-system-property]
+* link:delete-threadpool.html#GSRFM00111[delete-threadpool]
+* link:delete-transport.html#GSRFM00112[delete-transport]
+* link:delete-virtual-server.html#GSRFM00113[delete-virtual-server]
+* link:deploy.html#GSRFM00114[deploy]
+* link:deploydir.html#GSRFM00115[deploydir]
+* link:disable.html#GSRFM00116[disable]
+* link:disable-http-lb-application.html#GSRFM00118[disable-http-lb-application]
+* link:disable-http-lb-server.html#GSRFM00119[disable-http-lb-server]
+* link:disable-monitoring.html#GSRFM00120[disable-monitoring]
+* link:disable-secure-admin.html#GSRFM00121[disable-secure-admin]
+* link:disable-secure-admin-internal-user.html#GSRFM00122[disable-secure-admin-internal-user]
+* link:disable-secure-admin-principal.html#GSRFM00123[disable-secure-admin-principal]
+* link:enable.html#GSRFM00124[enable]
+* link:enable-http-lb-application.html#GSRFM00126[enable-http-lb-application]
+* link:enable-http-lb-server.html#GSRFM00127[enable-http-lb-server]
+* link:enable-monitoring.html#GSRFM00128[enable-monitoring]
+* link:enable-secure-admin.html#GSRFM00129[enable-secure-admin]
+* link:enable-secure-admin-internal-user.html#GSRFM00130[enable-secure-admin-internal-user]
+* link:enable-secure-admin-principal.html#GSRFM00131[enable-secure-admin-principal]
+* link:export.html#GSRFM00132[export]
+* link:export-http-lb-config.html#GSRFM00133[export-http-lb-config]
+* link:export-sync-bundle.html#GSRFM00134[export-sync-bundle]
+* link:flush-connection-pool.html#GSRFM00135[flush-connection-pool]
+* link:flush-jmsdest.html#GSRFM00136[flush-jmsdest]
+* link:freeze-transaction-service.html#GSRFM00137[freeze-transaction-service]
+* link:generate-jvm-report.html#GSRFM00138[generate-jvm-report]
+* link:get-active-module-config.html#GSRFM859[get-active-module-config]
+* link:get-client-stubs.html#GSRFM00140[get-client-stubs]
+* link:get-health.html#GSRFM00141[get-health]
+* link:import-sync-bundle.html#GSRFM00142[import-sync-bundle]
+* link:install-node.html#GSRFM00143[install-node]
+* link:install-node-dcom.html#GSRFM626[install-node-dcom]
+* link:install-node-ssh.html#GSRFM628[install-node-ssh]
+* link:jms-ping.html#GSRFM00144[jms-ping]
+* link:list-admin-objects.html#GSRFM00146[list-admin-objects]
+* link:list-application-refs.html#GSRFM00147[list-application-refs]
+* link:list-applications.html#GSRFM00148[list-applications]
+* link:list-audit-modules.html#GSRFM00149[list-audit-modules]
+* link:list-auth-realms.html#GSRFM00150[list-auth-realms]
+* link:list-backups.html#GSRFM00152[list-backups]
+* link:list-batch-job-executions.html#GSRFM884[list-batch-job-executions]
+* link:list-batch-jobs.html#GSRFM861[list-batch-jobs]
+* link:list-batch-job-steps.html#GSRFM895[list-batch-job-steps]
+* link:list-batch-runtime-configuration.html#GSRFM863[list-batch-runtime-configuration]
+* link:list-clusters.html#GSRFM00153[list-clusters]
+* link:list-commands.html#GSRFM00154[list-commands]
+* link:list-components.html#GSRFM00155[list-components]
+* link:list-configs.html#GSRFM00156[list-configs]
+* link:list-connector-connection-pools.html#GSRFM00157[list-connector-connection-pools]
+* link:list-connector-resources.html#GSRFM00158[list-connector-resources]
+* link:list-connector-security-maps.html#GSRFM00159[list-connector-security-maps]
+* link:list-connector-work-security-maps.html#GSRFM00160[list-connector-work-security-maps]
+* link:list-containers.html#GSRFM00161[list-containers]
+* link:list-context-services.html#GSRFM865[list-context-services]
+* link:list-custom-resources.html#GSRFM00162[list-custom-resources]
+* link:list-domains.html#GSRFM00163[list-domains]
+* link:list-file-groups.html#GSRFM00164[list-file-groups]
+* link:list-file-users.html#GSRFM00165[list-file-users]
+* link:list-http-lb-configs.html#GSRFM00166[list-http-lb-configs]
+* link:list-http-lbs.html#GSRFM00167[list-http-lbs]
+* link:list-http-listeners.html#GSRFM00168[list-http-listeners]
+* link:list-iiop-listeners.html#GSRFM00169[list-iiop-listeners]
+* link:list-instances.html#GSRFM00170[list-instances]
+* link:list-jacc-providers.html#GSRFM00171[list-jacc-providers]
+* link:list-javamail-resources.html#GSRFM00172[list-javamail-resources]
+* link:list-jdbc-connection-pools.html#GSRFM00173[list-jdbc-connection-pools]
+* link:list-jdbc-resources.html#GSRFM00174[list-jdbc-resources]
+* link:list-jmsdest.html#GSRFM00175[list-jmsdest]
+* link:list-jms-hosts.html#GSRFM00176[list-jms-hosts]
+* link:list-jms-resources.html#GSRFM00177[list-jms-resources]
+* link:list-jndi-entries.html#GSRFM00178[list-jndi-entries]
+* link:list-jndi-resources.html#GSRFM00179[list-jndi-resources]
+* link:list-jobs.html#GSRFM867[list-jobs]
+* link:list-jvm-options.html#GSRFM00180[list-jvm-options]
+* link:list-libraries.html#GSRFM00819[list-libraries]
+* link:list-lifecycle-modules.html#GSRFM00181[list-lifecycle-modules]
+* link:list-log-attributes.html#GSRFM00182[list-log-attributes]
+* link:list-loggers.html#GSRFM869[list-loggers]
+* link:list-log-levels.html#GSRFM00183[list-log-levels]
+* link:list-managed-executor-services.html#GSRFM871[list-managed-executor-services]
+* link:list-managed-scheduled-executor-services.html#GSRFM873[list-managed-scheduled-executor-services]
+* link:list-managed-thread-factories.html#GSRFM875[list-managed-thread-factories]
+* link:list-message-security-providers.html#GSRFM00184[list-message-security-providers]
+* link:list-modules.html#GSRFM00185[list-modules]
+* link:list-network-listeners.html#GSRFM00186[list-network-listeners]
+* link:list-nodes.html#GSRFM00187[list-nodes]
+* link:list-nodes-config.html#GSRFM00188[list-nodes-config]
+* link:list-nodes-dcom.html#GSRFM693[list-nodes-dcom]
+* link:list-nodes-ssh.html#GSRFM00189[list-nodes-ssh]
+* link:list-password-aliases.html#GSRFM00190[list-password-aliases]
+* link:list-persistence-types.html#GSRFM00191[list-persistence-types]
+* link:list-protocol-filters.html#GSRFM00193[list-protocol-filters]
+* link:list-protocol-finders.html#GSRFM00194[list-protocol-finders]
+* link:list-protocols.html#GSRFM00195[list-protocols]
+* link:list-resource-adapter-configs.html#GSRFM00196[list-resource-adapter-configs]
+* link:list-resource-refs.html#GSRFM00197[list-resource-refs]
+* link:list-secure-admin-internal-users.html#GSRFM00199[list-secure-admin-internal-users]
+* link:list-secure-admin-principals.html#GSRFM00200[list-secure-admin-principals]
+* link:list-sub-components.html#GSRFM00201[list-sub-components]
+* link:list-supported-cipher-suites.html#GSRFM00202[list-supported-cipher-suites]
+* link:list-system-properties.html#GSRFM00203[list-system-properties]
+* link:list-threadpools.html#GSRFM00204[list-threadpools]
+* link:list-timers.html#GSRFM00205[list-timers]
+* link:list-transports.html#GSRFM00206[list-transports]
+* link:list-virtual-servers.html#GSRFM00207[list-virtual-servers]
+* link:list-web-context-param.html#GSRFM00208[list-web-context-param]
+* link:list-web-env-entry.html#GSRFM00209[list-web-env-entry]
+* link:login.html#GSRFM00210[login]
+* link:migrate-timers.html#GSRFM00211[migrate-timers]
+* link:monitor.html#GSRFM00212[monitor]
+* link:multimode.html#GSRFM00213[multimode]
+* link:osgi-shell.html#GSRFM890[osgi-shell]
+* link:ping-connection-pool.html#GSRFM00214[ping-connection-pool]
+* link:ping-node-dcom.html#GSRFM728[ping-node-dcom]
+* link:ping-node-ssh.html#GSRFM00215[ping-node-ssh]
+* link:recover-transactions.html#GSRFM00216[recover-transactions]
+* link:redeploy.html#GSRFM00217[redeploy]
+* link:remove-library.html#GSRFM00820[remove-library]
+* link:restart-domain.html#GSRFM00218[restart-domain]
+* link:restart-instance.html#GSRFM00219[restart-instance]
+* link:restart-local-instance.html#GSRFM00220[restart-local-instance]
+* link:restore-domain.html#GSRFM00221[restore-domain]
+* link:rollback-transaction.html#GSRFM00223[rollback-transaction]
+* link:rotate-log.html#GSRFM00224[rotate-log]
+* link:set-batch-runtime-configuration.html#GSRFM897[set-batch-runtime-configuration]
+* link:set-log-attributes.html#GSRFM00227[set-log-attributes]
+* link:set-log-file-format.html#GSRFM879[set-log-file-format]
+* link:set-log-levels.html#GSRFM00228[set-log-levels]
+* link:setup-local-dcom.html#GSRFM893[setup-local-dcom]
+* link:setup-ssh.html#GSRFM00229[setup-ssh]
+* link:set-web-context-param.html#GSRFM00230[set-web-context-param]
+* link:set-web-env-entry.html#GSRFM00231[set-web-env-entry]
+* link:show-component-status.html#GSRFM00232[show-component-status]
+* link:start-cluster.html#GSRFM00233[start-cluster]
+* link:start-database.html#GSRFM00234[start-database]
+* link:start-domain.html#GSRFM00235[start-domain]
+* link:start-instance.html#GSRFM00236[start-instance]
+* link:start-local-instance.html#GSRFM00237[start-local-instance]
+* link:stop-cluster.html#GSRFM00238[stop-cluster]
+* link:stop-database.html#GSRFM00239[stop-database]
+* link:stop-domain.html#GSRFM00240[stop-domain]
+* link:stop-instance.html#GSRFM00241[stop-instance]
+* link:stop-local-instance.html#GSRFM00242[stop-local-instance]
+* link:undeploy.html#GSRFM00244[undeploy]
+* link:unfreeze-transaction-service.html#GSRFM00245[unfreeze-transaction-service]
+* link:uninstall-node.html#GSRFM00246[uninstall-node]
+* link:uninstall-node-dcom.html#GSRFM775[uninstall-node-dcom]
+* link:uninstall-node-ssh.html#GSRFM778[uninstall-node-ssh]
+* link:unset.html#GSRFM00247[unset]
+* link:unset-web-context-param.html#GSRFM00248[unset-web-context-param]
+* link:unset-web-env-entry.html#GSRFM00249[unset-web-env-entry]
+* link:update-connector-security-map.html#GSRFM00252[update-connector-security-map]
+* link:update-connector-work-security-map.html#GSRFM00253[update-connector-work-security-map]
+* link:update-file-user.html#GSRFM00254[update-file-user]
+* link:update-node-config.html#GSRFM00255[update-node-config]
+* link:update-node-dcom.html#GSRFM789[update-node-dcom]
+* link:update-node-ssh.html#GSRFM00256[update-node-ssh]
+* link:update-password-alias.html#GSRFM00257[update-password-alias]
+* link:uptime.html#GSRFM00258[uptime]
+* link:validate-dcom.html#GSRFM796[validate-dcom]
+* link:validate-multicast.html#GSRFM00259[validate-multicast]
+* link:verify-domain-xml.html#GSRFM00260[verify-domain-xml]
+* link:version.html#GSRFM00261[version]
+
+=== link:manvol1m.html#GSRFM803[2 Eclipse GlassFish Server 7 Utility Commands]
+
+* link:appclient.html#GSRFM00262[appclient]
+* link:asadmin.html#GSRFM00263[asadmin]
+* link:debug-asadmin.html#GSRFM00263[debug-asadmin]
+* link:capture-schema.html#GSRFM00821[capture-schema]
+* link:package-appclient.html#GSRFM00264[package-appclient]
+
+=== link:manvol5asc.html#GSRFM814[3 Eclipse GlassFish Server 7 GlassFish Server Concepts]
+
+* link:application.html#GSRFM00265[application]
+* link:configuration.html#GSRFM00266[configuration]
+* link:domain.html#GSRFM00267[domain]
+* link:dotted-names.html#GSRFM00268[dotted-names]
+* link:instance.html#GSRFM00269[instance]
+* link:logging.html#GSRFM00270[logging]
+* link:monitoring.html#GSRFM00271[monitoring]
+* link:passwords.html#GSRFM00272[passwords]
+* link:resource.html#GSRFM00273[resource]
+* link:security.html#GSRFM00274[security]
diff --git a/docs/reference-manual/src/main/jbake/content/undeploy.adoc b/docs/reference-manual/src/main/jbake/content/undeploy.adoc
index b1eb527..53e37d3 100644
--- a/docs/reference-manual/src/main/jbake/content/undeploy.adoc
+++ b/docs/reference-manual/src/main/jbake/content/undeploy.adoc
@@ -5,13 +5,11 @@
prev=stop-local-instance.html
~~~~~~
-undeploy
-========
+= undeploy
[[undeploy-1]][[GSRFM00244]][[undeploy]]
-undeploy
---------
+== undeploy
Removes a deployed component
diff --git a/docs/reference-manual/src/main/jbake/content/unfreeze-transaction-service.adoc b/docs/reference-manual/src/main/jbake/content/unfreeze-transaction-service.adoc
index 7db6d70..6db2c01 100644
--- a/docs/reference-manual/src/main/jbake/content/unfreeze-transaction-service.adoc
+++ b/docs/reference-manual/src/main/jbake/content/unfreeze-transaction-service.adoc
@@ -5,13 +5,11 @@
prev=undeploy.html
~~~~~~
-unfreeze-transaction-service
-============================
+= unfreeze-transaction-service
[[unfreeze-transaction-service-1]][[GSRFM00245]][[unfreeze-transaction-service]]
-unfreeze-transaction-service
-----------------------------
+== unfreeze-transaction-service
Resumes all suspended transactions
diff --git a/docs/reference-manual/src/main/jbake/content/uninstall-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/uninstall-node-dcom.adoc
index 80c4b9a..cc8db60 100644
--- a/docs/reference-manual/src/main/jbake/content/uninstall-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/uninstall-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=uninstall-node.html
~~~~~~
-uninstall-node-dcom
-===================
+= uninstall-node-dcom
[[uninstall-node-dcom-1]][[GSRFM775]][[uninstall-node-dcom]]
-uninstall-node-dcom
--------------------
+== uninstall-node-dcom
Uninstalls {productName} software from specified DCOM-enabled hosts
diff --git a/docs/reference-manual/src/main/jbake/content/uninstall-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/uninstall-node-ssh.adoc
index 7a08dc5..6ab1d55 100644
--- a/docs/reference-manual/src/main/jbake/content/uninstall-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/uninstall-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=uninstall-node-dcom.html
~~~~~~
-uninstall-node-ssh
-==================
+= uninstall-node-ssh
[[uninstall-node-ssh-1]][[GSRFM778]][[uninstall-node-ssh]]
-uninstall-node-ssh
-------------------
+== uninstall-node-ssh
Uninstalls {productName} software from specified SSH-enabled hosts
diff --git a/docs/reference-manual/src/main/jbake/content/uninstall-node.adoc b/docs/reference-manual/src/main/jbake/content/uninstall-node.adoc
index e69b2da..964b39a 100644
--- a/docs/reference-manual/src/main/jbake/content/uninstall-node.adoc
+++ b/docs/reference-manual/src/main/jbake/content/uninstall-node.adoc
@@ -5,13 +5,11 @@
prev=unfreeze-transaction-service.html
~~~~~~
-uninstall-node
-==============
+= uninstall-node
[[uninstall-node-1]][[GSRFM00246]][[uninstall-node]]
-uninstall-node
---------------
+== uninstall-node
Uninstalls {productName} software from specified hosts
diff --git a/docs/reference-manual/src/main/jbake/content/unset-web-context-param.adoc b/docs/reference-manual/src/main/jbake/content/unset-web-context-param.adoc
index 399f974..f06f6b1 100644
--- a/docs/reference-manual/src/main/jbake/content/unset-web-context-param.adoc
+++ b/docs/reference-manual/src/main/jbake/content/unset-web-context-param.adoc
@@ -5,13 +5,11 @@
prev=unset.html
~~~~~~
-unset-web-context-param
-=======================
+= unset-web-context-param
[[unset-web-context-param-1]][[GSRFM00248]][[unset-web-context-param]]
-unset-web-context-param
------------------------
+== unset-web-context-param
Unsets a servlet context-initialization parameter of a deployed web
application or module
diff --git a/docs/reference-manual/src/main/jbake/content/unset-web-env-entry.adoc b/docs/reference-manual/src/main/jbake/content/unset-web-env-entry.adoc
index d0ca056..b0a634e 100644
--- a/docs/reference-manual/src/main/jbake/content/unset-web-env-entry.adoc
+++ b/docs/reference-manual/src/main/jbake/content/unset-web-env-entry.adoc
@@ -5,13 +5,11 @@
prev=unset-web-context-param.html
~~~~~~
-unset-web-env-entry
-===================
+= unset-web-env-entry
[[unset-web-env-entry-1]][[GSRFM00249]][[unset-web-env-entry]]
-unset-web-env-entry
--------------------
+== unset-web-env-entry
Unsets an environment entry for a deployed web application or module
diff --git a/docs/reference-manual/src/main/jbake/content/update-connector-security-map.adoc b/docs/reference-manual/src/main/jbake/content/update-connector-security-map.adoc
index aefc476..1591573 100644
--- a/docs/reference-manual/src/main/jbake/content/update-connector-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-connector-security-map.adoc
@@ -5,13 +5,11 @@
prev=unset-web-env-entry.html
~~~~~~
-update-connector-security-map
-=============================
+= update-connector-security-map
[[update-connector-security-map-1]][[GSRFM00252]][[update-connector-security-map]]
-update-connector-security-map
------------------------------
+== update-connector-security-map
Modifies a security map for the specified connector connection pool
diff --git a/docs/reference-manual/src/main/jbake/content/update-connector-work-security-map.adoc b/docs/reference-manual/src/main/jbake/content/update-connector-work-security-map.adoc
index 89ae1ec..197413a 100644
--- a/docs/reference-manual/src/main/jbake/content/update-connector-work-security-map.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-connector-work-security-map.adoc
@@ -5,13 +5,11 @@
prev=update-connector-security-map.html
~~~~~~
-update-connector-work-security-map
-==================================
+= update-connector-work-security-map
[[update-connector-work-security-map-1]][[GSRFM00253]][[update-connector-work-security-map]]
-update-connector-work-security-map
-----------------------------------
+== update-connector-work-security-map
Modifies a work security map for the specified resource adapter
diff --git a/docs/reference-manual/src/main/jbake/content/update-file-user.adoc b/docs/reference-manual/src/main/jbake/content/update-file-user.adoc
index 9676178..c0de140 100644
--- a/docs/reference-manual/src/main/jbake/content/update-file-user.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-file-user.adoc
@@ -5,13 +5,11 @@
prev=update-connector-work-security-map.html
~~~~~~
-update-file-user
-================
+= update-file-user
[[update-file-user-1]][[GSRFM00254]][[update-file-user]]
-update-file-user
-----------------
+== update-file-user
Updates a current file user as specified
diff --git a/docs/reference-manual/src/main/jbake/content/update-node-config.adoc b/docs/reference-manual/src/main/jbake/content/update-node-config.adoc
index b46ac6f..723cd6f 100644
--- a/docs/reference-manual/src/main/jbake/content/update-node-config.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-node-config.adoc
@@ -5,13 +5,11 @@
prev=update-file-user.html
~~~~~~
-update-node-config
-==================
+= update-node-config
[[update-node-config-1]][[GSRFM00255]][[update-node-config]]
-update-node-config
-------------------
+== update-node-config
Updates the configuration data of a node
diff --git a/docs/reference-manual/src/main/jbake/content/update-node-dcom.adoc b/docs/reference-manual/src/main/jbake/content/update-node-dcom.adoc
index a8dd424..f81ede5 100644
--- a/docs/reference-manual/src/main/jbake/content/update-node-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-node-dcom.adoc
@@ -5,13 +5,11 @@
prev=update-node-config.html
~~~~~~
-update-node-dcom
-================
+= update-node-dcom
[[update-node-dcom-1]][[GSRFM789]][[update-node-dcom]]
-update-node-dcom
-----------------
+== update-node-dcom
Updates the configuration data of a node
diff --git a/docs/reference-manual/src/main/jbake/content/update-node-ssh.adoc b/docs/reference-manual/src/main/jbake/content/update-node-ssh.adoc
index a7add83..0f17cd1 100644
--- a/docs/reference-manual/src/main/jbake/content/update-node-ssh.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-node-ssh.adoc
@@ -5,13 +5,11 @@
prev=update-node-dcom.html
~~~~~~
-update-node-ssh
-===============
+= update-node-ssh
[[update-node-ssh-1]][[GSRFM00256]][[update-node-ssh]]
-update-node-ssh
----------------
+== update-node-ssh
Updates the configuration data of a node
diff --git a/docs/reference-manual/src/main/jbake/content/update-password-alias.adoc b/docs/reference-manual/src/main/jbake/content/update-password-alias.adoc
index af92ff4..f342ba5 100644
--- a/docs/reference-manual/src/main/jbake/content/update-password-alias.adoc
+++ b/docs/reference-manual/src/main/jbake/content/update-password-alias.adoc
@@ -5,13 +5,11 @@
prev=update-node-ssh001.html
~~~~~~
-update-password-alias
-=====================
+= update-password-alias
[[update-password-alias-1]][[GSRFM00257]][[update-password-alias]]
-update-password-alias
----------------------
+== update-password-alias
Updates a password alias
diff --git a/docs/reference-manual/src/main/jbake/content/uptime.adoc b/docs/reference-manual/src/main/jbake/content/uptime.adoc
index d3dc904..5914fe3 100644
--- a/docs/reference-manual/src/main/jbake/content/uptime.adoc
+++ b/docs/reference-manual/src/main/jbake/content/uptime.adoc
@@ -5,13 +5,11 @@
prev=update-password-alias.html
~~~~~~
-uptime
-======
+= uptime
[[uptime-1]][[GSRFM00258]][[uptime]]
-uptime
-------
+== uptime
Returns the length of time that the DAS has been running
diff --git a/docs/reference-manual/src/main/jbake/content/validate-dcom.adoc b/docs/reference-manual/src/main/jbake/content/validate-dcom.adoc
index 8defa81..a711c6c 100644
--- a/docs/reference-manual/src/main/jbake/content/validate-dcom.adoc
+++ b/docs/reference-manual/src/main/jbake/content/validate-dcom.adoc
@@ -5,13 +5,11 @@
prev=uptime.html
~~~~~~
-validate-dcom
-=============
+= validate-dcom
[[validate-dcom-1]][[GSRFM796]][[validate-dcom]]
-validate-dcom
--------------
+== validate-dcom
Tests the connection over DCOM to a remote host
diff --git a/docs/reference-manual/src/main/jbake/content/validate-multicast.adoc b/docs/reference-manual/src/main/jbake/content/validate-multicast.adoc
index 92de822..53860c8 100644
--- a/docs/reference-manual/src/main/jbake/content/validate-multicast.adoc
+++ b/docs/reference-manual/src/main/jbake/content/validate-multicast.adoc
@@ -5,13 +5,11 @@
prev=validate-dcom.html
~~~~~~
-validate-multicast
-==================
+= validate-multicast
[[validate-multicast-1]][[GSRFM00259]][[validate-multicast]]
-validate-multicast
-------------------
+== validate-multicast
Validates that multicast transport is available for clusters
diff --git a/docs/reference-manual/src/main/jbake/content/verify-domain-xml.adoc b/docs/reference-manual/src/main/jbake/content/verify-domain-xml.adoc
index 7b16e7c..a3e1712 100644
--- a/docs/reference-manual/src/main/jbake/content/verify-domain-xml.adoc
+++ b/docs/reference-manual/src/main/jbake/content/verify-domain-xml.adoc
@@ -5,13 +5,11 @@
prev=validate-multicast.html
~~~~~~
-verify-domain-xml
-=================
+= verify-domain-xml
[[verify-domain-xml-1]][[GSRFM00260]][[verify-domain-xml]]
-verify-domain-xml
------------------
+== verify-domain-xml
Verifies the content of the domain.xml file
diff --git a/docs/reference-manual/src/main/jbake/content/version.adoc b/docs/reference-manual/src/main/jbake/content/version.adoc
index ddc4a78..97e8fc4 100644
--- a/docs/reference-manual/src/main/jbake/content/version.adoc
+++ b/docs/reference-manual/src/main/jbake/content/version.adoc
@@ -5,13 +5,11 @@
prev=verify-domain-xml.html
~~~~~~
-version
-=======
+= version
[[version-1]][[GSRFM00261]][[version]]
-version
--------
+== version
Displays version information for{productName}
diff --git a/docs/release-notes/src/main/jbake/content/preface.adoc b/docs/release-notes/src/main/jbake/content/preface.adoc
index b762cff..7b4e83a 100644
--- a/docs/release-notes/src/main/jbake/content/preface.adoc
+++ b/docs/release-notes/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[gkamj]][[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -48,8 +46,7 @@
[[ghpbz]][[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -153,8 +150,7 @@
[[giprl]][[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -197,8 +193,7 @@
[[fwbkx]][[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -237,8 +232,7 @@
[[fquvc]][[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -280,8 +274,7 @@
[[ghpfg]][[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/release-notes/src/main/jbake/content/release-notes.adoc b/docs/release-notes/src/main/jbake/content/release-notes.adoc
index 2fc8c3d..9b68f45 100644
--- a/docs/release-notes/src/main/jbake/content/release-notes.adoc
+++ b/docs/release-notes/src/main/jbake/content/release-notes.adoc
@@ -4,15 +4,13 @@
prev=preface.html
~~~~~~
-Eclipse GlassFish Server 7 Release Notes
-========================================
+= Eclipse GlassFish Server 7 Release Notes
[[GSRLN00001]][[abppa]]
[[glassfish-server-open-source-edition-release-notes]]
-1 Eclipse GlassFish Server 7 Release Notes
-------------------------------------------
+== 1 Eclipse GlassFish Server 7 Release Notes
[CAUTION]
====
@@ -55,8 +53,7 @@
[[ghmvk]][[GSRLN00128]][[revision-history]]
-Revision History
-~~~~~~~~~~~~~~~~
+=== Revision History
This section lists the revision history for these Release Notes.
@@ -73,8 +70,7 @@
[[glcmf]][[GSRLN00129]][[whats-new-in-the-glassfish-server-release]]
-What's New in the GlassFish Server 7 Release?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== What's New in the GlassFish Server 7 Release?
GlassFish is the Reference Implementation for Jakarta EE. Jakarta EE 10
introduces ... To Be Done
@@ -112,8 +108,7 @@
[[abpaj]][[GSRLN00131]][[hardware-and-software-requirements]]
-Hardware and Software Requirements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Hardware and Software Requirements
This section lists the requirements that must be met before installing
Eclipse GlassFish Server Release 7 software.
@@ -128,8 +123,7 @@
[[abpak]][[GSRLN00246]][[required-jdk-versions]]
-Required JDK Versions
-^^^^^^^^^^^^^^^^^^^^^
+==== Required JDK Versions
Eclipse GlassFish Server Release 7 requires Oracle JDK 8
Update 144 or later.
@@ -145,8 +139,7 @@
[[ggppy]][[GSRLN00248]][[required-disk-space]]
-Required Disk Space
-^^^^^^^^^^^^^^^^^^^
+==== Required Disk Space
The download sizes for GlassFish Server 7 vary depending on the
package you choose. The following are the approximate sizes of the ZIP
@@ -164,8 +157,7 @@
[[ggpoq]][[GSRLN00249]][[required-free-ports]]
-Required Free Ports
-^^^^^^^^^^^^^^^^^^^
+==== Required Free Ports
You must have sixteen unused ports available for the ports GlassFish
Server uses. The installation program automatically detects ports that
@@ -223,8 +215,7 @@
[[sthref4]][[to-configure-specific-ports-for-a-jms-host]]
-To Configure Specific Ports for a JMS Host
-++++++++++++++++++++++++++++++++++++++++++
+===== To Configure Specific Ports for a JMS Host
When you create a JMS Host, GlassFish server automatically selects ports
for the JMS provider (called the portmapper port in Message Queue
@@ -252,8 +243,7 @@
[[sthref5]][[to-configure-specific-gms-ports-for-a-cluster]]
-To Configure Specific GMS Ports for a Cluster
-+++++++++++++++++++++++++++++++++++++++++++++
+===== To Configure Specific GMS Ports for a Cluster
When you create a cluster, GlassFish server automatically selects a port
for GMS multicast that does not conflict with the GMS multicast port of
@@ -290,8 +280,7 @@
[[gkxlg]][[GSRLN00250]][[message-queue-broker-requirements]]
-Message Queue Broker Requirements
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Queue Broker Requirements
GlassFish Server 7 is now bundled with Message Queue (MQ) Broker
5.1.1. Refer to the
@@ -300,8 +289,7 @@
[[gfgps]][[GSRLN00252]][[paths-and-environment-settings-for-the-jdk-software]]
-Paths and Environment Settings for the JDK Software
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Paths and Environment Settings for the JDK Software
Ensure that your JDK configuration settings on all local and remote
GlassFish Server hosts adhere to the guidelines listed below. Failure to
@@ -316,8 +304,7 @@
[[gldjj]][[GSRLN00155]][[use-the-jdk-binaries]]
-Use the JDK Binaries
-++++++++++++++++++++
+===== Use the JDK Binaries
The following binary files that are used with GlassFish Server must come
from the JDK software, not the Java Runtime Environment (JRE) software:
@@ -330,8 +317,7 @@
[[gldgl]][[GSRLN00156]][[set-the-java_home-environment-variable]]
-Set the `JAVA_HOME` Environment Variable
-++++++++++++++++++++++++++++++++++++++++
+===== Set the `JAVA_HOME` Environment Variable
Before performing any GlassFish Server installation or configuration
procedures, set the `JAVA_HOME` environment variable on the GlassFish
@@ -342,8 +328,7 @@
[[gldho]][[GSRLN00157]][[set-other-environment-variables-as-necessary]]
-Set Other Environment Variables As Necessary
-++++++++++++++++++++++++++++++++++++++++++++
+===== Set Other Environment Variables As Necessary
All remote `asadmin` subcommands require the correct version of Java to
be available on the affected remote machine. For example, when creating
@@ -375,8 +360,7 @@
[[glcmm]][[GSRLN00253]][[known-issues-in-glassfish-server-5.1]]
-Known Issues in GlassFish Server 7
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Known Issues in GlassFish Server 7
This section describes known issues and any available workarounds for
Eclipse GlassFish Server 7 software.
@@ -394,8 +378,7 @@
[[sthref6]][[description]]
-Description
-+++++++++++
+===== Description
Jakarta XML Binding (previous JAXB) and Jakarta XML Web Services (previouly JAX-WS)
are part of Jakarta EE platform, but as optional technologies. However,
@@ -409,20 +392,17 @@
[[sthref7]][[workaround]]
-Workaround
-++++++++++
+===== Workaround
None
[[CHDIBEAJ]][[resource-validation-property-is-enabled-in-the-jvm-option-for-deployment]]
-Resource validation property is enabled in the JVM option for deployment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Resource validation property is enabled in the JVM option for deployment
[[sthref8]][[description-1]]
-Description
-+++++++++++
+===== Description
A new JVM option for deployment - deployment.resource.validation is
introduced in GlassFish Server 7. This property is set to True by
@@ -445,21 +425,18 @@
[[sthref9]][[workaround-1]]
-Workaround
-++++++++++
+===== Workaround
In case you do not want the resource validation to take place during the
deployment, you can set this property value to False.
[[CHDBJDGF]][[update-tool-and-pkg-command-no-longer-part-of-glassfish-server]]
-Update Tool and pkg Command no longer part of GlassFish Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Update Tool and pkg Command no longer part of GlassFish Server
[[sthref10]][[description-2]]
-Description
-+++++++++++
+===== Description
In previous releases, you could update your GlassFish Server software
using the pkg command and the Update tool. Since the recent release of
@@ -468,20 +445,17 @@
[[sthref11]][[workaround-2]]
-Workaround
-++++++++++
+===== Workaround
No workaround.
[[CHDJGJHD]][[java-db-has-been-replaced-by-apache-derby]]
-Java DB has been replaced by Apache Derby
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Java DB has been replaced by Apache Derby
[[sthref12]][[description-3]]
-Description
-+++++++++++
+===== Description
In the previous releases, Java DB was used as the database for GlassFish
servers. With the release of GlassFish Server 7, Apache Derby
@@ -489,15 +463,13 @@
[[sthref13]][[workaround-3]]
-Workaround
-++++++++++
+===== Workaround
No workaround.
[[ggqok]][[GSRLN00133]][[restrictions-and-deprecated-functionality]]
-Restrictions and Deprecated Functionality
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Restrictions and Deprecated Functionality
This section describes restrictions and deprecated functionality in
Oracle GlassFish Server 7.
@@ -512,8 +484,7 @@
[[ggqoc]][[GSRLN00258]][[asadmin-subcommands]]
-`asadmin` Subcommands
-^^^^^^^^^^^^^^^^^^^^^
+==== `asadmin` Subcommands
In GlassFish Server 7, it is recommended that utility options of the
`asadmin` command precede the subcommand. Utility options are options
@@ -532,8 +503,7 @@
[[abmbf]][[GSRLN00259]][[deprecated-unsupported-and-obsolete-options]]
-Deprecated, Unsupported, and Obsolete Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deprecated, Unsupported, and Obsolete Options
Options in link:#gaeki[Table 1-3] are deprecated or no longer supported,
or are obsolete and are ignored.
@@ -623,8 +593,7 @@
[[gkueg]][[GSRLN00260]][[applications-that-use-apache-derby]]
-Applications That Use Apache Derby
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Applications That Use Apache Derby
The directory location of Apache Derby in GlassFish Server 7 has
changed from its location in previous installations. Suppose that you
@@ -653,8 +622,7 @@
[[ghpen]][[GSRLN00261]][[no-support-for-client-vm-on-windows-amd64]]
-No Support for Client VM on Windows AMD64
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== No Support for Client VM on Windows AMD64
By default, the GlassFish Server DAS uses the Client VM to achieve best
startup and deployment performance. If you are using Windows AMD64, edit
@@ -669,8 +637,7 @@
[[gkwbd]][[GSRLN00262]][[metro-reliable-messaging-in-inorder-delivery-mode]]
-Metro Reliable Messaging in `InOrder` Delivery Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Metro Reliable Messaging in `InOrder` Delivery Mode
The Metro Reliable Messaging in `InOrder` Delivery mode has not been
tested for high availability in GlassFish Server 7. The feature may
@@ -679,8 +646,7 @@
[[glgiy]][[GSRLN00263]][[no-support-for-kerberos-on-aix]]
-No Support for Kerberos on AIX
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== No Support for Kerberos on AIX
GlassFish Server 7 does not support Kerberos on the AIX platform.
@@ -689,8 +655,7 @@
[[BABDACBE]][[documentation-errata]]
-Documentation Errata
-~~~~~~~~~~~~~~~~~~~~
+=== Documentation Errata
This section describes documentation errata.
@@ -698,8 +663,7 @@
[[BABIDEHD]][[upgrading-to-oracle-glassfish-server-is-not-necessary]]
-Upgrading to Oracle GlassFish Server Is Not Necessary
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Upgrading to Oracle GlassFish Server Is Not Necessary
The Eclipse GlassFish Server Administration Guide discusses
upgrading Eclipse GlassFish Server to Oracle GlassFish
@@ -715,8 +679,7 @@
[[giraq]][[GSRLN00135]][[features-available-only-in-the-full-platform]]
-Features Available Only in the Full Platform
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Features Available Only in the Full Platform
The following features of GlassFish Server 7 are available only in the
Full Platform:
@@ -746,8 +709,7 @@
[[gipkz]][[GSRLN00136]][[java-ee-standards-support]]
-Jakarta EE Standards Support
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Jakarta EE Standards Support
link:#gjxcp[Table 1-4] lists the Jakarta EE standards implemented in
GlassFish Server 7. The table also indicates the distributions in
@@ -977,8 +939,7 @@
[[abpha]][[GSRLN00138]][[how-to-report-problems-and-provide-feedback]]
-How to Report Problems and Provide Feedback
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== How to Report Problems and Provide Feedback
If you have problems with GlassFish Server 7, provide feedback through
one of the following mechanisms:
@@ -992,8 +953,7 @@
[[abphc]][[GSRLN00139]][[additional-resources]]
-Additional Resources
-~~~~~~~~~~~~~~~~~~~~
+=== Additional Resources
Useful information can be found at the following locations:
diff --git a/docs/release-notes/src/main/jbake/content/title.adoc b/docs/release-notes/src/main/jbake/content/title.adoc
index 06273f7..7acaeb4 100644
--- a/docs/release-notes/src/main/jbake/content/title.adoc
+++ b/docs/release-notes/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-Eclipse GlassFish Server Release Notes, Release 7
-=================================================
+= Eclipse GlassFish Server Release Notes, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Release Notes
diff --git a/docs/release-notes/src/main/jbake/content/toc.adoc b/docs/release-notes/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..b534f0c
--- /dev/null
+++ b/docs/release-notes/src/main/jbake/content/toc.adoc
@@ -0,0 +1,48 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Release Notes, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Release Notes, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#ghpbz[GlassFish Server Documentation Set]
+** link:preface.html#giprl[Related Documentation]
+** link:preface.html#fwbkx[Typographic Conventions]
+** link:preface.html#fquvc[Symbol Conventions]
+** link:preface.html#ghpfg[Default Paths and File Names]
+
+[[glassfish-server-open-source-edition-release-notes]]
+=== link:release-notes.html#GSRLN00001[1 Eclipse GlassFish Server 7 Release Notes]
+
+** link:release-notes.html#GSRLN00128[Revision History]
+** link:release-notes.html#GSRLN00129[What's New in the GlassFish Server 7 Release?]
+** link:release-notes.html#GSRLN00131[Hardware and Software Requirements]
+*** link:release-notes.html#GSRLN00246[Required JDK Versions]
+*** link:release-notes.html#GSRLN00248[Required Disk Space]
+*** link:release-notes.html#GSRLN00249[Required Free Ports]
+*** link:release-notes.html#GSRLN00250[Message Queue Broker Requirements]
+*** link:release-notes.html#GSRLN00252[Paths and Environment Settings for the JDK Software]
+** link:release-notes.html#GSRLN00253[Known Issues in GlassFish Server 7]
+*** link:release-notes.html#CHDIBEAJ[Resource validation property is enabled in the JVM option for deployment]
+*** link:release-notes.html#CHDBJDGF[Update Tool and pkg Command no longer part of GlassFish Server]
+*** link:release-notes.html#CHDJGJHD[Java DB has been replaced by Apache Derby]
+** link:release-notes.html#GSRLN00133[Restrictions and Deprecated Functionality]
+*** link:release-notes.html#GSRLN00258[`asadmin` Subcommands]
+*** link:release-notes.html#GSRLN00259[Deprecated, Unsupported, and Obsolete Options]
+*** link:release-notes.html#GSRLN00260[Applications That Use Apache Derby]
+*** link:release-notes.html#GSRLN00261[No Support for Client VM on Windows AMD64]
+*** link:release-notes.html#GSRLN00262[Metro Reliable Messaging in `InOrder` Delivery Mode]
+*** link:release-notes.html#GSRLN00263[No Support for Kerberos on AIX]
+** link:release-notes.html#BABDACBE[Documentation Errata]
+*** link:release-notes.html#BABIDEHD[Upgrading to Oracle GlassFish Server Is Not Necessary]
+** link:release-notes.html#GSRLN00135[Features Available Only in the Full Platform]
+** link:release-notes.html#GSRLN00136[Jakarta EE Standards Support]
+** link:release-notes.html#GSRLN00138[How to Report Problems and Provide Feedback]
+** link:release-notes.html#GSRLN00139[Additional Resources]
diff --git a/docs/security-guide/src/main/jbake/content/administrative-security.adoc b/docs/security-guide/src/main/jbake/content/administrative-security.adoc
index a59d3a0..e18de08 100644
--- a/docs/security-guide/src/main/jbake/content/administrative-security.adoc
+++ b/docs/security-guide/src/main/jbake/content/administrative-security.adoc
@@ -5,15 +5,13 @@
prev=security-in-cluster-mode.html
~~~~~~
-Managing Administrative Security
-================================
+= Managing Administrative Security
[[GSSCG00039]][[gknqh]]
[[managing-administrative-security]]
-5 Managing Administrative Security
-----------------------------------
+== 5 Managing Administrative Security
This chapter describes how to manage administrative security by using
the secure administration feature.
@@ -36,8 +34,7 @@
[[gkocp]][[GSSCG00162]][[secure-administration-overview]]
-Secure Administration Overview
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Secure Administration Overview
The secure administration feature allows an administrator to secure all
administrative communication between the domain administration server
@@ -92,8 +89,7 @@
[[gkofl]][[GSSCG00163]][[how-secure-admin-works-the-big-picture]]
-How Secure Admin Works: The Big Picture
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== How Secure Admin Works: The Big Picture
Secure admin is a domain-wide setting. It affects the DAS and all
instances and all administration clients. This section describes the
@@ -109,8 +105,7 @@
[[gkqce]][[GSSCG00227]][[functions-performed-by-secure-admin]]
-Functions Performed by Secure Admin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Functions Performed by Secure Admin
The `enable-secure-admin` subcommand performs the following functions.
Subsequent sections describe these functions in more detail.
@@ -143,8 +138,7 @@
[[gkocv]][[GSSCG00228]][[which-administration-account-is-used]]
-Which Administration Account is Used?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Which Administration Account is Used?
If only one administration account exists in the realm, GlassFish Server
treats that account as the current default administration account. In
@@ -171,8 +165,7 @@
[[gkodi]][[GSSCG00229]][[what-authentication-methods-are-used-for-secure-administration]]
-What Authentication Methods Are Used for Secure Administration?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== What Authentication Methods Are Used for Secure Administration?
The secure admin feature enforces security via the following
authentication methods:
@@ -234,8 +227,7 @@
[[gkpex]][[GSSCG00230]][[understanding-how-certificate-authentication-is-performed]]
-Understanding How Certificate Authentication is Performed
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Understanding How Certificate Authentication is Performed
The domain creation process creates a primary (private) key and a
self-signed certificate for the DAS, and a separate private key and
@@ -260,8 +252,7 @@
[[gkoey]][[GSSCG00231]][[what-certificates-are-used]]
-What Certificates Are Used?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== What Certificates Are Used?
When you enable secure admin, you can optionally set the `--adminalias`
and `--instancealias` options that tell secure admin which aliases to
@@ -318,8 +309,7 @@
[[gkpfi]][[GSSCG00201]][[self-signed-certificates-and-trust]]
-Self-Signed Certificates and Trust
-++++++++++++++++++++++++++++++++++
+===== Self-Signed Certificates and Trust
The self-signed certificates that GlassFish Server uses might not be
trusted by clients by default because a certificate authority does not
@@ -420,8 +410,7 @@
[[gkped]][[GSSCG00202]][[using-your-own-certificates]]
-Using Your Own Certificates
-+++++++++++++++++++++++++++
+===== Using Your Own Certificates
By default, `--adminalias` of the `enable-secure-admin` subcommand uses
the `s1as` alias, and the `--instancealias` option uses the
@@ -462,8 +451,7 @@
[[glgmy]][[GSSCG00232]][[an-alternate-approach-using-distinguished-names-to-specify-certificates]]
-An Alternate Approach: Using Distinguished Names to Specify Certificates
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== An Alternate Approach: Using Distinguished Names to Specify Certificates
By default, the DAS uses the alias associated with the `--instancealias`
option to check incoming requests that use SSL/TLS cert authentication.
@@ -628,8 +616,7 @@
[[gkqjj]][[GSSCG00233]][[guarding-against-unwanted-connections]]
-Guarding Against Unwanted Connections
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Guarding Against Unwanted Connections
Secure admin guards against unwanted connections in several ways:
@@ -674,8 +661,7 @@
[[gkofe]][[GSSCG00164]][[considerations-when-running-glassfish-server-with-default-security]]
-Considerations When Running GlassFish Server With Default Security
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Considerations When Running GlassFish Server With Default Security
In GlassFish Server, the default admin account is username "admin" with
an empty password. Admin clients provide empty credentials or none at
@@ -724,16 +710,14 @@
[[gkomz]][[GSSCG00165]][[running-secure-admin]]
-Running Secure Admin
-~~~~~~~~~~~~~~~~~~~~
+=== Running Secure Admin
This section describes how to run secure admin. The section begins with
prerequisites for running secure admin.
[[gkokc]][[GSSCG00234]][[prerequisites-for-running-secure-admin]]
-Prerequisites for Running Secure Admin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Prerequisites for Running Secure Admin
Before running GlassFish Server with secure admin enabled, you must make
sure that:
@@ -762,8 +746,7 @@
[[glgmh]][[GSSCG00235]][[an-alternate-approach-using-a-user-name-and-password-for-internal-authentication-and-authorization]]
-An Alternate Approach: Using A User Name and Password for Internal Authentication and Authorization
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== An Alternate Approach: Using A User Name and Password for Internal Authentication and Authorization
By default, secure admin uses the GlassFish Server self-signed
certificates, via the aliases corresponding to these certificates, to
@@ -864,8 +847,7 @@
[[gkqby]][[GSSCG00236]][[example-of-running-enable-secure-admin]]
-Example of Running enable-secure-admin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Example of Running enable-secure-admin
The following example shows how to enable secure admin for a domain
using the default admin alias and the default instance alias. You must
@@ -912,8 +894,7 @@
[[gkolu]][[GSSCG00166]][[additional-considerations-when-creating-local-instances]]
-Additional Considerations When Creating Local Instances
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Additional Considerations When Creating Local Instances
If you use `xxx-local-instance` commands to set up local instances,
either leave secure admin disabled, or enable it before you create or
@@ -925,8 +906,7 @@
[[gkqah]][[GSSCG00167]][[secure-admin-use-case]]
-Secure Admin Use Case
-~~~~~~~~~~~~~~~~~~~~~
+=== Secure Admin Use Case
This section describes a simple secure admin use case.
@@ -973,8 +953,7 @@
[[gkodn]][[GSSCG00168]][[upgrading-an-ssl-enabled-secure-glassfish-installation-to-secure-admin]]
-Upgrading an SSL-Enabled Secure GlassFish Installation to Secure Admin
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading an SSL-Enabled Secure GlassFish Installation to Secure Admin
If you enable secure admin on an SSL-enabled GlassFish Server
installation, secure admin uses the existing <ssl cert-nickname> value
diff --git a/docs/security-guide/src/main/jbake/content/loe.adoc b/docs/security-guide/src/main/jbake/content/loe.adoc
index 93ea55e..8aa7284 100644
--- a/docs/security-guide/src/main/jbake/content/loe.adoc
+++ b/docs/security-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:system-security.html#gksel[1-1 Sample
AppservCertificateLoginModule Code]
diff --git a/docs/security-guide/src/main/jbake/content/lof.adoc b/docs/security-guide/src/main/jbake/content/lof.adoc
index 8daf6d7..107cde4 100644
--- a/docs/security-guide/src/main/jbake/content/lof.adoc
+++ b/docs/security-guide/src/main/jbake/content/lof.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Figures
-===============
+= List of Figures
[[list-of-figures]]
-List of Figures
----------------
+== List of Figures
* link:system-security.html#fxjfw[1-1 Role Mapping]
* link:administrative-security.html#gkqpv[5-1 Sample Browser Response to
diff --git a/docs/security-guide/src/main/jbake/content/lot.adoc b/docs/security-guide/src/main/jbake/content/lot.adoc
index d3138ec..5f3b480 100644
--- a/docs/security-guide/src/main/jbake/content/lot.adoc
+++ b/docs/security-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=lof.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:message-security.html#fxjcu[3-1 Message Protection Policy Mapping
to WS-Security SOAP Operations]
diff --git a/docs/security-guide/src/main/jbake/content/message-security.adoc b/docs/security-guide/src/main/jbake/content/message-security.adoc
index 8c9cdbb..fdf050a 100644
--- a/docs/security-guide/src/main/jbake/content/message-security.adoc
+++ b/docs/security-guide/src/main/jbake/content/message-security.adoc
@@ -5,15 +5,13 @@
prev=user-security.html
~~~~~~
-Administering Message Security
-==============================
+= Administering Message Security
[[GSSCG00037]][[ablrk]]
[[administering-message-security]]
-3 Administering Message Security
---------------------------------
+== 3 Administering Message Security
This chapter provides information and procedures on configuring the
message layer security for web services in the GlassFish Server environment.
@@ -42,8 +40,7 @@
[[ablrn]][[GSSCG00153]][[about-message-security-in-glassfish-server]]
-About Message Security in GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About Message Security in GlassFish Server
Message security enables a server to perform end-to-end authentication
of web service invocations and responses at the message layer. Security
@@ -79,8 +76,7 @@
[[ablrs]][[GSSCG00218]][[security-tokens-and-security-mechanisms]]
-Security Tokens and Security Mechanisms
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Security Tokens and Security Mechanisms
WS-Security is a specification that provides a communications protocol
for applying security to web services. The security mechanisms implement
@@ -124,8 +120,7 @@
[[ablrx]][[GSSCG00219]][[authentication-providers]]
-Authentication Providers
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== Authentication Providers
The authentication layer is the message layer on which authentication
processing must be performed. GlassFish Server enforces web services
@@ -172,8 +167,7 @@
[[ablrw]][[GSSCG00220]][[message-protection-policies]]
-Message Protection Policies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Protection Policies
A request policy defines the authentication policy requirements
associated with request processing performed by the authentication
@@ -214,8 +208,7 @@
[[ablrz]][[GSSCG00221]][[application-specific-web-services-security]]
-Application-Specific Web Services Security
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Application-Specific Web Services Security
Application-specific web services security functionality is configured
(at application assembly) by defining the `message-security-binding`
@@ -232,8 +225,7 @@
[[gioom]][[GSSCG00222]][[message-security-administration]]
-Message Security Administration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Security Administration
When GlassFish Server is installed, SOAP layer message security
providers are configured in the client and server-side containers of
@@ -272,8 +264,7 @@
[[giose]][[GSSCG00199]][[message-security-tasks]]
-Message Security Tasks
-++++++++++++++++++++++
+===== Message Security Tasks
The general implementation tasks for message security include some or
all of the following:
@@ -291,8 +282,7 @@
[[ablro]][[GSSCG00200]][[message-security-roles]]
-Message Security Roles
-++++++++++++++++++++++
+===== Message Security Roles
In GlassFish Server, the administrator and the application deployer are
expected to take primary responsibility for configuring message
@@ -348,8 +338,7 @@
[[ablsa]][[GSSCG00223]][[sample-application-for-web-services]]
-Sample Application for Web Services
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Sample Application for Web Services
GlassFish Server includes a sample application named `xms`. The `xms`
application features a simple web service that is implemented by both a
@@ -377,8 +366,7 @@
[[giood]][[GSSCG00154]][[enabling-default-message-security-providers-for-web-services]]
-Enabling Default Message Security Providers for Web Services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Enabling Default Message Security Providers for Web Services
By default, message security is disabled on GlassFish Server. Default
message security providers have been created, but are not active until
@@ -392,8 +380,7 @@
[[giork]][[GSSCG00123]][[to-enable-a-default-server-provider]]
-To Enable a Default Server Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable a Default Server Provider
To enable message security for web services endpoints deployed in
GlassFish Server, you must specify a security provider to be used by
@@ -420,8 +407,7 @@
[[giort]][[GSSCG00124]][[to-enable-a-default-client-provider]]
-To Enable a Default Client Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable a Default Client Provider
To enable message security for web service invocations originating from
deployed endpoints, you must specify a default client provider. If you
@@ -448,8 +434,7 @@
[[giouf]][[GSSCG00155]][[configuring-message-protection-policies]]
-Configuring Message Protection Policies
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Message Protection Policies
Message protection policies are defined for request message processing
and response message processing. The policies are expressed in terms of
@@ -468,8 +453,7 @@
[[giraj]][[GSSCG00224]][[message-protection-policy-mapping]]
-Message Protection Policy Mapping
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Message Protection Policy Mapping
The following table shows message protection policy configurations and
the resulting message security operations performed by the WS-Security
@@ -536,8 +520,7 @@
[[gioqu]][[GSSCG00125]][[to-configure-the-message-protection-policies-for-a-provider]]
-To Configure the Message Protection Policies for a Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure the Message Protection Policies for a Provider
Typically, you would not reconfigure a provider. However, if needed for
your situation, you can modify a provider's message protection policies
@@ -592,8 +575,7 @@
[[ablsl]][[GSSCG00225]][[setting-the-request-and-response-policy-for-the-application-client-configuration]]
-Setting the Request and Response Policy for the Application Client Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Setting the Request and Response Policy for the Application Client Configuration
The request and response policies define the authentication policy
requirements associated with request and response processing performed
@@ -660,8 +642,7 @@
[[giosl]][[GSSCG00156]][[administering-non-default-message-security-providers]]
-Administering Non-default Message Security Providers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Non-default Message Security Providers
The following topics are addressed here:
@@ -674,8 +655,7 @@
[[giory]][[GSSCG00126]][[to-create-a-message-security-provider]]
-To Create a Message Security Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create a Message Security Provider
Use the `create-message-security-provider` subcommand in remote mode to
create a new message provider for the security service. If the message
@@ -720,8 +700,7 @@
[[giotv]][[GSSCG00127]][[to-list-message-security-providers]]
-To List Message Security Providers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Message Security Providers
Use the `list-message-security-providers` subcommand in remote mode to
list the message providers for the security layer.
@@ -755,8 +734,7 @@
[[giwkd]][[GSSCG00128]][[to-update-a-message-security-provider]]
-To Update a Message Security Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update a Message Security Provider
1. Ensure that the server is running. Remote subcommands require a running server.
2. List the message security providers by using the
@@ -768,8 +746,7 @@
[[giorr]][[GSSCG00129]][[to-delete-a-message-security-provider]]
-To Delete a Message Security Provider
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Message Security Provider
Use the `delete-message-security-provider` subcommand in remote mode to
remove a message security provider.
@@ -802,8 +779,7 @@
[[gkxru]][[GSSCG00130]][[to-configure-a-servlet-layer-server-authentication-module-sam]]
-To Configure a Servlet Layer Server Authentication Module (SAM)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a Servlet Layer Server Authentication Module (SAM)
You configure a JSR 196 Server Authentication Module (SAM) as an
HttpServlet-layer message security provider, either through the
@@ -881,8 +857,7 @@
[[gdhgg]][[GSSCG00157]][[enabling-message-security-for-application-clients]]
-Enabling Message Security for Application Clients
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Enabling Message Security for Application Clients
The message protection policies of client providers must be configured
such that they are equivalent to the message protection policies of the
@@ -897,8 +872,7 @@
[[gglrb]][[GSSCG00158]][[additional-information-about-message-security]]
-Additional Information About Message Security
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Additional Information About Message Security
For additional information about message security, see the following documentation:
diff --git a/docs/security-guide/src/main/jbake/content/preface.adoc b/docs/security-guide/src/main/jbake/content/preface.adoc
index e680724..492c6b4 100644
--- a/docs/security-guide/src/main/jbake/content/preface.adoc
+++ b/docs/security-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[sthref2]][[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -53,8 +51,7 @@
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -159,8 +156,7 @@
[[GSSCG00136]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -203,8 +199,7 @@
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -245,8 +240,7 @@
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -290,8 +284,7 @@
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/security-guide/src/main/jbake/content/running-in-secure-environment.adoc b/docs/security-guide/src/main/jbake/content/running-in-secure-environment.adoc
index 29e7741..ace759e 100644
--- a/docs/security-guide/src/main/jbake/content/running-in-secure-environment.adoc
+++ b/docs/security-guide/src/main/jbake/content/running-in-secure-environment.adoc
@@ -4,15 +4,13 @@
prev=administrative-security.html
~~~~~~
-Running in a Secure Environment
-===============================
+= Running in a Secure Environment
[[GSSCG00040]][[gkscr]]
[[running-in-a-secure-environment]]
-6 Running in a Secure Environment
----------------------------------
+== 6 Running in a Secure Environment
This chapter describes important information about running GlassFish
Server in a secure environment.
@@ -36,8 +34,7 @@
[[gksbk]][[GSSCG00169]][[determining-your-security-needs]]
-Determining Your Security Needs
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Determining Your Security Needs
Before you deploy GlassFish Server and your Jakarta EE applications into a
production environment, determine your security needs and make sure that
@@ -49,8 +46,7 @@
[[gkscs]][[GSSCG00237]][[understand-your-environment]]
-Understand Your Environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Understand Your Environment
To better understand your security needs, ask yourself the following
questions:
@@ -87,8 +83,7 @@
[[GSSCG00239]][[read-security-publications]]
-Read Security Publications
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Read Security Publications
Read about security issues:
@@ -99,8 +94,7 @@
[[gksbw]][[GSSCG00170]][[installing-glassfish-server-in-a-secure-environment]]
-Installing GlassFish Server in a Secure Environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Installing GlassFish Server in a Secure Environment
This section describes recommendations for installing GlassFish Server
in a secure environment. The link:#gkscn[Enable the Secure
@@ -108,8 +102,7 @@
[[gkscn]][[GSSCG00240]][[enable-the-secure-administration-feature]]
-Enable the Secure Administration Feature
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enable the Secure Administration Feature
The secure administration feature allows an administrator to secure all
administrative communication between the domain administration server
@@ -130,8 +123,7 @@
[[gksby]][[GSSCG00172]][[run-on-the-web-profile-if-possible]]
-Run on the Web Profile if Possible
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Run on the Web Profile if Possible
If your applications can run on the Web Profile, use that instead of the
Full Platform.
@@ -157,8 +149,7 @@
[[gksct]][[GSSCG00173]][[securing-the-glassfish-server-host]]
-Securing the GlassFish Server Host
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Securing the GlassFish Server Host
A GlassFish Server production environment is only as secure as the
security of the machine on which it is running. It is important that you
@@ -345,8 +336,7 @@
[[gksca]][[GSSCG00174]][[securing-glassfish-server]]
-Securing GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Securing GlassFish Server
GlassFish Server provides a powerful and flexible set of software tools
for securing the subsystems and applications that run on a server
@@ -477,8 +467,7 @@
[[gksbf]][[GSSCG00175]][[securing-applications]]
-Securing Applications
-~~~~~~~~~~~~~~~~~~~~~
+=== Securing Applications
Although much of the responsibility for securing the GlassFish Server
resources in a domain fall within the scope of the server, some security
diff --git a/docs/security-guide/src/main/jbake/content/security-in-cluster-mode.adoc b/docs/security-guide/src/main/jbake/content/security-in-cluster-mode.adoc
index da755eb..807f53c 100644
--- a/docs/security-guide/src/main/jbake/content/security-in-cluster-mode.adoc
+++ b/docs/security-guide/src/main/jbake/content/security-in-cluster-mode.adoc
@@ -5,15 +5,13 @@
prev=message-security.html
~~~~~~
-Administering Security in Cluster Mode
-======================================
+= Administering Security in Cluster Mode
[[GSSCG00038]][[gknpf]]
[[administering-security-in-cluster-mode]]
-4 Administering Security in Cluster Mode
-----------------------------------------
+== 4 Administering Security in Cluster Mode
This chapter describes important information about administering
security in a cluster.
@@ -34,8 +32,7 @@
[[gksam]][[GSSCG00159]][[configuring-certificates-in-cluster-mode]]
-Configuring Certificates in Cluster Mode
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Configuring Certificates in Cluster Mode
The sections link:system-security.html#abloj[Certificates and SSL] and
link:system-security.html#ablqz[Administering JSSE Certificates] describe
@@ -51,8 +48,7 @@
[[gkmhh]][[GSSCG00160]][[dynamic-reconfiguration]]
-Dynamic Reconfiguration
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Dynamic Reconfiguration
Administrative commands that you execute on the domain administration
server (DAS) must either be replicated on the affected server instances,
@@ -111,8 +107,7 @@
[[gkned]][[GSSCG00226]][[enabling-dynamic-configuration]]
-Enabling Dynamic Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enabling Dynamic Configuration
Dynamic configuration is enabled by default and no additional action is required.
@@ -140,8 +135,7 @@
[[gktgi]][[GSSCG00161]][[understanding-synchronization]]
-Understanding Synchronization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Understanding Synchronization
As described in "link:../ha-administration-guide/instances.html#GSHAG00189[
Resynchronizing GlassFish Server Instances and the DAS]"
diff --git a/docs/security-guide/src/main/jbake/content/system-security.adoc b/docs/security-guide/src/main/jbake/content/system-security.adoc
index 4cfc9d5..82ae9b0 100644
--- a/docs/security-guide/src/main/jbake/content/system-security.adoc
+++ b/docs/security-guide/src/main/jbake/content/system-security.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Administering System Security
-=============================
+= Administering System Security
[[GSSCG00035]][[ablnk]]
[[administering-system-security]]
-1 Administering System Security
--------------------------------
+== 1 Administering System Security
This chapter describes general information about administering system security.
@@ -35,8 +33,7 @@
[[ggktf]][[GSSCG00143]][[about-system-security-in-glassfish-server]]
-About System Security in GlassFish Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== About System Security in GlassFish Server
Security is about protecting data, that is, how to prevent unauthorized
access or damage to data that is in storage or in transit. The GlassFish
@@ -61,8 +58,7 @@
[[ablnx]][[GSSCG00203]][[authentication]]
-Authentication
-^^^^^^^^^^^^^^
+==== Authentication
Authentication is the way in which an entity (a user, an application, or
a component) determines that another entity is who it claims to be. An
@@ -82,8 +78,7 @@
[[ghsqc]][[GSSCG00184]][[authentication-types]]
-Authentication Types
-++++++++++++++++++++
+===== Authentication Types
Within its deployment descriptors, an application can specify the type
of authentication that it uses. The Jakarta EE Security API provides an
@@ -116,8 +111,7 @@
[[sthref4]][[jsr-375-authentication-mechanisms-and-identity-stores]]
-JSR 375 Authentication Mechanisms and Identity Stores
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== JSR 375 Authentication Mechanisms and Identity Stores
The Jakarta EE Security API defines the `HttpAuthenticationMechanism`
interface, the `IdentityStore` and `IdentityStoreHandler` interfaces.
@@ -156,8 +150,7 @@
[[gknah]][[GSSCG00185]][[jsr-196-server-authentication-modules]]
-JSR 196 Server Authentication Modules
-+++++++++++++++++++++++++++++++++++++
+===== JSR 196 Server Authentication Modules
GlassFish Server implements the Servlet Container Profile of
http://www.jcp.org/en/jsr/detail?id=196[JSR 196 Java Authentication
@@ -379,8 +372,7 @@
[[ghlvu]][[GSSCG00204]][[authorization]]
-Authorization
-^^^^^^^^^^^^^
+==== Authorization
Authorization, also known as access control, is the means by which users
are granted permission to access data or perform operations. After a
@@ -436,8 +428,7 @@
[[ghsqd]][[GSSCG00190]][[java-authorization-contract-for-containers]]
-Java Authorization Contract for Containers
-++++++++++++++++++++++++++++++++++++++++++
+===== Java Authorization Contract for Containers
Java Authorization Contract for Containers (JACC) is the part of the
Jakarta EE specification that defines an interface for pluggable
@@ -455,8 +446,7 @@
[[gkriq]][[GSSCG00191]][[working-with-the-server.policy-policy-file]]
-Working With the server.policy Policy File
-++++++++++++++++++++++++++++++++++++++++++
+===== Working With the server.policy Policy File
Each GlassFish Server domain has its own global Java SE policy file,
located in domain-dir`/config`. The file is named `server.policy`.
@@ -639,8 +629,7 @@
[[ghlql]][[GSSCG00205]][[auditing]]
-Auditing
-^^^^^^^^
+==== Auditing
Auditing is the means used to capture security-related events for the
purpose of evaluating the effectiveness of security measures. GlassFish
@@ -655,8 +644,7 @@
[[ghlti]][[GSSCG00206]][[firewalls]]
-Firewalls
-^^^^^^^^^
+==== Firewalls
A firewall controls the flow of data between two or more networks, and
manages the links between the networks. A firewall can consist of both
@@ -688,8 +676,7 @@
[[abloj]][[GSSCG00207]][[certificates-and-ssl]]
-Certificates and SSL
-^^^^^^^^^^^^^^^^^^^^
+==== Certificates and SSL
The following topics are addressed here:
@@ -703,8 +690,7 @@
[[ablok]][[GSSCG00192]][[certificates]]
-Certificates
-++++++++++++
+===== Certificates
Certificates, also called digital certificates, are electronic files
that uniquely identify people and resources on the Internet.
@@ -748,8 +734,7 @@
[[ablol]][[GSSCG00193]][[certificate-chains]]
-Certificate Chains
-++++++++++++++++++
+===== Certificate Chains
A certificate chain is a series of certificates issued by successive CA
certificates, eventually ending in a root CA certificate.
@@ -783,8 +768,7 @@
[[ablqx]][[GSSCG00194]][[certificate-files]]
-Certificate Files
-+++++++++++++++++
+===== Certificate Files
During GlassFish Server installation, a certificate is generated in Java
Secure Socket Extension (JSSE) format suitable for internal testing.
@@ -811,8 +795,7 @@
[[ablom]][[GSSCG00195]][[secure-sockets-layer]]
-Secure Sockets Layer
-++++++++++++++++++++
+===== Secure Sockets Layer
Secure Sockets Layer (SSL) is the most popular standard for securing
Internet communications and transactions. Secure web applications use
@@ -895,8 +878,7 @@
[[gksdc]][[GSSCG00196]][[custom-authentication-of-client-certificate-in-ssl-mutual-authentication]]
-Custom Authentication of Client Certificate in SSL Mutual Authentication
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Custom Authentication of Client Certificate in SSL Mutual Authentication
Release 7 of GlassFish Server extends the Certificate realm to allow
custom authentication and group assignment based on the client
@@ -1039,8 +1021,7 @@
[[ablno]][[GSSCG00208]][[tools-for-managing-system-security]]
-Tools for Managing System Security
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Tools for Managing System Security
GlassFish Server provides the following tools for managing system
security:
@@ -1071,8 +1052,7 @@
[[ghgrp]][[GSSCG00144]][[administering-passwords]]
-Administering Passwords
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Passwords
There are multiple ways to administer passwords. You can rely on
administrators to keep passwords secret and change the passwords
@@ -1093,8 +1073,7 @@
[[giudi]][[GSSCG00093]][[to-change-the-master-password]]
-To Change the Master Password
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change the Master Password
The master password gives access to the keystore used with the domain.
This password is not tied to a UNIX user. You should treat this overall
@@ -1191,8 +1170,7 @@
[[gktgr]][[GSSCG00209]][[additional-considerations-for-the-start-instance-and-start-cluster-subcommands]]
-Additional Considerations for the `start-instance` and `start-cluster` Subcommands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Additional Considerations for the `start-instance` and `start-cluster` Subcommands
If you change the master password for DAS, the `start-domain` and
`start-local-instance` subcommands allow you to provide it during domain
@@ -1238,8 +1216,7 @@
[[gktey]][[GSSCG00094]][[using-start-instance-and-start-cluster-with-a-password-file]]
-Using `start-instance` and `start-cluster` With a Password File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Using `start-instance` and `start-cluster` With a Password File
Assume that you have changed the master password on the DAS and you want
to make the same change for all instances.
@@ -1294,8 +1271,7 @@
[[ghgpu]][[GSSCG00095]][[to-change-an-administration-password]]
-To Change an Administration Password
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Change an Administration Password
Use the `change-admin-password` subcommand in remote mode to change an
administration password. The default administration user is `admin`. You
@@ -1371,8 +1347,7 @@
[[ghytn]][[GSSCG00096]][[to-set-a-password-from-a-file]]
-To Set a Password From a File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Set a Password From a File
Instead of typing the password at the command line, you can access the
password for a command from a file such as `passwords.txt`. The
@@ -1429,8 +1404,7 @@
[[ghgqc]][[GSSCG00210]][[administering-password-aliases]]
-Administering Password Aliases
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering Password Aliases
A password alias is used to indirectly access a password so that the
password itself does not appear in cleartext in the domain's
@@ -1452,8 +1426,7 @@
[[ghgrf]][[GSSCG00097]][[to-create-a-password-alias]]
-To Create a Password Alias
-++++++++++++++++++++++++++
+===== To Create a Password Alias
Use the `create-password-alias` subcommand in remote mode to create an
alias for a password in the domain's keystore. The password
@@ -1520,8 +1493,7 @@
[[ghgsr]][[GSSCG00098]][[to-list-password-aliases]]
-To List Password Aliases
-++++++++++++++++++++++++
+===== To List Password Aliases
Use the `list-password-aliases` subcommand in remote mode to list
existing the password aliases.
@@ -1551,8 +1523,7 @@
[[ghgnv]][[GSSCG00099]][[to-delete-a-password-alias]]
-To Delete a Password Alias
-++++++++++++++++++++++++++
+===== To Delete a Password Alias
Use the `delete-password-alias` subcommand in remote mode to delete an
existing password alias.
@@ -1583,8 +1554,7 @@
[[giobz]][[GSSCG00100]][[to-update-a-password-alias]]
-To Update a Password Alias
-++++++++++++++++++++++++++
+===== To Update a Password Alias
Use the `update-password-alias` subcommand in remote mode to change the
password for an existing password alias. The `update-password-alias`
@@ -1625,8 +1595,7 @@
[[ghgol]][[GSSCG00146]][[administering-audit-modules]]
-Administering Audit Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Audit Modules
The following topics are addressed here:
@@ -1636,8 +1605,7 @@
[[ghgra]][[GSSCG00101]][[to-create-an-audit-module]]
-To Create an Audit Module
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Audit Module
Use the `create-audit-module` subcommand in remote mode to create an
audit module for the add-on component that implements the audit
@@ -1672,8 +1640,7 @@
[[ghgsm]][[GSSCG00102]][[to-list-audit-modules]]
-To List Audit Modules
-^^^^^^^^^^^^^^^^^^^^^
+==== To List Audit Modules
Use the `list-audit-modules` subcommand in remote mode to list the audit
modules on one of the following targets:
@@ -1708,8 +1675,7 @@
[[ghgpo]][[GSSCG00104]][[to-delete-an-audit-module]]
-To Delete an Audit Module
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an Audit Module
Use the `delete-audit-module` subcommand in remote mode to delete an
existing audit module.
@@ -1733,8 +1699,7 @@
[[ablqz]][[GSSCG00147]][[administering-jsse-certificates]]
-Administering JSSE Certificates
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JSSE Certificates
In the developer profile, the GlassFish Server 7 uses the JSSE format
on the server side to manage certificates and key stores. In all
@@ -1755,8 +1720,7 @@
[[ghlgv]][[GSSCG00105]][[to-generate-a-certificate-by-using-keytool]]
-To Generate a Certificate by Using `keytool`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Generate a Certificate by Using `keytool`
By default, the `keytool` utility creates a keystore file in the
directory where the utility is run.
@@ -1875,8 +1839,7 @@
[[ghlgj]][[GSSCG00106]][[to-sign-a-certificate-by-using-keytool]]
-To Sign a Certificate by Using `keytool`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Sign a Certificate by Using `keytool`
After creating a certificate, the owner must sign the certificate to
prevent forgery. E-commerce sites, or those for which authentication of
@@ -2044,8 +2007,7 @@
[[ghleq]][[GSSCG00107]][[to-delete-a-certificate-by-using-keytool]]
-To Delete a Certificate by Using `keytool`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a Certificate by Using `keytool`
Use the `keytool` `delete` command to delete an existing certificate.
@@ -2074,8 +2036,7 @@
[[gkngj]][[GSSCG00148]][[administering-jacc-providers]]
-Administering JACC Providers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering JACC Providers
The Java Authorization Contract for Containers (JACC) is part of the
J2EE 1.4 specification that defines an interface for pluggable
@@ -2102,8 +2063,7 @@
[[gksgp]][[GSSCG00108]][[administering-jacc-providers-from-the-administration-console]]
-Administering JACC Providers From the Administration Console
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering JACC Providers From the Administration Console
To use the Administration Console to administer JACC providers, perform
the following steps:
@@ -2129,8 +2089,7 @@
[[gksfx]][[GSSCG00109]][[administering-jacc-providers-from-the-command-line]]
-Administering JACC Providers from the Command Line
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Administering JACC Providers from the Command Line
To use the command line to administer JACC providers, perform the
following steps:
diff --git a/docs/security-guide/src/main/jbake/content/title.adoc b/docs/security-guide/src/main/jbake/content/title.adoc
index 58485d5..fef6718 100644
--- a/docs/security-guide/src/main/jbake/content/title.adoc
+++ b/docs/security-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Security Guide, Release 7
-==================================================
+= Eclipse GlassFish Server Security Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Security Guide
diff --git a/docs/security-guide/src/main/jbake/content/toc.adoc b/docs/security-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..8bb767a
--- /dev/null
+++ b/docs/security-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,136 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Security Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Security Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#preface[Preface]
+
+** link:preface.html#GSSCG00135[GlassFish Server Documentation Set]
+** link:preface.html#GSSCG00136[Related Documentation]
+** link:preface.html#typographic-conventions[Typographic Conventions]
+** link:preface.html#GSSCG00138[Symbol Conventions]
+** link:preface.html#GSSCG00139[Default Paths and File Names]
+
+[[administering-system-security]]
+=== link:system-security.html#GSSCG00035[1 Administering System Security]
+
+** link:system-security.html#GSSCG00143[About System Security in GlassFish Server]
+*** link:system-security.html#GSSCG00203[Authentication]
+*** link:system-security.html#GSSCG00204[Authorization]
+*** link:system-security.html#GSSCG00205[Auditing]
+*** link:system-security.html#GSSCG00206[Firewalls]
+*** link:system-security.html#GSSCG00207[Certificates and SSL]
+*** link:system-security.html#GSSCG00208[Tools for Managing System Security]
+** link:system-security.html#GSSCG00144[Administering Passwords]
+*** link:system-security.html#GSSCG00093[To Change the Master Password]
+*** link:system-security.html#GSSCG00209[Additional Considerations for the `start-instance` and `start-cluster` Subcommands]
+*** link:system-security.html#GSSCG00094[Using `start-instance` and `start-cluster` With a Password File]
+*** link:system-security.html#GSSCG00095[To Change an Administration Password]
+*** link:system-security.html#GSSCG00096[To Set a Password From a File]
+*** link:system-security.html#GSSCG00210[Administering Password Aliases]
+** link:system-security.html#GSSCG00146[Administering Audit Modules]
+*** link:system-security.html#GSSCG00101[To Create an Audit Module]
+*** link:system-security.html#GSSCG00102[To List Audit Modules]
+*** link:system-security.html#GSSCG00104[To Delete an Audit Module]
+** link:system-security.html#GSSCG00147[Administering JSSE Certificates]
+*** link:system-security.html#GSSCG00105[To Generate a Certificate by Using `keytool`]
+*** link:system-security.html#GSSCG00106[To Sign a Certificate by Using `keytool`]
+*** link:system-security.html#GSSCG00107[To Delete a Certificate by Using `keytool`]
+** link:system-security.html#GSSCG00148[Administering JACC Providers]
+*** link:system-security.html#GSSCG00108[Administering JACC Providers From the Administration Console]
+*** link:system-security.html#GSSCG00109[Administering JACC Providers from the Command Line]
+
+[[administering-user-security]]
+=== link:user-security.html#GSSCG00036[2 Administering User Security]
+
+** link:user-security.html#GSSCG00151[Administering Authentication Realms]
+*** link:user-security.html#GSSCG00217[Overview of Authentication Realms]
+*** link:user-security.html#GSSCG00110[To Create an Authentication Realm]
+*** link:user-security.html#GSSCG00111[To List Authentication Realms]
+*** link:user-security.html#GSSCG00112[To Update an Authentication Realm]
+*** link:user-security.html#GSSCG00113[To Delete an Authentication Realm]
+*** link:user-security.html#GSSCG00114[To Configure a JDBC or Digest Authentication Realm]
+*** link:user-security.html#GSSCG00115[To Configure LDAP Authentication with OID]
+*** link:user-security.html#GSSCG00116[To Configure LDAP Authentication with OVD]
+*** link:user-security.html#GSSCG00117[To Enable LDAP Authentication on the GlassFish Server DAS]
+** link:user-security.html#GSSCG00152[Administering File Users]
+*** link:user-security.html#GSSCG00118[To Create a File User]
+*** link:user-security.html#GSSCG00119[To List File Users]
+*** link:user-security.html#GSSCG00120[To List File Groups]
+*** link:user-security.html#GSSCG00121[To Update a File User]
+*** link:user-security.html#GSSCG00122[To Delete a File User]
+
+[[administering-message-security]]
+=== link:message-security.html#GSSCG00037[3 Administering Message Security]
+
+** link:message-security.html#GSSCG00153[About Message Security in GlassFish Server]
+*** link:message-security.html#GSSCG00218[Security Tokens and Security Mechanisms]
+*** link:message-security.html#GSSCG00219[Authentication Providers]
+*** link:message-security.html#GSSCG00220[Message Protection Policies]
+*** link:message-security.html#GSSCG00221[Application-Specific Web Services Security]
+*** link:message-security.html#GSSCG00222[Message Security Administration]
+*** link:message-security.html#GSSCG00223[Sample Application for Web Services]
+** link:message-security.html#GSSCG00154[Enabling Default Message Security Providers for Web Services]
+*** link:message-security.html#GSSCG00123[To Enable a Default Server Provider]
+*** link:message-security.html#GSSCG00124[To Enable a Default Client Provider]
+** link:message-security.html#GSSCG00155[Configuring Message Protection Policies]
+*** link:message-security.html#GSSCG00224[Message Protection Policy Mapping]
+*** link:message-security.html#GSSCG00125[To Configure the Message Protection Policies for a Provider]
+*** link:message-security.html#GSSCG00225[Setting the Request and Response Policy for the Application Client Configuration]
+** link:message-security.html#GSSCG00156[Administering Non-default Message Security Providers]
+*** link:message-security.html#GSSCG00126[To Create a Message Security Provider]
+*** link:message-security.html#GSSCG00127[To List Message Security Providers]
+*** link:message-security.html#GSSCG00128[To Update a Message Security Provider]
+*** link:message-security.html#GSSCG00129[To Delete a Message Security Provider]
+*** link:message-security.html#GSSCG00130[To Configure a Servlet Layer Server Authentication Module (SAM)]
+** link:message-security.html#GSSCG00157[Enabling Message Security for Application Clients]
+** link:message-security.html#GSSCG00158[Additional Information About Message Security]
+
+[[administering-security-in-cluster-mode]]
+=== link:security-in-cluster-mode.html#GSSCG00038[4 Administering Security in Cluster Mode]
+
+** link:security-in-cluster-mode.html#GSSCG00159[Configuring Certificates in Cluster Mode]
+** link:security-in-cluster-mode.html#GSSCG00160[Dynamic Reconfiguration]
+*** link:security-in-cluster-mode.html#GSSCG00226[Enabling Dynamic Configuration]
+** link:security-in-cluster-mode.html#GSSCG00161[Understanding Synchronization]
+
+[[managing-administrative-security]]
+=== link:administrative-security.html#GSSCG00039[5 Managing Administrative Security]
+
+** link:administrative-security.html#GSSCG00162[Secure Administration Overview]
+** link:administrative-security.html#GSSCG00163[How Secure Admin Works: The Big Picture]
+*** link:administrative-security.html#GSSCG00227[Functions Performed by Secure Admin]
+*** link:administrative-security.html#GSSCG00228[Which Administration Account is Used?]
+*** link:administrative-security.html#GSSCG00229[What Authentication Methods Are Used for Secure Administration?]
+*** link:administrative-security.html#GSSCG00230[Understanding How Certificate Authentication is Performed]
+*** link:administrative-security.html#GSSCG00231[What Certificates Are Used?]
+*** link:administrative-security.html#GSSCG00232[An Alternate Approach: Using Distinguished Names to Specify Certificates]
+*** link:administrative-security.html#GSSCG00233[Guarding Against Unwanted Connections]
+** link:administrative-security.html#GSSCG00164[Considerations When Running GlassFish Server With Default Security]
+** link:administrative-security.html#GSSCG00165[Running Secure Admin]
+*** link:administrative-security.html#GSSCG00234[Prerequisites for Running Secure Admin]
+*** link:administrative-security.html#GSSCG00235[An Alternate Approach: Using A User Name and Password for Internal Authentication and Authorization]
+*** link:administrative-security.html#GSSCG00236[Example of Running enable-secure-admin]
+** link:administrative-security.html#GSSCG00166[Additional Considerations When Creating Local Instances]
+** link:administrative-security.html#GSSCG00167[Secure Admin Use Case]
+** link:administrative-security.html#GSSCG00168[Upgrading an SSL-Enabled Secure GlassFish Installation to Secure Admin]
+
+[[running-in-a-secure-environment]]
+=== link:running-in-secure-environment.html#GSSCG00040[6 Running in a Secure Environment]
+
+** link:running-in-secure-environment.html#GSSCG00169[Determining Your Security Needs]
+*** link:running-in-secure-environment.html#GSSCG00237[Understand Your Environment]
+*** link:running-in-secure-environment.html#GSSCG00239[Read Security Publications]
+** link:running-in-secure-environment.html#GSSCG00170[Installing GlassFish Server in a Secure Environment]
+*** link:running-in-secure-environment.html#GSSCG00240[Enable the Secure Administration Feature]
+** link:running-in-secure-environment.html#GSSCG00172[Run on the Web Profile if Possible]
+** link:running-in-secure-environment.html#GSSCG00173[Securing the GlassFish Server Host]
+** link:running-in-secure-environment.html#GSSCG00174[Securing GlassFish Server]
+** link:running-in-secure-environment.html#GSSCG00175[Securing Applications]
diff --git a/docs/security-guide/src/main/jbake/content/user-security.adoc b/docs/security-guide/src/main/jbake/content/user-security.adoc
index ae684fd..18e3c90 100644
--- a/docs/security-guide/src/main/jbake/content/user-security.adoc
+++ b/docs/security-guide/src/main/jbake/content/user-security.adoc
@@ -5,15 +5,13 @@
prev=system-security.html
~~~~~~
-Administering User Security
-===========================
+= Administering User Security
[[GSSCG00036]][[ggnqj]]
[[administering-user-security]]
-2 Administering User Security
------------------------------
+== 2 Administering User Security
This chapter provides instructions for administering user security in
the Oracle GlassFish Server environment by using the `asadmin`
@@ -45,8 +43,7 @@
[[ggkuk]][[GSSCG00151]][[administering-authentication-realms]]
-Administering Authentication Realms
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering Authentication Realms
The following topics are addressed here:
@@ -62,8 +59,7 @@
[[gkbiy]][[GSSCG00217]][[overview-of-authentication-realms]]
-Overview of Authentication Realms
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Overview of Authentication Realms
An authentication realm, also called a security policy domain or
security domain, is a scope over which the GlassFish Server defines and
@@ -154,8 +150,7 @@
[[ggnca]][[GSSCG00110]][[to-create-an-authentication-realm]]
-To Create an Authentication Realm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Create an Authentication Realm
Use the `create-auth-realm` subcommand in remote mode to create an
authentication realm.
@@ -190,8 +185,7 @@
[[ggngh]][[GSSCG00111]][[to-list-authentication-realms]]
-To List Authentication Realms
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To List Authentication Realms
Use the `list-auth-realms` subcommand in remote mode to list the
existing authentication realms.
@@ -224,8 +218,7 @@
[[giwlt]][[GSSCG00112]][[to-update-an-authentication-realm]]
-To Update an Authentication Realm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Update an Authentication Realm
Use the `set` subcommand to modify an existing authentication realm.
@@ -249,8 +242,7 @@
[[ggngf]][[GSSCG00113]][[to-delete-an-authentication-realm]]
-To Delete an Authentication Realm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Delete an Authentication Realm
Use the `delete-auth-realm` subcommand in remote mode to delete an
existing authentication realm.
@@ -285,8 +277,7 @@
[[ggmww]][[GSSCG00114]][[to-configure-a-jdbc-or-digest-authentication-realm]]
-To Configure a JDBC or Digest Authentication Realm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure a JDBC or Digest Authentication Realm
GlassFish Server enables you to specify a user's credentials (user name
and password) in the JDBC realm instead of in the connection pool. Using
@@ -369,8 +360,7 @@
[[gkbeo]][[GSSCG00115]][[to-configure-ldap-authentication-with-oid]]
-To Configure LDAP Authentication with OID
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure LDAP Authentication with OID
This procedure explains how to configure GlassFish Server to use LDAP
authentication with Oracle Internet Directory.
@@ -469,8 +459,7 @@
[[gksgi]][[GSSCG00116]][[to-configure-ldap-authentication-with-ovd]]
-To Configure LDAP Authentication with OVD
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Configure LDAP Authentication with OVD
This procedure explains how to configure GlassFish Server to use LDAP
authentication with Oracle Virtual Directory.
@@ -531,8 +520,7 @@
[[gkbjp]][[GSSCG00117]][[to-enable-ldap-authentication-on-the-glassfish-server-das]]
-To Enable LDAP Authentication on the GlassFish Server DAS
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Enable LDAP Authentication on the GlassFish Server DAS
This procedure explains how to enable LDAP authentication for logins to
the GlassFish Server Domain Administration Server (DAS). Logging in to
@@ -587,8 +575,7 @@
[[ggnxq]][[GSSCG00152]][[administering-file-users]]
-Administering File Users
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administering File Users
A user is an individual (or application program) identity that is
defined in GlassFish Server. A user who has been authenticated is
@@ -609,8 +596,7 @@
[[ggocf]][[GSSCG00118]][[to-create-a-file-user]]
-To Create a File User
-^^^^^^^^^^^^^^^^^^^^^
+==== To Create a File User
Use the `create-file-user` subcommand in remote mode to create a new
user by adding a new entry to the `keyfile`. The entry includes the user
@@ -661,8 +647,7 @@
[[ggoab]][[GSSCG00119]][[to-list-file-users]]
-To List File Users
-^^^^^^^^^^^^^^^^^^
+==== To List File Users
Use the `list-file-users` subcommand in remote mode to list the users
that are in the `keyfile`.
@@ -692,8 +677,7 @@
[[ghlgs]][[GSSCG00120]][[to-list-file-groups]]
-To List File Groups
-^^^^^^^^^^^^^^^^^^^
+==== To List File Groups
A group is a category of users classified by common traits, such as job
title or customer profile. For example, users of an e-commerce
@@ -732,8 +716,7 @@
[[ggoaw]][[GSSCG00121]][[to-update-a-file-user]]
-To Update a File User
-^^^^^^^^^^^^^^^^^^^^^
+==== To Update a File User
Use the `update-file-user` subcommand in remote mode to modify the
information in the `keyfile` for a specified user.
@@ -773,8 +756,7 @@
[[ggoah]][[GSSCG00122]][[to-delete-a-file-user]]
-To Delete a File User
-^^^^^^^^^^^^^^^^^^^^^
+==== To Delete a File User
Use the `delete-file-user` subcommand in remote mode to remove a user
entry from the `keyfile` by specifying the user name. You cannot delete
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/faqs.adoc b/docs/troubleshooting-guide/src/main/jbake/content/faqs.adoc
index 45635aa..309c394 100644
--- a/docs/troubleshooting-guide/src/main/jbake/content/faqs.adoc
+++ b/docs/troubleshooting-guide/src/main/jbake/content/faqs.adoc
@@ -4,15 +4,13 @@
prev=specific-issues.html
~~~~~~
-Frequently Asked Questions
-==========================
+= Frequently Asked Questions
[[GSTSG00006]][[abgkd]]
[[frequently-asked-questions]]
-3 Frequently Asked Questions
-----------------------------
+== 3 Frequently Asked Questions
This chapter lists a few of the Frequently Asked Questions (FAQs)
related to Oracle GlassFish Server 7. For the latest FAQs, see the
@@ -30,13 +28,11 @@
[[ghynj]][[GSTSG00071]][[administration-faqs]]
-Administration FAQs
-~~~~~~~~~~~~~~~~~~~
+=== Administration FAQs
[[ghvhr]][[GSTSG00252]][[which-asadmin-commands-are-supported]]
-Which `asadmin` Commands are Supported?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Which `asadmin` Commands are Supported?
Use `asadmin` `list-commands` to determine which commands are supported
and available for use. For related information, see
@@ -45,42 +41,36 @@
[[ghyaf]][[GSTSG00072]][[application-faqs]]
-Application FAQs
-~~~~~~~~~~~~~~~~
+=== Application FAQs
[[ghybu]][[GSTSG00253]][[how-do-i-debug-applications]]
-How Do I Debug Applications?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Debug Applications?
See "link:../application-development-guide/debugging-apps.html#GSDVG00004[Debugging Applications]" in GlassFish Server Open
Source Edition Application Development Guide.
[[ghybh]][[GSTSG00254]][[how-do-i-change-application-permissions]]
-How Do I Change Application Permissions?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Change Application Permissions?
See "link:../application-development-guide/securing-apps.html#GSDVG00372[Changing Permissions for an Application]" in
Eclipse GlassFish Server Application Development Guide.
[[ghybt]][[GSTSG00255]][[what-are-the-restrictions-and-optimizations-for-session-beans]]
-What Are the Restrictions and Optimizations for Session Beans?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== What Are the Restrictions and Optimizations for Session Beans?
See "link:../application-development-guide/ejb.html#GSDVG00427[Session Bean Restrictions and Optimizations]" in
Eclipse GlassFish Server Application Development Guide.
[[ghyak]][[GSTSG00073]][[eclipse-faqs]]
-Eclipse FAQs
-~~~~~~~~~~~~
+=== Eclipse FAQs
[[ghvmc]][[GSTSG00256]][[where-can-i-find-more-information-about-eclipse-and-glassfish-server-integration]]
-Where Can I Find More Information About Eclipse and GlassFish Server Integration?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Where Can I Find More Information About Eclipse and GlassFish Server Integration?
Eclipse is a development environment that provides a framework, tools,
and runtime for deploying and managing software. The GlassFish plugin
@@ -91,21 +81,18 @@
[[ghybv]][[GSTSG00074]][[extensibility-faqs]]
-Extensibility FAQs
-~~~~~~~~~~~~~~~~~~
+=== Extensibility FAQs
[[ghyaw]][[GSTSG00257]][[how-do-i-develop-add-on-components]]
-How Do I Develop Add-On Components?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Develop Add-On Components?
See the link:../add-on-component-development-guide/toc.html#GSACG[Eclipse GlassFish Server Add-On
Component Development Guide] for complete details.
[[ghvhg]][[GSTSG00258]][[how-do-i-add-containers]]
-How Do I Add Containers?
-^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Add Containers?
GlassFish Server has a highly modular architecture that enables you to
add new types of containers that handle many application types, not just
@@ -120,34 +107,29 @@
[[ghvgv]][[GSTSG00259]][[how-do-i-extend-the-administration-console]]
-How Do I Extend the Administration Console?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Extend the Administration Console?
See "link:../add-on-component-development-guide/extending-the-admin-console.html#GSACG00003[Extending the Administration Console]" in
Eclipse GlassFish Server Add-On Component Development Guide.
[[ghybi]][[GSTSG00075]][[java-persistence-faqs]]
-Java Persistence FAQs
-~~~~~~~~~~~~~~~~~~~~~
+=== Java Persistence FAQs
[[ghvnl]][[GSTSG00260]][[what-are-the-restrictions-and-optimizations-for-the-java-persistence-api]]
-What Are the Restrictions and Optimizations for the Java Persistence API?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== What Are the Restrictions and Optimizations for the Java Persistence API?
See "link:../application-development-guide/jpa.html#GSDVG00139[Restrictions and Optimizations]" in GlassFish
Server Open Source Edition Application Development Guide.
[[ghybd]][[GSTSG00076]][[update-tool-faqs]]
-Update Tool FAQs
-~~~~~~~~~~~~~~~~
+=== Update Tool FAQs
[[ghvly]][[GSTSG00261]][[how-do-i-use-update-tool-to-extend-my-glassfish-server-installation]]
-How Do I Use Update Tool to Extend My GlassFish Server Installation?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Use Update Tool to Extend My GlassFish Server Installation?
Enterprise Server provides an administrative tool called Update Tool
that enables you to install updates and add-on components to your
@@ -184,16 +166,14 @@
[[gjjoq]][[GSTSG00262]][[how-do-i-turn-off-the-notifier]]
-How Do I Turn Off the Notifier?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== How Do I Turn Off the Notifier?
Update Tool provides automatic notifications of available updates after
installation. These notifications can be turned off if desired.
[[gjjox]][[GSTSG00028]][[to-turn-off-the-notifier]]
-To Turn Off the Notifier
-++++++++++++++++++++++++
+===== To Turn Off the Notifier
1. Launch the standalone graphical tool using the `updatetool` command:
+
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/overview.adoc b/docs/troubleshooting-guide/src/main/jbake/content/overview.adoc
index 86fa14f..0853e3b 100644
--- a/docs/troubleshooting-guide/src/main/jbake/content/overview.adoc
+++ b/docs/troubleshooting-guide/src/main/jbake/content/overview.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-Overview of Eclipse GlassFish Server Troubleshooting
-====================================================
+= Overview of Eclipse GlassFish Server Troubleshooting
[[GSTSG00002]][[abgap]]
[[overview-of-glassfish-server-open-source-edition-troubleshooting]]
-1 Overview of Eclipse GlassFish Server Troubleshooting
-------------------------------------------------------
+== 1 Overview of Eclipse GlassFish Server Troubleshooting
This chapter describes some of the tools, methods, and resources
available for troubleshooting Eclipse GlassFish Server.
@@ -27,8 +25,7 @@
[[abgar]][[GSTSG00039]][[identifying-the-problem]]
-Identifying the Problem
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Identifying the Problem
Application servers are typically deployed in complex operating
environments and involve many technologies, products, and tools.
@@ -43,16 +40,14 @@
[[ghvay]][[GSTSG00171]][[first-steps]]
-First Steps
-^^^^^^^^^^^
+==== First Steps
Sometimes the most obvious solutions are overlooked. As you begin your
investigation, try the following steps first.
[[ghyku]][[GSTSG00077]][[verify-system-requirements-and-configuration]]
-Verify System Requirements and Configuration
-++++++++++++++++++++++++++++++++++++++++++++
+===== Verify System Requirements and Configuration
Ensure that your system meets the requirements listed in
"link:../release-notes/release-notes.html#GSRLN00131[Hardware and Software Requirements]"
@@ -91,8 +86,7 @@
[[ghyml]][[GSTSG00078]][[review-known-issues]]
-Review Known Issues
-+++++++++++++++++++
+===== Review Known Issues
Your problem might be related to a known issue for the release. Refer to
the link:../release-notes/toc.html#GSRLN[Eclipse GlassFish Server Release Notes] for
@@ -102,8 +96,7 @@
[[ghykl]][[GSTSG00079]][[search-the-product-documentation]]
-Search the Product Documentation
-++++++++++++++++++++++++++++++++
+===== Search the Product Documentation
Eclipse GlassFish Server includes complete product
documentation. Search the documentation to see if your problem is
@@ -127,8 +120,7 @@
[[ghymp]][[GSTSG00080]][[search-the-glassfish-mailing-lists-and-forums]]
-Search the GlassFish Mailing Lists and Forums
-+++++++++++++++++++++++++++++++++++++++++++++
+===== Search the GlassFish Mailing Lists and Forums
Lists and forums are extremely helpful resources, and are accessed as follows:
@@ -138,8 +130,7 @@
[[ghuvf]][[GSTSG00172]][[gathering-information]]
-Gathering Information
-^^^^^^^^^^^^^^^^^^^^^
+==== Gathering Information
Troubleshooting and analysis require information. The more information
you have the easier it is to classify a problem and search for its
@@ -151,8 +142,7 @@
[[ghvar]][[GSTSG00081]][[when-does-the-problem-occur]]
-When Does the Problem Occur?
-++++++++++++++++++++++++++++
+===== When Does the Problem Occur?
* What do the logs show? What kind of error message are you getting? For
more information about logs, see link:#abgax[Examining Log Files]. Logs
@@ -168,8 +158,7 @@
[[ghvbb]][[GSTSG00082]][[what-is-your-environment]]
-What Is Your Environment?
-+++++++++++++++++++++++++
+===== What Is Your Environment?
* What version of Eclipse GlassFish Server are you using?
What operating system and version? What JDK version? Many problems are
@@ -195,8 +184,7 @@
[[ghvce]][[GSTSG00083]][[what-is-your-system-configuration]]
-What Is Your System Configuration?
-++++++++++++++++++++++++++++++++++
+===== What Is Your System Configuration?
* What are your settings?
* On which port is Eclipse GlassFish Server configured — the
@@ -217,8 +205,7 @@
[[ghvcr]][[GSTSG00084]][[what-is-different]]
-What Is Different?
-++++++++++++++++++
+===== What Is Different?
* What is different that could have provoked the problem or triggered
the event? Was something new added or changed? Have any new applications
@@ -231,8 +218,7 @@
[[abgax]][[GSTSG00173]][[examining-log-files]]
-Examining Log Files
-^^^^^^^^^^^^^^^^^^^
+==== Examining Log Files
Logging is one of your most important troubleshooting tools. It is the
process by which Eclipse GlassFish Server captures data
@@ -289,8 +275,7 @@
[[ghuvd]][[GSTSG00174]][[monitoring-the-system]]
-Monitoring the System
-^^^^^^^^^^^^^^^^^^^^^
+==== Monitoring the System
Monitoring is another helpful tool. It is the process of reviewing the
statistics of a system to improve performance or solve problems. By
@@ -304,8 +289,7 @@
[[ghuvy]][[GSTSG00040]][[troubleshooting-tools]]
-Troubleshooting Tools
-~~~~~~~~~~~~~~~~~~~~~
+=== Troubleshooting Tools
Several tools are available that can be used to collect information for
troubleshooting purposes. This section provides basic information about
@@ -318,8 +302,7 @@
[[ghvcm]][[GSTSG00175]][[operating-system-utilities]]
-Operating System Utilities
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Operating System Utilities
Operating system utilities, such as `pkginfo` and `showrev` on Solaris
and `rpm` on Linux, are helpful in gathering system information.
@@ -329,8 +312,7 @@
[[ghvbo]][[GSTSG00176]][[stack-traces-and-thread-dumps]]
-Stack Traces and Thread Dumps
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Stack Traces and Thread Dumps
A stack trace is a user-friendly snapshot of the threads and monitors in
a Virtual Machine for the Java platform (Java Virtual Machine or JVM
@@ -348,8 +330,7 @@
[[ghykr]][[GSTSG00023]][[to-obtain-a-server-thread-dump]]
-To Obtain a Server Thread Dump
-++++++++++++++++++++++++++++++
+===== To Obtain a Server Thread Dump
Type the following command:
@@ -366,8 +347,7 @@
[[ghyjq]][[GSTSG00177]][[visualvm]]
-VisualVM
-^^^^^^^^
+==== VisualVM
VisualVM is a Java troubleshooting tool that uses various technologies
such as `jvmstat`, JMX, and Attach API to access monitored applications.
@@ -389,8 +369,7 @@
[[gjjjl]][[GSTSG00178]][[jvm-command-line-tools]]
-JVM Command-Line Tools
-^^^^^^^^^^^^^^^^^^^^^^
+==== JVM Command-Line Tools
JVM command-line tools can be used to provide valuable information about
hung Java processes or Java core dumps. These tools include the
@@ -411,8 +390,7 @@
[[ghuyv]][[GSTSG00041]][[where-to-go-for-more-information]]
-Where to Go for More Information
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Where to Go for More Information
These resources were mentioned throughout this chapter and are provided
again here for easy reference.
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/preface.adoc b/docs/troubleshooting-guide/src/main/jbake/content/preface.adoc
index d46ad5c..151fbef 100644
--- a/docs/troubleshooting-guide/src/main/jbake/content/preface.adoc
+++ b/docs/troubleshooting-guide/src/main/jbake/content/preface.adoc
@@ -5,13 +5,11 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSTSG00001]][[gkbfu]]
[[preface]]
-Preface
--------
+== Preface
[NOTE]
====
@@ -52,8 +50,7 @@
[[GSTSG00031]][[ghpbz]]
[[glassfish-server-documentation-set]]
-GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -158,8 +155,7 @@
[[GSTSG00032]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -202,8 +198,7 @@
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -243,8 +238,7 @@
[[GSTSG00034]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -287,8 +281,7 @@
[[GSTSG00035]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/specific-issues.adoc b/docs/troubleshooting-guide/src/main/jbake/content/specific-issues.adoc
index 9678110..2a5271c 100644
--- a/docs/troubleshooting-guide/src/main/jbake/content/specific-issues.adoc
+++ b/docs/troubleshooting-guide/src/main/jbake/content/specific-issues.adoc
@@ -5,15 +5,13 @@
prev=overview.html
~~~~~~
-Specific Issues
-===============
+= Specific Issues
[[GSTSG00003]][[abgbj]]
[[specific-issues]]
-2 Specific Issues
------------------
+== 2 Specific Issues
This chapter lists problems that you might encounter when using Oracle
GlassFish Server 7. The following topics are addressed:
@@ -35,8 +33,7 @@
[[abgca]][[GSTSG00043]][[cannot-access-local-server-httplocalhost8080]]
-Cannot Access Local Server (`http://localhost:8080`)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cannot Access Local Server (`http://localhost:8080`)
When this error occurs, check the following:
@@ -46,13 +43,11 @@
[[abgcb]][[GSTSG00179]][[did-the-server-start]]
-Did the Server Start?
-^^^^^^^^^^^^^^^^^^^^^
+==== Did the Server Start?
[[abgcc]][[GSTSG00085]][[description]]
-Description
-+++++++++++
+===== Description
If the console window is still open, the expected message indicates that
the default domain was started successfully.
@@ -76,13 +71,11 @@
[[abgcd]][[GSTSG00180]][[was-the-server-started-at-the-expected-port]]
-Was the Server Started at the Expected Port?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Was the Server Started at the Expected Port?
[[abgce]][[GSTSG00086]][[description-1]]
-Description
-+++++++++++
+===== Description
The server might be running at a different port number than expected,
either because it was intentionally installed there, or because another
@@ -118,16 +111,14 @@
[[gjjpn]][[GSTSG00181]][[is-a-personal-firewall-enabled]]
-Is a Personal Firewall Enabled?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is a Personal Firewall Enabled?
Issues might result when personal firewalls are enabled. Disable your
personal firewall and see if the server access problem still exists.
[[abgcf]][[GSTSG00044]][[cannot-access-remote-server]]
-Cannot Access Remote Server
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cannot Access Remote Server
When attempting to open the start page of GlassFish Server, the initial
screen does not appear.
@@ -139,21 +130,18 @@
[[abgcg]][[GSTSG00182]][[is-the-server-available-locally]]
-Is the Server Available Locally?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is the Server Available Locally?
[[abgch]][[GSTSG00087]][[description-2]]
-Description
-+++++++++++
+===== Description
If the server cannot be accessed from the web, but it is running
locally, then the server is actually running.
[[abgci]][[GSTSG00088]][[solution]]
-Solution
-++++++++
+===== Solution
Verify that the server is running locally.
@@ -176,13 +164,11 @@
[[abgcj]][[GSTSG00183]][[is-the-proxy-setting-causing-a-problem]]
-Is the Proxy Setting Causing a Problem?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is the Proxy Setting Causing a Problem?
[[abgck]][[GSTSG00089]][[description-3]]
-Description
-+++++++++++
+===== Description
The server should be accessible directly from the host on which it is
running (`localhost`); for example, using the default port `8080`:
@@ -194,8 +180,7 @@
[[abgcl]][[GSTSG00090]][[solution-1]]
-Solution
-++++++++
+===== Solution
A server instance running on `localhost` might not be accessible if the
server host machine is connected to the web through a proxy. To solve
@@ -221,8 +206,7 @@
[[abgcm]][[GSTSG00045]][[cannot-access-the-administration-console]]
-Cannot Access the Administration Console
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cannot Access the Administration Console
The Administration Console provides a graphical interface for
administrative functions. If the Administration Console is not
@@ -238,34 +222,29 @@
[[abgcn]][[GSTSG00184]][[is-the-application-server-running]]
-Is the Application Server Running?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is the Application Server Running?
[[abgco]][[GSTSG00091]][[description-4]]
-Description
-+++++++++++
+===== Description
The server must be running before the Administration Console can be
accessed.
[[abgcp]][[GSTSG00092]][[solution-2]]
-Solution
-++++++++
+===== Solution
Review the information in link:#abgcb[Did the Server Start?] to
determine if the server is running.
[[abgcq]][[GSTSG00185]][[is-the-administration-console-running-on-the-expected-port]]
-Is the Administration Console Running on the Expected Port?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is the Administration Console Running on the Expected Port?
[[abgcr]][[GSTSG00093]][[description-5]]
-Description
-+++++++++++
+===== Description
The default port number for the Administration Console is `4848`.
However, it could be running on a different port number than expected,
@@ -274,8 +253,7 @@
[[abgcs]][[GSTSG00094]][[solution-3]]
-Solution
-++++++++
+===== Solution
Refer to link:#abgcd[Was the Server Started at the Expected Port?] for
guidelines on verifying the port on which the Administration Console is
@@ -284,8 +262,7 @@
[[abgcw]][[GSTSG00046]][[cannot-access-a-server-application]]
-Cannot Access a Server Application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cannot Access a Server Application
If a particular application cannot be accessed through GlassFish Server,
check the following:
@@ -295,20 +272,17 @@
[[abgcx]][[GSTSG00186]][[is-the-application-server-running-1]]
-Is the Application Server Running?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is the Application Server Running?
[[abgcy]][[GSTSG00095]][[description-6]]
-Description
-+++++++++++
+===== Description
If GlassFish Server is not running, applications are not accessible.
[[abgcz]][[GSTSG00096]][[solution-4]]
-Solution
-++++++++
+===== Solution
Review the information in link:#abgcb[Did the Server Start?] to
determine if the server is running. The server must be running before a
@@ -316,20 +290,17 @@
[[abgda]][[GSTSG00187]][[was-application-deployment-successful]]
-Was Application Deployment Successful?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Was Application Deployment Successful?
[[abgdb]][[GSTSG00097]][[description-7]]
-Description
-+++++++++++
+===== Description
An application must be successfully deployed before it can be accessed.
[[abgdc]][[GSTSG00098]][[solution-5]]
-Solution
-++++++++
+===== Solution
Verify that the application was successfully deployed. There are several
ways to do this:
@@ -352,8 +323,7 @@
[[gjjoz]][[GSTSG00047]][[administrator-user-name-or-password-not-known]]
-Administrator User Name or Password Not Known
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Administrator User Name or Password Not Known
If you have forgotten the administrator user name, you can find it by
inspecting the domain-dir`/config/admin-keyfile` file, where domain-dir
@@ -368,20 +338,17 @@
[[gjjpj]][[GSTSG00048]][[experience-issues-related-to-the-jdk]]
-Experience Issues Related to the JDK
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Experience Issues Related to the JDK
[[gjjpl]][[GSTSG00188]][[description-8]]
-Description
-^^^^^^^^^^^
+==== Description
You experience JDK-related issues in a variety of circumstances.
[[gjjop]][[GSTSG00189]][[solution-6]]
-Solution
-^^^^^^^^
+==== Solution
GlassFish Server 7 requires JDK 6, so check your system for that
dependency.
@@ -401,8 +368,7 @@
[[abgdi]][[GSTSG00049]][[server-will-not-start-on-windows-port-conflict]]
-Server Will Not Start on Windows (Port Conflict)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Server Will Not Start on Windows (Port Conflict)
If a message similar to the following is displayed when starting
GlassFish Server on Microsoft Windows, a server port conflict has
@@ -424,29 +390,25 @@
[[abgdj]][[GSTSG00190]][[is-another-application-running-on-the-servers-port]]
-Is Another Application Running on the Server's Port?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Is Another Application Running on the Server's Port?
If another application is using the server's port, stop the other
application, then restart GlassFish Server.
[[abgdk]][[GSTSG00191]][[has-an-ungraceful-shutdown-occurred-on-a-previously-running-server]]
-Has an Ungraceful Shutdown Occurred on a Previously Running Server?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Has an Ungraceful Shutdown Occurred on a Previously Running Server?
Use the `asadmin stop-domain` command to stop the server, or explicitly
kill the Java process and then restart GlassFish Server.
[[gkvcs]][[GSTSG00050]][[glassfish-server-fails-to-start-in-an-opensolaris-zone]]
-GlassFish Server Fails to Start in an OpenSolaris Zone
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== GlassFish Server Fails to Start in an OpenSolaris Zone
[[gkvcx]][[GSTSG00192]][[description-9]]
-Description
-^^^^^^^^^^^
+==== Description
If GlassFish Server is installed in an OpenSolaris zone, an attempt to
start a domain might fail with the following error message:
@@ -466,8 +428,7 @@
[[gkvdf]][[GSTSG00026]][[resolution-to-enable-glassfish-server-to-run-in-an-opensolaris-zone]]
-Resolution: To Enable GlassFish Server to Run in an OpenSolaris Zone
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Resolution: To Enable GlassFish Server to Run in an OpenSolaris Zone
1. Install the package that provides language and encoding support for
your locale.
@@ -488,13 +449,11 @@
[[abgdr]][[GSTSG00051]][[two-server-instances-bind-to-same-port-on-windows]]
-Two Server Instances Bind to Same Port on Windows
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Two Server Instances Bind to Same Port on Windows
[[abgds]][[GSTSG00193]][[description-10]]
-Description
-^^^^^^^^^^^
+==== Description
This problem occurs on Windows XP systems with GlassFish Server
software, and is due to a known Windows security flaw rather than a
@@ -521,21 +480,18 @@
[[fxxyd]][[GSTSG00194]][[solution-7]]
-Solution
-^^^^^^^^
+==== Solution
Be sure to use unique port numbers for all server instances on Windows
systems.
[[abgel]][[GSTSG00052]][[cannot-produce-a-jvm-thread-dump-after-server-crash]]
-Cannot Produce a JVM Thread Dump After Server Crash
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Cannot Produce a JVM Thread Dump After Server Crash
[[abgem]][[GSTSG00195]][[description-11]]
-Description
-^^^^^^^^^^^
+==== Description
If GlassFish Server crashes, the server dumps a core file and, by
default, restarts with the `-Xrs` flag, which prevents the dump of a JVM
@@ -543,13 +499,11 @@
[[fxxyw]][[GSTSG00196]][[solution-8]]
-Solution
-^^^^^^^^
+==== Solution
[[ghylc]][[GSTSG00027]][[to-obtain-a-server-thread-dump-specific-issues]]
-To Obtain a Server Thread Dump
-++++++++++++++++++++++++++++++
+===== To Obtain a Server Thread Dump
Type the following command:
@@ -566,18 +520,15 @@
[[ghvgk]][[GSTSG00053]][[issues-related-to-applications]]
-Issues Related to Applications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Issues Related to Applications
[[abgee]][[GSTSG00197]][[cannot-undeploy-or-redeploy-application-with-open-streams-to-jar-files-windows]]
-Cannot Undeploy or Redeploy Application With Open Streams to `jar` Files (Windows)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Cannot Undeploy or Redeploy Application With Open Streams to `jar` Files (Windows)
[[abgef]][[GSTSG00099]][[description-12]]
-Description
-+++++++++++
+===== Description
On Windows systems, after running an application, subsequent attempts to
undeploy it or redeploy it throw exceptions about the server being
@@ -593,8 +544,7 @@
[[fxxyr]][[GSTSG00100]][[solution-9]]
-Solution
-++++++++
+===== Solution
Be sure to close streams opened by your applications. Also, if an
application needs to be redeployed or undeployed repeatedly, and also
@@ -613,13 +563,11 @@
[[gldbk]][[GSTSG00198]][[maxpermgen-exception]]
-`MaxPermGen` Exception
-^^^^^^^^^^^^^^^^^^^^^^
+==== `MaxPermGen` Exception
[[gldbn]][[GSTSG00101]][[description-13]]
-Description
-+++++++++++
+===== Description
Application servers such as GlassFish Server allow you to redeploy an
application without restarting the server. Simply make the change in
@@ -654,8 +602,7 @@
[[gldbw]][[GSTSG00102]][[solution-10]]
-Solution
-++++++++
+===== Solution
Classloader leaks are difficult to diagnose. Most profilers list leaked
objects but don't highlight the ones causing classloader leaks. Most
@@ -685,13 +632,11 @@
[[ghvhy]][[GSTSG00054]][[issues-related-to-asadmin]]
-Issues Related to `asadmin`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Issues Related to `asadmin`
[[ghvhi]][[GSTSG00199]][[asadmin-start-domain-command-fails]]
-`asadmin` `start-domain` Command Fails
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== `asadmin` `start-domain` Command Fails
The command `asadmin start-domain` fails with the following error:
@@ -702,8 +647,7 @@
[[gjkph]][[GSTSG00103]][[description-14]]
-Description
-+++++++++++
+===== Description
When issued with no arguments, the command `asadmin start-domain` fails.
@@ -713,8 +657,7 @@
[[gjkoy]][[GSTSG00104]][[solution-11]]
-Solution
-++++++++
+===== Solution
Specify the domain when issuing the `start-domain` command:
@@ -732,20 +675,17 @@
[[ghvhx]][[GSTSG00200]][[cannot-stop-domain-using-asadmin-stop-domain]]
-Cannot Stop Domain Using `asadmin` `stop-domain`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Cannot Stop Domain Using `asadmin` `stop-domain`
[[ghvhl]][[GSTSG00105]][[description-15]]
-Description
-+++++++++++
+===== Description
You cannot stop the domain using the `asadmin` `stop-domain` command.
[[ghvha]][[GSTSG00106]][[solution-12]]
-Solution
-++++++++
+===== Solution
Look for error messages that display in the console when you issue the command.
@@ -754,25 +694,21 @@
[[ghvgu]][[GSTSG00055]][[issues-related-to-installation]]
-Issues Related to Installation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Issues Related to Installation
[[gjjnu]][[GSTSG00201]][[installation-hangs-during-update-tool-configuration]]
-Installation Hangs During Update Tool Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Installation Hangs During Update Tool Configuration
[[giqjt]][[GSTSG00107]][[description-16]]
-Description
-+++++++++++
+===== Description
Installation hangs more than five minutes during Update Tool configuration.
[[giqle]][[GSTSG00108]][[solution-13]]
-Solution
-++++++++
+===== Solution
Cancel the installation and run the installation program again, but this
time deselect the Install Update Tool check box. Update Tool can be
@@ -795,13 +731,11 @@
[[gjjob]][[GSTSG00202]][[glassfish-server-components-not-removed-during-uninstallation]]
-GlassFish Server Components Not Removed During Uninstallation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== GlassFish Server Components Not Removed During Uninstallation
[[gjjoh]][[GSTSG00109]][[description-17]]
-Description
-+++++++++++
+===== Description
Not all GlassFish Server directories are automatically removed by the
uninstallation program. Some directories and files remain after
@@ -809,8 +743,7 @@
[[gjjnk]][[GSTSG00110]][[solution-14]]
-Solution
-++++++++
+===== Solution
Examine the remaining directories and remove any files or directories
that you do not want, including hidden directories prefixed with a dot.
@@ -823,18 +756,15 @@
[[ghvrh]][[GSTSG00056]][[issues-related-to-security]]
-Issues Related to Security
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Issues Related to Security
[[abgjt]][[GSTSG00203]][[java.security.accesscontrolexception-access-denied-error]]
-`java.security.AccessControlException`: Access Denied Error
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== `java.security.AccessControlException`: Access Denied Error
[[abgju]][[GSTSG00111]][[description-18]]
-Description
-+++++++++++
+===== Description
The following error occurs from an application client, or appears in the
`server.log` file:
@@ -852,8 +782,7 @@
[[fxxzk]][[GSTSG00112]][[solution-15]]
-Solution
-++++++++
+===== Solution
Add the permission in `client.policy` (for the application client), or
in `server.policy` (for web modules) for the application that needs to
@@ -873,21 +802,18 @@
[[abgka]][[GSTSG00204]][[mutual-authentication-not-working-with-the-application-client]]
-Mutual Authentication Not Working With the Application Client
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Mutual Authentication Not Working With the Application Client
[[abgkb]][[GSTSG00113]][[description-19]]
-Description
-+++++++++++
+===== Description
This failure can occur when the keystore and truststore properties are
not set properly.
[[fxxzu]][[GSTSG00114]][[solution-16]]
-Solution
-++++++++
+===== Solution
Set the following properties on the JVM:
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/title.adoc b/docs/troubleshooting-guide/src/main/jbake/content/title.adoc
index 8369f64..7fd58dc 100644
--- a/docs/troubleshooting-guide/src/main/jbake/content/title.adoc
+++ b/docs/troubleshooting-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-Eclipse GlassFish Server Troubleshooting Guide, Release 7
-=========================================================
+= Eclipse GlassFish Server Troubleshooting Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Troubleshooting Guide
diff --git a/docs/troubleshooting-guide/src/main/jbake/content/toc.adoc b/docs/troubleshooting-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..48ca683
--- /dev/null
+++ b/docs/troubleshooting-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,100 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Troubleshooting Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Troubleshooting Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSTSG00001[Preface]
+
+** link:preface.html#GSTSG00031[GlassFish Server Documentation Set]
+** link:preface.html#GSTSG00032[Related Documentation]
+** link:preface.html#typographic-conventions[Typographic Conventions]
+** link:preface.html#GSTSG00034[Symbol Conventions]
+** link:preface.html#GSTSG00035[Default Paths and File Names]
+
+[[overview-of-glassfish-server-open-source-edition-troubleshooting]]
+=== link:overview.html#GSTSG00002[1 Overview of Eclipse GlassFish Server Troubleshooting]
+
+** link:overview.html#GSTSG00039[Identifying the Problem]
+*** link:overview.html#GSTSG00171[First Steps]
+*** link:overview.html#GSTSG00172[Gathering Information]
+*** link:overview.html#GSTSG00173[Examining Log Files]
+*** link:overview.html#GSTSG00174[Monitoring the System]
+** link:overview.html#GSTSG00040[Troubleshooting Tools]
+*** link:overview.html#GSTSG00175[Operating System Utilities]
+*** link:overview.html#GSTSG00176[Stack Traces and Thread Dumps]
+*** link:overview.html#GSTSG00177[VisualVM]
+*** link:overview.html#GSTSG00178[JVM Command-Line Tools]
+** link:overview.html#GSTSG00041[Where to Go for More Information]
+
+[[specific-issues]]
+=== link:specific-issues.html#GSTSG00003[2 Specific Issues]
+
+** link:specific-issues.html#GSTSG00043[Cannot Access Local Server (`http://localhost:8080`)]
+*** link:specific-issues.html#GSTSG00179[Did the Server Start?]
+*** link:specific-issues.html#GSTSG00180[Was the Server Started at the Expected Port?]
+*** link:specific-issues.html#GSTSG00181[Is a Personal Firewall Enabled?]
+** link:specific-issues.html#GSTSG00044[Cannot Access Remote Server]
+*** link:specific-issues.html#GSTSG00182[Is the Server Available Locally?]
+*** link:specific-issues.html#GSTSG00183[Is the Proxy Setting Causing a Problem?]
+** link:specific-issues.html#GSTSG00045[Cannot Access the Administration Console]
+*** link:specific-issues.html#GSTSG00184[Is the Application Server Running?]
+*** link:specific-issues.html#GSTSG00185[Is the Administration Console Running on the Expected Port?]
+** link:specific-issues.html#GSTSG00046[Cannot Access a Server Application]
+*** link:specific-issues.html#GSTSG00186[Is the Application Server Running?]
+*** link:specific-issues.html#GSTSG00187[Was Application Deployment Successful?]
+** link:specific-issues.html#GSTSG00047[Administrator User Name or Password Not Known]
+** link:specific-issues.html#GSTSG00048[Experience Issues Related to the JDK]
+*** link:specific-issues.html#GSTSG00188[Description]
+*** link:specific-issues.html#GSTSG00189[Solution]
+** link:specific-issues.html#GSTSG00049[Server Will Not Start on Windows (Port Conflict)]
+*** link:specific-issues.html#GSTSG00190[Is Another Application Running on the Server's Port?]
+*** link:specific-issues.html#GSTSG00191[Has an Ungraceful Shutdown Occurred on a Previously Running Server?]
+** link:specific-issues.html#GSTSG00050[GlassFish Server Fails to Start in an OpenSolaris Zone]
+*** link:specific-issues.html#GSTSG00192[Description]
+*** link:specific-issues.html#GSTSG00026[Resolution: To Enable GlassFish Server to Run in an OpenSolaris Zone]
+** link:specific-issues.html#GSTSG00051[Two Server Instances Bind to Same Port on Windows]
+*** link:specific-issues.html#GSTSG00193[Description]
+*** link:specific-issues.html#GSTSG00194[Solution]
+** link:specific-issues.html#GSTSG00052[Cannot Produce a JVM Thread Dump After Server Crash]
+*** link:specific-issues.html#GSTSG00195[Description]
+*** link:specific-issues.html#GSTSG00196[Solution]
+** link:specific-issues.html#GSTSG00053[Issues Related to Applications]
+*** link:specific-issues.html#GSTSG00197[Cannot Undeploy or Redeploy Application With Open Streams to `jar` Files (Windows)]
+*** link:specific-issues.html#GSTSG00198[`MaxPermGen` Exception]
+** link:specific-issues.html#GSTSG00054[Issues Related to `asadmin`]
+*** link:specific-issues.html#GSTSG00199[`asadmin` `start-domain` Command Fails]
+*** link:specific-issues.html#GSTSG00200[Cannot Stop Domain Using `asadmin` `stop-domain`]
+** link:specific-issues.html#GSTSG00055[Issues Related to Installation]
+*** link:specific-issues.html#GSTSG00201[Installation Hangs During Update Tool Configuration]
+*** link:specific-issues.html#GSTSG00202[GlassFish Server Components Not Removed During Uninstallation]
+** link:specific-issues.html#GSTSG00056[Issues Related to Security]
+*** link:specific-issues.html#GSTSG00203[`java.security.AccessControlException`: Access Denied Error]
+*** link:specific-issues.html#GSTSG00204[Mutual Authentication Not Working With the Application Client]
+
+[[frequently-asked-questions]]
+=== link:faqs.html#GSTSG00006[3 Frequently Asked Questions]
+
+** link:faqs.html#GSTSG00071[Administration FAQs]
+*** link:faqs.html#GSTSG00252[Which `asadmin` Commands are Supported?]
+** link:faqs.html#GSTSG00072[Application FAQs]
+*** link:faqs.html#GSTSG00253[How Do I Debug Applications?]
+*** link:faqs.html#GSTSG00254[How Do I Change Application Permissions?]
+*** link:faqs.html#GSTSG00255[What Are the Restrictions and Optimizations for Session Beans?]
+** link:faqs.html#GSTSG00073[Eclipse FAQs]
+*** link:faqs.html#GSTSG00256[Where Can I Find More Information About Eclipse and GlassFish Server Integration?]
+** link:faqs.html#GSTSG00074[Extensibility FAQs]
+*** link:faqs.html#GSTSG00257[How Do I Develop Add-On Components?]
+*** link:faqs.html#GSTSG00258[How Do I Add Containers?]
+*** link:faqs.html#GSTSG00259[How Do I Extend the Administration Console?]
+** link:faqs.html#GSTSG00075[Java Persistence FAQs]
+*** link:faqs.html#GSTSG00260[What Are the Restrictions and Optimizations for the Java Persistence API?]
+** link:faqs.html#GSTSG00076[Update Tool FAQs]
+*** link:faqs.html#GSTSG00261[How Do I Use Update Tool to Extend My GlassFish Server Installation?]
+*** link:faqs.html#GSTSG00262[How Do I Turn Off the Notifier?]
diff --git a/docs/upgrade-guide/src/main/jbake/content/loe.adoc b/docs/upgrade-guide/src/main/jbake/content/loe.adoc
index b399501..f31c408 100644
--- a/docs/upgrade-guide/src/main/jbake/content/loe.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/loe.adoc
@@ -5,12 +5,10 @@
prev=toc.html
~~~~~~
-List of Examples
-================
+= List of Examples
[[list-of-examples]]
-List of Examples
-----------------
+== List of Examples
* link:upgrading-legacy-installation.html#gktiu[2-1 Using the asupgrade
Command Line]
diff --git a/docs/upgrade-guide/src/main/jbake/content/lot.adoc b/docs/upgrade-guide/src/main/jbake/content/lot.adoc
index 3f9d7e1..a523637 100644
--- a/docs/upgrade-guide/src/main/jbake/content/lot.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/lot.adoc
@@ -5,12 +5,10 @@
prev=loe.html
~~~~~~
-List of Tables
-==============
+= List of Tables
[[list-of-tables]]
-List of Tables
---------------
+== List of Tables
* link:upgrade-compatibility-issues.html#gklho[1-1 GMS Administration
Console Settings Changes from 2.1.1 to 4.0]
diff --git a/docs/upgrade-guide/src/main/jbake/content/preface.adoc b/docs/upgrade-guide/src/main/jbake/content/preface.adoc
index e8b03ea..bbc87c6 100644
--- a/docs/upgrade-guide/src/main/jbake/content/preface.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/preface.adoc
@@ -5,15 +5,13 @@
prev=title.html
~~~~~~
-Preface
-=======
+= Preface
[[GSUPG00001]][[gkbei]]
[[preface]]
-Preface
--------
+== Preface
This guide explains how to upgrade to {productName} from previous
of GlassFish Server and Sun GlassFish Enterprise Server product releases.
@@ -56,8 +54,7 @@
[[GSUPG00020]][[ghpbz]]
[[glassfish-server-documentation-set]]
-Eclipse GlassFish Server Documentation Set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Eclipse GlassFish Server Documentation Set
The GlassFish Server documentation set describes deployment planning and
system installation. For an introduction to GlassFish Server, refer to
@@ -162,8 +159,7 @@
[[GSUPG00021]][[giprl]]
[[related-documentation]]
-Related Documentation
-~~~~~~~~~~~~~~~~~~~~~
+=== Related Documentation
The following tutorials explain how to develop Jakarta EE applications:
@@ -206,8 +202,7 @@
[[typographic-conventions]]
-Typographic Conventions
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Typographic Conventions
The following table describes the typographic changes that are used in
this book.
@@ -247,8 +242,7 @@
[[GSUPG00023]][[fquvc]]
[[symbol-conventions]]
-Symbol Conventions
-~~~~~~~~~~~~~~~~~~
+=== Symbol Conventions
The following table explains symbols that might be used in this book.
@@ -291,8 +285,7 @@
[[GSUPG00024]][[ghpfg]]
[[default-paths-and-file-names]]
-Default Paths and File Names
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Default Paths and File Names
The following table describes the default paths and file names that are
used in this book.
diff --git a/docs/upgrade-guide/src/main/jbake/content/title.adoc b/docs/upgrade-guide/src/main/jbake/content/title.adoc
index 8ca9fe4..ba687f2 100644
--- a/docs/upgrade-guide/src/main/jbake/content/title.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/title.adoc
@@ -5,12 +5,10 @@
prev=lot.html
~~~~~~
-Eclipse GlassFish Server Upgrade Guide, Release 7
-=================================================
+= Eclipse GlassFish Server Upgrade Guide, Release 7
[[eclipse-glassfish-server]]
-Eclipse GlassFish Server
-------------------------
+== Eclipse GlassFish Server
Upgrade Guide
diff --git a/docs/upgrade-guide/src/main/jbake/content/toc.adoc b/docs/upgrade-guide/src/main/jbake/content/toc.adoc
new file mode 100644
index 0000000..3669fd9
--- /dev/null
+++ b/docs/upgrade-guide/src/main/jbake/content/toc.adoc
@@ -0,0 +1,73 @@
+type=page
+status=published
+title=Eclipse GlassFish Server Upgrade Guide, Release 7
+next=title.html
+~~~~~~
+= Eclipse GlassFish Server Upgrade Guide, Release 7
+
+[[contents]]
+== Contents
+
+* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
+
+=== link:preface.html#GSUPG00001[Preface]
+
+** link:preface.html#GSUPG00020[Eclipse GlassFish Server Documentation Set]
+** link:preface.html#GSUPG00021[Related Documentation]
+** link:preface.html#typographic-conventions[Typographic Conventions]
+** link:preface.html#GSUPG00023[Symbol Conventions]
+** link:preface.html#GSUPG00024[Default Paths and File Names]
+
+[[glassfish-server-upgrade-compatibility-issues]]
+=== link:upgrade-compatibility-issues.html#GSUPG00002[1 GlassFish Server Upgrade Compatibility Issues]
+
+** link:upgrade-compatibility-issues.html#GSUPG00028[Binary-Compatible Releases For GlassFish Server 7]
+** link:upgrade-compatibility-issues.html#GSUPG00029[New Default Installation Directory]
+** link:upgrade-compatibility-issues.html#GSUPG00030[Changes to Group Management Service Settings]
+** link:upgrade-compatibility-issues.html#GSUPG00031[Application Client Interoperability]
+** link:upgrade-compatibility-issues.html#GSUPG00032[Node Agent Support]
+** link:upgrade-compatibility-issues.html#GSUPG00033[HADB and `hadbm` Command Support]
+** link:upgrade-compatibility-issues.html#GSUPG00034[Command Line Interface: The `asadmin` Command]
+*** link:upgrade-compatibility-issues.html#GSUPG00053[Deprecated `asadmin` Subcommands]
+*** link:upgrade-compatibility-issues.html#GSUPG00054[Deprecated, Unsupported, and Obsolete Options]
+** link:upgrade-compatibility-issues.html#GSUPG00035[Applications That Use Java DB]
+** link:upgrade-compatibility-issues.html#GSUPG00036[Applications That Use Persistence]
+** link:upgrade-compatibility-issues.html#GSUPG00037[HTTP Service to Network Service Changes]
+*** link:upgrade-compatibility-issues.html#GSUPG00055[Changes to Dotted Names]
+*** link:upgrade-compatibility-issues.html#GSUPG00056[Changes to `asadmin` Subcommands]
+*** link:upgrade-compatibility-issues.html#GSUPG00057[Remapping of HTTP Service Attributes and Properties]
+*** link:upgrade-compatibility-issues.html#GSUPG00058[New Network Service Elements and Attributes]
+** link:upgrade-compatibility-issues.html#GSUPG00038[NSS Cryptographic Token Support]
+
+[[upgrading-an-installation-of-application-server-or-glassfish-server]]
+=== link:upgrading-legacy-installation.html#GSUPG00003[2 Upgrading an Installation of Application Server or GlassFish Server]
+
+** link:upgrading-legacy-installation.html#GSUPG00039[Upgrade Overview]
+*** link:upgrading-legacy-installation.html#GSUPG00059[Upgrade Paths]
+*** link:upgrading-legacy-installation.html#GSUPG00060[Upgrade Terminology]
+*** link:upgrading-legacy-installation.html#GSUPG00061[Summary of Upgrade Tools and Procedures]
+*** link:upgrading-legacy-installation.html#GSUPG00062[Supported Releases for Upgrade to GlassFish Server 7]
+*** link:upgrading-legacy-installation.html#GSUPG00063[Upgrading From Version 8.x or Older Product Releases]
+*** link:upgrading-legacy-installation.html#GSUPG00065[Upgrading GlassFish Server Inside a Closed Network]
+** link:upgrading-legacy-installation.html#GSUPG00040[Performing a Side-By-Side Upgrade With Upgrade Tool]
+*** link:upgrading-legacy-installation.html#GSUPG00066[Upgrade Tool Summary]
+*** link:upgrading-legacy-installation.html#GSUPG00067[Upgrade Tool Functionality]
+*** link:upgrading-legacy-installation.html#GSUPG00010[To Upgrade From the Command Line Using Upgrade Tool]
+*** link:upgrading-legacy-installation.html#GSUPG00011[To Upgrade Using the Upgrade Tool Wizard]
+** link:upgrading-legacy-installation.html#GSUPG00041[Performing an In-Place Upgrade With the Update Center Tools]
+*** link:upgrading-legacy-installation.html#GSUPG00068[Update Center Tool Procedures]
+*** link:upgrading-legacy-installation.html#GSUPG00012[To Upgrade Using the Update Tool GUI]
+*** link:upgrading-legacy-installation.html#GSUPG00013[To Upgrade Using the Software Update Notifier]
+*** link:upgrading-legacy-installation.html#GSUPG00014[To Upgrade From the Command Line Using the `pkg` Utility]
+** link:upgrading-legacy-installation.html#GSUPG00042[Upgrading Installations That Use NSS Cryptographic Tokens]
+*** link:upgrading-legacy-installation.html#GSUPG00015[To Prepare for the Upgrade]
+*** link:upgrading-legacy-installation.html#GSUPG00016[To Perform Post-Upgrade Configuration]
+*** link:upgrading-legacy-installation.html#GSUPG00017[To Upgrade PKCS#11 Hardware Tokens]
+** link:upgrading-legacy-installation.html#GSUPG00043[Upgrading Clusters and Node Agent Configurations]
+*** link:upgrading-legacy-installation.html#GSUPG00069[Overview of Cluster and Node Agent Upgrade Procedures]
+*** link:upgrading-legacy-installation.html#GSUPG00018[To Correct the Configuration of a Node After an Upgrade]
+*** link:upgrading-legacy-installation.html#GSUPG00019[To Re-Create a Cluster]
+** link:upgrading-legacy-installation.html#GSUPG00044[Correcting Potential Upgrade Problems]
+*** link:upgrading-legacy-installation.html#GSUPG00070[Cluster Profile Security Setting]
+*** link:upgrading-legacy-installation.html#GSUPG00071[Cluster Profile Upgrade on Windows]
+*** link:upgrading-legacy-installation.html#GSUPG00072[`asupgrade` Fails Without Internet Connection]
diff --git a/docs/upgrade-guide/src/main/jbake/content/upgrade-compatibility-issues.adoc b/docs/upgrade-guide/src/main/jbake/content/upgrade-compatibility-issues.adoc
index f8e03db..c3de541 100644
--- a/docs/upgrade-guide/src/main/jbake/content/upgrade-compatibility-issues.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/upgrade-compatibility-issues.adoc
@@ -5,15 +5,13 @@
prev=preface.html
~~~~~~
-GlassFish Server Upgrade Compatibility Issues
-=============================================
+= GlassFish Server Upgrade Compatibility Issues
[[GSUPG00002]][[abmaq]]
[[glassfish-server-upgrade-compatibility-issues]]
-1 GlassFish Server Upgrade Compatibility Issues
------------------------------------------------
+== 1 GlassFish Server Upgrade Compatibility Issues
This section describes some compatibility issues between GlassFish
Server 7 and earlier product releases. This section also describes
@@ -38,8 +36,7 @@
[[gjwpd]][[GSUPG00028]][[binary-compatible-releases-for-glassfish-server]]
-Binary-Compatible Releases For GlassFish Server 7
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Binary-Compatible Releases For GlassFish Server 7
GlassFish Server Open Source Edition 7 is NOT binary-compatible with the
following earlier releases of the software:
@@ -67,8 +64,7 @@
[[gkric]][[GSUPG00029]][[new-default-installation-directory]]
-New Default Installation Directory
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New Default Installation Directory
The default GlassFish Server 7 installation directories are as follows:
@@ -88,8 +84,7 @@
[[gklhr]][[GSUPG00030]][[changes-to-group-management-service-settings]]
-Changes to Group Management Service Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Changes to Group Management Service Settings
The functionality of the Group Management Service (GMS) has not changed
since Sun GlassFish Enterprise Server v2.1.1, but the names of GMS
@@ -119,8 +114,7 @@
[[geyyk]][[GSUPG00031]][[application-client-interoperability]]
-Application Client Interoperability
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Application Client Interoperability
The Jakarta EE 6 platform specification imposes stricter requirements than
Jakarta EE 5 did on which JAR files can be visible to various modules
@@ -171,8 +165,7 @@
[[gktad]][[GSUPG00032]][[node-agent-support]]
-Node Agent Support
-~~~~~~~~~~~~~~~~~~
+=== Node Agent Support
GlassFish Server 7 does not support node agents. When updating from
installations of earlier product versions in which node agents were
@@ -183,8 +176,7 @@
[[gkrjm]][[GSUPG00033]][[hadb-and-hadbm-command-support]]
-HADB and `hadbm` Command Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== HADB and `hadbm` Command Support
GlassFish Server 7 does not support HADB or the `hadbm` management command.
@@ -198,8 +190,7 @@
[[abmbc]][[GSUPG00034]][[command-line-interface-the-asadmin-command]]
-Command Line Interface: The `asadmin` Command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Command Line Interface: The `asadmin` Command
The following sections describe changes to the command line utility `asadmin`:
@@ -211,8 +202,7 @@
[[abmbd]][[GSUPG00053]][[deprecated-asadmin-subcommands]]
-Deprecated `asadmin` Subcommands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deprecated `asadmin` Subcommands
In GlassFish Server 7, it is recommended that utility options of the
`asadmin` command precede the subcommand. Utility options are options
@@ -231,8 +221,7 @@
[[abmbf]][[GSUPG00054]][[deprecated-unsupported-and-obsolete-options]]
-Deprecated, Unsupported, and Obsolete Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Deprecated, Unsupported, and Obsolete Options
Options in link:#gaeki[Table 1-2] are deprecated or no longer supported,
or are obsolete and are ignored.
@@ -347,8 +336,7 @@
[[gflnv]][[GSUPG00035]][[applications-that-use-java-db]]
-Applications That Use Java DB
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Applications That Use Java DB
The directory location of Java DB in GlassFish Server 7 has changed
from its location in previous installations. Suppose that you have
@@ -377,8 +365,7 @@
[[gjizi]][[GSUPG00036]][[applications-that-use-persistence]]
-Applications That Use Persistence
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Applications That Use Persistence
GlassFish Server 7 and 3.0.1, and Sun GlassFish Enterprise Server v3
use the persistence provider EclipseLink, while earlier versions used
@@ -446,8 +433,7 @@
[[gjiqj]][[GSUPG00037]][[http-service-to-network-service-changes]]
-HTTP Service to Network Service Changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== HTTP Service to Network Service Changes
In GlassFish Server 7, most HTTP Service settings are defined in the
Network Service configuration that was introduced in Sun GlassFish
@@ -462,8 +448,7 @@
[[gipsa]][[GSUPG00055]][[changes-to-dotted-names]]
-Changes to Dotted Names
-^^^^^^^^^^^^^^^^^^^^^^^
+==== Changes to Dotted Names
The dotted name hierarchy for the HTTP Service configuration in
GlassFish Server 7 is shown below. Elements that are no longer
@@ -547,8 +532,7 @@
[[giprg]][[GSUPG00056]][[changes-to-asadmin-subcommands]]
-Changes to `asadmin` Subcommands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Changes to `asadmin` Subcommands
To accommodate the move of HTTP Service into the new Network Service
configuration, link:../reference-manual/asadmin.html#GSRFM00263[`asadmin`] subcommands are changed as
@@ -564,8 +548,7 @@
[[gipfo]][[GSUPG00057]][[remapping-of-http-service-attributes-and-properties]]
-Remapping of HTTP Service Attributes and Properties
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Remapping of HTTP Service Attributes and Properties
The following tables describe how attributes and properties in the HTTP
Service configuration for GlassFish Server 7 are remapped to
@@ -866,8 +849,7 @@
[[gipcg]][[GSUPG00058]][[new-network-service-elements-and-attributes]]
-New Network Service Elements and Attributes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== New Network Service Elements and Attributes
The following tables describe the Network Service elements and
attributes that were introduced in Sun GlassFish Enterprise Server v3.
@@ -1085,8 +1067,7 @@
[[gktkt]][[GSUPG00038]][[nss-cryptographic-token-support]]
-NSS Cryptographic Token Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== NSS Cryptographic Token Support
GlassFish Server 7 does not support Network Security Services (NSS)
cryptographic tokens. When upgrading to GlassFish Server 7 from
diff --git a/docs/upgrade-guide/src/main/jbake/content/upgrading-legacy-installation.adoc b/docs/upgrade-guide/src/main/jbake/content/upgrading-legacy-installation.adoc
index af0a5cc..acb1481 100644
--- a/docs/upgrade-guide/src/main/jbake/content/upgrading-legacy-installation.adoc
+++ b/docs/upgrade-guide/src/main/jbake/content/upgrading-legacy-installation.adoc
@@ -4,15 +4,13 @@
prev=upgrade-compatibility-issues.html
~~~~~~
-Upgrading an Installation of Application Server or GlassFish Server
-===================================================================
+= Upgrading an Installation of Application Server or GlassFish Server
[[GSUPG00003]][[abmbq]]
[[upgrading-an-installation-of-application-server-or-glassfish-server]]
-2 Upgrading an Installation of Application Server or GlassFish Server
----------------------------------------------------------------------
+== 2 Upgrading an Installation of Application Server or GlassFish Server
The Upgrade Tool that is bundled with GlassFish Server 7 replicates
the configuration of a previously installed server in the target
@@ -47,8 +45,7 @@
[[gaejc]][[GSUPG00039]][[upgrade-overview]]
-Upgrade Overview
-~~~~~~~~~~~~~~~~
+=== Upgrade Overview
The subsections that follow provide information that you will need when
you perform an upgrade.
@@ -64,8 +61,7 @@
[[gkxum]][[GSUPG00059]][[upgrade-paths]]
-Upgrade Paths
-^^^^^^^^^^^^^
+==== Upgrade Paths
There are two general paths you can use when upgrading to GlassFish
Server 7:
@@ -115,8 +111,7 @@
[[gdkiw]][[GSUPG00060]][[upgrade-terminology]]
-Upgrade Terminology
-^^^^^^^^^^^^^^^^^^^
+==== Upgrade Terminology
The following are important terms related to the upgrade process.
@@ -135,8 +130,7 @@
[[gktcb]][[GSUPG00061]][[summary-of-upgrade-tools-and-procedures]]
-Summary of Upgrade Tools and Procedures
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Summary of Upgrade Tools and Procedures
There are several tools you can use to upgrade from an earlier GlassFish
Server or Enterprise Server installation to GlassFish Server 7. The
@@ -153,8 +147,7 @@
[[gktdx]][[GSUPG00045]][[summary-of-tools-for-performing-an-upgrade]]
-Summary of Tools for Performing an Upgrade
-++++++++++++++++++++++++++++++++++++++++++
+===== Summary of Tools for Performing an Upgrade
There are several tools you can use to perform an upgrade to GlassFish
Server 7 are described below.
@@ -250,8 +243,7 @@
[[gktdz]][[GSUPG00046]][[summary-of-procedure-for-upgrading-with-upgrade-tool]]
-Summary of Procedure for Upgrading With Upgrade Tool
-++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Summary of Procedure for Upgrading With Upgrade Tool
The general procedure for using Upgrade Tool to perform an upgrade to
GlassFish Server 7 from any compatible older version of GlassFish
@@ -276,8 +268,7 @@
[[gktcl]][[GSUPG00047]][[summary-of-procedure-for-upgrading-with-update-tool]]
-Summary of Procedure for Upgrading With Update Tool
-+++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Summary of Procedure for Upgrading With Update Tool
The general procedure for using Update Tool to perform an upgrade to
GlassFish Server 7 from GlassFish Server 3.0.1 or Enterprise Server v3
@@ -298,8 +289,7 @@
[[gkuef]][[GSUPG00048]][[summary-of-procedure-for-upgrading-with-the-software-update-notifier]]
-Summary of Procedure for Upgrading With the Software Update Notifier
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Summary of Procedure for Upgrading With the Software Update Notifier
The general procedure for using the Software Update Notifier to perform
an upgrade to GlassFish Server 7 from GlassFish Server3.0.1 or
@@ -321,8 +311,7 @@
[[gktnb]][[GSUPG00049]][[summary-of-procedure-for-upgrading-with-the-pkg-utility]]
-Summary of Procedure for Upgrading With the `pkg` Utility
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+===== Summary of Procedure for Upgrading With the `pkg` Utility
The general procedure for using the `pkg` utility to perform an upgrade
to GlassFish Server 7 from GlassFish Server3.0.1 or Enterprise Server
@@ -342,8 +331,7 @@
[[gjxkx]][[GSUPG00062]][[supported-releases-for-upgrade-to-glassfish-server-7]]
-Supported Releases for Upgrade to GlassFish Server 7
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Supported Releases for Upgrade to GlassFish Server 7
Upgrades to GlassFish Server 7 are supported from the following
earlier GlassFish Server product releases:
@@ -356,8 +344,7 @@
[[gkufi]][[GSUPG00063]][[upgrading-from-version-8.x-or-older-product-releases]]
-Upgrading From Version 8.x or Older Product Releases
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Upgrading From Version 8.x or Older Product Releases
It is not possible to upgrade to GlassFish Server 7 directly from Sun
GlassFish Enterprise Server 8.x or older product releases.
@@ -387,8 +374,7 @@
[[gkxrp]][[GSUPG00065]][[upgrading-glassfish-server-inside-a-closed-network]]
-Upgrading GlassFish Server Inside a Closed Network
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Upgrading GlassFish Server Inside a Closed Network
For instructions on upgrading a GlassFish Server installation in an
environment where Internet access is not available, see
@@ -398,8 +384,7 @@
[[abmbr]][[GSUPG00040]][[performing-a-side-by-side-upgrade-with-upgrade-tool]]
-Performing a Side-By-Side Upgrade With Upgrade Tool
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Performing a Side-By-Side Upgrade With Upgrade Tool
This section explains how to use Upgrade Tool to perform a side-by-side
upgrade to GlassFish Server 7 from any compatible older product release.
@@ -413,8 +398,7 @@
[[gktgx]][[GSUPG00066]][[upgrade-tool-summary]]
-Upgrade Tool Summary
-^^^^^^^^^^^^^^^^^^^^
+==== Upgrade Tool Summary
The Upgrade Tool upgrades your domain configurations and deployed
applications. When you use the Upgrade Tool, the source server and the
@@ -433,8 +417,7 @@
[[gdkix]][[GSUPG00067]][[upgrade-tool-functionality]]
-Upgrade Tool Functionality
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Upgrade Tool Functionality
The Upgrade Tool migrates the configurations and deployed applications
from an earlier version of Sun Java System Application Server or Sun
@@ -457,8 +440,7 @@
[[gebrv]][[GSUPG00050]][[migration-of-deployed-applications]]
-Migration of Deployed Applications
-++++++++++++++++++++++++++++++++++
+===== Migration of Deployed Applications
Application archives (EAR files) and component archives (JAR, WAR, and
RAR files) that are deployed in the source server do not require any
@@ -489,8 +471,7 @@
[[gebqm]][[GSUPG00051]][[upgrade-of-clusters]]
-Upgrade of Clusters
-+++++++++++++++++++
+===== Upgrade of Clusters
When upgrading from a clustered configuration, the older cluster
information is retained in a new `domain.xml` file in the GlassFish
@@ -501,8 +482,7 @@
[[gebvn]][[GSUPG00052]][[upgrade-verification]]
-Upgrade Verification
-++++++++++++++++++++
+===== Upgrade Verification
An upgrade log records the upgrade activity. The upgrade log file is
named `upgrade.log` and is created in the working directory from which
@@ -521,8 +501,7 @@
[[gktjn]][[GSUPG00010]][[to-upgrade-from-the-command-line-using-upgrade-tool]]
-To Upgrade From the Command Line Using Upgrade Tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade From the Command Line Using Upgrade Tool
This procedure explains how to use the Upgrade Tool command line to
upgrade to GlassFish Server 7 from any supported older product
@@ -702,8 +681,7 @@
[[gaejn]][[GSUPG00011]][[to-upgrade-using-the-upgrade-tool-wizard]]
-To Upgrade Using the Upgrade Tool Wizard
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade Using the Upgrade Tool Wizard
This procedure explains how to use the graphical Upgrade Tool Wizard to
upgrade to GlassFish Server 7 from any supported older product
@@ -835,8 +813,7 @@
[[gkthu]][[GSUPG00041]][[performing-an-in-place-upgrade-with-the-update-center-tools]]
-Performing an In-Place Upgrade With the Update Center Tools
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Performing an In-Place Upgrade With the Update Center Tools
This section explains how to use the three Update Center tools to
perform an in-place upgrade to GlassFish Server 7 from GlassFish
@@ -865,8 +842,7 @@
[[gkthx]][[GSUPG00068]][[update-center-tool-procedures]]
-Update Center Tool Procedures
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Update Center Tool Procedures
Unlike when using Upgrade Tool, when you use the Update Tool, the
Software Update Notifier, or the `pkg` utility to perform a GlassFish
@@ -886,8 +862,7 @@
[[gktjf]][[GSUPG00012]][[to-upgrade-using-the-update-tool-gui]]
-To Upgrade Using the Update Tool GUI
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade Using the Update Tool GUI
This procedure explains how to use the graphical Update Tool to perform
an in-place upgrade to GlassFish Server 7 from GlassFish Server 3.0.1
@@ -940,8 +915,7 @@
[[gkuhu]][[GSUPG00013]][[to-upgrade-using-the-software-update-notifier]]
-To Upgrade Using the Software Update Notifier
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade Using the Software Update Notifier
This procedure explains how to use the Software Update Notifier to
perform an in-place upgrade to GlassFish Server 7 from GlassFish
@@ -1004,8 +978,7 @@
[[gktks]][[GSUPG00014]][[to-upgrade-from-the-command-line-using-the-pkg-utility]]
-To Upgrade From the Command Line Using the `pkg` Utility
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade From the Command Line Using the `pkg` Utility
This procedure explains how to use the `pkg` utility to perform an
in-place upgrade to GlassFish Server 7 from GlassFish Server 3.0.1 or
@@ -1058,8 +1031,7 @@
[[gktnh]][[GSUPG00042]][[upgrading-installations-that-use-nss-cryptographic-tokens]]
-Upgrading Installations That Use NSS Cryptographic Tokens
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading Installations That Use NSS Cryptographic Tokens
GlassFish Server v2.x EE (Enterprise Edition) uses Network Security
Services (NSS) for cryptographic software tokens. GlassFish Server 7
@@ -1074,8 +1046,7 @@
[[gktnq]][[GSUPG00015]][[to-prepare-for-the-upgrade]]
-To Prepare for the Upgrade
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Prepare for the Upgrade
This procedure explains how to prepare for modifying an NSS-based
GlassFish Server 2.x installation when upgrading to GlassFish Server 7.
@@ -1155,8 +1126,7 @@
[[gktlz]][[GSUPG00016]][[to-perform-post-upgrade-configuration]]
-To Perform Post-Upgrade Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Perform Post-Upgrade Configuration
These instructions explain the post-upgrade configuration steps that
must be performed when upgrading from an NSS-based installation to
@@ -1307,8 +1277,7 @@
[[gktlp]][[GSUPG00017]][[to-upgrade-pkcs11-hardware-tokens]]
-To Upgrade PKCS#11 Hardware Tokens
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Upgrade PKCS#11 Hardware Tokens
If you are using GlassFish Server v2.x Enterprise Edition with Hardware
Tokens (for example, FIPS-140 compliant Sun Cryptographic Accelerator
@@ -1357,8 +1326,7 @@
[[gfybw]][[GSUPG00043]][[upgrading-clusters-and-node-agent-configurations]]
-Upgrading Clusters and Node Agent Configurations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Upgrading Clusters and Node Agent Configurations
This section explains additional steps you need to perform when
upgrading cluster and node agent configurations from Application Server
@@ -1384,8 +1352,7 @@
[[gkyda]][[GSUPG00069]][[overview-of-cluster-and-node-agent-upgrade-procedures]]
-Overview of Cluster and Node Agent Upgrade Procedures
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Overview of Cluster and Node Agent Upgrade Procedures
The general steps for upgrading a cluster and node agent configuration
so it will work in GlassFish Server 7 are as follows:
@@ -1407,8 +1374,7 @@
[[gktle]][[GSUPG00018]][[to-correct-the-configuration-of-a-node-after-an-upgrade]]
-To Correct the Configuration of a Node After an Upgrade
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== To Correct the Configuration of a Node After an Upgrade
As part of the upgrade process, node agent elements in the DAS
configuration are transformed into GlassFish Server node elements of
@@ -1550,8 +1516,7 @@
[[gktkx]][[GSUPG00019]][[to-re-create-a-cluster]]
-To Re-Create a Cluster
-^^^^^^^^^^^^^^^^^^^^^^
+==== To Re-Create a Cluster
This procedure explains how to re-create a clustered GlassFish Server or
Enterprise Server configuration for GlassFish Server 7.
@@ -1660,8 +1625,7 @@
[[gkrfh]][[GSUPG00044]][[correcting-potential-upgrade-problems]]
-Correcting Potential Upgrade Problems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Correcting Potential Upgrade Problems
This section addresses issues that can occur during an upgrade to
GlassFish Server 7.
@@ -1674,8 +1638,7 @@
[[gkrgh]][[GSUPG00070]][[cluster-profile-security-setting]]
-Cluster Profile Security Setting
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Cluster Profile Security Setting
When upgrading a clustered domain configuration from Application Server
9.1 or Enterprise Server v2 to GlassFish Server 7, you may encounter
@@ -1715,8 +1678,7 @@
[[gkrib]][[GSUPG00071]][[cluster-profile-upgrade-on-windows]]
-Cluster Profile Upgrade on Windows
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Cluster Profile Upgrade on Windows
On Windows, when you upgrade cluster profile domains, you could
encounter the following error:
@@ -1731,8 +1693,7 @@
[[gkyho]][[GSUPG00072]][[asupgrade-fails-without-internet-connection]]
-`asupgrade` Fails Without Internet Connection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== `asupgrade` Fails Without Internet Connection
This problem only occurs when using GlassFish Server 3.1 Upgrade Tool to
perform a side-by-side upgrade on a 2.x domain without an Internet