You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by cl...@apache.org on 2015/03/03 18:18:54 UTC
[4/9] activemq-6 git commit: update user manual to use the phrase
'Apache ActiveMQ'
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/slow-consumers.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/slow-consumers.md b/docs/user-manual/en/slow-consumers.md
index 0ad19f4..c773f7d 100644
--- a/docs/user-manual/en/slow-consumers.md
+++ b/docs/user-manual/en/slow-consumers.md
@@ -1,6 +1,6 @@
#Detecting Slow Consumers
-In this section we will discuss how ActiveMQ can be configured to deal
+In this section we will discuss how Apache ActiveMQ can be configured to deal
with slow consumers. A slow consumer with a server-side queue (e.g. JMS
topic subscriber) can pose a significant problem for broker performance.
If messages build up in the consumer's server-side queue then memory
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/spring-integration.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/spring-integration.md b/docs/user-manual/en/spring-integration.md
index 4bcb0f4..1cdb454 100644
--- a/docs/user-manual/en/spring-integration.md
+++ b/docs/user-manual/en/spring-integration.md
@@ -1,11 +1,11 @@
# Spring Integration
-ActiveMQ provides a simple bootstrap class,
+Apache ActiveMQ provides a simple bootstrap class,
`org.apache.activemq.integration.spring.SpringJmsBootstrap`, for
-integration with Spring. To use it, you configure ActiveMQ as you always
+integration with Spring. To use it, you configure Apache ActiveMQ as you always
would, through its various configuration files like
`activemq-configuration.xml`, `activemq-jms.xml`, and
-`activemq-users.xml`. The Spring helper class starts the ActiveMQ server
+`activemq-users.xml`. The Spring helper class starts the Apache ActiveMQ server
and adds any factories or destinations configured within
`activemq-jms.xml` directly into the namespace of the Spring context.
Let's take this `activemq-jms.xml` file for instance:
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/thread-pooling.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/thread-pooling.md b/docs/user-manual/en/thread-pooling.md
index edc7741..b26c73e 100644
--- a/docs/user-manual/en/thread-pooling.md
+++ b/docs/user-manual/en/thread-pooling.md
@@ -1,6 +1,6 @@
# Thread management
-This chapter describes how ActiveMQ uses and pools threads and how you
+This chapter describes how Apache ActiveMQ uses and pools threads and how you
can manage them.
First we'll discuss how threads are managed and used on the server side,
@@ -8,12 +8,12 @@ then we'll look at the client side.
## Server-Side Thread Management
-Each ActiveMQ Server maintains a single thread pool for general use, and
+Each Apache ActiveMQ Server maintains a single thread pool for general use, and
a scheduled thread pool for scheduled use. A Java scheduled thread pool
cannot be configured to use a standard thread pool, otherwise we could
use a single thread pool for both scheduled and non scheduled activity.
-A separate thread pool is also used to service connections. ActiveMQ can
+A separate thread pool is also used to service connections. Apache ActiveMQ can
use "old" (blocking) IO or "new" (non-blocking) IO also called NIO. Both
of these options use a separate thread pool, but each of them behaves
uniquely.
@@ -33,7 +33,7 @@ However, even an unbounded thread pool can run into trouble if it
becomes too large. If you require the server to handle many concurrent
connections you should use NIO, not old IO.
-When using new IO (NIO), ActiveMQ will, by default, cap its thread pool
+When using new IO (NIO), Apache ActiveMQ will, by default, cap its thread pool
at three times the number of cores (or hyper-threads) as reported by `
Runtime.getRuntime().availableProcessors()` for processing
incoming packets. To override this value, you can set the number of
@@ -96,7 +96,7 @@ For more information on configuring the reaper, please see ?.
Asynchronous IO has a thread pool for receiving and dispatching events
out of the native layer. You will find it on a thread dump with the
-prefix ActiveMQ-AIO-poller-pool. ActiveMQ uses one thread per opened
+prefix ActiveMQ-AIO-poller-pool. Apache ActiveMQ uses one thread per opened
file on the journal (there is usually one).
There is also a single thread used to invoke writes on libaio. We do
@@ -106,14 +106,14 @@ ActiveMQ-AIO-writer-pool.
## Client-Side Thread Management
-On the client side, ActiveMQ maintains a single static scheduled thread
+On the client side, Apache ActiveMQ maintains a single static scheduled thread
pool and a single static general thread pool for use by all clients
using the same classloader in that JVM instance.
The static scheduled thread pool has a maximum size of `5` threads, and
the general purpose thread pool has an unbounded maximum size.
-If required ActiveMQ can also be configured so that each
+If required Apache ActiveMQ can also be configured so that each
`ClientSessionFactory` instance does not use these static pools but
instead maintains its own scheduled and general purpose pool. Any
sessions created from that `ClientSessionFactory` will use those pools
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/tools.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/tools.md b/docs/user-manual/en/tools.md
index 5427c87..ae5ffe7 100644
--- a/docs/user-manual/en/tools.md
+++ b/docs/user-manual/en/tools.md
@@ -1,6 +1,6 @@
# Tools
-ActiveMQ ships with several helpful command line tools. All tools are
+Apache ActiveMQ ships with several helpful command line tools. All tools are
available from the activemq-tools-\<version\>-jar-with-dependencies.jar.
As the name suggests, this Java archive contains ActiveMQ along with all
of its dependencies. This is done to simplify the execution of the tools
@@ -50,7 +50,7 @@ by eliminating the need so specify a classpath. These tools are:
- **`import`**. Used for importing data from an XML document generated
by the `export` tool. The `import` tool reads the XML document and
- connects to a ActiveMQ server via Netty to import all the data. It
+ connects to an Apache ActiveMQ server via Netty to import all the data. It
takes 5 parameters:
- `input-file` - the path to the XML file generated by the
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/transaction-config.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/transaction-config.md b/docs/user-manual/en/transaction-config.md
index 12f1bf8..cbe6d80 100644
--- a/docs/user-manual/en/transaction-config.md
+++ b/docs/user-manual/en/transaction-config.md
@@ -1,13 +1,13 @@
# Resource Manager Configuration
-ActiveMQ has its own Resource Manager for handling the lifespan of JTA
+Apache ActiveMQ has its own Resource Manager for handling the lifespan of JTA
transactions. When a transaction is started the resource manager is
notified and keeps a record of the transaction and its current state. It
is possible in some cases for a transaction to be started but then
forgotten about. Maybe the client died and never came back. If this
happens then the transaction will just sit there indefinitely.
-To cope with this ActiveMQ can, if configured, scan for old transactions
+To cope with this Apache ActiveMQ can, if configured, scan for old transactions
and rollback any it finds. The default for this is 3000000 milliseconds
(5 minutes), i.e. any transactions older than 5 minutes are removed.
This timeout can be changed by editing the `transaction-timeout`
@@ -15,7 +15,7 @@ property in `activemq-configuration.xml` (value must be in
milliseconds). The property `transaction-timeout-scan-period` configures
how often, in milliseconds, to scan for old transactions.
-Please note that ActiveMQ will not unilaterally rollback any XA
+Please note that Apache ActiveMQ will not unilaterally rollback any XA
transactions in a prepared state - this must be heuristically rolled
back via the management API if you are sure they will never be resolved
by the transaction manager.
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/undelivered-messages.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/undelivered-messages.md b/docs/user-manual/en/undelivered-messages.md
index 2a44f4e..ad7fa93 100644
--- a/docs/user-manual/en/undelivered-messages.md
+++ b/docs/user-manual/en/undelivered-messages.md
@@ -46,7 +46,7 @@ Delayed redelivery is defined in the address-setting configuration:
</address-setting>
-If a `redelivery-delay` is specified, ActiveMQ will wait this delay
+If a `redelivery-delay` is specified, Apache ActiveMQ will wait this delay
before redelivering the messages.
By default, there is no redelivery delay (`redelivery-delay`is set to
@@ -92,7 +92,7 @@ to a dead letter address.
Any such messages can then be diverted to queue(s) where they can later
be perused by the system administrator for action to be taken.
-ActiveMQ's addresses can be assigned a dead letter address. Once the
+Apache ActiveMQ's addresses can be assigned a dead letter address. Once the
messages have been unsuccessfully delivered for a given number of
attempts, they are removed from their queue and sent to the relevant
dead letter address. These *dead letter* messages can later be consumed
@@ -144,7 +144,7 @@ that shows how dead letter is configured and used with JMS.
## Delivery Count Persistence
-In normal use, ActiveMQ does not update delivery count *persistently*
+In normal use, Apache ActiveMQ does not update delivery count *persistently*
until a message is rolled back (i.e. the delivery count is not updated
*before* the message is delivered to the consumer). In most messaging
use cases, the messages are consumed, acknowledged and forgotten as soon
@@ -160,7 +160,7 @@ delivery count. During the recovery phase, the server will not have
knowledge of that and will deliver the message with `redelivered` set to
`false` while it should be `true`.
-As this behavior breaks strict JMS semantics, ActiveMQ allows to persist
+As this behavior breaks strict JMS semantics, Apache ActiveMQ allows to persist
delivery count before message delivery but this feature is disabled by default
due to performance implications.
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/using-core.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-core.md b/docs/user-manual/en/using-core.md
index a23883e..d23cbac 100644
--- a/docs/user-manual/en/using-core.md
+++ b/docs/user-manual/en/using-core.md
@@ -1,6 +1,6 @@
# Using Core
-ActiveMQ core is a completely JMS-agnostic messaging system with its own
+Apache ActiveMQ core is a completely JMS-agnostic messaging system with its own
non-JMS API. We call this the *core API*.
If you don't want to use JMS you can use the core API directly. The core
@@ -41,16 +41,16 @@ please consult the Javadoc.
- Messages can be specified with a priority value between 0 and 9. 0
represents the lowest priority and 9 represents the highest.
- ActiveMQ will attempt to deliver higher priority messages before
+ Apache ActiveMQ will attempt to deliver higher priority messages before
lower priority ones.
-- Messages can be specified with an optional expiry time. ActiveMQ
+- Messages can be specified with an optional expiry time. Apache ActiveMQ
will not deliver messages after its expiry time has been exceeded.
- Messages also have an optional timestamp which represents the time
the message was sent.
-- ActiveMQ also supports the sending/consuming of very large messages
+- Apache ActiveMQ also supports the sending/consuming of very large messages
much larger than can fit in available RAM at any one time.
### Address
@@ -132,7 +132,7 @@ ClientSession instances group ClientConsumers and ClientProducers.
ClientSession instances can be registered with an optional
`SendAcknowledgementHandler`. This allows your client code to be
notified asynchronously when sent messages have successfully reached the
-server. This unique ActiveMQ feature, allows you to have full guarantees
+server. This unique Apache ActiveMQ feature, allows you to have full guarantees
that sent messages have reached the server without having to block on
each message sent until a response is received. Blocking on each
messages sent is costly since it requires a network round trip for each
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/using-jms.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-jms.md b/docs/user-manual/en/using-jms.md
index 7de469a..1482ddd 100644
--- a/docs/user-manual/en/using-jms.md
+++ b/docs/user-manual/en/using-jms.md
@@ -1,6 +1,6 @@
# Using JMS
-Although ActiveMQ provides a JMS agnostic messaging API, many users will
+Although Apache ActiveMQ provides a JMS agnostic messaging API, many users will
be more comfortable using JMS.
JMS is a very popular API standard for messaging, and most messaging
@@ -8,7 +8,7 @@ systems provide a JMS API. If you are completely new to JMS we suggest
you follow the [Oracle JMS tutorial](http://docs.oracle.com/javaee/7/tutorial/partmessaging.htm) -
a full JMS tutorial is out of scope for this guide.
-ActiveMQ also ships with a wide range of examples, many of which
+Apache ActiveMQ also ships with a wide range of examples, many of which
demonstrate JMS API usage. A good place to start would be to play around
with the simple JMS Queue and Topic example, but we also provide
examples for many other parts of the JMS API. A full description of the
@@ -16,7 +16,7 @@ examples is available in [Examples](examples.md).
In this section we'll go through the main steps in configuring the
server for JMS and creating a simple JMS program. We'll also show how to
-configure and use JNDI, and also how to use JMS with ActiveMQ without
+configure and use JNDI, and also how to use JMS with Apache ActiveMQ without
using any JNDI.
A simple ordering system
@@ -42,18 +42,18 @@ JNDI Configuration
The JMS specification establishes the convention that *administered
objects* (i.e. JMS queue, topic and connection factory instances) are
made available via the JNDI API. Brokers are free to implement JNDI as
-they see fit assuming the implementation fits the API. ActiveMQ does not
+they see fit assuming the implementation fits the API. Apache ActiveMQ does not
have a JNDI server. Rather, it uses a client-side JNDI implementation
that relies on special properties set in the environment to construct
the appropriate JMS objects. In other words, no objects are stored in
-JNDI on the ActiveMQ server, instead they are simply instantiated on the
+JNDI on the Apache ActiveMQ server, instead they are simply instantiated on the
client based on the provided configuration. Let's look at the different
kinds of administered objects and how to configure them.
> **Note**
>
> The following configuration properties *are strictly required when
-> ActiveMQ is running in stand-alone mode*. When ActiveMQ is integrated
+> Apache ActiveMQ is running in stand-alone mode*. When Apache ActiveMQ is integrated
> to an application server (e.g. Wildfly) the application server itself
> will almost certainly provide a JNDI client with its own properties.
@@ -66,7 +66,7 @@ well as many other configuration parameters.
Here's a simple example of the JNDI context environment for a client
looking up a connection factory to access an *embedded* instance of
-ActiveMQ:
+Apache ActiveMQ:
java.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
connectionFactory.invmConnectionFactory=vm://0
@@ -224,7 +224,7 @@ connection factories, destinations can be configured using special
properties in the JNDI context environment. The property *name* should
follow the pattern: `queue.<jndi-binding>` or `topic.<jndi-binding>`.
The property *value* should be the name of the queue hosted by the
-ActiveMQ server. For example, if the server had a JMS queue configured
+Apache ActiveMQ server. For example, if the server had a JMS queue configured
like so:
<queue name="OrderQueue"/>
@@ -317,7 +317,7 @@ Although it is a very common JMS usage pattern to lookup JMS
instances) from JNDI, in some cases you just think "Why do I need JNDI?
Why can't I just instantiate these objects directly?"
-With ActiveMQ you can do exactly that. ActiveMQ supports the direct
+With Apache ActiveMQ you can do exactly that. Apache ActiveMQ supports the direct
instantiation of JMS Queue, Topic and ConnectionFactory instances, so
you don't have to use JNDI at all.
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/using-server.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md
index 35d1fdc..451a957 100644
--- a/docs/user-manual/en/using-server.md
+++ b/docs/user-manual/en/using-server.md
@@ -1,12 +1,12 @@
# Using the Server
-This chapter will familiarise you with how to use the ActiveMQ server.
+This chapter will familiarise you with how to use the Apache ActiveMQ server.
We'll show where it is, how to start and stop it, and we'll describe the
directory layout and what all the files are and what they do.
-For the remainder of this chapter when we talk about the ActiveMQ server
-we mean the ActiveMQ standalone server, in its default configuration
+For the remainder of this chapter when we talk about the Apache ActiveMQ server
+we mean the Apache ActiveMQ standalone server, in its default configuration
with a JMS Service enabled.
## Starting and Stopping the standalone server
@@ -16,21 +16,21 @@ In the distribution you will find a directory called `bin`.
`cd` into that directory and you will find a Unix/Linux script called
`activemq` and a Windows script called `activemq.cmd`.
-To start the ActiveMQ instance on Unix/Linux type `./activemq run`
+To start the Apache ActiveMQ instance on Unix/Linux type `./activemq run`
-To start the ActiveMQ instance on Windows type `activemq.cmd run`
+To start the Apache ActiveMQ instance on Windows type `activemq.cmd run`
These scripts are very simple and basically just set-up the classpath
and some JVM parameters and bootstrap the server using
[Airline](https://github.com/airlift/airline).
-To stop the ActiveMQ instance you will use the same `activemq` script.
+To stop the Apache ActiveMQ instance you will use the same `activemq` script.
To run on Unix/Linux type `./activemq stop`
To run on Windows type `activemq.cmd stop`
-Please note that ActiveMQ requires a Java 6 or later runtime to run.
+Please note that Apache ActiveMQ requires a Java 6 or later runtime to run.
By default the `config/non-clustered/bootstrap.xml` configuration is
used. The configuration can be changed e.g. by running
@@ -43,7 +43,7 @@ The run scripts set some JVM settings for tuning the garbage collection
policy and heap size. We recommend using a parallel garbage collection
algorithm to smooth out latency and minimise large GC pauses.
-By default ActiveMQ runs in a maximum of 1GiB of RAM. To increase the
+By default Apache ActiveMQ runs in a maximum of 1GiB of RAM. To increase the
memory settings change the `-Xms` and `-Xmx` memory settings as you
would for any Java program.
@@ -77,7 +77,7 @@ JVM will use the environment variable `LD_LIBRARY_PATH`.
## System properties
-ActiveMQ can take a system property on the command line for configuring
+Apache ActiveMQ can take a system property on the command line for configuring
logging.
For more information on configuring logging, please see the section on
@@ -129,11 +129,11 @@ The bootstrap file is very simple. Let's take a look at an example:
## The main configuration file.
-The configuration for the ActiveMQ core server is contained in
+The configuration for the Apache ActiveMQ core server is contained in
`activemq-configuration.xml`. This is what the FileConfiguration bean
uses to configure the messaging server.
-There are many attributes which you can configure ActiveMQ. In most
+There are many attributes which you can configure Apache ActiveMQ. In most
cases the defaults will do fine, in fact every attribute can be
defaulted which means a file with a single empty `configuration` element
is a valid configuration file. The different configuration will be
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/vertx-integration.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/vertx-integration.md b/docs/user-manual/en/vertx-integration.md
index a77353e..20168a9 100644
--- a/docs/user-manual/en/vertx-integration.md
+++ b/docs/user-manual/en/vertx-integration.md
@@ -4,14 +4,14 @@
application platform for the JVM that's designed for modern mobile, web,
and enterprise applications. Vert.x provides a distributed event bus
that allows messages to be sent across vert.x instances and clients. You
-can now redirect and persist any vert.x messages to ActiveMQ and route
-those messages to a specified vertx address by configuring ActiveMQ
+can now redirect and persist any vert.x messages to Apache ActiveMQ and route
+those messages to a specified vertx address by configuring Apache ActiveMQ
vertx incoming and outgoing vertx connector services.
## Configuring a Vertx Incoming Connector Service
Vertx Incoming Connector services receive messages from vertx event bus
-and route them to a ActiveMQ queue. Such a service can be configured as
+and route them to an Apache ActiveMQ queue. Such a service can be configured as
follows:
<connector-service name="vertx-incoming-connector">
@@ -25,7 +25,7 @@ follows:
Shown are the required params for the connector service:
-- `queue`. The name of the ActiveMQ queue to send message to.
+- `queue`. The name of the Apache ActiveMQ queue to send message to.
As well as these required parameters there are the following optional
parameters
@@ -62,7 +62,7 @@ as follows:
Shown are the required params for the connector service:
-- `queue`. The name of the ActiveMQ queue to fetch message from.
+- `queue`. The name of the Apache ActiveMQ queue to fetch message from.
As well as these required paramaters there are the following optional
parameters
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/wildcard-routing.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/wildcard-routing.md b/docs/user-manual/en/wildcard-routing.md
index 7491571..e75b9fb 100644
--- a/docs/user-manual/en/wildcard-routing.md
+++ b/docs/user-manual/en/wildcard-routing.md
@@ -1,6 +1,6 @@
# Routing Messages With Wild Cards
-ActiveMQ allows the routing of messages via wildcard addresses.
+Apache ActiveMQ allows the routing of messages via wildcard addresses.
If a queue is created with an address of say `queue.news.#` then it will
receive any messages sent to addresses that match this, for instance
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/docs/user-manual/en/wildcard-syntax.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/wildcard-syntax.md b/docs/user-manual/en/wildcard-syntax.md
index 6344012..a94adba 100644
--- a/docs/user-manual/en/wildcard-syntax.md
+++ b/docs/user-manual/en/wildcard-syntax.md
@@ -1,11 +1,11 @@
-# Understanding the ActiveMQ Wildcard Syntax
+# Understanding the Apache ActiveMQ Wildcard Syntax
-ActiveMQ uses a specific syntax for representing wildcards in security
+Apache ActiveMQ uses a specific syntax for representing wildcards in security
settings, address settings and when creating consumers.
The syntax is similar to that used by [AMQP](http://www.amqp.org).
-An ActiveMQ wildcard expression contains words delimited by the character
+An Apache ActiveMQ wildcard expression contains words delimited by the character
'`.`' (full stop).
The special characters '`#`' and '`*`' also have special meaning and can
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/9d72cefd/examples/jms/queue/pom.xml
----------------------------------------------------------------------
diff --git a/examples/jms/queue/pom.xml b/examples/jms/queue/pom.xml
index a90df43..5a48e6e 100644
--- a/examples/jms/queue/pom.xml
+++ b/examples/jms/queue/pom.xml
@@ -25,7 +25,7 @@ under the License.
<parent>
<groupId>org.apache.activemq.examples.jms</groupId>
<artifactId>jms-examples</artifactId>
- <version>6.0.0-SNAPSHOT</version>
+ <version>${project.version}</version>
</parent>
<artifactId>activemq-jms-queue-example</artifactId>