A Few fixes around docs using GMF (Github Markdown Flavored) on tables
I also did some review of the huge table we have, removed a few columns such as the datatype and embedded the default on the description. Just trying to make easier to render and read Also a few fixes on the doc context such as adding links and improving configuration-index
This commit is contained in:
parent
4afa19b348
commit
0cf2a56fd6
File diff suppressed because it is too large
Load Diff
|
@ -53,7 +53,7 @@ Expiry address are defined in the address-setting configuration:
|
||||||
|
|
||||||
If messages are expired and no expiry address is specified, messages are
|
If messages are expired and no expiry address is specified, messages are
|
||||||
simply removed from the queue and dropped. Address wildcards can be used
|
simply removed from the queue and dropped. Address wildcards can be used
|
||||||
to configure expiry address for a set of addresses (see [Understanding the HornetQ Wildcard Syntax](wildcard-syntax.md)).
|
to configure expiry address for a set of addresses (see [Understanding the Wildcard Syntax](wildcard-syntax.md)).
|
||||||
|
|
||||||
## Configuring The Expiry Reaper Thread
|
## Configuring The Expiry Reaper Thread
|
||||||
|
|
||||||
|
|
|
@ -124,7 +124,7 @@ situations. This is discussed in [Paging](paging.md).
|
||||||
|
|
||||||
If no persistence is required at all, Apache ActiveMQ can also be configured
|
If no persistence is required at all, Apache ActiveMQ can also be configured
|
||||||
not to persist any data at all to storage as discussed in the Configuring
|
not to persist any data at all to storage as discussed in the Configuring
|
||||||
HornetQ for Zero Persistence section.
|
the broker for Zero Persistence section.
|
||||||
|
|
||||||
## Configuring the bindings journal
|
## Configuring the bindings journal
|
||||||
|
|
||||||
|
|
|
@ -1385,48 +1385,17 @@ role your own security by specifying security constraints with your
|
||||||
web.xml for every path of every queue and topic you have deployed. Here
|
web.xml for every path of every queue and topic you have deployed. Here
|
||||||
is a list of URI patterns:
|
is a list of URI patterns:
|
||||||
|
|
||||||
<table>
|
Post | Description
|
||||||
<tr>
|
--- | ---
|
||||||
<td>/queues </td>
|
/queues | secure the POST operation to secure queue creation
|
||||||
<td>secure the POST operation to secure queue creation</td>
|
/queues/{queue-name}/create/ | secure this URL pattern for producing messages.
|
||||||
</tr>
|
/queues/{queue-name}/pull-consumers/ | secure this URL pattern for pushing messages.
|
||||||
<tr>
|
/queues/{queue-name}/push-consumers/ | secure the POST operation to secure topic creation
|
||||||
<td>/queues/{queue-name}</td>
|
/topics | secure the POST operation to secure topic creation
|
||||||
<td>secure the GET HEAD operation to getting information about the queue.</td>
|
/topics/{topic-name} | secure the GET HEAD operation to getting information about the topic.
|
||||||
</tr>
|
/topics/{topic-name}/create/ | secure this URL pattern for producing messages
|
||||||
<tr>
|
/topics/{topic-name}/pull-subscriptions/ | secure this URL pattern for pulling messages
|
||||||
<td>/queues/{queue-name}/create/\* </td>
|
/topics/{topic-name}/push-subscriptions/ | secure this URL pattern for pushing messages
|
||||||
<td>secure this URL pattern for producing messages. </td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/queues/{queue-name}/pull-consumers/\*</td>
|
|
||||||
<td>secure this URL pattern for pushing messages.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/queues/{queue-name}/push-consumers/\*</td>
|
|
||||||
<td>secure the POST operation to secure topic creation</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/topics</td>
|
|
||||||
<td>secure the POST operation to secure topic creation</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/topics/{topic-name}</td>
|
|
||||||
<td>secure the GET HEAD operation to getting information about the topic.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/topics/{topic-name}/create/\*</td>
|
|
||||||
<td>secure this URL pattern for producing messages.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/topics/{topic-name}/pull-subscriptions/\*</td>
|
|
||||||
<td>secure this URL pattern for pulling messages.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>/topics/{topic-name}/push-subscriptions/\*</td>
|
|
||||||
<td>secure this URL pattern for pushing messages.</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## Mixing JMS and REST
|
## Mixing JMS and REST
|
||||||
|
|
||||||
|
@ -1463,10 +1432,12 @@ If you have a REST client producing messages and a JMS consumer,
|
||||||
Apache ActiveMQ REST has a simple helper class for you to transform the HTTP
|
Apache ActiveMQ REST has a simple helper class for you to transform the HTTP
|
||||||
body to a Java object. Here's some example code:
|
body to a Java object. Here's some example code:
|
||||||
|
|
||||||
public void onMessage(Message message)
|
```java
|
||||||
{
|
public void onMessage(Message message)
|
||||||
MyType obj = org.apache.activemq.rest.Jms.getEntity(message, MyType.class);
|
{
|
||||||
}
|
MyType obj = org.apache.activemq.rest.Jms.getEntity(message, MyType.class);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The way the `getEntity()` method works is that if the message is an
|
The way the `getEntity()` method works is that if the message is an
|
||||||
ObjectMessage, it will try to extract the desired type from it like any
|
ObjectMessage, it will try to extract the desired type from it like any
|
||||||
|
|
|
@ -67,7 +67,7 @@ Let's take a simple example, here's a security block from
|
||||||
|
|
||||||
The '`#`' character signifies "any sequence of words". Words are
|
The '`#`' character signifies "any sequence of words". Words are
|
||||||
delimited by the '`.`' character. For a full description of the wildcard
|
delimited by the '`.`' character. For a full description of the wildcard
|
||||||
syntax please see [Understanding the HornetQ Wildcard Syntax](wildcard-syntax.md).
|
syntax please see [Understanding the Wildcard Syntax](wildcard-syntax.md).
|
||||||
The above security block applies to any address
|
The above security block applies to any address
|
||||||
that starts with the string "globalqueues.europe.":
|
that starts with the string "globalqueues.europe.":
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,9 @@ by eliminating the need so specify a classpath. These tools are:
|
||||||
the bindings and message journals are stored, respectively. For
|
the bindings and message journals are stored, respectively. For
|
||||||
example:
|
example:
|
||||||
|
|
||||||
java -jar activemq-tools-<version>-jar-with-dependencies.jar print-data /home/user/activemq/data/bindings /home/user/activemq/data/journal
|
```sh
|
||||||
|
java -jar activemq-tools-<version>-jar-with-dependencies.jar print-data /home/user/activemq/data/bindings /home/user/activemq/data/journal
|
||||||
|
```
|
||||||
|
|
||||||
- **`print-pages`**. Used for low-level inspection of paged message
|
- **`print-pages`**. Used for low-level inspection of paged message
|
||||||
data. It takes two parameters - `paging-directory` and
|
data. It takes two parameters - `paging-directory` and
|
||||||
|
@ -20,7 +22,9 @@ by eliminating the need so specify a classpath. These tools are:
|
||||||
paged messages and the message journals are stored, respectively.
|
paged messages and the message journals are stored, respectively.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
java -jar activemq-tools-<version>-jar-with-dependencies.jar print-pages /home/user/activemq/data/paging-directory /home/user/activemq/data/journal
|
```sh
|
||||||
|
java -jar activemq-tools-<version>-jar-with-dependencies.jar print-pages /home/user/activemq/data/paging-directory /home/user/activemq/data/journal
|
||||||
|
```
|
||||||
|
|
||||||
- **`export`**. Used for exporting all binding and message data
|
- **`export`**. Used for exporting all binding and message data
|
||||||
(including paged and large messages) as well as JMS destinations and
|
(including paged and large messages) as well as JMS destinations and
|
||||||
|
@ -39,8 +43,9 @@ by eliminating the need so specify a classpath. These tools are:
|
||||||
directory.
|
directory.
|
||||||
|
|
||||||
Here's an example:
|
Here's an example:
|
||||||
|
```
|
||||||
java -jar activemq-tools-<version>-jar-with-dependencies.jar export /home/user/activemq/data/bindings-directory /home/user/activemq/data/journal-directory /home/user/activemq/data/paging-directory /home/user/activemq/data/large-messages
|
java -jar activemq-tools-<version>-jar-with-dependencies.jar export /home/user/activemq/data/bindings-directory /home/user/activemq/data/journal-directory /home/user/activemq/data/paging-directory /home/user/activemq/data/large-messages
|
||||||
|
```
|
||||||
|
|
||||||
This tool will export directly to standard out so if the data needs
|
This tool will export directly to standard out so if the data needs
|
||||||
to be stored in a file please redirect as appropriate for the
|
to be stored in a file please redirect as appropriate for the
|
||||||
|
@ -78,7 +83,9 @@ by eliminating the need so specify a classpath. These tools are:
|
||||||
|
|
||||||
Here's an example:
|
Here's an example:
|
||||||
|
|
||||||
java -jar activemq-tools-<version>-jar-with-dependencies.jar import /home/user/exportData.xml 127.0.0.1 61616 false false
|
```sh
|
||||||
|
java -jar activemq-tools-<version>-jar-with-dependencies.jar import /home/user/exportData.xml 127.0.0.1 61616 false false
|
||||||
|
```
|
||||||
|
|
||||||
Like the `export` tool the `import` tool is single threaded so
|
Like the `export` tool the `import` tool is single threaded so
|
||||||
depending on the size of the XML file it may take awhile for the
|
depending on the size of the XML file it may take awhile for the
|
||||||
|
|
|
@ -73,7 +73,7 @@ Example:
|
||||||
6. Wait Delay Period: 15000 // (10000 * 2) > max-delay-period: Use max-delay-delivery
|
6. Wait Delay Period: 15000 // (10000 * 2) > max-delay-period: Use max-delay-delivery
|
||||||
|
|
||||||
Address wildcards can be used to configure redelivery delay for a set of
|
Address wildcards can be used to configure redelivery delay for a set of
|
||||||
addresses (see [Understanding the HornetQ Wildcard Syntax](wildcard-syntax.md)), so you don't have to specify redelivery delay
|
addresses (see [Understanding the Wildcard Syntax](wildcard-syntax.md)), so you don't have to specify redelivery delay
|
||||||
individually for each address.
|
individually for each address.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
@ -120,7 +120,7 @@ addresses and you can set `max-delivery-attempts` to -1 for a specific
|
||||||
address setting to allow infinite redeliveries only for this address.
|
address setting to allow infinite redeliveries only for this address.
|
||||||
|
|
||||||
Address wildcards can be used to configure dead letter settings for a
|
Address wildcards can be used to configure dead letter settings for a
|
||||||
set of addresses (see [Understanding the HornetQ Wildcard Syntax](wildcard-syntax.md)).
|
set of addresses (see [Understanding the Wildcard Syntax](wildcard-syntax.md)).
|
||||||
|
|
||||||
### Dead Letter Properties
|
### Dead Letter Properties
|
||||||
|
|
||||||
|
|
|
@ -186,36 +186,15 @@ This can be changed by setting the type like so
|
||||||
In this example it is still set to the default, below shows a list of types that can be set.
|
In this example it is still set to the default, below shows a list of types that can be set.
|
||||||
|
|
||||||
#### Configuration for Connection Factory Types
|
#### Configuration for Connection Factory Types
|
||||||
<table>
|
|
||||||
<tr>
|
type | interface
|
||||||
<th>type</th>
|
--- |---
|
||||||
<th>interface</th>
|
CF (default) | javax.jms.ConnectionFactory
|
||||||
</tr>
|
XA_CF | javax.jms.XAConnectionFactory
|
||||||
<tr>
|
QUEUE_CF | javax.jms.QueueConnectionFactory
|
||||||
<td>CF (default)</td>
|
QUEUE_XA_CF | javax.jms.XAQueueConnectionFactory
|
||||||
<td>javax.jms.ConnectionFactory</td>
|
TOPIC_CF | javax.jms.TopicConnectionFactory
|
||||||
</tr>
|
TOPIC_XA_CF | javax.jms.XATopicConnectionFactory
|
||||||
<tr>
|
|
||||||
<td>XA_CF</td>
|
|
||||||
<td>javax.jms.XAConnectionFactory</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>QUEUE_CF</td>
|
|
||||||
<td>javax.jms.QueueConnectionFactory</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>QUEUE_XA_CF</td>
|
|
||||||
<td>javax.jms.XAQueueConnectionFactory</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>TOPIC_CF</td>
|
|
||||||
<td>javax.jms.TopicConnectionFactory</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>TOPIC_XA_CF</td>
|
|
||||||
<td>javax.jms.XATopicConnectionFactory</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
### Destination JNDI
|
### Destination JNDI
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue