blob: b3acc0d269daf946a6940491d48bffb5a87a2185 [file] [log] [blame]
<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">7.9.&#160;Ports</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Consumers.html">Prev</a>&#160;</td><th align="center" width="60%">Chapter&#160;7.&#160;Managing Entities</th><td align="right" width="20%">&#160;<a accesskey="n" href="Java-Broker-Management-Managing-Authentication-Providers.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Management-Managing-Ports"></a>7.9.&#160;Ports</h2></div></div></div><p>Ports provide TCP/IP connectivity for messaging and management. A port is defined to use a
protocol. This can be an AMQP protocol for messaging or HTTP for management.</p><p>A port is defined to have one or more transports. A transport can either be plain (TCP) or
SSL (TLS). When SSL is in use, the port can be configured to accept or require client
authentication.</p><p>Any number of ports defined to use AMQP or HTTP protocols can be defined.</p><p>Ports can only be managed by the HTTP management channel.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Ports-Context"></a>7.9.1.&#160;Context</h3></div></div></div><p>
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="emphasis"><em>qpid.port.max_open_connections</em></span>. The default maximum number
of concurrent connections supported by an AMQP port.</p></li><li class="listitem"><p><span class="emphasis"><em>qpid.port.amqp.acceptBacklog</em></span>. The backlog is the maximum
number of pending connections that may be queued by the AMQP port. Once the queue
is full, further connections will be refused. This is a request to the operating system
which may or may not be respected. The operating system itself may impose a ceiling.
<a class="footnote" href="#ftn.d0e3631" id="d0e3631"><sup class="footnote">[8]</sup></a></p></li><li class="listitem"><p><span class="emphasis"><em>qpid.port.heartbeatDelay</em></span>. For AMQP 0-8..0-10 the default period with
which Broker and client will exchange heartbeat messages (in seconds). Clients may negotiate a
different heartbeat frequency or disable it altogether. For AMQP 1.0 this setting controls the
incoming idle timeout only. A value of 0 disables.</p></li></ul></div><p>
</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Ports-Attributes"></a>7.9.2.&#160;Attributes</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="emphasis"><em>Name the port</em></span>.</p></li><li class="listitem"><p><span class="emphasis"><em>Port number</em></span>.</p></li><li class="listitem"><p><span class="emphasis"><em>Binding address</em></span>. Used to limit port binding to a
single network interface.</p></li><li class="listitem"><p><span class="emphasis"><em>Authentication Provider</em></span>. The <a class="link" href="Java-Broker-Concepts-Authentication-Providers.html" title="4.9.&#160;Authentication Providers">authentication
provider</a> used to authenticate incoming connections.</p></li><li class="listitem"><p><span class="emphasis"><em>Protocol(s)</em></span>. A list of protocols to be supported by
the port. For messaging choose one or more AMQP protocols. For management
choose HTTP.</p></li><li class="listitem"><p><span class="emphasis"><em>Transports</em></span>. A list of transports supported by the
port. For messaging or HTTP management chose TCP, SSL or both.</p></li><li class="listitem"><p><span class="emphasis"><em>Enabled/Disabled Cipher Suites</em></span>. Allows cipher
suites supported by the JVM to be enabled or disabled. The cipher
suite names are those understood by the JVM.
</p><p>SSLv3 is disabled by default.</p></li><li class="listitem"><p><span class="emphasis"><em>Keystore</em></span>. <a class="link" href="Java-Broker-Management-Managing-Keystores.html" title="7.11.&#160;Keystores">Keystore</a>
containing the Broker's private key. Required if SSL is in use.</p></li><li class="listitem"><p><span class="emphasis"><em>Want/Need Client Auth</em></span>. Client authentication can be
either accepted if offered (want), or demanded (need). When Client
Certificate Authentication is in use a Truststore must be configured. When
using Client Certificate Authentication it may be desirable to use the <a class="link" href="Java-Broker-Security.html#Java-Broker-Security-External-Provider" title="8.1.4.&#160;External (SSL Client Certificates)">External Authentication
Provider</a>.</p></li><li class="listitem"><p><span class="emphasis"><em>Truststore</em></span>. <a class="link" href="Java-Broker-Management-Managing-Truststores.html" title="7.12.&#160;Truststores">Trust store</a>
contain an issuer certificate or the public keys of the clients themselves
if peers only is desired.</p></li><li class="listitem"><p><span class="emphasis"><em>Maximum Open Connections</em></span>. AMQP ports only. Limits
the number of connections that may be open at any one time.</p></li><li class="listitem"><p><span class="emphasis"><em>Thread pool size</em></span>. AMQP ports only. Number of worker threads
used to process AMQP connections during connection negotiation phase.</p><p>Defaults to 8.</p></li><li class="listitem"><p><span class="emphasis"><em>Number of selectors</em></span>. AMQP ports only. Number of worker threads
used from the thread pool to dispatch I/O activity to the worker threads.</p><p>Defaults to one eighth of the thread pool size. Minimum 1.</p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Ports-Children"></a>7.9.3.&#160;Children</h3></div></div></div><p>
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Connection</p></li></ul></div><p>
</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Ports-Lifecycle"></a>7.9.4.&#160;Lifecycle</h3></div></div></div><p>Not supported</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>When updating an existing port, changes to SSL settings, binding address and port
numbers do not become effective until the Broker is restarted.</p></div></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div class="footnote" id="ftn.d0e3631"><p><a class="para" href="#d0e3631"><sup class="para">[8] </sup></a>Some Linux distributions govern the ceiling with a <code class="literal">sysctl</code>
setting <code class="literal">net.core.somaxconn</code>.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Managing-Consumers.html">Prev</a>&#160;</td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%">&#160;<a accesskey="n" href="Java-Broker-Management-Managing-Authentication-Providers.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.8.&#160;Consumers&#160;</td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;7.10.&#160;Authentication Providers</td></tr></table></div></div>