Skip to content

Commit

Permalink
Extract help files to new module
Browse files Browse the repository at this point in the history
  • Loading branch information
@pzygielo
pzygielo committed Sep 10, 2022
1 parent c6cea44 commit 0bf3c03
Show file tree
Hide file tree
Showing 49 changed files with 2,849 additions and 0 deletions.
45 changes: 45 additions & 0 deletions mq/main/helpfiles/pom.xml
View file
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2022 Contributors to the Eclipse Foundation
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.glassfish.mq</groupId>
<artifactId>mq</artifactId>
<version>6.4.0-SNAPSHOT</version>
</parent>

<artifactId>helpfiles</artifactId>

<name>MQ Help Files</name>

<build>
<plugins>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<addMavenDescriptor>false</addMavenDescriptor>
</archive>
</configuration>
</plugin>
</plugins>
</build>
</project>
34 changes: 34 additions & 0 deletions mq/main/helpfiles/src/main/resources/Master.hs
View file
@@ -0,0 +1,34 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE helpset PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN"
"http://java.sun.com/products/javahelp/helpset_1_0.dtd">
<!--

Copyright (c) 2000-2017 Oracle and/or its affiliates. All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.

SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->

<helpset version="1.0" xml:lang="en">
<title>Oracle GlassFish(tm) Server Message Queue Administration Console Help</title>
<maps>
<homeID>overview</homeID>
<mapref location="en/Master.jhm"/>
</maps>
<view>
<name>TOC</name>
<label>Table of Contents</label>
<type>javax.help.TOCView</type>
<data>en/MasterTOC.xml</data>
</view>
</helpset>
64 changes: 64 additions & 0 deletions mq/main/helpfiles/src/main/resources/en/Master.jhm
View file
@@ -0,0 +1,64 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN"
"http://java.sun.com/products/javahelp/map_1_0.dtd">
<!--
Copyright (c) 2010-2017 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->

<map version="1.0">
<mapID target="add_destination_obj" url="add_destination_obj.htm"/>
<mapID target="add_connfact_handling_htm" url="add_connfact_handling.htm"/>
<mapID target="broker_configuration" url="broker_configuration.htm"/>
<mapID target="add_connfact_rel_htm" url="add_connfact_rel.htm"/>
<mapID target="broker_config_logging_htm" url="broker_config_logging.htm"/>
<mapID target="add_broker" url="add_broker.htm"/>
<mapID target="add_broker_destination" url="add_broker_destination.htm"/>
<mapID target="add_connfact_handling_old_htm" url="add_connfact_handling_old.htm"/>
<mapID target="connfact_jmsx_htm" url="connfact_jmsx.htm"/>
<mapID target="IMQ_INDEX" url="imq_index.htm"/>
<mapID target="connfact_rel_htm" url="connfact_rel.htm"/>
<mapID target="connfact_clientid_htm" url="connfact_clientid.htm"/>
<mapID target="broker_destination_properties" url="broker_destination_properties.htm"/>
<mapID target="BROKER_INDEX" url="broker_index.htm"/>
<mapID target="broker_dest_basic_htm" url="broker_dest_basic.htm"/>
<mapID target="add_connfact_queue_htm" url="add_connfact_queue.htm"/>
<mapID target="add_object_store" url="add_object_store.htm"/>
<mapID target="conndis_broker" url="conndis_broker.htm"/>
<mapID target="object_store_properties" url="object_store_properties.htm"/>
<mapID target="OS_INDEX" url="os_index.htm"/>
<mapID target="connfact_queue_htm" url="connfact_queue.htm"/>
<mapID target="add_connection_fact" url="add_connection_fact.htm"/>
<mapID target="connection_factory_prop" url="connection_factory_prop.htm"/>
<mapID target="overview" url="overview.htm"/>
<mapID target="broker_dest_durable_htm" url="broker_dest_durable.htm"/>
<mapID target="add_connfact_jmsx_htm" url="add_connfact_jmsx.htm"/>
<mapID target="service_properties" url="service_properties.htm"/>
<mapID target="connfact_handling_htm" url="connfact_handling.htm"/>
<mapID target="add_connfact_clientid_htm" url="add_connfact_clientid.htm"/>
<mapID target="broker_information" url="broker_information.htm"/>
<mapID target="destination_obj_properties" url="destination_obj_properties.htm"/>
<mapID target="broker_config_messaging_htm" url="broker_config_messaging.htm"/>
<mapID target="conndis_object_store" url="conndis_object_store.htm"/>
<mapID target="connfact_handling_old_htm" url="connfact_handling_old.htm"/>
<mapID target="broker_config_basic_htm" url="broker_config_basic.htm"/>
<mapID target="add_connfact_message_header_overrides_htm" url="add_connfact_message_header_overrides.htm"/>
<mapID target="connfact_message_header_overrides_htm" url="connfact_message_header_overrides.htm"/>
<mapID target="message_server_syntax_htm" url="message_server_syntax.htm"/>
<mapID target="IMQ_TOP_FOLDER_IMG" url="../images/AppIcon16xCDE.gif"/>
<mapID target="OBJSTORE_TOP_FOLDER_IMG" url="../images/ObjectStore16x.gif"/>
<mapID target="BROKER_TOP_FOLDER_IMG" url="../images/Broker16X.gif"/>
</map>
67 changes: 67 additions & 0 deletions mq/main/helpfiles/src/main/resources/en/MasterTOC.xml
View file
@@ -0,0 +1,67 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN"
"http://java.sun.com/products/javahelp/toc_1_0.dtd">
<!--
Copyright (c) 2000-2017 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->

<toc version="1.0">
<tocitem image="IMQ_TOP_FOLDER_IMG" text="Message Queue Administration Console" target="IMQ_INDEX">
<tocitem text="Overview" target="overview" />
</tocitem>
<tocitem image="OBJSTORE_TOP_FOLDER_IMG" text="Message Queue Object Store Management" target="OS_INDEX">
<tocitem text="Add Object Store" target="add_object_store" />
<tocitem text="Object Store Properties" target="object_store_properties" />
<tocitem text="Connect/Disconnect Object Store" target="conndis_object_store" />
<tocitem text="Add Destination Object" target="add_destination_obj" />
<tocitem text="Destination Object Properties" target="destination_obj_properties" />
<tocitem text="Add Connection Factory Object" target="add_connection_fact">
<tocitem text="Reliability and Flow Control" target="add_connfact_rel_htm" />
<tocitem text="QueueBrowsers and ServerSessions" target="add_connfact_queue_htm" />
<tocitem text="Connection Handling" target="add_connfact_handling_htm" />
<tocitem text="Client Identification" target="add_connfact_clientid_htm" />
<tocitem text="JMSX Properties" target="add_connfact_jmsx_htm" />
<tocitem text="Message Header Overrides" target="add_connfact_message_header_overrides_htm" />
<tocitem text="3.0 Connection Handling" target="add_connfact_handling_old_htm" />
</tocitem>
<tocitem text="Connection Factory Object Properties" target="connection_factory_prop">
<tocitem text="Reliability and Flow Control" target="connfact_rel_htm" />
<tocitem text="QueueBrowsers and ServerSessions" target="connfact_queue_htm" />
<tocitem text="Connection Handling" target="connfact_handling_htm" />
<tocitem text="Client Identification" target="connfact_clientid_htm" />
<tocitem text="JMSX Properties" target="connfact_jmsx_htm" />
<tocitem text="Message Header Overrides" target="connfact_message_header_overrides_htm" />
<tocitem text="3.0 Connection Handling" target="connfact_handling_old_htm" />
</tocitem>
</tocitem>
<tocitem image="BROKER_TOP_FOLDER_IMG" text="Message Queue Broker Management" target="BROKER_INDEX">
<tocitem text="Add Broker" target="add_broker" />
<tocitem text="Broker Properties" target="broker_information" />
<tocitem text="Connect/Disconnect Broker" target="conndis_broker" />
<tocitem text="Query/Update Broker" target="broker_configuration">
<tocitem text="Basic" target="broker_config_basic_htm" />
<tocitem text="Logging" target="broker_config_logging_htm" />
<tocitem text="Messaging" target="broker_config_messaging_htm" />
</tocitem>
<tocitem text="Add Broker Destination" target="add_broker_destination" />
<tocitem text="Destination Properties" target="broker_destination_properties">
<tocitem text="Basic" target="broker_dest_basic_htm" />
<tocitem text="Durable Subscriptions" target="broker_dest_durable_htm" />
</tocitem>
<tocitem text="Service Properties" target="service_properties" />
</tocitem>
</toc>
88 changes: 88 additions & 0 deletions mq/main/helpfiles/src/main/resources/en/add_broker.htm
View file
@@ -0,0 +1,88 @@
<!--
Copyright (c) 2000-2017 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->

<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<title>add broker</title>
<link rel="StyleSheet" href="ide.css">
</head>
<body>
<h2>Add Broker</h2>

<p>Use this dialog to create a representation of a broker in the administration
console's navigational pane. You do not have to start the broker to do this.
You will need to start the broker before you can connect to it.</p>

<p><b>Broker Label</b> Specifies the name you would like displayed for this broker
in the administration console's navigational pane. This name does not have to
be the same as the broker's instance name.</p>

<p><b>Host</b> Specifies the name of the machine hosting this broker or leave
the default value of <code>localhost</code>.</p>

<p><b>Primary Port</b> Specifies the number of the port assigned to the port mapper.
By default this is 7676. The combination of the host name and primary port number
uniquely identifies the broker. To run two instances of a broker on the same
server, each broker's Port Mapper must have a different port number.</p>

<p><b>Username</b> Specifies your user name. By default, this is <code>admin</code>
for the administrator. This information is used to authenticate you when you
try to connect to the broker. Entering it in this dialog is not secure. If you
are concerned about security, you should wait until connection-time when you
will be prompted for this information.</p>

<p><b>Password</b> Specifies your user password. By default, this is <code>admin</code>
for the administrator. This information is used to authenticate you when you
try to connect to the broker. Entering it in this dialog is not secure. If you
are concerned about security, you should wait until connection-time when you
will be prompted for this information.</p>

<ul>
<li>Use the <b>OK</b> button to commit all the entered information and add the broker.
</ul>
<p>To connect to the broker that you have added:</p>

<ol>
<li>Select the broker in the administration console's navigational pane.</li>
<li>Choose <b>Actions &gt; Connect to Broker</b>.</li>
</ol>

<p>To query and/or update a running broker:</p>

<ol>
<li>Select the broker in the administration console's navigational pane.</li>
<li>Connect to it if it is not already connected.
<li>Choose <b>Actions &gt; Query/Update Broker.</b></li>
</ol>

<p>To change the information you have specified in this dialog for a particular
broker, you must do the following: </p>

<ol>
<li>Select the broker in the navigational pane.</li>
<li>Disconnect the broker if it isn't already disconnected. A broker is disconnected
if its icon in the navigational pane looks like: <img src="../images/BrokerX16X.gif" alt="broker icon with super-imposed x"><br>
To disconnect a broker, choose <b>Actions &gt; Disconnect from Broker</b></li>
<li>Choose <b>Actions &gt; Properties</b> to open the Broker Properties dialog.</li>
</ol>

<p>&nbsp;</p>

</body>
</html>
90 changes: 90 additions & 0 deletions mq/main/helpfiles/src/main/resources/en/add_broker_destination.htm
View file
@@ -0,0 +1,90 @@
<!--
Copyright (c) 2000-2017 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<TITLE>add broker destination</TITLE>
<LINK rel="StyleSheet" href="ide.css">

</HEAD>
<BODY>
<H2>Add Broker Destination</H2>

<P>Use this dialog to create and configure a physical destination on a broker.
The <i>destination</i> on the broker is a location in the broker's physical
memory where incoming messages are marshalled before being routed to message
consumers. </P>
<P>Message Queue messaging is implemented as a two-phase delivery of messages: first the
message is delivered from a producer to a <i>destination</i> on the broker;
second, the message is delivered from the destination on the broker to one or
more consumers. </P>
<P>A broker can be configured to dynamically create physical destinations if you
have not created them. These autocreated destinations are automatically destroyed
by the broker when they are no longer needed.</P>
<P>To configure a physical destination, set the following attribute values:</P>
<P><b>Destination Name</b> Specifies the name of the physical destination.</P>
<P><b>Destination Type</b> Specifies the destination type (queue or topic). Click
the <b>Queue</b> or <b>Topic</b> radio button. </P>

<P><b>Max Number of Messages</b> Specifies the maximum number of unconsumed messages
allowed in this destination. </P>
<p><b>Max Total Message Bytes </b> Specifies the maximum total amount of memory
allowed for unconsumed messages in this destination. Use the drop down list
to select the unit of measurement: bytes, kbytes, or megabytes.</p>
<p><b>Max Bytes per Message</b> Specifies the maximum size of any single message
allowed in this destination. Use the drop down list to select the unit of measurement:
bytes, kbytes, or megabytes.</p>
<p><b>Max Number of Producers</b> Specifies the maximum number of producers allowed
for this destination.</p>
<p><b>Max Number of Active Consumers </b> Applies to queue destinations only.
Specifies the maximum number of consumers that can be active in load-balanced
delivery from this destination.</p>
<p><b>Max Number of Backup Consumers </b> Applies to queue destinations only.
Specifies the maximum number of backup consumers that can take the place of
active consumers, should any active consumers fail during load-balanced delivery
from this destination.</p>
<P><b>To get information about a destination's current state or to change the
properties of a destination.</b></P>
<ol>
<li>Select the destination in the console's results pane.</li>
<li>Choose <b>Actions &gt; Properties</b>.</li>
</ol>
<P><b>To purge messages from a destination:</b></P>
<ol>
<li>Select the destination in the console's results pane.</li>
<li>Choose <b>Actions &gt; Purge Messages</b>.</li>
</ol>
<p><b>To delete a destination:</b></p>
<ol>
<li>Select the destination in the console's results pane.</li>
<li>Choose <b>Edit &gt; Delete</b>.</li>
</ol>
<p><b>To pause a destination:</b></p>
<ol>
<li>Select the destination in the console's results pane.</li>
<li>Choose <b>Actions &gt; Pause Producers | Pause Consumers | Pause All</b>.</li>
</ol>
<p><b>To resume a paused destination:</b></p>
<ol>
<li>Select the destination in the console's results pane.</li>
<li>Choose <b>Actions &gt; Resume</b></li>
</ol>
<p>&nbsp;</p>

</BODY>
</HTML>

0 comments on commit 0bf3c03

Please sign in to comment.