Apache Qpid

Documentation

Community

Developers

About AMQP

About Apache

AMQP Messaging Broker (Java)

AMQP Messaging Broker (Java)

Table of Contents

1. Introduction
2. Installation
2.1. Introduction
2.2. Prerequisites
2.2.1. Java Platform
2.2.2. Disk
2.2.3. Memory
2.2.4. Operating System Account
2.3. Download
2.3.1. Broker Release
2.3.2. Optional Dependencies
2.4. Installation on Windows
2.4.1. Setting the working directory
2.4.2. Optional Dependencies
2.5. Installation on UNIX platforms
2.5.1. Setting the working directory
2.5.2. Optional Dependencies
3. Getting Started
3.1. Introduction
3.2. Starting/Stopping the broker on Windows
3.3. Starting/Stopping the broker on Unix
3.4. Log file
3.5. Using the command line
4. Concepts
4.1. Broker
4.2. Virtual Hosts
4.3. Exchanges
4.4. Queues
4.5. Ports
4.6. Authentication Providers
4.7. Other Services
4.7.1. Access Control Providers
4.7.2. Group Providers
4.7.3. Keystores
4.7.4. Truststores
5. Configuring And Managing
5.1. Broker Configuration Store
5.1.1. Introduction
5.1.2. Configuration Store Location
5.1.3. 'Initial Configuration' Location
5.1.4. Creating an 'Initial Configuration' JSON File
5.1.5. Overwriting An Existing Configuration Store
5.1.6. Configuration Store Type
5.1.7. Customising Configuration using Configuration Properties
5.1.8. Example of JSON 'Initial Configuration'
5.1.9. Configuring Broker Attributes
5.2. HTTP Management
5.2.1. Introduction
5.2.2. Web Management Console
5.2.3. HTTP Management Plugin Configuration
5.2.4. REST API
5.3. JMX Management
5.3.1. Introduction
5.3.2. JMX Management Plugin Configuration
5.4. Other Tooling
6. Broker Ports
6.1. Configuring Broker Ports
7. Virtual Hosts
7.1. Configuring And Managing
8. Exchanges
8.1. Configuring Virtual Host Exchanges
9. Queues
9.1. Queue Types
9.1.1. Introduction
9.1.2. Priority Queues
9.1.3. Sorted Queues
9.1.4. Last Value Queues (LVQ)
9.1.5. Creating a Priority, Sorted or LVQ Queue
9.1.6. Messaging Grouping
9.1.7. Using low pre-fetch with special queue types
10. Virtual Host Message Stores
10.1. Memory Message Store
10.2. Derby Message Store
10.3. SQL Message Store
10.3.1. JDBC driver
10.4. BDB Message Store
10.4.1. Oracle BDB JE download
10.4.2. Oracle BDB JE jar installation
10.5. High Availability BDB Message Store
10.5.1. Oracle BDB JE download
10.5.2. Oracle BDB JE jar installation
10.5.3. Configuration
11. Security
11.1. Authentication Providers
11.1.1. Simple LDAP Authentication Provider
11.1.2. Kerberos
11.1.3. External (SSL Client Certificates)
11.1.4. Anonymous
11.1.5. Plain Password File
11.1.6. Base64MD5 Password File
11.2. Group Providers
11.2.1. GroupFile Provider
11.3. Access Control Lists
11.3.1. Writing .acl files
11.3.2. Syntax
11.3.3. Worked Examples
11.4. SSL
11.4.1. Keystore Configuration
11.4.2. Truststore / Client Certificate Authentication
12. Runtime
12.1. Log Files
12.2. Alerts
12.3. Disk Space Management
12.3.1. Producer Flow Control
12.4. Producer Transaction Timeout
12.4.1. General Information
12.4.2. Purpose
12.4.3. Scope
12.4.4. Effect
12.4.5. Configuration
12.5. Handing Undeliverable Messages
12.5.1. Introduction
12.5.2. Maximum Delivery Count
12.5.3. Dead Letter Queues (DLQ)
12.5.4. Configuration
13. High Availability
13.1. General Introduction
13.2. HA offerings of the Java Broker
13.3. Two Node Cluster
13.3.1. Overview
13.3.2. Depictions of cluster operation
13.4. Multi Node Cluster
13.5. Configuring a Virtual Host to be a node
13.5.1. Passing BDB environment and replication configuration options
13.6. Durability Guarantees
13.6.1. BDB Durability Controls
13.6.2. Coalescing-sync
13.6.3. Default
13.6.4. Examples
13.7. Client failover configuration
13.8. Qpid JMX API for HA
13.9. Monitoring cluster
13.10. Disk space requirements
13.11. Network Requirements
13.12. Security
13.13. Backups
13.14. Migration of a non-HA store to HA
13.15. Disaster Recovery
13.16. Performance
14. Virtual Host XML configuration file
14.1. Introduction
14.2. Configuring ACL
14.3. Configuring MemoryMessageStore
14.4. Configuring BDBMessageStore
14.5. Configuring DerbyMessageStore
14.6. Configuring JDBCMessageStore
14.7. Configuring Exchanges
14.8. Configuring Queues
14.8.1. Simple
14.8.2. Priority
14.8.3. Sorted
14.8.4. LVQ
14.9. Configuring of Producer Flow Control
14.10. Configuring of Disk Quota-based Flow Control
14.11. Configuring Transaction Timeouts
14.12. Configuring DLQs/Maximum Delivery Count
14.13. An example of virtual host configuration file
15. Miscellaneous
15.1. JVM Installation verification
15.1.1. Verify JVM on Windows
15.1.2. Verify JVM on Unix

List of Figures

4.1. Broker Model
4.2. Virtual Host Model
13.1. Key for figures
13.2. Normal operation of a two-node cluster
13.3. Failure of master and recovery sequence
13.4. Failure of replica and subsequent recovery sequence
13.5. Partition of the network separating master and replica
13.6. Split Brain
13.7. BDBHAMessageStore view from jconsole.
13.8. Test results

List of Tables

5.1. Base Configuration Properties
5.2. Rest services
9.1. Queue-declare arguments understood for priority, sorted and LVQ queues
9.2. Queue Declare Message Group Configuration Arguments
11.1. List of ACL permission
11.2. List of ACL actions
11.3. List of ACL objects
11.4. List of ACL properties
11.5. List of ACL rules
13.1. Effect of different durability guarantees
13.2. Mbean BDBHAMessageStore attributes
13.3. Mbean BDBHAMessageStore operations
13.4. Number of producers/consumers in performance tests
13.5. Performance Comparison

List of Examples

5.1. JSON 'Initial configuration' File
5.2. Examples of queue creation using curl:
5.3. Example of binding a queue to an exchange using curl
9.1. Creation of an LVQ using the Qpid extension to JMS
9.2. Creation of a sorted queue using JMX
13.1. Configuring a VirtualHost to use the BDBHAMessageStore
13.2. Example of connection URL for the HA Cluster
13.3. Example of java code to get the node state value
13.4. Using DbPing utility for monitoring HA nodes.
13.5. Performing store backup by using BDBBackup class directly
13.6. Performing store backup by using backup.sh bash script
13.7. Enabling replication
13.8. Example of XML configuration for HA message store
13.9. Reseting of replication group with DbResetRepGroup
14.1. Configuring a VirtualHost to use the MemoryMessageStore
14.2. Configuring a VirtualHost to use the BDBMessageStore
14.3. Configuring a VirtualHost to use the DerbyMessageStore
14.4. Configuring a VirtualHost to use the JDBCMessageStore
14.5. Configuring Exchanges on VirtualHost
14.6. Configuring a simple queue
14.7. Configuring a priority queue
14.8. Configuring a priority queue with fewer priorities
14.9. Configuring a sorted queue
14.10. Configuring a LVQ queue
14.11. Configuring a LVQ queue with custom message property name
14.12. Configuring a queue depth limit
14.13. Configuring of default queue depth limit on virtualhost
14.14. Configuring a limit on a store
14.15. Configuring producer transaction timeout
14.16. Enabling DLQs and maximum delivery count at virtualhost and queue level within virtualhosts.xml
14.17. An example of virtual host configuration file
   Next
   Chapter 1. Introduction