Apache Qpid Broker-J
		Next

Apache Qpid Broker-J

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.4. Installation on Windows

2.4.1. Setting the working directory

2.5. Installation on UNIX platforms

2.5.1. Setting the working directory

2.6. 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. Overview

4.2. Broker

4.3. Virtualhost Nodes

4.4. Remote Replication Nodes

4.5. Virtualhosts

4.6. Exchanges

4.6.1. Predeclared Exchanges
4.6.2. Exchange Types
4.6.3. Binding Arguments
4.6.4. Unrouteable Messages

4.7. Queues

4.7.1. Types
4.7.2. Messaging Grouping
4.7.3. Forcing all consumers to be non-destructive
4.7.4. Holding messages on a Queue
4.7.5. Controlling Queue Size
4.7.6. Using low pre-fetch with special queue types

4.9. Authentication Providers

4.10. Other Services

4.10.1. Access Control Providers
4.10.2. Connection Limit Providers
4.10.3. Group Providers
4.10.4. Keystores
4.10.5. Truststores
4.10.6. Loggers

5. Initial Configuration

5.1. Introduction
5.2. Configuration Store Location
5.3. 'Initial Configuration' Location
5.4. Creating an 'Initial Configuration' JSON File
5.5. Configuration Store Type
5.6. Customising Configuration using Configuration Properties
5.7. Example of JSON 'Initial Configuration'
5.8. Virtualhost Initial Configuration

6. Management Channels

6.1. HTTP Management

6.1.1. Introduction
6.1.2. Default Configuration

6.2. Web Management Console

6.2.1. Accessing the Console
6.2.2. Orientation
6.2.3. Managing Entities

6.3. REST API

6.3.1. Introduction
6.3.2. REST API documentation
6.3.3. Authentication
6.3.4. Configured Object creation
6.3.5. Configured Object update
6.3.6. Configured Object deletion
6.3.7. Retrieving Configured Object details
6.3.8. Configured Object operations
6.3.9. HTTP status codes returned by REST interfaces
6.3.10. Examples of REST requests with curl
6.3.11. Query API
6.3.12. Query Engine
6.3.13. Cross Origin Resource Sharing (CORS)

6.4. Prometheus Metrics

6.5. AMQP Intrinstic Management

7. Managing Entities

7.1. General Description

7.2. Broker

7.2.1. Attributes
7.2.2. Context
7.2.3. Children
7.2.4. Lifecycle

7.3. Virtualhost Nodes

7.3.1. Types
7.3.2. Attributes
7.3.3. Children
7.3.4. Lifecycle

7.4. VirtualHosts

7.4.1. Types
7.4.2. Context
7.4.3. Attributes
7.4.4. Children
7.4.5. Lifecycle

7.5. Remote Replication Nodes

7.5.1. Attributes
7.5.2. Children
7.5.3. Lifecycle
7.5.4. Operations

7.6. Exchanges

7.6.1. Types
7.6.2. Attributes
7.6.3. Lifecycle

7.7. Queues

7.7.1. Types
7.7.2. Attributes
7.7.3. Lifecycle

7.8. Consumers

7.8.1. Context

7.9. Producers

7.10. Ports

7.10.1. Context
7.10.2. Attributes
7.10.3. Children
7.10.4. Lifecycle

7.11. Authentication Providers

7.11.1. Types
7.11.2. Attributes
7.11.3. Children
7.11.4. Lifecycle

7.12. Keystores

7.12.1. Types
7.12.2. Attributes
7.12.3. Children
7.12.4. Lifecycle

7.13. Truststores

7.13.1. Types
7.13.2. Attributes
7.13.3. Children
7.13.4. Lifecycle

7.14. Group Providers

7.15. Access Control Providers

7.16. Connection Limit Providers

7.17. HTTP Plugin

7.17.1. Attributes
7.17.2. Children
7.17.3. Lifecycle

8. Security

8.1. Authentication Providers

8.1.1. Simple LDAP
8.1.2. Kerberos
8.1.3. OAuth2
8.1.4. External (SSL Client Certificates)
8.1.5. Anonymous
8.1.6. SCRAM SHA
8.1.7. Plain
8.1.8. Plain Password File (Deprecated)
8.1.9. MD5 Provider
8.1.10. Base64MD5 Password File (Deprecated)
8.1.11. Composite Provider

8.2. Group Providers

8.2.1. GroupFile Provider
8.2.2. ManagedGroupProvider
8.2.3. CloudFoundryDashboardManagementGroupProvider

8.3. Access Control Providers

8.3.1. Types
8.3.2. ACL Rules
8.3.3. Syntax
8.3.4. Worked Examples

8.4. Connection Limit Providers

8.4.1. Types
8.4.2. Connection Limit Rules
8.4.3. Syntax
8.4.4. Worked Example

8.5. Configuration Encryption

8.5.1. Configuration
8.5.2. Alternate Implementations

9.1. Logging

9.1.1. Concepts
9.1.2. Default Configuration
9.1.3. Loggers
9.1.4. Inclusion Rules
9.1.5. Logging Management

9.2. Disk Space Management

9.2.1. Disk quota-based flow control

9.3. Transaction Timeout

9.3.1. General Information
9.3.2. Purpose
9.3.3. Effect
9.3.4. Configuration

9.4. Handing Undeliverable Messages

9.4.1. Introduction
9.4.2. Maximum Delivery Count
9.4.3. Alternate Binding

9.5. Closing client connections on unroutable mandatory messages

9.5.1. Summary
9.5.2. Configuring closeWhenNoRoute

9.6. Flow to Disk

9.6.1. Flow to Disk Monitoring
9.6.2. Flow to Disk Logging

9.7. Consumers

9.7.1. Priority

9.8. Background Recovery

9.9. Message Compression

9.10. Connection Limits

9.11. Memory

9.11.1. Introduction
9.11.2. Types of Memory
9.11.3. Memory Usage in the Broker
9.11.4. Low Memory Conditions
9.11.5. Defaults
9.11.6. Memory Tuning the Broker

9.12. Broker Instrumentation

10. High Availability

10.1. General Introduction

10.2. High Availability Overview

10.3. Creating a group

10.4. Behaviour of the Group

10.4.1. Default Behaviour
10.4.2. Synchronization Policy
10.4.3. Node Priority
10.4.4. Required Minimum Number Of Nodes
10.4.5. Allow to Operate Solo
10.4.6. Maximum message size

10.5. Node Operations

10.5.1. Lifecycle
10.5.2. Transfer Master

10.6. Client failover

10.7. Disk space requirements

10.8. Network Requirements

10.9. Security

10.10. Backups

10.11. Reset Group Information

11. Backup And Recovery

11.1. Broker

11.2. Virtualhost Node

11.2.1. BDB
11.2.2. BDB-HA
11.2.3. Derby
11.2.4. JDBC
11.2.5. JSON

11.3. Virtualhost

11.3.1. BDB
11.3.2. Derby
11.3.3. JDBC
11.3.4. Provided
11.3.5. BDB-HA

A. Environment Variables

B. System Properties

C. Operational Logging

D. Statistics Reporting

D.1. Statistics Report Period
D.2. Statistic Report Patterns
D.3. Examples

E. Queue Alerts

F. Miscellaneous

F.1. JVM Installation verification

F.1.1. Verify JVM on Windows
F.1.2. Verify JVM on Unix

F.2. Installing External JDBC Driver

G. Queue Declaration Arguments supported by the Broker

H. BDB HA initial configuration

H.1. Example of BDB HA 'Initial Configuration'
H.2. Creation of BDB HA group using an initial configuration.

12. Docker Images

12.1. Building Container Image

12.2. Running the Container

12.2.1. Container Start
12.2.2. Container Volume
12.2.3. Stopping the Container

12.3. Broker Users

12.4. Broker Customization

12.4.1. Exchanges
12.4.2. Queues
12.4.3. Users
12.4.4. Overriding Broker Configuration

List of Figures

4.1. Message Flow through Key Entities
4.2. Broker Structure showing major entities
4.3. Virtualhost Model showing major entities
4.4. Direct exchange
4.5. Topic exchange - exact match on topic name
4.6. Topic exchange - matching on hierarchical topic patterns
4.7. Topic exchange - matching on JMS message selector
4.8. Fanout exchange
4.9. Control flow during Authentication
6.1. Web Management Console - Authentication
6.2. Web Management Orientation - Console
6.3. Web Management Orientation - Tab
6.4. Web Management Orientation - Add Dialogue
6.5. Web Management Orientation - Edit Dialogue
6.6. Web Management Orientation - Context Variables
9.1. Viewing a file logger
9.2. Editing an inclusion rule
9.3. Viewing a memory logger
10.1. 3-node group deployed across three Brokers.
10.2. Creating 1st node in a group
10.3. Adding subsequent nodes to the group
10.4. View of group from one node

List of Tables

4.1. Setting the replay period using a Qpid JMS AMQP 0-x address
5.1. Base Configuration Properties
6.1. HTTP status codes returned by REST interfaces
6.2. Query API URLs
6.3. Query API request parameters
6.4. Query API functions
6.5. Query Engine Configuration
6.6. Additional Request Parameters
6.7. Query Engine Domains
6.8. BETWEEN Parameters
6.9. EQUAL Parameters
6.10. GREATER THAN Parameters
6.11. GREATER THAN OR EQUAL Parameters
6.12. IN Parameters
6.13. IS NULL Parameters
6.14. LESS THAN Parameters
6.15. LESS THAN OR EQUAL Parameters
6.16. LIKE Parameters
6.17. CASE Parameters
6.18. Default sorting fields
6.19. AVG Parameters
6.20. COUNT Parameters
6.21. MAX Parameters
6.22. MIN Parameters
6.23. SUM Parameters
6.24. DATE Parameters
6.25. DATEADD Parameters
6.26. DATEDIFF Parameters
6.27. EXTRACT Parameters
6.28. COALESCE Parameters
6.29. ABS Parameters
6.30. ROUND Parameters
6.31. TRUNC Parameters
6.32. LENGTH Parameters
6.33. LENGTH Parameters
6.34. LOWER Parameters
6.35. LTRIM Parameters
6.36. POSITION Parameters
6.37. REPLACE Parameters
6.38. RTRIM Parameters
6.39. SUBSTRING Parameters
6.40. TRIM Parameters
6.41. UPPER Parameters
8.1. SASL Mechanisms
8.2. List of ACL permission
8.3. List of ACL actions
8.4. List of ACL objects
8.5. List of ACL properties
8.6. List of connection limit (CLT) properties
9.1. Setting the consumer priority
A.1. Environment variables
B.1. System properties
C.1. Actors Entities
C.2. Subject Entities
C.3. Broker Log Messages
C.4. Management Log Messages
C.5. Virtual Host Log Messages
C.6. Queue Log Messages
C.7. Exchange Log Messages
C.8. Binding Log Messages
C.9. Connection Log Messages
C.10. Channel Log Messages
C.11. Subscription Log Messages
C.12. Message Store Log Messages
C.13. Transaction Store Log Messages
C.14. Configuration Store Log Messages
C.15. HA Log Messages
C.16. Port Log Messages
C.17. Resource Limit Log Messages
C.18. User Log Messages
E.1. Queue Alerts
G.1. Queue declare arguments
12.1. Environment Variables

List of Examples

5.1. JSON 'Initial configuration' File
5.2. Example of virtual host initial configuration provided as stringified JSON
6.1. Examples of REST calls for Queue creation
6.2. Examples of REST calls for Queue update
6.3. Examples of REST calls for Queue deletion
6.4. Example REST call invoking the operation clear queue
6.5. Examples of queue creation using curl (authenticating as user admin):
6.6. Example of a Query API request to retrieve queue names and depths.
6.7. Example of Query API call for queue names and depths.
8.1. Worked example 1 - Management rights
8.2. Worked example 2a - Simple Messaging - Broker ACL rules
8.3. Worked example 2b - Simple Messaging - Broker ACL rules with multi-value property
8.4. Worked example 2 - Simple Messaging - Virtualhost ACL rules
8.5. Worked example 3 - firewall-like access control
8.6. CLT file example
9.1. Flow to Disk logging rule
10.1. Resetting of replication group with DbResetRepGroup
11.1. Performing store backup by using BDBBackup class directly
D.1. Enabling statistics for a single queue using the REST API and cURL
D.2. Disabling statistics for a single queue using the REST API and cURL
D.3. Enabling statistics for all queues using the REST API and cURL
H.1. BDB HA 'Initial configuration'

		Next
		Chapter 1. Introduction

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