<div class="docbook"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache Qpid Broker-J</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="Java-Broker-Introduction.html">Next</a></td></tr></table><hr /></div><div class="book"><div class="titlepage"><div><div><h1 class="title"><a id="d0e2"></a>Apache Qpid Broker-J</h1></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="Java-Broker-Introduction.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="Java-Broker-Installation.html">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation.html#Java-Broker-Installation-Introduction">2.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html">2.2. Prerequisites</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Java">2.2.1. Java Platform</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Disk">2.2.2. Disk</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Memory">2.2.3. Memory</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-OperatingSystemAccount">2.2.4. Operating System Account</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-Download.html">2.3. Download</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-Download.html#Java-Broker-Installation-Download-Release">2.3.1. Broker Release</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-InstallationWindows.html">2.4. Installation on Windows</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-InstallationWindows.html#Java-Broker-Installation-InstallationWindows-SettingQPIDWORK">2.4.1. Setting the working directory</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-InstallationUnix.html">2.5. Installation on UNIX platforms</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-InstallationUnix.html#Java-Broker-Installation-InstallationUnix-SettingQPIDWORK">2.5.1. Setting the working directory</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-OptionalDependencies.html">2.6. Optional Dependencies</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Getting-Started.html">3. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Getting-Started.html#Java-Broker-Getting-Started-Introduction">3.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Getting-Started-Starting-Stopping-Windows.html">3.2. Starting/Stopping the broker on Windows</a></span></dt><dt><span class="section"><a href="Java-Broker-Getting-Started-Starting-Stopping-Unix.html">3.3. Starting/Stopping the broker on Unix</a></span></dt><dt><span class="section"><a href="Java-Broker-Getting-Started-Logging.html">3.4. Log file</a></span></dt><dt><span class="section"><a href="Java-Broker-Getting-Started-CommandLine.html">3.5. Using the command line</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Concepts.html">4. Concepts</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Concepts.html#Java-Broker-Concepts-Overview">4.1. Overview</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Broker.html">4.2. Broker</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Virtualhost-Nodes.html">4.3. Virtualhost Nodes</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-RemoteReplicationNodes.html">4.4. Remote Replication Nodes</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Virtualhosts.html">4.5. Virtualhosts</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Exchanges.html">4.6. Exchanges</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Predeclared">4.6.1. Predeclared Exchanges</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Types">4.6.2. Exchange Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-BindingArguments">4.6.3. Binding Arguments</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-UnroutableMessage">4.6.4. Unrouteable Messages</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html">4.7. Queues</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queues-Types">4.7.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queues-Message-Grouping">4.7.2. Messaging Grouping</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-EnsureNonDestructiveConsumers">4.7.3. Forcing all consumers to be non-destructive</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-HoldingEntries">4.7.4. Holding messages on a Queue</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy">4.7.5. Controlling Queue Size</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queues-SetLowPrefetch">4.7.6. Using low pre-fetch with special queue types</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Concepts-Ports.html">4.8. Ports</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Authentication-Providers.html">4.9. Authentication Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html">4.10. Other Services</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Access-Control-Providers">4.10.1. Access Control Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Connection-Limit-Providers">4.10.2. Connection Limit Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Group-Providers">4.10.3. Group Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Keystores">4.10.4. Keystores</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Truststores">4.10.5. Truststores</a></span></dt><dt><span class="section"><a href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Loggers">4.10.6. Loggers</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="Java-Broker-Initial-Configuration.html">5. Initial Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Initial-Configuration.html#Java-Broker-Initial-Configuration-Introduction">5.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Location.html">5.2. Configuration Store Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">5.3. 'Initial Configuration' Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Create-Initial-Config.html">5.4. Creating an 'Initial Configuration' JSON File</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Type.html">5.5. Configuration Store Type</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Configuration-Properties.html">5.6. Customising Configuration using Configuration Properties</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Example.html">5.7. Example of JSON 'Initial Configuration'</a></span></dt><dt><span class="section"><a href="Java-Broker-Virtual-Host-Initial-Configuration.html">5.8. Virtualhost Initial Configuration</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Management-Channel.html">6. Management Channels</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP">6.1. HTTP Management</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP-Introduction">6.1.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP-DefaultConfiguration">6.1.2. Default Configuration</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html">6.2. Web Management Console</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Accessing">6.2.1. Accessing the Console</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Orientation">6.2.2. Orientation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities">6.2.3. Managing Entities</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html">6.3. REST API</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Introduction">6.3.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-APIDocs">6.3.2. REST API documentation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Authentication">6.3.3. Authentication</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Create">6.3.4. Configured Object creation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Update">6.3.5. Configured Object update</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Delete">6.3.6. Configured Object deletion</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Get">6.3.7. Retrieving Configured Object details</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Operations">6.3.8. Configured Object operations</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Status-Codes">6.3.9. HTTP status codes returned by REST interfaces</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Examples">6.3.10. Examples of REST requests with curl</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-Query-API">6.3.11. Query API</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-Query-Engine">6.3.12. Query Engine</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-CORS">6.3.13. Cross Origin Resource Sharing (CORS)</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Metrics.html">6.4. Prometheus Metrics</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">6.5. AMQP Intrinstic Management</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Management-Managing-Entities.html">7. Managing Entities</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Entities.html#Java-Broker-Management-Managing-Entities-General">7.1. General Description</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html">7.2. Broker</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Attributes">7.2.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Context">7.2.2. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Children">7.2.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Lifecycle">7.2.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html">7.3. Virtualhost Nodes</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Nodes-Types">7.3.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">7.3.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Node-Children">7.3.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Node-Lifecycle">7.3.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html">7.4. VirtualHosts</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhosts-Types">7.4.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Context">7.4.2. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Attributes">7.4.3. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Children">7.4.4. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Lifecycle">7.4.5. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html">7.5. Remote Replication Nodes</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Attributes">7.5.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Children">7.5.2. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Lifecycle">7.5.3. Lifecycle</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplication-Nodes-Operations">7.5.4. Operations</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html">7.6. Exchanges</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Types">7.6.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Attributes">7.6.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Lifecycle">7.6.3. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html">7.7. Queues</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queues-Types">7.7.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queues-Attributes">7.7.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queue-Lifecycle">7.7.3. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Consumers.html">7.8. Consumers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Consumers.html#Java-Broker-Management-Managing-Consumers-Context">7.8.1. Context</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Producers.html">7.9. Producers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html">7.10. Ports</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Context">7.10.1. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Attributes">7.10.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Children">7.10.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Lifecycle">7.10.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html">7.11. Authentication Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Types">7.11.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Attributes">7.11.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Children">7.11.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Lifecycle">7.11.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html">7.12. Keystores</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Types">7.12.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Attributes">7.12.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Children">7.12.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Lifecycle">7.12.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html">7.13. Truststores</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Types">7.13.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Attributes">7.13.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Children">7.13.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Lifecycle">7.13.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Group-Providers.html">7.14. Group Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Access-Control-Providers.html">7.15. Access Control Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Connection-Limit-Providers.html">7.16. Connection Limit Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html">7.17. HTTP Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Attributes">7.17.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Children">7.17.2. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Lifecycle">7.17.3. Lifecycle</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="Java-Broker-Security.html">8. Security</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Authentication-Providers">8.1. Authentication Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-LDAP-Provider">8.1.1. Simple LDAP</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Kerberos-Provider">8.1.2. Kerberos</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-OAuth2-Provider">8.1.3. OAuth2</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-External-Provider">8.1.4. External (SSL Client Certificates)</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Anonymous-Provider">8.1.5. Anonymous</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-ScramSha-Providers">8.1.6. SCRAM SHA</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Plain-Provider">8.1.7. Plain</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-PlainPasswordFile-Provider">8.1.8. Plain Password File <span class="emphasis"><em>(Deprecated)</em></span></a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-MD5-Provider">8.1.9. MD5 Provider</a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Base64MD5PasswordFile-Provider">8.1.10. Base64MD5 Password File <span class="emphasis"><em>(Deprecated)</em></span></a></span></dt><dt><span class="section"><a href="Java-Broker-Security.html#Java-Broker-Security-Composite-Provider">8.1.11. Composite Provider</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Security-Group-Providers.html">8.2. Group Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security-Group-Providers.html#File-Group-Manager">8.2.1. GroupFile Provider</a></span></dt><dt><span class="section"><a href="Java-Broker-Security-Group-Providers.html#Java-Broker-Security-Group-Providers-ManagedGroupProvider">8.2.2. ManagedGroupProvider</a></span></dt><dt><span class="section"><a href="Java-Broker-Security-Group-Providers.html#Java-Broker-Security-Group-Providers-CloudFoundry">8.2.3. CloudFoundryDashboardManagementGroupProvider</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Security-AccessControlProviders.html">8.3. Access Control Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security-AccessControlProviders.html#Java-Broker-Security-AccessControlProviders-Types">8.3.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Security-AccessControlProviders.html#Java-Broker-Security-AccessControlProviders-ACLRules">8.3.2. 
       ACL Rules
    </a></span></dt><dt><span class="section"><a href="Java-Broker-Security-AccessControlProviders.html#Java-Broker-Security-AccessControlProviders-Syntax">8.3.3. 
       Syntax
    </a></span></dt><dt><span class="section"><a href="Java-Broker-Security-AccessControlProviders.html#Java-Broker-Security-AccessControlProviders-WorkedExamples">8.3.4. 
      Worked Examples
    </a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Security-ConnectionLimitProviders.html">8.4. Connection Limit Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security-ConnectionLimitProviders.html#Java-Broker-Security-ConnectionLimitProviders-Types">8.4.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Security-ConnectionLimitProviders.html#Java-Broker-Security-ConnectionLimitProviders-Rules">8.4.2. 
            Connection Limit Rules
        </a></span></dt><dt><span class="section"><a href="Java-Broker-Security-ConnectionLimitProviders.html#Java-Broker-Security-ConnectionLimitProviders-Syntax">8.4.3. 
            Syntax
        </a></span></dt><dt><span class="section"><a href="Java-Broker-Security-ConnectionLimitProviders.html#Java-Broker-Security-ConnectionLimitProviders-WorkedExample">8.4.4. 
            Worked Example
        </a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Security-Configuration-Encryption.html">8.5. Configuration Encryption</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Security-Configuration-Encryption.html#Java-Broker-Security-Configuration-Encryption-Configuration">8.5.1. Configuration</a></span></dt><dt><span class="section"><a href="Java-Broker-Security-Configuration-Encryption.html#Java-Broker-Security-Configuration-Encryption-Alternate-Implementations">8.5.2. Alternate Implementations</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="Java-Broker-Runtime.html">9. Runtime</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging">9.1. Logging</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Concepts">9.1.1. Concepts</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Default-Configuration">9.1.2. Default Configuration</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Loggers">9.1.3. Loggers</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-InclusionRules">9.1.4. Inclusion Rules</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Management">9.1.5. Logging Management</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Disk-Space-Management.html">9.2. Disk Space Management</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Disk-Space-Management.html#Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control">9.2.1. Disk quota-based flow control</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Transaction-Timeout.html">9.3. Transaction Timeout</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Transaction-Timeout.html#Java-Broker-Runtime-Transaction-Timeout-GeneralInformation">9.3.1. General Information</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Transaction-Timeout.html#Java-Broker-Runtime-Transaction-Timeout-Purpose">9.3.2. Purpose</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Transaction-Timeout.html#Java-Broker-Runtime-Transaction-Timeout-Effect">9.3.3. Effect</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Transaction-Timeout.html#Java-Broker-Runtime-Transaction-Timeout-Configuration">9.3.4. Configuration</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html">9.4. Handing Undeliverable Messages</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Introduction">9.4.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count">9.4.2. Maximum Delivery Count</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues">9.4.3. Alternate Binding</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Close-Connection-When-No-Route.html">9.5. Closing client connections on unroutable mandatory messages</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Close-Connection-When-No-Route.html#Java-Broker-Runtime-Close-Connection-When-No-Route-Summary">9.5.1. Summary</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Close-Connection-When-No-Route.html#Java-Broker-Runtime-Close-Connection-When-No-Route-Configuration">9.5.2. Configuring
        <span class="emphasis"><em>closeWhenNoRoute</em></span>
    </a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Flow-To-Disk.html">9.6. Flow to Disk</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Flow-To-Disk.html#Java-Broker-Runtime-Flow-To-Disk-Monitoring">9.6.1. Flow to Disk Monitoring</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Flow-To-Disk.html#Java-Broker-Runtime-Flow-To-Disk-Logging">9.6.2. Flow to Disk Logging</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Consumers.html">9.7. Consumers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Consumers.html#Java-Broker-Runtime-Consumers-Prioirty">9.7.1. Priority</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Background-Recovery.html">9.8. Background Recovery</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Message-Compression.html">9.9. Message Compression</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Connection-Limit.html">9.10. Connection Limits</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html">9.11. Memory</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Introduction">9.11.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Types">9.11.2. Types of Memory</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Usage">9.11.3. Memory Usage in the Broker</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Low-Memory">9.11.4. Low Memory Conditions</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Defaults">9.11.5. Defaults</a></span></dt><dt><span class="section"><a href="Java-Broker-Runtime-Memory.html#Java-Broker-Runtime-Memory-Tuning">9.11.6. Memory Tuning the Broker</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Runtime-Instrumentation.html">9.12. Broker Instrumentation</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-High-Availability.html">10. High Availability</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-High-Availability.html#Java-Broker-High-Availability-GeneralIntroduction">10.1. General Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-OverviewOfHA.html">10.2. High Availability Overview</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-CreatingGroup.html">10.3. Creating a group</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html">10.4. Behaviour of the Group</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-Default-Behaviour">10.4.1. Default Behaviour</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-SynchronizationPolicy">10.4.2. Synchronization Policy</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-NodePriority">10.4.3. Node Priority</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-MinimumNumberOfNodes">10.4.4. Required Minimum Number Of Nodes</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-DesignatedPrimary">10.4.5. Allow to Operate Solo</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-MaximumMessageSize">10.4.6. Maximum message size</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-High-Availability-NodeOperations.html">10.5. Node Operations</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-High-Availability-NodeOperations.html#Java-Broker-High-Availability-NodeOperations-Lifecycle">10.5.1. Lifecycle</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-NodeOperations.html#Java-Broker-High-Availability-NodeOperations-TransferMaster">10.5.2. Transfer Master</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-High-Availability-ClientFailover.html">10.6. Client failover</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-DiskSpace.html">10.7. Disk space requirements</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Network-Requirements.html">10.8. Network Requirements</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Security.html">10.9. Security</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Backup.html">10.10. Backups</a></span></dt><dt><span class="section"><a href="Java-Broker-High-Availability-Reset-Group-Infomational.html">10.11. Reset Group Information</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Backup-And-Recovery.html">11. Backup And Recovery</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery.html#Java-Broker-Backup-And-Recovery-Broker">11.1. Broker</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html">11.2. Virtualhost Node</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB">11.2.1. BDB</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB-HA">11.2.2. BDB-HA</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-Derby">11.2.3. Derby</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-JDBC">11.2.4. JDBC</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-JSON">11.2.5. JSON</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html">11.3. Virtualhost</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html#Java-Broker-Backup-And-Recovery-Virtualhost-BDB">11.3.1. BDB</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html#Java-Broker-Backup-And-Recovery-Virtualhost-Derby">11.3.2. Derby</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html#Java-Broker-Backup-And-Recovery-Virtualhost-JDBC">11.3.3. JDBC</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html#Java-Broker-Backup-And-Recovery-Virtualhost-Provided">11.3.4. Provided</a></span></dt><dt><span class="section"><a href="Java-Broker-Backup-And-Recovery-Virtualhost.html#Java-Broker-Backup-And-Recovery-Virtualhost-BDBHA">11.3.5. BDB-HA</a></span></dt></dl></dd></dl></dd><dt><span class="appendix"><a href="Java-Broker-Appendix-Environment-Variables.html">A. Environment Variables</a></span></dt><dt><span class="appendix"><a href="Java-Broker-Appendix-System-Properties.html">B. System Properties</a></span></dt><dt><span class="appendix"><a href="Java-Broker-Appendix-Operation-Logging.html">C. Operational Logging</a></span></dt><dt><span class="appendix"><a href="Java-Broker-Appendix-Statistics-Reporting.html">D. Statistics Reporting</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Appendix-Statistics-Reporting.html#d0e12961">D.1. Statistics Report Period</a></span></dt><dt><span class="section"><a href="apds02.html">D.2. Statistic Report Patterns</a></span></dt><dt><span class="section"><a href="apds03.html">D.3. Examples</a></span></dt></dl></dd><dt><span class="appendix"><a href="Java-Broker-Appendix-Queue-Alerts.html">E. Queue Alerts</a></span></dt><dt><span class="appendix"><a href="Java-Broker-Miscellaneous.html">F. Miscellaneous</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification">F.1. JVM Installation verification</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification-Windows">F.1.1. Verify JVM on Windows</a></span></dt><dt><span class="section"><a href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification-Unix">F.1.2. Verify JVM on Unix</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver.html">F.2. Installing External JDBC Driver</a></span></dt></dl></dd><dt><span class="appendix"><a href="Java-Broker-Appendix-Queue-Declare-Arguments.html">G. Queue Declaration Arguments supported by the Broker</a></span></dt><dt><span class="appendix"><a href="Java-Broker-Appendix-BDB-HA-initial-configuration.html">H. BDB HA initial configuration</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Appendix-BDB-HA-initial-configuration.html#Java-Broker-Appendix-BDB-HA-initial-configuration-example">H.1. Example of BDB HA 'Initial Configuration'</a></span></dt><dt><span class="section"><a href="Java-Broker-Appendix-BDB-HA-initial-configuration-creation.html">H.2. Creation of BDB HA group using an initial configuration.</a></span></dt></dl></dd><dt><span class="chapter"><a href="Java-Broker-Docker.html">12. Docker Images</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Docker.html#Java-Broker-Docker-Building-Image">12.1. Building Container Image</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Running-The-Container.html">12.2. Running the Container</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Docker-Running-The-Container.html#Java-Broker-Docker-Container-Start">12.2.1. Container Start</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Running-The-Container.html#Java-Broker-Docker-Container-Volume">12.2.2. Container Volume</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Running-The-Container.html#Java-Broker-Docker-Container-Stop">12.2.3. Stopping the Container</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Docker-Broker-Users.html">12.3. Broker Users</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Broker-Customization.html">12.4. Broker Customization</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Docker-Broker-Customization.html#Java-Broker-Docker-Broker-Customization-Exchanges">12.4.1. Exchanges</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Broker-Customization.html#Java-Broker-Docker-Broker-Customization-Queues">12.4.2. Queues</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Broker-Customization.html#Java-Broker-Docker-Broker-Customization-Users">12.4.3. Users</a></span></dt><dt><span class="section"><a href="Java-Broker-Docker-Broker-Customization.html#Java-Broker-Docker-Broker-Customization-Override">12.4.4. Overriding Broker Configuration</a></span></dt></dl></dd></dl></dd></dl></div><div class="list-of-figures"><p><strong>List of Figures</strong></p><dl><dt>4.1. <a href="Java-Broker-Concepts.html#d0e403">Message Flow through Key Entities</a></dt><dt>4.2. <a href="Java-Broker-Concepts.html#d0e415">Broker Structure showing major entities</a></dt><dt>4.3. <a href="Java-Broker-Concepts-Virtualhosts.html#d0e523">Virtualhost Model showing major entities</a></dt><dt>4.4. <a href="Java-Broker-Concepts-Exchanges.html#d0e641">Direct exchange</a></dt><dt>4.5. <a href="Java-Broker-Concepts-Exchanges.html#d0e683">Topic exchange - exact match on topic name</a></dt><dt>4.6. <a href="Java-Broker-Concepts-Exchanges.html#d0e696">Topic exchange - matching on hierarchical topic patterns</a></dt><dt>4.7. <a href="Java-Broker-Concepts-Exchanges.html#d0e734">Topic exchange - matching on JMS message selector</a></dt><dt>4.8. <a href="Java-Broker-Concepts-Exchanges.html#d0e781">Fanout exchange</a></dt><dt>4.9. <a href="Java-Broker-Concepts-Ports.html#d0e1315">Control flow during Authentication</a></dt><dt>6.1. <a href="Java-Broker-Management-Channel-Web-Console.html#d0e1860">Web Management Console - Authentication</a></dt><dt>6.2. <a href="Java-Broker-Management-Channel-Web-Console.html#d0e1874">Web Management Orientation - Console</a></dt><dt>6.3. <a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Orientation-Tab">Web Management Orientation - Tab</a></dt><dt>6.4. <a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities-Add-Dialogue">Web Management Orientation - Add Dialogue</a></dt><dt>6.5. <a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities-Edit-Dialogue">Web Management Orientation - Edit Dialogue</a></dt><dt>6.6. <a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities-Context-Variables-Dialogue">Web Management Orientation - Context Variables</a></dt><dt>9.1. <a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Management-FileLogger">Viewing a file logger</a></dt><dt>9.2. <a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Management-InclusionRule">Editing an inclusion rule</a></dt><dt>9.3. <a href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging-Management-MemoryLogger">Viewing a memory logger</a></dt><dt>10.1. <a href="Java-Broker-High-Availability-OverviewOfHA.html#Java-Broker-High-Availability-OverviewOfHA-Figure">3-node group deployed across three Brokers.</a></dt><dt>10.2. <a href="Java-Broker-High-Availability-CreatingGroup.html#d0e9872">Creating 1st node in a group</a></dt><dt>10.3. <a href="Java-Broker-High-Availability-CreatingGroup.html#d0e9930">Adding subsequent nodes to the group</a></dt><dt>10.4. <a href="Java-Broker-High-Availability-CreatingGroup.html#d0e9942">View of group from one node</a></dt></dl></div><div class="list-of-tables"><p><strong>List of Tables</strong></p><dl><dt>4.1. <a href="Java-Broker-Concepts-Queues.html#d0e1096">Setting the replay period using a Qpid JMS AMQP 0-x address</a></dt><dt>5.1. <a href="Java-Broker-Initial-Configuration-Configuration-Properties.html#d0e1636">Base Configuration Properties</a></dt><dt>6.1. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2274">HTTP status codes returned by REST interfaces</a></dt><dt>6.2. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2425">Query API URLs</a></dt><dt>6.3. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2484">Query API request parameters</a></dt><dt>6.4. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2695">Query API functions</a></dt><dt>6.5. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2818">Query Engine Configuration</a></dt><dt>6.6. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2927">Additional Request Parameters</a></dt><dt>6.7. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3086">Query Engine Domains</a></dt><dt>6.8. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3233">BETWEEN Parameters</a></dt><dt>6.9. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3298">EQUAL Parameters</a></dt><dt>6.10. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3359">GREATER THAN Parameters</a></dt><dt>6.11. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3420">GREATER THAN OR EQUAL Parameters</a></dt><dt>6.12. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3481">IN Parameters</a></dt><dt>6.13. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3546">IS NULL Parameters</a></dt><dt>6.14. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3596">LESS THAN Parameters</a></dt><dt>6.15. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3657">LESS THAN OR EQUAL Parameters</a></dt><dt>6.16. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3718">LIKE Parameters</a></dt><dt>6.17. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3797">CASE Parameters</a></dt><dt>6.18. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3854">Default sorting fields</a></dt><dt>6.19. <a href="Java-Broker-Management-Channel-REST-API.html#d0e3977">AVG Parameters</a></dt><dt>6.20. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4027">COUNT Parameters</a></dt><dt>6.21. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4077">MAX Parameters</a></dt><dt>6.22. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4127">MIN Parameters</a></dt><dt>6.23. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4177">SUM Parameters</a></dt><dt>6.24. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4255">DATE Parameters</a></dt><dt>6.25. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4309">DATEADD Parameters</a></dt><dt>6.26. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4381">DATEDIFF Parameters</a></dt><dt>6.27. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4453">EXTRACT Parameters</a></dt><dt>6.28. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4517">COALESCE Parameters</a></dt><dt>6.29. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4570">ABS Parameters</a></dt><dt>6.30. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4620">ROUND Parameters</a></dt><dt>6.31. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4681">TRUNC Parameters</a></dt><dt>6.32. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4745">LENGTH Parameters</a></dt><dt>6.33. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4795">LENGTH Parameters</a></dt><dt>6.34. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4845">LOWER Parameters</a></dt><dt>6.35. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4895">LTRIM Parameters</a></dt><dt>6.36. <a href="Java-Broker-Management-Channel-REST-API.html#d0e4956">POSITION Parameters</a></dt><dt>6.37. <a href="Java-Broker-Management-Channel-REST-API.html#d0e5028">REPLACE Parameters</a></dt><dt>6.38. <a href="Java-Broker-Management-Channel-REST-API.html#d0e5100">RTRIM Parameters</a></dt><dt>6.39. <a href="Java-Broker-Management-Channel-REST-API.html#d0e5161">SUBSTRING Parameters</a></dt><dt>6.40. <a href="Java-Broker-Management-Channel-REST-API.html#d0e5233">TRIM Parameters</a></dt><dt>6.41. <a href="Java-Broker-Management-Channel-REST-API.html#d0e5294">UPPER Parameters</a></dt><dt>8.1. <a href="Java-Broker-Security.html#d0e7358">SASL Mechanisms</a></dt><dt>8.2. <a href="Java-Broker-Security-AccessControlProviders.html#table-Java-Broker-Security-AccessControlProviders-Syntax_permissions">List of ACL permission</a></dt><dt>8.3. <a href="Java-Broker-Security-AccessControlProviders.html#table-Java-Broker-Security-AccessControlProviders-Syntax_actions">List of ACL actions</a></dt><dt>8.4. <a href="Java-Broker-Security-AccessControlProviders.html#table-Java-Broker-Security-AccessControlProviders-Syntax_objects">List of ACL objects</a></dt><dt>8.5. <a href="Java-Broker-Security-AccessControlProviders.html#table-Java-Broker-Security-AccessControlProviders-Syntax_properties">List of ACL properties</a></dt><dt>8.6. <a href="Java-Broker-Security-ConnectionLimitProviders.html#table-Java-Broker-Security-ConnectionLimitProviders-Syntax_properties">List of connection limit (CLT) properties</a></dt><dt>9.1. <a href="Java-Broker-Runtime-Consumers.html#d0e9301">Setting the consumer priority</a></dt><dt>A.1. <a href="Java-Broker-Appendix-Environment-Variables.html#d0e10490">Environment variables</a></dt><dt>B.1. <a href="Java-Broker-Appendix-System-Properties.html#d0e10658">System properties</a></dt><dt>C.1. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Actor-Format">Actors Entities</a></dt><dt>C.2. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Subject-Format">Subject Entities</a></dt><dt>C.3. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Broker">Broker Log Messages</a></dt><dt>C.4. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Management">Management Log Messages</a></dt><dt>C.5. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-VirtualHost">Virtual Host Log Messages</a></dt><dt>C.6. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Queue">Queue Log Messages</a></dt><dt>C.7. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Exchange">Exchange Log Messages</a></dt><dt>C.8. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Binding">Binding Log Messages</a></dt><dt>C.9. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Connection">Connection Log Messages</a></dt><dt>C.10. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Channel">Channel Log Messages</a></dt><dt>C.11. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Subscription">Subscription Log Messages</a></dt><dt>C.12. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-MessageStore">Message Store Log Messages</a></dt><dt>C.13. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-TransactionStore">Transaction Store Log Messages</a></dt><dt>C.14. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-ConfigurationStore">Configuration Store Log Messages</a></dt><dt>C.15. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-HA">HA Log Messages</a></dt><dt>C.16. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-Port">Port Log Messages</a></dt><dt>C.17. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-ResourceLimit">Resource Limit Log Messages</a></dt><dt>C.18. <a href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-List-User">User Log Messages</a></dt><dt>E.1. <a href="Java-Broker-Appendix-Queue-Alerts.html#Java-Broker-Appendix-Queue-Alerts-Alerting-Messages">Queue Alerts</a></dt><dt>G.1. <a href="Java-Broker-Appendix-Queue-Declare-Arguments.html#Java-Broker-Appendix-Supported-Queue-Declare-Arguments">Queue declare arguments</a></dt><dt>12.1. <a href="Java-Broker-Docker-Running-The-Container.html#d0e13779">Environment Variables</a></dt></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>5.1. <a href="Java-Broker-Initial-Configuration-Example.html#d0e1705">JSON 'Initial configuration' File</a></dt><dt>5.2. <a href="Java-Broker-Virtual-Host-Initial-Configuration.html#d0e1769">Example of virtual host initial configuration provided as stringified JSON</a></dt><dt>6.1. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2147">Examples of REST calls for Queue creation</a></dt><dt>6.2. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2167">Examples of REST calls for Queue update</a></dt><dt>6.3. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2192">Examples of REST calls for Queue deletion</a></dt><dt>6.4. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2264">Example REST call invoking the operation clear queue</a></dt><dt>6.5. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2378">Examples of queue creation using curl (authenticating as user admin):</a></dt><dt>6.6. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2594">Example of a Query API request to retrieve queue names and depths.</a></dt><dt>6.7. <a href="Java-Broker-Management-Channel-REST-API.html#d0e2639">Example of Query API call for queue names and depths.</a></dt><dt>8.1. <a href="Java-Broker-Security-AccessControlProviders.html#d0e8226">Worked example 1 - Management rights</a></dt><dt>8.2. <a href="Java-Broker-Security-AccessControlProviders.html#d0e8249">Worked example 2a - Simple Messaging - Broker ACL rules</a></dt><dt>8.3. <a href="Java-Broker-Security-AccessControlProviders.html#d0e8254">Worked example 2b - Simple Messaging - Broker ACL rules with multi-value property</a></dt><dt>8.4. <a href="Java-Broker-Security-AccessControlProviders.html#d0e8264">Worked example 2 - Simple Messaging - Virtualhost ACL rules</a></dt><dt>8.5. <a href="Java-Broker-Security-AccessControlProviders.html#d0e8274">Worked example 3 - firewall-like access control</a></dt><dt>8.6. <a href="Java-Broker-Security-ConnectionLimitProviders.html#d0e8463">CLT file example</a></dt><dt>9.1. <a href="Java-Broker-Runtime-Flow-To-Disk.html#d0e9203">Flow to Disk logging rule</a></dt><dt>10.1. <a href="Java-Broker-High-Availability-Reset-Group-Infomational.html#d0e10317">Resetting of replication group with <code class="classname">DbResetRepGroup</code></a></dt><dt>11.1. <a href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#d0e10385">Performing store backup by using <code class="classname">BDBBackup</code> class
          directly</a></dt><dt>D.1. <a href="apds03.html#d0e13041">Enabling statistics for a single queue using the REST API and cURL</a></dt><dt>D.2. <a href="apds03.html#d0e13053">Disabling statistics for a single queue using the REST API and cURL</a></dt><dt>D.3. <a href="apds03.html#d0e13060">Enabling statistics for all queues using the REST API and cURL</a></dt><dt>H.1. <a href="Java-Broker-Appendix-BDB-HA-initial-configuration.html#d0e13557">BDB HA 'Initial configuration'</a></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="Java-Broker-Introduction.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></div>