Skip to content

Commit

Permalink
Issue #24070 Remaining manual fixes
Browse files Browse the repository at this point in the history
- typos in references, missing labels, etc.

Signed-off-by: David Matějček <david.matejcek@omnifish.ee>
  • Loading branch information
dmatej committed Aug 10, 2022
1 parent d237c6f commit 915a94b
Show file tree
Hide file tree
Showing 27 changed files with 216 additions and 243 deletions.
Expand Up @@ -7,7 +7,6 @@ prev=adding-monitoring-capabilities.html

= 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
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=adding-configuration-data.html

= Adding Container Capabilities

[[adding-container-capabilities]]
== Adding Container Capabilities

Applications run on {productName} in containers. {productName}
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=extending-asadmin.html

= Adding Monitoring Capabilities

[[adding-monitoring-capabilities]]
== Adding Monitoring Capabilities

Monitoring is the process of reviewing the statistics of a system to
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=extending-the-admin-console.html

= Extending the asadmin Utility

[[extending-the-asadmin-utility]]
== Extending the `asadmin` Utility

The `asadmin` utility is a command-line tool for configuring and
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=writing-hk2-components.html

= Extending the Administration Console

[[extending-the-administration-console]]
== Extending the Administration Console

The Administration Console is a browser-based tool for administering
Expand Down
Expand Up @@ -22,12 +22,10 @@ the `asadmin` utility.

The following topics are addressed here:

* xref:#glassfish-server-modular-architecture-and-add-on-components[{productName} Modular Architecture and Add-On
Components]
* xref:#osgi-alliance-module-management-subsystem[OSGi Alliance Module Management Subsystem]
* xref:#hundred-kilobyte-kernel[Hundred-Kilobyte Kernel]
* xref:#overview-of-the-development-process-for-an-add-on-component[Overview of the Development Process for an Add-On
Component]
* <<{productName} Modular Architecture and Add-On Components>>
* <<OSGi Alliance Module Management Subsystem>>
* <<Hundred-Kilobyte Kernel>>
* <<Overview of the Development Process for an Add-On Component>>

[[glassfish-server-modular-architecture-and-add-on-components]]

Expand All @@ -50,8 +48,7 @@ has the following characteristics:

* The component provides a set of Java classes.
* The component offers services and public interfaces.
* The component implements the public interfaces with a set of private
classes.
* The component implements the public interfaces with a set of private classes.
* The component depends on other components.

Add-on components that you develop interact with {productName} in the
Expand Down Expand Up @@ -125,16 +122,14 @@ monitoring data, it must provide that data to users through {productName} admini
To develop add-on components that meet these requirements, follow the
development process that is described in the following sections:

* xref:#writing-hk2-components[Writing HK2 Components]
* xref:#extending-the-administration-console[Extending the Administration Console]
* xref:#extending-the-asadmin-utility[Extending the `asadmin` Utility]
* xref:#adding-monitoring-capabilities[Adding Monitoring Capabilities]
* xref:#adding-configuration-data-for-a-component[Adding Configuration Data for a Component]
* xref:#adding-container-capabilities[Adding Container Capabilities]
* xref:#creating-a-session-persistence-module[Creating a Session Persistence Module]
* xref:#packaging-and-delivering-an-add-on-component[Packaging and Delivering an Add-On Component]

[[writing-hk2-components]]
* <<Writing HK2 Components>>
* <<Extending the Administration Console]
* <<Extending the `asadmin` Utility]
* <<Adding Monitoring Capabilities>>
* <<Adding Configuration Data for a Component>>
* <<Adding Container Capabilities>>
* <<Creating a Session Persistence Module>>
* <<Packaging and Delivering an Add-On Component>>

==== Writing HK2 Components

Expand All @@ -149,8 +144,6 @@ service implements an HK2 contract.
For more information, see xref:writing-hk2-components.adoc#writing-hk2-components[Writing
HK2 Components].

[[extending-the-administration-console]]

==== Extending the Administration Console

The Administration Console is a browser-based tool for administering
Expand All @@ -168,8 +161,6 @@ For more information, see
xref:extending-the-admin-console.adoc#extending-the-administration-console[Extending the Administration
Console].

[[extending-the-asadmin-utility]]

==== Extending the `asadmin` Utility

The `asadmin` utility is a command-line tool for configuring and
Expand All @@ -183,8 +174,6 @@ link:reference-manual/asadmin.html#asadmin[`asadmin`(1M)] man page.
For more information, see xref:extending-asadmin.adoc#extending-the-asadmin-utility[Extending the
`asadmin` Utility].

[[adding-monitoring-capabilities]]

==== Adding Monitoring Capabilities

Monitoring is the process of reviewing the statistics of a system to
Expand All @@ -203,10 +192,7 @@ interfaces to monitor statistics from any installed {productName}
component, regardless of the origin of the component.

For more information, see
xref:adding-monitoring-capabilities.adoc#adding-monitoring-capabilities[Adding Monitoring
Capabilities].

[[adding-configuration-data-for-a-component]]
xref:adding-monitoring-capabilities.adoc#adding-monitoring-capabilities[Adding Monitoring Capabilities].

==== Adding Configuration Data for a Component

Expand All @@ -223,10 +209,8 @@ configure an add-on component in the same way as they can configure
other {productName} components.

For more information, see
xref:adding-configuration-data.adoc#adding-configuration-data-for-a-component[Adding Configuration Data for a
Component].

[[adding-container-capabilities]]
xref:adding-configuration-data.adoc#adding-configuration-data-for-a-component[
Adding Configuration Data for a Component].

==== Adding Container Capabilities

Expand All @@ -237,10 +221,7 @@ you to run new types of applications and to deploy new archive types in
{productName}.

For more information, see
xref:adding-container-capabilities.adoc#adding-container-capabilities[Adding Container
Capabilities].

[[creating-a-session-persistence-module]]
xref:adding-container-capabilities.adoc#adding-container-capabilities[Adding Container Capabilities].

==== Creating a Session Persistence Module

Expand All @@ -260,8 +241,6 @@ For more information, see
xref:session-persistence-modules.adoc#creating-a-session-persistence-module[Creating a Session
Persistence Module].

[[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
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=adding-container-capabilities.html

= Creating a Session Persistence Module

[[creating-a-session-persistence-module]]
== Creating a Session Persistence Module

{productName} enables you to create a session persistence module in
Expand Down
Expand Up @@ -7,7 +7,6 @@ prev=introduction.html

= Writing HK2 Components

[[writing-hk2-components]]
== Writing HK2 Components

The Hundred-Kilobyte Kernel (HK2) is the lightweight and extensible
Expand Down
Expand Up @@ -703,7 +703,7 @@ link:reference-manual/set-log-file-format.html#set-log-file-format[`set-log-file
link:reference-manual/set-log-levels.html#set-log-levels[`set-log-levels`]::
Sets the log level for a module. Supported in remote mode only. For
procedural information in this guide, see
xref:logging.adoc#gklml[Setting Log Levels].
xref:logging.adoc#setting-log-levels[Setting Log Levels].

[[orb-subcommands]]

Expand Down
Expand Up @@ -740,7 +740,7 @@ active configuration of a module.
2. Display the current active configuration of a module by using the
link:reference-manual/create-jdbc-resource.html#create-jdbc-resource[`get-active-module-config`] subcommand.

[[GSADG1104]]
[[ex-dcacm]]
Example 2-20 Displaying the Current Active Configuration of a Module

This example displays the current active configuration of the JMS
Expand Down
22 changes: 9 additions & 13 deletions docs/administration-guide/src/main/asciidoc/jdbc.adoc
Expand Up @@ -570,8 +570,7 @@ following topics address several of these features:
* <<Statement Tracing>>

[[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
Expand Down Expand Up @@ -610,7 +609,7 @@ retried.

[[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
Expand All @@ -635,7 +634,7 @@ asadmin set domain1.resources.jdbc-connection-pool.DerbyPool.init-sql="sql-strin

[[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
Expand All @@ -657,7 +656,7 @@ link:reference-manual/create-jdbc-connection-pool.html#create-jdbc-connection-po

[[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
Expand All @@ -680,8 +679,7 @@ subcommand. For example:
asadmin set resources.jdbc-connection-pool.pool-name.statement-leak-timeout-in-seconds=300
----

When selecting a value for Statement Leak Timeout In Seconds, make sure
that:
When selecting a value for Statement Leak Timeout In Seconds, make sure that:

* It is less than the Connection Leak Timeout; otherwise, the connection
could be closed before the statement leak is recognized.
Expand All @@ -705,7 +703,7 @@ asadmin set resources.jdbc-connection-pool.pool-name.statement-leak-reclaim=true

[[statement-caching]]

Statement Caching
====== Statement Caching

Statement caching stores statements, prepared statements, and callable
statements that are executed repeatedly by applications in a cache,
Expand Down Expand Up @@ -739,7 +737,7 @@ the statement cache are recreated.

[[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
Expand Down Expand Up @@ -865,15 +863,13 @@ database might be specified as `jdbc/payrolldb`.
Before You Begin

Before creating a JDBC resource, you must first create a JDBC connection
pool. For instructions, see xref:#to-create-a-jdbc-connection-pool[To Create a JDBC Connection
Pool].
pool. For instructions, see xref:#to-create-a-jdbc-connection-pool[To Create a JDBC Connection Pool].

1. Ensure that the server is running. Remote subcommands require a running server.
2. Create a JDBC resource by using the
link:reference-manual/create-jdbc-resource.html#create-jdbc-resource[`create-jdbc-resource`] subcommand.
+
Information about properties for the subcommand is included in this help
page.
Information about properties for the subcommand is included in this help page.
3. If necessary, notify users that the new resource has been created.

[[ggplj]]
Expand Down
2 changes: 1 addition & 1 deletion docs/administration-guide/src/main/asciidoc/loe.adoc
Expand Up @@ -32,7 +32,7 @@ Utility Option and a Subcommand Option in Single Mode]
* xref:general-administration.adoc#ggovp[2-15 Creating a System Property]
* xref:general-administration.adoc#ggopn[2-16 Listing System Properties]
* xref:general-administration.adoc#ggoph[2-17 Deleting a System Property]
* xref:general-administration.adoc#sthref12[2-18 Adding Module Configuration to domain.xml]
* xref:general-administration.adoc#GSADG1098[2-18 Adding Module Configuration to domain.xml]
* xref:general-administration.adoc#ex-rmcfd[2-19 Removing Module Configuration From domain.xml]
* xref:general-administration.adoc#ex-dcacm[2-20 Displaying the Current Active Configuration of a Module]
* xref:general-administration.adoc#ggozc[2-21 Adding Resources]
Expand Down
6 changes: 3 additions & 3 deletions docs/administration-guide/src/main/asciidoc/webapps.adoc
Expand Up @@ -237,7 +237,7 @@ the network listener attribute `jk-enabled`.
* `apache2/conf/httpd.conf`, the main Apache configuration file
* `apache2/conf/workers.properties`
+
<<Example 6-4] and xref:#gixqt[Example 6-5>> provide examples
xref:gixrq[Example 6-4] and xref:gixqt[Example 6-5] provide examples
of configuring these two files.
3. Start Apache HTTP Server (`httpd`).
4. Start {productName} with at least one web application deployed.
Expand Down Expand Up @@ -307,7 +307,7 @@ Example 6-5 `workers.properties` File for `mod_jk`

This example shows a `workers.properties` that is set for `mod_jk`. This
`workers.properties` file is referenced in the second line of
<<Example 6-4>>.
xref:gixrq[Example 6-4]

[source]
----
Expand Down Expand Up @@ -347,7 +347,7 @@ configured with a unique `jvmRoute` system property.
If your instances run on the same machine, you must choose different JK
ports. The ports must match `worker.worker*.port` in your
`workers.properties` file. See the properties file in
<<Example 6-5>>.
xref:gixqt[Example 6-5].
2. On each of the instances, create the `jvmRoute` system property of
{productName} by using the link:reference-manual/create-jvm-options.html#create-jvm-options[`create-jvm-options`]
subcommand.
Expand Down

0 comments on commit 915a94b

Please sign in to comment.