Menu Search

Apache Qpid Broker for 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.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. Queue Declare Arguments
4.7.3. Messaging Grouping
4.7.4. Using low pre-fetch with special queue types
4.7.5. Forcing all consumers to be non-destructive
4.7.6. Holding messages on a Queue
4.8. Ports
4.9. Authentication Providers
4.10. Other Services
4.10.1. Access Control Providers
4.10.2. Group Providers
4.10.3. Keystores
4.10.4. Truststores
4.10.5. 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. Overwriting An Existing Configuration Store
5.6. Configuration Store Type
5.7. Customising Configuration using Configuration Properties
5.8. Example of JSON '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. Cross Origin Resource Sharing (CORS)
6.4. AMQP Intrinstic Management
6.5. QMF
7. Managing Entities
7.1. General Description
7.2. Entity/Management Channel Support Matrix
7.3. Broker
7.3.1. Attributes
7.3.2. Context
7.3.3. Children
7.3.4. Lifecycle
7.4. Virtualhost Nodes
7.4.1. Types
7.4.2. Attributes
7.4.3. Children
7.4.4. Lifecycle
7.5. VirtualHosts
7.5.1. Types
7.5.2. Context
7.5.3. Attributes
7.5.4. Children
7.5.5. Lifecycle
7.6. Remote Replication Nodes
7.6.1. Attributes
7.6.2. Children
7.6.3. Lifecycle
7.6.4. Operations
7.7. Exchanges
7.7.1. Types
7.7.2. Attributes
7.7.3. Children
7.7.4. Lifecycle
7.8. Queues
7.8.1. Types
7.8.2. Attributes
7.8.3. Children
7.8.4. Lifecycle
7.9. Consumers
7.9.1. Context
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. HTTP Plugin
7.16.1. Attributes
7.16.2. Children
7.16.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.2. Group Providers
8.2.1. GroupFile Provider
8.2.2. ManagedGroupProvider
8.2.3. CloudFoundryDashboardManagementGroupProvider
8.3. Access Control Lists
8.3.1. Writing .acl files
8.3.2. Syntax
8.3.3. Worked Examples
8.4. Configuration Encryption
8.4.1. Configuration
8.4.2. Alternate Implementations
9. Runtime
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. Producer Flow Control
9.3. Producer Transaction Timeout
9.3.1. General Information
9.3.2. Purpose
9.3.3. Scope
9.3.4. Effect
9.3.5. Configuration
9.4. Handing Undeliverable Messages
9.4.1. Introduction
9.4.2. Maximum Delivery Count
9.4.3. Dead Letter Queues (DLQ)
9.5. Closing client connections on unroutable mandatory messages
9.5.1. Summary
9.5.2. Configuring closeWhenNoRoute
9.6. Flow to Disk
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
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.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. Queue Alerts
E. Miscellaneous
E.1. JVM Installation verification
E.1.1. Verify JVM on Windows
E.1.2. Verify JVM on Unix
E.2. Installing External JDBC Driver
E.3. Installing Oracle BDB JE