http://git-wip-us.apache.org/repos/asf/qpid-site/blob/6e5b75e1/content/releases/qpid-java-6.1.1/java-broker/book/Java-Broker-Initial-Configuration.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-java-6.1.1/java-broker/book/Java-Broker-Initial-Configuration.html b/content/releases/qpid-java-6.1.1/java-broker/book/Java-Broker-Initial-Configuration.html new file mode 100644 index 0000000..91e3ec2 --- /dev/null +++ b/content/releases/qpid-java-6.1.1/java-broker/book/Java-Broker-Initial-Configuration.html @@ -0,0 +1,154 @@ + + + +
+Table of Contents
This section describes how to perform initial configuration on the command line. Once + the Broker is started, subsequent management is performed using the Management interfaces
The configuration for each component is stored as an entry in the broker + configuration store, currently implemented as a JSON file which persists changes to + disk, BDB or Derby database or an in-memory store which does not. The following + components configuration is stored there:
Broker
Virtual Host Nodes
Loggers
Ports
Authentication Providers (optionally with Users for managing users Authentication Providers)
Access Control Providers
Group Providers (optionally with Groups and GroupMembers for managing groups Group Providers)
Key stores
Trust stores
Plugins
+
Broker startup involves two configuration related items, the 'Initial Configuration' + and the Configuration Store. When the broker is started, if a Configuration Store does + not exist at the current store location then one will be initialised with the current 'Initial + Configuration'. Unless otherwise requested to overwrite the configuration + store then subsequent broker restarts will use the existing configuration + store and ignore the contents of the 'Initial Configuration'.
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+You can download the latest Broker package from the Download Page .
It is recommended that you confirm the integrity of the download by verifying the PGP + signature matches that available on the site. Instructions are given on the download page. +
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+Firstly, verify that your JVM is installed properly by following these instructions. +
Now chose a directory for Qpid broker installation. This directory will be used for the + Qpid JARs and configuration files. It need not be the same location as the work directory used + for the persistent message store or the log file (you will choose this location later). For + the remainder this example we will assume that location /usr/local/qpid has been + chosen.
Next extract the qpid-broker-6.1.1-bin.tgz package into the directory.
mkdir /usr/local/qpid +cd /usr/local/qpid +tar xvzf qpid-broker-6.1.1-bin.tgz
The extraction of the broker package will have created a directory + qpid-broker/6.1.1 within /usr/local/qpid
ls -la qpid-broker/6.1.1/ +total 56 +drwxrwxr-x. 5 alex alex 4096 Nov 25 11:43 . +drwxrwxr-x. 3 alex alex 4096 Nov 25 11:43 .. +drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 bin +drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 etc +drwxrwxr-x. 2 alex alex 4096 Nov 25 11:43 lib +-rw-r--r--. 1 alex alex 28143 Nov 24 23:38 LICENSE +-rw-r--r--. 1 alex alex 3409 Nov 24 23:38 NOTICE +-rw-r--r--. 1 alex alex 116 Nov 24 23:38 README.txt +
Qpid requires a work directory. This directory is used for the default location of the + Qpid log file and is used for the storage of persistent messages. The work directory can be + set on the command-line (for the lifetime of the current shell), but you will normally want + to set the environment variable permanently the user's shell profile file (~/.bash_profile + for Bash etc).
export QPID_WORK=/var/qpidwork +
If the directory referred to by QPID_WORK does not + exist, the Broker will attempt to create it on start-up.
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+Firstly, verify that your JVM is installed properly by following these instructions. +
Now chose a directory for Qpid broker installation. This directory will be used for the + Qpid JARs and configuration files. It need not be the same location as the work directory used + for the persistent message store or the log file (you will choose this location later). For + the remainder this example we will assume that location c:\qpid has been chosen.
Next extract the qpid-broker-6.1.1-bin.zip package into the directory, using either + the zip file handling offered by Windows (right click the file and select 'Extract All') or a + third party tool of your choice.
The extraction of the broker package will have created a directory + qpid-broker\\6.1.1 within c:\qpid
+ Directory of c:\qpid\qpid-broker\\6.1.1 + +25/11/2015 11:29 <DIR> . +25/11/2015 11:29 <DIR> .. +25/11/2015 10:56 <DIR> bin +03/07/2015 08:06 <DIR> etc +25/11/2015 11:25 <DIR> lib +25/11/2015 10:56 28,143 LICENSE +25/11/2015 10:56 3,409 NOTICE +29/04/2015 09:13 116 README.txt +3 File(s) 31,668 bytes +5 Dir(s) 25,981,767,680 bytes free +
Qpid requires a work directory. This directory is used for the default location of the + Qpid log file and is used for the storage of persistent messages. The work directory can be + set on the command-line (for the lifetime of the command interpreter), but you will normally + want to set the environment variable permanently via the Advanced System Settings in the + Control Panel.
set QPID_WORK=C:\qpidwork
If the directory referred to by QPID_WORK does not + exist, the Broker will attempt to create it on start-up.
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+If you wish to utilise storage options using Oracle BDB JE or an External Database, see + Section E.3, “Installing Oracle BDB JE” and Section E.2, “Installing External JDBC Driver” for details of + installing their dependencies.
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+The Apache Qpid Broker for Java is an 100% Java implementation and as such it can be used on any + operating system supporting Java 1.7 or higher[4]. This includes Linux, Solaris, Mac OS X, and + Windows XP/Vista/7/8.
The broker has been tested with Java implementations from both Oracle and IBM. Whatever + platform you chose, it is recommended that you ensure it is patched with any critical + updates made available from the vendor.
Verify that your JVM is installed properly by following these instructions. +
The Broker installation requires approximately 20MB of free disk space.
The Broker also requires a working directory. The working directory is used for the + message store, that is, the area of the file-system used to record messages + whilst they are passing through the Broker. The working directory is also used for the + default location of the log file. The size of the working directory will depend on the how + the Broker is used.
The performance of the file system hosting the work directory is key to the performance + of Broker as a whole. For best performance, choose a device that has low latency and one + that is uncontended by other applications.
Be aware that there are additional considerations if you are considering hosting the + working directory on NFS.
Qpid caches messages in memory for performance reasons, so in general, the Broker will + benefit from as much memory as possible. However, on a 32bit JVM, the maximum addressable + memory range for a process is 4GB, after leaving space for the JVM's own use this will give + a maximum usable size of approximately ~3.7GB.
See Section 9.11, “Memory” for a full description of how memory is + used.
Installation or operation of Qpid does not require a privileged + account (i.e. root on UNIX platforms or Administrator on Windows). However it is suggested + that you use an dedicated account (e.g. qpid) for the installation and operation of the Broker.
[4] Java Cryptography Extension (JCE) + Unlimited Strength policy file are required for some features
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
++ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+The Apache Qpid Broker for Java is a powerful open-source message broker that implements all versions of the + Advanced Message Queuing Protocol (AMQP). The Apache Qpid Broker for Java + is actually one of two message brokers provided by the Apache Qpid project: Broker for Java and the C++ + Broker.
This document relates to the Apache Qpid Broker for Java. The C++ Broker is + described separately.
Headline features
100% Java implementation - runs on any platform supporting Java 1.7 or higher
Messaging clients support in Java, C++, Python.
JMS 1.1 compliance (Java client).
Persistent and non-persistent (transient) message support
Supports for all common messaging patterns (point-to-point, publish/subscribe, fan-out + etc).
Transaction support including XA[1]
Supports for all versions of the AMQP protocol
Automatic message translation, allowing clients using different AMQP versions to communicate with each other.
Pluggable authentication architecture with out-of-the-box support for Kerberos, LDAP, + External, OAuth2, and file-based authentication mechanisms.
Support for message compression
Client support for end to end message encryption
Pluggable storage architecture with implementations including Apache Derby, Oracle BDB JE[2], and External Database
Web based management interface and programmatic management interfaces via REST.
SSL support
High availability (HA) support.[3]
+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +
+