Modified: qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html?rev=1722689&r1=1722688&r2=1722689&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html (original) +++ qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html Sat Jan 2 23:59:48 2016 @@ -21,7 +21,7 @@ --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> <head> - <title>Chapter 9. System Properties - Apache Qpid™</title> + <title>Chapter 10. System Properties - Apache Qpid™</title> <meta http-equiv="X-UA-Compatible" content="IE=edge"/> <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> @@ -111,13 +111,13 @@ https://github.com/apache/qpid-proton/bl </div> <div id="-middle" class="panel"> - <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/jms-client-0-8/book/index.html">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>Chapter 9. System Properties</li></ul> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/jms-client-0-8/book/index.html">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>Chapter 10. System Properties</li></ul> <div id="-middle-content"> - <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 9. System Properties</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-0-8-Binding-URL.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-0-8-Logging.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="JMS-Client-0-8-System-Properties"></a>Chapter 9. System Properties</h1></div></div></div><p>The following system properties affect the behaviour of the Qpid JMS client. System + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 10. System Properties</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-Message-Encryption-Receiving.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-0-8-Logging.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="JMS-Client-0-8-System-Properties"></a>Chapter 10. System Properties</h1></div></div></div><p>The following system properties affect the behaviour of the Qpid JMS client. System properties are global in nature so affect all Qpid interactions made from within the same JVM. For many options, there are equivalent <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">Connection URL</a> options allowing the option to be controlled at the level of the - Connection.</p><div class="table"><a id="idm139643149285648"></a><p class="title"><strong>Table 9.1. System Properties Affecting Connection Behaviour</strong></p><div class="table-contents"><table border="1" summary="System Properties Affecting Connection Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>qpid.amqp.version</td><td>string</td><td>0-10</td><td><p>Sets the AMQP version to be used - currently supports one of + Connection.</p><div class="table"><a id="d0e1990"></a><p class="title"><strong>Table 10.1. System Properties Affecting Connection Behaviour</strong></p><div class="table-contents"><table border="1" summary="System Properties Affecting Connection Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>qpid.amqp.version</td><td>string</td><td>0-10</td><td><p>Sets the AMQP version to be used - currently supports one of {0-8,0-9,0-91,0-10}.</p><p>The client will begin negotiation at the specified version and only negotiate downwards if the Broker does not support the specified version.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-Heartbeat"></a>qpid.heartbeat</td><td>int</td><td><p>Defaults to the heartbeat value suggested by the Broker, if @@ -132,14 +132,14 @@ https://github.com/apache/qpid-proton/bl allow you to set a client ID of your choice later on.</p></td></tr><tr><td>qpid.connection_ssl_verify_hostname</td><td>boolean</td><td>true</td><td>This property is used to turn on/off broker host name verification on SSL negotiation if SSL transport is used. It is set to 'true' by default. <p>Setting this property to 'false' will disable that check and - allow you to ignore host name errors.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-ConnectionCompressMessages"></a>qpid.connection_compress_messages</td><td>Boolean</td><td>false</td><td><p>Controls whether the client will compress messages before they they are sent.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-MessageCompressionThresholdSize"></a>qpid.message_compression_threshold_size</td><td>Integer</td><td>102400</td><td><p>The payload size beyond which the client will start to compress message payloads.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643150563632"></a><p class="title"><strong>Table 9.2. Config Options For Session Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Session Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Defaul t Value</th><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-DestSyntax"></a>qpid.dest_syntax</td><td>String</td><td>ADDR</td><td><p>Addressing syntax: ADDR (Address format) or BURL (Binding URL)</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-Maxprefetch"></a>max_prefetch</td><td>int</td><td>500</td><td><p>Maximum number of pre-fetched messages per Session. This can also + allow you to ignore host name errors.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-ConnectionCompressMessages"></a>qpid.connection_compress_messages</td><td>Boolean</td><td>false</td><td><p>Controls whether the client will compress messages before they they are sent.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-MessageCompressionThresholdSize"></a>qpid.message_compression_threshold_size</td><td>Integer</td><td>102400</td><td><p>The payload size beyond which the client will start to compress message payloads.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2081"></a><p class="title"><strong>Table 10.2. Config Options For Session Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Session Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</t h><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-DestSyntax"></a>qpid.dest_syntax</td><td>String</td><td>ADDR</td><td><p>Addressing syntax: ADDR (Address format) or BURL (Binding URL)</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-Maxprefetch"></a>max_prefetch</td><td>int</td><td>500</td><td><p>Maximum number of pre-fetched messages per Session. This can also be defaulted for sessions created on a particular connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-ConnectionOptions-Maxprefetch">Connection URL</a> options.</p></td></tr><tr><td>qpid.use_legacy_map_message</td><td>boolean</td><td>false</td><td><p>If set will use the old map message encoding. By default the Map messages are encoded using the 0-10 map encoding.</p><p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-ConnectionOptions-UseLegacyMap">Connection URL</a> options.</p></td></tr><tr><td>qpid.jms.daemon.dispatcher</td><td>boolean</td><td>false</td><td><p>Controls whether the Session dispatcher thread is a daemon thread or not. If this system property is set to true then the Session dispatcher threads will be created as daemon threads. This setting is - introduced in version 0.16.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643148234528"></a><p class="title"><strong>Table 9.3. Config Options For Consumer Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Consumer Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-DeclareExchanges"></a>qpid.declare_exchanges</td><td>Boolean</td><td>true</td><td><p>If true, creating a consumer will also declare the exchange on the + introduced in version 0.16.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2146"></a><p class="title"><strong>Table 10.3. Config Options For Consumer Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Consumer Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-DeclareExchanges"></a>qpid.declare_exchanges</td><td>Boolean</td><td>true</td><td><p>If true, creating a consumer will also declare the exchange on the Broker (specified within the Binding URL associated with the Destination), creating it if is does not already exist. </p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-DeclareQueues"></a>qpid.declare_queues</td><td>Boolean</td><td>true</td><td><p>If true, creating a consumer will also declare the queue on the @@ -147,8 +147,8 @@ https://github.com/apache/qpid-proton/bl Destination), creating it if is does not already exist.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-BindQueues"></a>qpid.bind_queues</td><td>Boolean</td><td>true</td><td><p>If true, creating a consumer will also bind the queue to the to the exchange using the routing key as a binding key. The - exchange name, queue name and routing key are taken from - the Binding URL associated with the Destination.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-RejectBehaviour"></a>qpid.reject.behaviour</td><td>String</td><td>NORMAL</td><td><p>Used with the maximum delivery count feature. See <a class="xref" href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html#JMS-Client-0-8-Client-Understanding-MessageConsumer-MaximumDeliveryCount" title="5.6.3. Maximum Delivery Count">Section 5.6.3, “Maximum Delivery Count”</a> for details.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643146366720"></a><p class="title"><strong>Table 9.4. Config Options For Producer Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Producer Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody ><tr><td><a >id="JMS-Client-0-8-System-Properties-DefaultMandatory"></a>qpid.default_mandatory</td><td>Boolean</td><td>True</td><td><p>If > true, messages sent to Queue destinations for which cannot be + exchange name, queue name and routing key are taken from + the Binding URL associated with the Destination.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-RejectBehaviour"></a>qpid.reject.behaviour</td><td>String</td><td>NORMAL</td><td><p>Used with the maximum delivery count feature. See <a class="xref" href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html#JMS-Client-0-8-Client-Understanding-MessageConsumer-MaximumDeliveryCount" title="5.6.3. Maximum Delivery Count">Section 5.6.3, “Maximum Delivery Count”</a> for details.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2205"></a><p class="title"><strong>Table 10.4. Config Options For Producer Behaviour</strong></p><div class="table-contents"><table border="1" summary="Config Options For Producer Behaviour" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>< a id="JMS-Client-0-8-System-Properties-DefaultMandatory"></a>qpid.default_mandatory</td><td>Boolean</td><td>True</td><td><p>If true, messages sent to Queue destinations for which cannot be routed to at least one queue on the Broker, will be returned to the application. See <a class="xref" href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-MandatoryMessage" title="5.5.1. Mandatory Messages">Section 5.5.1, “Mandatory Messages”</a> for more details.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-DefaultMandatoryTopic"></a>qpid.default_mandatory_topic</td><td>Boolean</td><td>False</td><td><p>If true, messages sent to Topic destinations for which cannot be routed to at least one queue on the Broker, will be returned to the @@ -158,16 +158,16 @@ https://github.com/apache/qpid-proton/bl out.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-FlowControlWaitNotifyPeriod"></a>qpid.flow_control_wait_notify_period</td><td>Long</td><td>5000</td><td><p>Used with <a class="xref" href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-FlowControl" title="5.5.4. Flow Control">Section 5.5.4, “Flow Control”</a>. The frequency at which the log message informing that the producer is flow controlled .</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-SyncPublish"></a>sync_publish</td><td>string</td><td>"" (disabled)</td><td> <p>If 'all' is set then messages will be sent synchronously.</p> - <p>This can also be set per connection using the + <p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish"> Connection URL - </a> + </a> options. </p> - </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643146340560"></a><p class="title"><strong>Table 9.5. Config Options For Threading</strong></p><div class="table-contents"><table border="1" summary="Config Options For Threading" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>qpid.thread_factory</td><td>string</td><td>org.apache.qpid.thread.DefaultThreadFactory</td><td><p>Specifies the thread factory to use.</p><p>If using a real + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2298"></a><p class="title"><strong>Table 10.5. Config Options For Threading</strong></p><div class="table-contents"><table border="1" summary="Config Options For Threading" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>qpid.thread_factory</td><td>string</td><td>org.apache.qpid.thread.DefaultThreadFactory</td><td><p>Specifies the thread factory to use.</p><p>If using a real time JVM, you need to set the above property to <code class="varname">org.apache.qpid.thread.RealtimeThreadFactory</code>.</p></td></tr><tr><td>qpid.rt_thread_priority</td><td>int</td><td>20</td><td><p>Specifies the priority (1-99) for Real time threads created by the - real time thread factory.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643146330048"></a><p class="title"><strong>Table 9.6. Config Options For I/O</strong></p><div class="table-contents"><table border="1" summary="Config Options For I/O" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-SyncOpTimeout"></a>qpid.sync_op_timeout</td><td>long</td><td>60000</td><td><p>The length of time (in milliseconds) to wait for a synchronous + real time thread factory.</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2338"></a><p class="title"><strong>Table 10.6. Config Options For I/O</strong></p><div class="table-contents"><table border="1" summary="Config Options For I/O" width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><a id="JMS-Client-0-8-System-Properties-SyncOpTimeout"></a>qpid.sync_op_timeout</td><td>long</td><td>60000</td><td><p>The length of time (in milliseconds) to wait for a synchronous operation to complete.</p><p>For compatibility with older clients, the synonym <code class="varname">amqj.default_syncwrite_timeout</code> is supported.</p></td></tr><tr><td>qpid.tcp_nodelay</td><td>boolean</td><td>true</td><td> @@ -192,7 +192,7 @@ https://github.com/apache/qpid-proton/bl re-establish the connection. If a reconnection attempt exceeds the timeout, the entire failover process is aborted.</p> <p>It is only applicable for AMQP 0-8/0-9/0-9-1 clients.</p> - </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643146302064"></a><p class="title"><strong>Table 9.7. Config Options For Security - Using SSL for securing connections or using EXTERNAL as + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2446"></a><p class="title"><strong>Table 10.7. Config Options For Security - Using SSL for securing connections or using EXTERNAL as the SASL mechanism.</strong></p><div class="table-contents"><table border="1" summary="Config Options For Security - Using SSL for securing connections or using EXTERNAL as the SASL mechanism." width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>qpid.ssl_timeout</td><td>long</td><td>60000</td><td><p>Timeout value used by the Java SSL engine when waiting on operations.</p></td></tr><tr><td>qpid.ssl.KeyManagerFactory.algorithm</td><td>string</td><td>-</td><td> <p>The key manager factory algorithm name. If not set, defaults to the @@ -206,14 +206,14 @@ https://github.com/apache/qpid-proton/bl <code class="literal">TrustManagerFactory.getDefaultAlgorithm()</code></p> <p>For compatibility with older clients, the synonym <code class="varname">qpid.ssl.trustStoreCertType</code> is supported.</p> - </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="idm139643146285856"></a><p class="title"><strong>Table 9.8. Config Options For Security - Standard JVM properties needed when Using SSL for - securing connections or using EXTERNAL as the SASL mechanism.<a class="footnote" href="#ftn.idm139643146284880" id="idm139643146284880"><sup class="footnote">[a]</sup></a></strong></p><div class="table-contents"><table border="1" summary="Config Options For Security - Standard JVM properties needed when Using SSL for securing connections or using EXTERNAL as the SASL mechanism.Qpid allows you to have per connection key and trust stores if required. If specified per connection, the JVM arguments are ignored." width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>javax.net.ssl.keyStore</td><td>string</td><td>jvm default</td><td><p>Specifies the key store path.</p><p>This can also be set per + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2511"></a><p class="title"><strong>Table 10.8. Config Options For Security - Standard JVM properties needed when Using SSL for + securing connections or using EXTERNAL as the SASL mechanism.<a class="footnote" href="#ftn.d0e2514" id="d0e2514"><sup class="footnote">[a]</sup></a></strong></p><div class="table-contents"><table border="1" summary="Config Options For Security - Standard JVM properties needed when Using SSL for securing connections or using EXTERNAL as the SASL mechanism.Qpid allows you to have per connection key and trust stores if required. If specified per connection, the JVM arguments are ignored." width="100%"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Property Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td>javax.net.ssl.keyStore</td><td>string</td><td>jvm default</td><td><p>Specifies the key store path.</p><p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">Connection URL</a> options.</p></td></tr><tr><td>javax.net.ssl.keyStorePassword</td><td>string</td><td>jvm default</td><td><p>Specifies the key store password.</p><p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">Connection URL</a> options.</p></td></tr><tr><td>javax.net.ssl.trustStore</td><td>string</td><td>jvm default</td><td><p>Specifies the trust store path.</p><p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">Connection URL</a> options.</p></td></tr><tr><td>javax.net.ssl.trustStorePassword</td><td>string</td><td>jvm default</td><td><p>Specifies the trust store password.</p><p>This can also be set per connection using the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">Connection URL</a> - options.</p></td></tr></tbody><tbody class="footnotes"><tr><td colspan="4"><div class="footnote" id="ftn.idm139643146284880"><p><a class="para" href="#idm139643146284880"><sup class="para">[a] </sup></a>Qpid allows you to have per connection key and trust stores if required. If - specified per connection, the JVM arguments are ignored.</p></div></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-0-8-Binding-URL.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-0-8-Logging.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 8. Binding URL </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 10. Logging</td></tr></table></div></div> + options.</p></td></tr></tbody><tbody class="footnotes"><tr><td colspan="4"><div class="footnote" id="ftn.d0e2514"><p><a class="para" href="#d0e2514"><sup class="para">[a] </sup></a>Qpid allows you to have per connection key and trust stores if required. If + specified per connection, the JVM arguments are ignored.</p></div></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-Message-Encryption-Receiving.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-0-8-Logging.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">9.3. Receiving an Encrypted Message </td><td align="center" width="20%"><a accesskey="h" href="JMS-Client-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 11. Logging</td></tr></table></div></div> <hr/>
Added: qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Book.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Book.html?rev=1722689&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Book.html (added) +++ qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Book.html Sat Jan 2 23:59:48 2016 @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<!-- + - + - Licensed to the Apache Software Foundation (ASF) under one + - or more contributor license agreements. See the NOTICE file + - distributed with this work for additional information + - regarding copyright ownership. The ASF licenses this file + - to you under the Apache License, Version 2.0 (the + - "License"); you may not use this file except in compliance + - with the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, + - software distributed under the License is distributed on an + - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + - KIND, either express or implied. See the License for the + - specific language governing permissions and limitations + - under the License. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1 - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + + <!-- Redirects for `go get` and godoc.org --> + <meta name="go-import" + content="qpid.apache.org git https://git-wip-us.apache.org/repos/asf/qpid-proton.git"/> + <meta name="go-source" + content="qpid.apache.org +https://github.com/apache/qpid-proton/blob/go1/README.md +https://github.com/apache/qpid-proton/tree/go1{/dir} +https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/discussion.html">Discussion</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <div class="flex"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Messaging APIs</h3> + + <ul> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/components/jms/index.html">Qpid JMS</a></li> + <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li> + </ul> + </section> + + <section> + <h3>Servers and tools</h3> + + <ul> + <li><a href="/components/java-broker/index.html">Java broker</a></li> + <li><a href="/components/cpp-broker/index.html">C++ broker</a></li> + <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/dashboard.html">Dashboard</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index";>Wiki</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + </div> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <a href="/search.html">More ways to search</a> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li>Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</li></ul> + + <div id="-middle-content"> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</th></tr><tr><td align="left" width="20%"> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-0-8-Introduction.html">Next</a></td></tr></table><hr /></div><div class="book"><div class="titlepage"><div><div><h1 class="title"><a id="d0e2"></a>Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</h1></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="JMS-Client-0-8-Introduction.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="JMS-Client-0-8-Document-Scope-And-Intended-Audience.html">2. Document Scope And Intended Audience</a></span></dt><dt><span class="chapter"><a href="JMS-Client-0-8-JMS-Getting-And-Dependencies.html">3. Ge tting the Client And Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-JMS-Getting-And-Dependencies.html#JMS-Client-0-8-JMS-Getting-And-Dependencies-Getting">Getting the Client</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JMS-Getting-And-Dependencies-Dependencies.html">Dependencies</a></span></dt></dl></dd><dt><span class="chapter"><a href="JMS-Client-0-8-Examples.html">4. Examples</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Examples.html#JMS-Client-0-8-Examples-PTP">Point to point example</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Examples-PubSub.html">Publish/subscribe example</a></span></dt></dl></dd><dt><span class="chapter"><a href="JMS-Client-0-8-Client-Understanding.html">5. Understanding the Qpid JMS client</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding.html#JMS-Client-0-8-Client-Understanding-Overview">Overview</a></span>< /dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-ConnectionFactory.html">ConnectionFactory</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html">Connection</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html#JMS-Client-0-8-Client-Understanding-Connection-Failover">Failover</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html#JMS-Client-0-8-Client-Understanding-Connection-Heartbeating">Heartbeating</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html#JMS-Client-0-8-Client-Understanding-Connection-SSL">SSL</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html#JMS-Client-0-8-Client-Understanding-Connection-MessageCompression">Message Compression</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Cli ent-0-8-Client-Understanding-Session.html">Session</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Session.html#JMS-Client-0-8-Client-Understanding-Session-Prefecth">Prefetch</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Session.html#JMS-Client-0-8-Client-Understanding-Session-TemporaryQueues">TemporaryQueues</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Session.html#JMS-Client-0-8-Client-Understanding-Session-CreateQueue">CreateQueue</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Session.html#JMS-Client-0-8-Client-Understanding-Session-CreateTopic">CreateTopic</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html">MessageProducer</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8- Client-Understanding-MessageProducer-MandatoryMessage">Mandatory Messages</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-CloseWhenNoRoute">Close When No Route</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-ImmediateMessage">Immediate Messages</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-FlowControl">Flow Control</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html">MessageConsumer</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html#JMS-Client-0-8-Client-Understanding-MessageConsumer-ConsumerSideEffect">Consumers have Exchange/ Queue Declaration and Binding Side Effect</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html#JMS-Client-0-8-Client-Understanding-MessageConsumer-TopicSubscriptions">Topic Subscriptions</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html#JMS-Client-0-8-Client-Understanding-MessageConsumer-MaximumDeliveryCount">Maximum Delivery Count</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Destinations.html">Destinations</a></span></dt></dl></dd><dt><span class="chapter"><a href="JMS-Client-0-8-JNDI-Properties-Format.html">6. JNDI Properties Format</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format.html#JMS-Client-0-8-JNDI-Properties-Format-ConnectionFactory">ConnectionFactory</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Queue.html">Queue</a></span></ dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Topic.html">Topic</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Destination.html">Destination</a></span></dt></dl></dd><dt><span class="chapter"><a href="JMS-Client-0-8-Connection-URL.html">7. Connection URLs</a></span></dt><dt><span class="chapter"><a href="JMS-Client-0-8-Binding-URL.html">8. Binding URL</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-Examples">Binding URL Examples</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-JMS-Queues">Binding URLs for declaring of JMS Queues</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-JMS-Topics">Binding URLs for declaring of JMS Topics</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Binding-URL.html#JMS-Client -0-8-Binding-URL-Topics-Wildcards">Wildcard characters in routing keys for topic destinations</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-Extra-Examples">More Examples</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="JMS-Client-Message-Encryption.html">9. Message Encryption</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-Message-Encryption.html#JMS-Client-Message-Encryption-Overview">Overview</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Sending.html">Sending an Encrypted Message</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Setting-TrustStore">Providing the Trust Store</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Enabling-Encryption">Enabling Encryption</a></span></dt ><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Choosing-Recipients">Choosing > Recipients</a></span></dt><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Exposing-Properties">Exposing > Properties</a></span></dt></dl></dd><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Receiving.html">Receiving an Encrypted >Message</a></span></dt><dd><dl><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Receiving.html#JMS-Client-Message-Encryption-Sending-Setting-KeyStore">Providing > the Key Store</a></span></dt></dl></dd></dl></dd><dt><span >class="chapter"><a href="JMS-Client-0-8-System-Properties.html">10. System >Properties</a></span></dt><dt><span class="chapter"><a >href="JMS-Client-0-8-Logging.html">11. >Logging</a></span></dt><dd><dl><dt><span class="section"><a >href="JMS-Client-0-8-Logging.html#JMS-Client-0-8-Logging-RecommendedProdu ctionLoggingLevel">Recommended Production Logging Level</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Logging-EnablingDebugLogging.html">Enabling Debug</a></span></dt></dl></dd><dt><span class="appendix"><a href="JMS-Client-0-8-Appendix-Exceptions.html">A. Exceptions</a></span></dt><dt><span class="appendix"><a href="JMS-Client-0-8-Appendix-Maven.html">B. Minimal Maven POM</a></span></dt><dt><span class="appendix"><a href="JMS-Client-0-8-Appendix-JMS-Extensions.html">C. JMS Extensions</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Appendix-JMS-Extensions.html#JMS-Client-0-8-Appendix-JMS-Extensions-Queue">Queue Management</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-0-8-Appendix-JMS-Extensions.html#JMS-Client-0-8-Appendix-JMS-Extensions-Queue-Creation">Queue creation</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Appendix-JMS-Extensions-Binding.html">Binding Management</a></span></dt><dd> <dl><dt><span class="section"><a href="JMS-Client-0-8-Appendix-JMS-Extensions-Binding.html#JMS-Client-0-8-Appendix-JMS-Extensions-Binding-Creation">Binding creation</a></span></dt></dl></dd></dl></dd><dt><span class="appendix"><a href="JMS-Client-0-8-Appendix-PooledConnecytionFactory.html">D. PooledConnectionFactory</a></span></dt><dt><span class="appendix"><a href="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration.html">E. How to bind Qpid destinations and connection factories into Tomcat JNDI</a></span></dt></dl></div><div class="list-of-figures"><p><strong>List of Figures</strong></p><dl><dt>5.1. <a href="JMS-Client-0-8-Client-Understanding.html#d0e327">Architecture of a typical JMS application</a></dt><dt>5.2. <a href="JMS-Client-0-8-Client-Understanding-ConnectionFactory.html#d0e369">JNDI overview</a></dt></dl></div><div class="list-of-tables"><p><strong>List of Tables</strong></p><dl><dt>7.1. <a href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-Options">Conn ection URL Options</a></dt><dt>7.2. <a href="JMS-Client-0-8-Connection-URL.html#d0e1346">Broker List Options</a></dt><dt>8.1. <a href="JMS-Client-0-8-Binding-URL.html#d0e1634">Binding URL options </a></dt><dt>8.2. <a href="JMS-Client-0-8-Binding-URL.html#d0e1833">Binding URL examples</a></dt><dt>10.1. <a href="JMS-Client-0-8-System-Properties.html#d0e1990">System Properties Affecting Connection Behaviour</a></dt><dt>10.2. <a href="JMS-Client-0-8-System-Properties.html#d0e2081">Config Options For Session Behaviour</a></dt><dt>10.3. <a href="JMS-Client-0-8-System-Properties.html#d0e2146">Config Options For Consumer Behaviour</a></dt><dt>10.4. <a href="JMS-Client-0-8-System-Properties.html#d0e2205">Config Options For Producer Behaviour</a></dt><dt>10.5. <a href="JMS-Client-0-8-System-Properties.html#d0e2298">Config Options For Threading</a></dt><dt>10.6. <a href="JMS-Client-0-8-System-Properties.html#d0e2338">Config Options For I/O</a></dt><dt>10.7. <a href="JMS-Client-0-8-System-Prope rties.html#d0e2446">Config Options For Security - Using SSL for securing connections or using EXTERNAL as + the SASL mechanism.</a></dt><dt>10.8. <a href="JMS-Client-0-8-System-Properties.html#d0e2511">Config Options For Security - Standard JVM properties needed when Using SSL for + securing connections or using EXTERNAL as the SASL mechanism.</a></dt><dt>A.1. <a href="JMS-Client-0-8-Appendix-Exceptions.html#d0e2665">Exceptions linked to JMSExceptions thrown by JMS methods</a></dt><dt>A.2. <a href="JMS-Client-0-8-Appendix-Exceptions.html#d0e2781">Exceptions linked to JMSExceptions received by ExceptionListeners</a></dt></dl></div><div class="list-of-examples"><p><strong>List of Examples</strong></p><dl><dt>4.1. <a href="JMS-Client-0-8-Examples.html#JMS-Client-0-8-Examples-PTP-Java">JMS Example - Point to Point Messaging</a></dt><dt>4.2. <a href="JMS-Client-0-8-Examples.html#JMS-Client-0-8-Examples-PTP-PropertiesFile">JMS Example - Point to Point Messaging - JNDI Properties</a></dt><dt>4.3. <a href="JMS-Client-0-8-Examples-PubSub.html#JMS-Client-0-8-Examples-PubSub-Java">JMS Example - Publish/subscribe Messaging</a></dt><dt>4.4. <a href="JMS-Client-0-8-Examples-PubSub.html#JMS-Client-0-8-Examples-PubSub-PropertiesFile">JMS Example - Publish/subscribe Messagin g - JNDI Properties</a></dt><dt>5.1. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e439">Connection URL configured for failover</a></dt><dt>5.2. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e453">Connection URL configured with nofailover</a></dt><dt>5.3. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e489">Connection URL configured for heartbeating</a></dt><dt>5.4. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e505">Connection URL configured for SSL - CA trusted by JVM</a></dt><dt>5.5. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e521">Connection URL configured for SSL - CA not trusted by JVM</a></dt><dt>5.6. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e537">Connection URL configured for SSL - SSL client-auth</a></dt><dt>5.7. <a href="JMS-Client-0-8-Client-Understanding-Connection.html#d0e552">Connection URL configured for SSL - SSL client-auth (2)</a></dt><dt>7.1. <a href="JMS-C lient-0-8-Connection-URL.html#d0e1321">Broker Lists</a></dt><dt>8.1. <a href="JMS-Client-0-8-Binding-URL.html#d0e1790">Binding URL examples for JMS queues</a></dt><dt>8.2. <a href="JMS-Client-0-8-Binding-URL.html#d0e1808">Binding URL examples for JMS topics</a></dt><dt>B.1. <a href="JMS-Client-0-8-Appendix-Maven.html#d0e2866">Minimal Maven POM </a></dt><dt>C.1. <a href="JMS-Client-0-8-Appendix-JMS-Extensions.html#d0e2893">Creation of an LVQ using the Qpid extension to JMS</a></dt><dt>C.2. <a href="JMS-Client-0-8-Appendix-JMS-Extensions-Binding.html#d0e2908">Binding a queue using JMS</a></dt><dt>D.1. <a href="JMS-Client-0-8-Appendix-PooledConnecytionFactory.html#d0e2977">Example of configuring <span class="emphasis"><em>PooledConnectionFactory</em></span> in spring xml + configuration.</a></dt><dt>D.2. <a href="JMS-Client-0-8-Appendix-PooledConnecytionFactory.html#d0e3000">Examples of configuring <span class="emphasis"><em>PooledConnectionFactory</em></span> with + <span class="emphasis"><em>DefaultMessageListenerContainer</em></span> and + <span class="emphasis"><em>JmsTemplate</em></span>.</a></dt><dt>E.1. <a href="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration.html#d0e3215">An example of Tomcat context.xml declaring Qpid JNDI resources</a></dt><dt>E.2. <a href="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration.html#d0e3239">An example of JNDI lookup for Qpid resources registered in Tomcat JNDI</a></dt><dt>E.3. <a href="JMS-Client-0-8-Appendix-Tomcat-JNDI-Integration.html#d0e3262">An example of Tomcat context.xml declaring Qpid JNDI resources using deprecated <code class="literal">ObjectFactory</code> and deprecated addresses</a></dt></dl></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-0-8-Introduction.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%"> </td><td align="center" width="20%"> 0;</td><td align="right" valign="top" width="40%"> Chapter 1. Introduction</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; 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 + </p> + </div> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html?rev=1722689&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html (added) +++ qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html Sat Jan 2 23:59:48 2016 @@ -0,0 +1,154 @@ +<!DOCTYPE html> +<!-- + - + - Licensed to the Apache Software Foundation (ASF) under one + - or more contributor license agreements. See the NOTICE file + - distributed with this work for additional information + - regarding copyright ownership. The ASF licenses this file + - to you under the Apache License, Version 2.0 (the + - "License"); you may not use this file except in compliance + - with the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, + - software distributed under the License is distributed on an + - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + - KIND, either express or implied. See the License for the + - specific language governing permissions and limitations + - under the License. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>9.3. Receiving an Encrypted Message - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + + <!-- Redirects for `go get` and godoc.org --> + <meta name="go-import" + content="qpid.apache.org git https://git-wip-us.apache.org/repos/asf/qpid-proton.git"/> + <meta name="go-source" + content="qpid.apache.org +https://github.com/apache/qpid-proton/blob/go1/README.md +https://github.com/apache/qpid-proton/tree/go1{/dir} +https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/discussion.html">Discussion</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <div class="flex"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Messaging APIs</h3> + + <ul> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/components/jms/index.html">Qpid JMS</a></li> + <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li> + </ul> + </section> + + <section> + <h3>Servers and tools</h3> + + <ul> + <li><a href="/components/java-broker/index.html">Java broker</a></li> + <li><a href="/components/cpp-broker/index.html">C++ broker</a></li> + <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/dashboard.html">Dashboard</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index";>Wiki</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + </div> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <a href="/search.html">More ways to search</a> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/jms-client-0-8/book/index.html">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>9.3. Receiving an Encrypted Message</li></ul> + + <div id="-middle-content"> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">9.3. Receiving an Encrypted Message</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-Message-Encryption-Sending.html">Prev</a> </td><th align="center" width="60%">Chapter 9. Message Encryption</th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-0-8-System-Properties.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="JMS-Client-Message-Encryption-Receiving"></a>9.3. Receiving an Encrypted Message</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Sending-Setting-KeyStore"></a>9.3.1. Providing the Key Store</h3></div></div></div><p> + In order for a connection to be capable of decrypting received encrypted messages, it must be provided + with a key store which contains the X509 certificates and associated Private Keys of the identities + on behalf of which it will be able to decrypt. The details of the + key store are supplied in the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">connection URL</a>. + The location and password for this must + be specified using the <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-EncryptionKeyStore"> + encryption_key_store</a> and + <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-EncryptionKeyStorePassword">encryption_trust_store_password + </a> options respectively. Such a connection URL might look somthing like: + </p><pre class="programlisting">amqp://username:password@clientid/test?brokerlist='tcp://localhost:5672?encryption_key_store='/home/qpid/identities.jks'&encryption_key_store_password='password''</pre></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-Message-Encryption-Sending.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="JMS-Client-Message-Encryption.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-0-8-System-Properties.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">9.2. Sending an Encrypted Message </td><td align="center" width="20%"><a accesskey="h" href="JMS-Client-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 10. System Properties</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; 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 + </p> + </div> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Sending.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Sending.html?rev=1722689&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Sending.html (added) +++ qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption-Sending.html Sat Jan 2 23:59:48 2016 @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<!-- + - + - Licensed to the Apache Software Foundation (ASF) under one + - or more contributor license agreements. See the NOTICE file + - distributed with this work for additional information + - regarding copyright ownership. The ASF licenses this file + - to you under the Apache License, Version 2.0 (the + - "License"); you may not use this file except in compliance + - with the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, + - software distributed under the License is distributed on an + - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + - KIND, either express or implied. See the License for the + - specific language governing permissions and limitations + - under the License. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>9.2. Sending an Encrypted Message - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + + <!-- Redirects for `go get` and godoc.org --> + <meta name="go-import" + content="qpid.apache.org git https://git-wip-us.apache.org/repos/asf/qpid-proton.git"/> + <meta name="go-source" + content="qpid.apache.org +https://github.com/apache/qpid-proton/blob/go1/README.md +https://github.com/apache/qpid-proton/tree/go1{/dir} +https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/discussion.html">Discussion</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <div class="flex"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Messaging APIs</h3> + + <ul> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/components/jms/index.html">Qpid JMS</a></li> + <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li> + </ul> + </section> + + <section> + <h3>Servers and tools</h3> + + <ul> + <li><a href="/components/java-broker/index.html">Java broker</a></li> + <li><a href="/components/cpp-broker/index.html">C++ broker</a></li> + <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/dashboard.html">Dashboard</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index";>Wiki</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + </div> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <a href="/search.html">More ways to search</a> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/jms-client-0-8/book/index.html">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>9.2. Sending an Encrypted Message</li></ul> + + <div id="-middle-content"> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">9.2. Sending an Encrypted Message</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-Message-Encryption.html">Prev</a> </td><th align="center" width="60%">Chapter 9. Message Encryption</th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-Message-Encryption-Receiving.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="JMS-Client-Message-Encryption-Sending"></a>9.2. Sending an Encrypted Message</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Sending-Setting-TrustStore"></a>9.2.1. Providing the Trust Store</h3></div></div></div><p> + In order for a connection to be capable of sending encrypted messages, it must be provided with a trust + store which contains the X509 certificates of the entities to which you wish to send. The details of the + trust store are supplied in the <a class="link" href="JMS-Client-0-8-Connection-URL.html" title="Chapter 7. Connection URLs">connection URL</a>. + </p><p> + There are two distinct mechanisms for providing the encryption trust store. Firstly you can supply a + standard password-protected trust store file on the file system. The location and password for this must + be specified using the <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-EncryptionTrustStore"> + encryption_trust_store</a> and + <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-EncryptionTrustStorePassword">encryption_trust_store_password + </a> options respectively. Such a connection URL might look somthing like: + </p><pre class="programlisting">amqp://username:password@clientid/test?brokerlist='tcp://localhost:5672?encryption_trust_store='/home/qpid/certificates.jks'&encryption_trust_store_password='password''</pre><p> + Alternatively, where available, you can configure the broker to distribute certificates from a trust + store (this is currently only available in the Java Broker). In order to use this method, the broker + details in the connection url must contain the correctly configured + <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-EncryptionRemoteTrustStore">encryption_remote_trust_store</a> + option. Such a connection URL might look somthing like: + </p><pre class="programlisting">amqp://username:password@clientid/test?brokerlist='tcp://localhost:5672?encryption_remote_trust_store='$certificates%5c/certstore''</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Sending-Enabling-Encryption"></a>9.2.2. Enabling Encryption</h3></div></div></div><p> + Message encryption can be enabled individually on each sent message, or - using configuration - all + messages sent to a Destination can be encrypted. + </p><p> + In order to encrypt messages on a case by case basis, the appliation must set the boolean property + <code class="literal">x-qpid-encrypt</code> to true on the message before sending. The intended recipients of the + message must also be set (see + <a class="link" href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Choosing-Recipients" title="9.2.3. Choosing Recipients">Choosing Recipients</a>). + </p><pre class="programlisting">message.setBooleanProperty("x-qpid-encrypt", true);</pre><p> + In order to encrypt all messages sent to a given Destination, the option + <a class="link" href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-Options-SendEncrypted">sendencrypted</a> can be used. Note + that enabling encryption on the address can be overridden by explicitly seting the property + <code class="literal">x-qpid-encrypt</code> to false on an individual message. An example address would look like: + </p><pre class="programlisting">direct:///queue/queue?sendencrypted='true'</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Sending-Choosing-Recipients"></a>9.2.3. Choosing Recipients</h3></div></div></div><p> + Any message which is to be sent encrypted must also have a list of recipients who the sender wishes to + be able to decrypt the message. The recipients must be encoded as a semi-colon separated list of the + names given in the respective certificates of the recipients, e.g. + <code class="literal">[email protected],ou=example,o=example,l=ny,st=ny,c=us;[email protected],ou=example,o=example,l=ny,st=ny,c=us</code>. + </p><p> + As with enabling encryption, the recipients can be set either on a per-message basis or for all messages + sent to a given address. If both forms are used, the former overrides the latter. To set on an individual + message, set the String property <code class="literal">x-qpid-encrypt-recipients</code>. + </p><pre class="programlisting">message.setStringProperty("x-qpid-encrypt-recipients", "[email protected],ou=example,o=example");</pre><p> + To set the recipients on an address, use the address option + <a class="link" href="JMS-Client-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-Options-EncryptedRecipients">encryptedrecipients</a>. + </p><pre class="programlisting">direct:///queue/queue?sendencrypted='true'&encryptedrecipients='[email protected],ou=example,o=example'</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Sending-Exposing-Properties"></a>9.2.4. Exposing Properties</h3></div></div></div><p> + Message Encryption encrypts the message content and the properties set by the application. Sometimes + it is important to expose properties to allow (for example) message routing or message selectors within + the broker to work. To enable this it is possible to specify for each message all the properties which + the application wishes to make available to the broker. Note that exposing properties in this way means + that they are now visibe to anyone who can inspect the broker memory or file system stores. + </p><p> + To make message properties visible to the broker, set the String property + <code class="literal">x-qpid-unencrypted-properties</code> with a semi-colon separated list of the names of the + properties to be exposed. + </p><pre class="programlisting">message.setStringProperty("x-qpid-unencrypted-properties", "foo;bar;baz");</pre></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-Message-Encryption.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="JMS-Client-Message-Encryption.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-Message-Encryption-Receiving.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 9. Message Encryption </td><td align="center" width="20%"><a accesskey="h" href="JMS-Client-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 9.3. Receiving an Encrypted Message</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; 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 + </p> + </div> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption.html?rev=1722689&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption.html (added) +++ qpid/site/docs/releases/qpid-java-trunk/jms-client-0-8/book/JMS-Client-Message-Encryption.html Sat Jan 2 23:59:48 2016 @@ -0,0 +1,174 @@ +<!DOCTYPE html> +<!-- + - + - Licensed to the Apache Software Foundation (ASF) under one + - or more contributor license agreements. See the NOTICE file + - distributed with this work for additional information + - regarding copyright ownership. The ASF licenses this file + - to you under the Apache License, Version 2.0 (the + - "License"); you may not use this file except in compliance + - with the License. You may obtain a copy of the License at + - + - http://www.apache.org/licenses/LICENSE-2.0 + - + - Unless required by applicable law or agreed to in writing, + - software distributed under the License is distributed on an + - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + - KIND, either express or implied. See the License for the + - specific language governing permissions and limitations + - under the License. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>Chapter 9. Message Encryption - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + + <!-- Redirects for `go get` and godoc.org --> + <meta name="go-import" + content="qpid.apache.org git https://git-wip-us.apache.org/repos/asf/qpid-proton.git"/> + <meta name="go-source" + content="qpid.apache.org +https://github.com/apache/qpid-proton/blob/go1/README.md +https://github.com/apache/qpid-proton/tree/go1{/dir} +https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/discussion.html">Discussion</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <div class="flex"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Messaging APIs</h3> + + <ul> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/components/jms/index.html">Qpid JMS</a></li> + <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li> + </ul> + </section> + + <section> + <h3>Servers and tools</h3> + + <ul> + <li><a href="/components/java-broker/index.html">Java broker</a></li> + <li><a href="/components/cpp-broker/index.html">C++ broker</a></li> + <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/dashboard.html">Dashboard</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index";>Wiki</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + </div> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <a href="/search.html">More ways to search</a> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/jms-client-0-8/book/index.html">Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>Chapter 9. Message Encryption</li></ul> + + <div id="-middle-content"> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 9. Message Encryption</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-0-8-Binding-URL.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="JMS-Client-Message-Encryption-Sending.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="JMS-Client-Message-Encryption"></a>Chapter 9. Message Encryption</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="JMS-Client-Message-Encryption.html#JMS-Client-Message-Encryption-Overview">9.1. Overview</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Sending.html">9.2. Sending an Encrypted Message</a></span></dt><dd ><dl><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Setting-TrustStore">9.2.1. > Providing the Trust Store</a></span></dt><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Enabling-Encryption">9.2.2. > Enabling Encryption</a></span></dt><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Choosing-Recipients">9.2.3. > Choosing Recipients</a></span></dt><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Sending.html#JMS-Client-Message-Encryption-Sending-Exposing-Properties">9.2.4. > Exposing Properties</a></span></dt></dl></dd><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Receiving.html">9.3. Receiving an >Encrypted Message</a></span></dt><dd><dl><dt><span class="section"><a >href="JMS-Client-Message-Encryption-Receiving.html#JMS-Client-Message-Encryption-Sending-Set ting-KeyStore">9.3.1. Providing the Key Store</a></span></dt></dl></dd></dl></div><p> + In some cases it is desirable to ensure no-one but the intended recipient(s) of a message will be able to read + its contents. Using SSL/TLS to encrypt traffic travelling between client and broker only ensures that those + snooping the network cannot read messages, however once the message arrives at the broker it is decrypted and + so anyone with access to the broker can read the message. For such confidential information it is necessary to + implement a mechanism of end-to-end encryption such that the sender of the message encrypts the message before + sending, and the recipient(s), upon receiving the message, decrypt it with some secret known only to them. + </p><p> + Neither JMS nor AMQP provide any defined mechanism for message encryption, however it is possible for any + application to build a message encryption scheme on top of a JMS API. For convenience the Qpid JMS client + provides a built in mechanism for encryption and decrypting messages. This mechanism is currently only + implemented in the Qpid JMS client for AMQP 0-8/0-9/0-9-1/0-10. If you use a different client you will be + unable to read encrypted messages. + </p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="JMS-Client-Message-Encryption-Overview"></a>9.1. Overview</h2></div></div></div><p> + For each encrypted message which the client sends, a new message-specific secret key is generated. This + secret key is used encrypt the message contents using symmetric encryption (currently only AES-256 is + supported, although other algorithms may be added at a later date). For each intended recipient of the + message, the client encrypts the secret key using the public key associated with the recipient, and adds + this as a message header. On receipt of an encrypted message, the client looks to see if it has a private + key which can decrypt the secret key. If the client is unable to decrypt the message (for instance, because + they were not one of the intended recipients) then the message will be presented to the application as a + BytesMessage containing the encrypted data. + </p><p> + In order to send an encrypted message it is necessary to know the Certificates of the intended recipients. + Certificates can be distributed either through out-of-band mechanisms, or the Qpid Java Broker can be used + to distribute them to clients. + </p><p> + In order to receive an encrypted message it is necessary to have a Certificate (which needs to be + distributed to those who you wish to send messages to you) and to have the private key associated with the + certificate so that you can decrypt messages sent to you. + </p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="JMS-Client-0-8-Binding-URL.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="JMS-Client-Message-Encryption-Sending.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 8. Binding URL </td><td align="center" width="20%"><a accesskey="h" href="JMS-Client-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 9.2. Sending an Encrypted Message</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; 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 + </p> + </div> + </div> + </div> + </body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
