http://git-wip-us.apache.org/repos/asf/qpid-site/blob/d1947fd4/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html new file mode 100644 index 0000000..4e47a58 --- /dev/null +++ b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-0-8-System-Properties.html @@ -0,0 +1,254 @@ +<!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 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"/> + <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/broker-j/index.html">Broker-J</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-6.1.7/index.html">Qpid for Java 6.1.7</a></li><li><a href="/releases/qpid-java-6.1.7/jms-client-0-8/book/index.html">Apache 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 10. System Properties</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="JMS-Client-Message-Encryption-Example.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 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="d0e2129"></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 + any.</p></td><td>Frequency of heartbeat messages (in seconds). A value of 0 disables + heartbeating. <p>Two consecutive missed heartbeats will result in the + connection timing out.</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-BrokerOptions-Heartbeat">Connection URL</a> options.</p><p>For compatibility with + old client configuration, the synonym + <code class="varname">amqj.heartbeat.delay</code> is supported.</p></td></tr><tr><td>ignore_setclientID</td><td>boolean</td><td>false</td><td>If a client ID is specified in the connection URL it's used or else an ID + is generated. If an ID is specified after it's been set Qpid will throw an + exception. <p>Setting this property to 'true' will disable that check and + 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="d0e2220"></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="d0e2285"></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 + 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-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><tr><td>sync_client_ack</td><td>boolean</td><td>true</td><td> + <p> + If set <code class="literal">true</code>, for sessions using <a class="link" href="http://docs.oracle.com/javaee/6/api/javax/jms/Session.html#CLIENT_ACKNOWLEDGE"; target="_top">Session#CLIENT_ACKNOWLEDGE</a>, + a sync command is sent after every message <a class="link" href="http://docs.oracle.com/javaee/6/api/javax/jms/Message.html#acknowledge()" target="_top">Message#acknowledge()</a>. + This ensure that the client awaits the successful processing of the acknowledgement by server before continuing. + </p> + <p>If <code class="literal">false</code>, the sync is not performed. This will improve performance but will mean + duplicate messages are more likely to be received following a failure. + </p> + <p>This can also be set per connection using the <a class="link" href=""> + Connection URL</a> options.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2377"></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 + 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-DefaultImmediate"></a>qpid.default_immediate</td><td>Boolean</td><td>False</td><td><p>If true, the message will be returned to the application unless the + Broker is able to route the message to at least one queue with a + consumer attached. See <a class="xref" href="JMS-Client-0-8-Client-Understanding-MessageProducer.html#JMS-Client-0-8-Client-Understanding-MessageProducer-ImmediateMessage" title="5.5.3. Immediate Messages">Section 5.5.3, “Immediate Messages”</a> for more details.</p></td></tr><tr><td><a id="JMS-Client-0-8-System-Properties-FlowControlWaitFailure"></a>qpid.flow_control_wait_failure</td><td>Long</td><td>60000</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 amount of time (in milliseconds) to wait before timing + 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 + <a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-ConnectionOptions-SyncPublish"> + Connection URL + </a> + options. + </p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="d0e2470"></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="d0e2510"></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> + <p>Sets the TCP_NODELAY property of the underlying socket. The default + was changed to true as of Qpid 0.14.</p> + <p>This can also be set per connection using the Connection URL broker + option<a class="link" href="JMS-Client-0-8-Connection-URL.html#JMS-Client-0-8-Connection-URL-BrokerOptions-TcpNoDelay"><code class="literal">tcp_nodelay</code>.</a> options.</p> + <p>For compatibility with older clients, the synonym + <code class="varname">amqj.tcp_nodelay</code> is supported.</p> + </td></tr><tr><td>qpid.send_buffer_size</td><td>integer</td><td>65535</td><td> + <p>Sets the SO_SNDBUF property of the underlying socket. Added in Qpid + 0.16.</p> + <p>For compatibility with older clients, the synonym + <code class="varname">amqj.sendBufferSize</code> is supported.</p> + </td></tr><tr><td>qpid.receive_buffer_size</td><td>integer</td><td>65535</td><td> + <p>Sets the SO_RCVBUF property of the underlying socket. Added in Qpid + 0.16.</p> + <p>For compatibility with older clients, the synonym + <code class="varname">amqj.receiveBufferSize</code> is supported.</p> + </td></tr><tr><td>qpid.failover_method_timeout</td><td>long</td><td>60000</td><td> + <p>During failover, this is the timeout for each attempt to try to + 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="d0e2618"></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 + value returned from the Java runtime call + <code class="literal">KeyManagerFactory.getDefaultAlgorithm()</code></p> + <p>For compatibility with older clients, the synonym + <code class="varname">qpid.ssl.keyStoreCertType</code> is supported.</p> + </td></tr><tr><td>qpid.ssl.TrustManagerFactory.algorithm</td><td>string</td><td>-</td><td> + <p>The trust manager factory algorithm name. If not set, defaults to the + value returned from the Java runtime call + <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="d0e2683"></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.d0e2686" id="d0e2686"><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.d0e2686"><p><a class="para" href="#d0e2686"><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-Example.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.4. Message Encryption Example </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/> + + <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="/security.html">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>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/d1947fd4/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Book.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Book.html b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Book.html new file mode 100644 index 0000000..aa87c2a --- /dev/null +++ b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Book.html @@ -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>Apache 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/broker-j/index.html">Broker-J</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-6.1.7/index.html">Qpid for Java 6.1.7</a></li><li><a href="/releases/qpid-java-6.1.7/jms-client-0-8/book/index.html">Apache Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>Apache 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">Apache 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>Apache 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-Dependenci es.html">3. Getting 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">3.1. Getting the Client</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JMS-Getting-And-Dependencies-Dependencies.html">3.2. 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">4.1. Point to point example</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Examples-PubSub.html">4.2. Publish/subscribe example</a></span></dt></dl></dd><dt><span class="chapter"><a href="JMS-Client-0-8-Client-Understanding.html">5. Understanding the 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-Overv iew">5.1. Overview</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-ConnectionFactory.html">5.2. ConnectionFactory</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Connection.html">5.3. 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">5.3.1. 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">5.3.2. 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">5.3.3. 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">5.3.4. Message Compression </a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Session.html">5.4. 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">5.4.1. 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">5.4.2. 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">5.4.3. 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">5.4.4. CreateTopic</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageProducer.html">5.5. 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">5.5.1. 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">5.5.2. 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">5.5.3. 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">5.5.4. Flow Control</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-MessageConsumer.html">5.6. 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">5.6.1. 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">5.6.2. 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">5.6.3. Maximum Delivery Count</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Client-Understanding-Destinations.html">5.7. 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-Properti es-Format-ConnectionFactory">6.1. ConnectionFactory</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Queue.html">6.2. Queue</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Topic.html">6.3. Topic</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-JNDI-Properties-Format-Destination.html">6.4. 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">8.1. 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">8.1.1. Binding URLs for declaring of JMS Queues</a></span></dt><dt><span class="section"><a href="JMS-Cli ent-0-8-Binding-URL.html#JMS-Client-0-8-Binding-URL-JMS-Topics">8.1.2. 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">8.1.3. 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">8.1.4. 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">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-Sett ing-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-Setting-KeyStore">9.3.1. Providing the Key Store</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-Message- Encryption-Example.html">9.4. Message Encryption Example</a></span></dt><dd><dl><dt><span class="section"><a href="JMS-Client-Message-Encryption-Example.html#JMS-Client-Message-Encryption-Example-Introduction">9.4.1. Introduction</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Example.html#JMS-Client-Message-Encryption-Example-Prerequisites">9.4.2. Prerequisites</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Example.html#JMS-Client-Message-Encryption-Example-Broker-Config">9.4.3. Broker Configuration</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Example.html#JMS-Client-Message-Encryption-Example-Client-Config">9.4.4. Client Configuration</a></span></dt><dt><span class="section"><a href="JMS-Client-Message-Encryption-Example.html#JMS-Client-Message-Encryption-Example-Application">9.4.5. Application Code</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-RecommendedProductionLoggingLevel">11.1. Recommended Production Logging Level</a></span></dt><dt><span class="section"><a href="JMS-Client-0-8-Logging-EnablingDebugLogging.html">11.2. 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">C.1. Queue Management</a></span></dt><dd><dl><dt><span class="sec tion"><a href="JMS-Client-0-8-Appendix-JMS-Extensions.html#JMS-Client-0-8-Appendix-JMS-Extensions-Queue-Creation">C.1.1. Queue creation</a></span></dt></dl></dd><dt><span class="section"><a href="JMS-Client-0-8-Appendix-JMS-Extensions-Binding.html">C.2. 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">C.2.1. 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 appli cation</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">Connection URL Options</a></dt><dt>7.2. <a href="JMS-Client-0-8-Connection-URL.html#d0e1368">Broker List Options</a></dt><dt>8.1. <a href="JMS-Client-0-8-Binding-URL.html#d0e1659">Binding URL options </a></dt><dt>8.2. <a href="JMS-Client-0-8-Binding-URL.html#d0e1868">Binding URL examples</a></dt><dt>10.1. <a href="JMS-Client-0-8-System-Properties.html#d0e2129">System Properties Affecting Connection Behaviour</a></dt><dt>10.2. <a href="JMS-Client-0-8-System-Properties.html#d0e2220">Config Options For Session Behaviour</a></dt><dt>10.3. <a href="JMS-Client-0-8-System-Properties.html#d0e2285">Config Options For Consumer Behaviour</a></dt><dt>10.4. <a href="JMS-Client-0-8-System-Properties.html#d0 e2377">Config Options For Producer Behaviour</a></dt><dt>10.5. <a href="JMS-Client-0-8-System-Properties.html#d0e2470">Config Options For Threading</a></dt><dt>10.6. <a href="JMS-Client-0-8-System-Properties.html#d0e2510">Config Options For I/O</a></dt><dt>10.7. <a href="JMS-Client-0-8-System-Properties.html#d0e2618">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#d0e2683">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#d0e2837">Exceptions linked to JMSExceptions thrown by JMS methods</a></dt><dt>A.2. <a href="JMS-Client-0-8-Appendix-Exceptions.html#d0e2965">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#d0e1343">Broker Lists</a></dt><dt>8.1. <a href="JMS-Client-0-8-Binding-URL.html#d0e1825">Binding URL examples for JMS queues</a></dt><dt>8.2. <a href="JMS-Client-0-8-Binding-URL.html#d0e1843">Binding URL examples for JMS topics</a></dt><dt>B.1. <a href="JMS-Client-0-8-Appendix-Maven.html#d0e3050">Minimal Maven POM </a></dt><dt>C.1. <a href="JMS-Client-0-8-Appendix-JMS-Extensions.html#d0e3077">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#d0e3092">Binding a queue using JMS</a></dt><dt>D.1. <a href="JMS-Client-0-8-Appendix-PooledConnecytionFactory.html#d0e3161">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#d0e3184">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#d0e3399">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#d0e3423">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#d0e3446">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="/security.html">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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/d1947fd4/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Example.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Example.html b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Example.html new file mode 100644 index 0000000..9913e32 --- /dev/null +++ b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Example.html @@ -0,0 +1,326 @@ +<!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.4. Message Encryption Example - 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/broker-j/index.html">Broker-J</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-6.1.7/index.html">Qpid for Java 6.1.7</a></li><li><a href="/releases/qpid-java-6.1.7/jms-client-0-8/book/index.html">Apache Qpid JMS Client for AMQP protocols 0-8, 0-9 and 0-9-1</a></li><li>9.4. Message Encryption Example</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.4. Message Encryption Example</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%">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-Example"></a>9.4. Message Encryption Example</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Example-Introduction"></a>9.4.1. Introduction</h3></div></div></div><p> + In this example we will setup the Qpid Broker for Java and two clients who will send each other encrypted messages. + The clients will use self signed certificates and the certificates will be distributed by the Broker. + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Example-Prerequisites"></a>9.4.2. Prerequisites</h3></div></div></div><p> + For this example it is assumed the Broker is already running and that Management is enabled on port + 8443. + </p><p> + The example requires two (one for each client) self-signed X.509 certificates and the corresponding + keys. We refer to these as + <code class="literal">client_1/2.cert</code> + and + <code class="literal">client_1/2.key</code> + throughout the text below. + </p><p> + The following + <a class="link" href="https://www.openssl.org"; target="_top">openssl</a> + commands can be used to generate self signed certicates suitable for this test. + </p><pre class="programlisting"> +openssl req -x509 -newkey rsa:4096 -keyout client_1.key -out client_1.cert -days 365 -nodes -subj "/C=US/O=Apache/OU=Qpid/CN=client1" +openssl req -x509 -newkey rsa:4096 -keyout client_2.key -out client_2.cert -days 365 -nodes -subj "/C=US/O=Apache/OU=Qpid/CN=client2" + </pre><p> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Example-Broker-Config"></a>9.4.3. Broker Configuration</h3></div></div></div><p> + In this example we want the broker to distribute the client certificates. + Essentially, we want the broker to act as a<a class="link" href="https://en.wikipedia.org/wiki/Key_server_(cryptographic)" target="_top"> + Key Server</a>. + Use + <a class="link" href="http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool.html"; target="_top">java's keytool</a> + to create a trust store containing the two client certificates. + </p><pre class="programlisting"> +keytool -importcert -file client_1.cert -alias client1 -keystore mytruststore.jks +keytool -importcert -file client_2.cert -alias client2 -keystore mytruststore.jks + </pre><p> + Now a FileTrustStore can be created on the broker pointing to the java trust store that was just + created. + This can be done via the Web Management Console or the REST API: + </p><pre class="programlisting">curl -v -u admin https://localhost:8443/api/v6.1/truststore/clientcerts -X PUT -d + '{"type": "FileTrustStore", "stroeUrl": "<path_to_truststore>", "password": "<your_truststore_password>"}' + </pre><p> + The TrustStore must be configured to expose the certificates as a message source to the clients: + </p><pre class="programlisting">curl -v -u admin https://localhost:8443/api/v6.1/truststore/clientcerts -X POST -d + '{"exposedAsMessageSource": true}' + </pre><p> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Example-Client-Config"></a>9.4.4. Client Configuration</h3></div></div></div><p> + The configuration for the clients happens in the connection URL. In this example this is provided via a + JNDI properties file. + </p><p> + On the producing side, in order to encrypt a message for a recipient, the Qpid client needs the + recipient's public certificate which is distributed by the Broker following our above broker setup. The + <code class="literal">encryption_remote_trust_store</code> + element within the connection URL provides the name of the truststore. + </p><p> + On the receiving side, in order to decrypt a message it needs a JKS keystore with the private key + matching the public certificate. + For this example, the keystores can again be created with a two-step process involving + <a class="link" href="https://www.openssl.org"; target="_top">openssl</a> + and <a class="link" href="http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/keytool.html"; target="_top">java's keytool</a>. + </p><pre class="programlisting"> +openssl pkcs12 -export -in client_1.cert -inkey client_1.key -out client_1.pkcs12 -name "client1" +openssl pkcs12 -export -in client_2.cert -inkey client_2.key -out client_2.pkcs12 -name "client2" + +keytool -importkeystore -destkeystore client_1.jks -srckeystore client_1.pkcs12 -srcstoretype PKCS12 +keytool -importkeystore -destkeystore client_2.jks -srckeystore client_2.pkcs12 -srcstoretype PKCS12 + </pre><p> + + </p><p> + The final JNDI properties file should look similar to this: + </p><pre class="programlisting"> +java.naming.factory.initial = org.apache.qpid.jndi.PropertiesFileInitialContextFactory + +# connection factories. This is where end-to-end encryption is configured on the client. +# connectionfactory.[jndiname] = [ConnectionURL] +connectionfactory.producerConnectionFactory = amqp://<username>:<password>@?brokerlist='tcp://localhost:5672?encryption_remote_trust_store='$certificates%255c/clientcerts'' +connectionfactory.consumer1ConnectionFactory = amqp://<username>:<password>@?brokerlist='tcp://localhost:5672?encryption_key_store='path/to/client_1.jks'&encryption_key_store_password='<keystore_password>'' +connectionfactory.consumer2ConnectionFactory = amqp://<username>:<password>@?brokerlist='tcp://localhost:5672?encryption_key_store='path/to/client_2.jks'&encryption_key_store_password='<keystore_password>'' + +# Rest of JNDI configuration. For example +# destination.[jniName] = [Address Format] +queue.myTestQueue = testQueue + </pre><p> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="JMS-Client-Message-Encryption-Example-Application"></a>9.4.5. Application Code</h3></div></div></div><p> + On the producing side, the application needs to enable encryption and indicate the intended recipient(s) + of each message. This is done via the + <code class="literal">x-qpid-encrypt</code> + and + <code class="literal">x-qpid-encrypt-recipients</code> + message properties. Note that the order of the relative distinguished name (RDN) entries within the + recipent's distinguished name (DNs) is significant. If the order does not match that recorded in + truststore, a + <a class="link" href="JMS-Client-0-8-Appendix-Exceptions.html#JMS-Client-0-8-Appendix-Exceptions-CertificateException">CertificateException</a> + will be encountered. + </p><p> + On the receiving side, there is nothing to do. The application code does not have to add decryption code as this is handled transparently by the Qpid client library. + However, the receiving application should gracefully handle failures in decryption in which case the encrypted message will be delivered as a BytesMessage. + </p><pre class="programlisting"> +// imports omitted for brevity + +public class EncryptionExample { + public EncryptionExample() { + } + + public static void main(String[] args) throws Exception { + EncryptionExample encryptionExampleApp = new EncryptionExample(); + encryptionExampleApp.runProducerExample(); + encryptionExampleApp.runReceiverExample(); + } + + private void runProducerExample() throws Exception + { + Connection connection = createConnection("producerConnectionFactory"); + try { + Session session = connection.createSession(true, Session.SESSION_TRANSACTED); + Destination destination = createDesination("myTestQueue"); + + MessageProducer messageProducer = session.createProducer(destination); + TextMessage message = session.createTextMessage("Hello world!"); + + // ============== Enable encryption for this message ============== + message.setBooleanProperty("x-qpid-encrypt", true); + // ============== Configure recipients for encryption ============== + message.setStringProperty("x-qpid-encrypt-recipients", "CN=client1, OU=Qpid, O=Apache, C=US"); + + messageProducer.send(message); + session.commit(); + } + finally { + connection.close(); + } + } + + private void runReceiverExample() throws Exception + { + Connection connection = createConnection("consumer1ConnectionFactory"); + try { + connection.start(); + Session session = connection.createSession(true, Session.SESSION_TRANSACTED); + Destination destination = createDesination("myTestQueue"); + MessageConsumer messageConsumer = session.createConsumer(destination); + Message message = messageConsumer.receive(); + if (message instanceof TextMessage) { + // application logic + System.out.println(((TextMessage) message).getText()); + } else if (message instanceof BytesMessage) { + // handle potential decryption failure + System.out.println("Potential decryption problem. Application not in list of intended recipients?"); + } + session.commit(); + } + finally { + connection.close(); + } + } + + /////////////////////////////////////// + // The following is boilerplate code // + /////////////////////////////////////// + + private Connection createConnection(final String connectionFactoryName) throws JMSException, IOException, NamingException + { + try (InputStream resourceAsStream = this.getClass().getResourceAsStream("example.properties")) { + Properties properties = new Properties(); + properties.load(resourceAsStream); + Context context = new InitialContext(properties); + ConnectionFactory connectionFactory = (ConnectionFactory) context.lookup(connectionFactoryName); + final Connection connection = connectionFactory.createConnection(); + context.close(); + return connection; + } + } + + private Destination createDesination(String desinationJndiName) throws IOException, NamingException + { + try (InputStream resourceAsStream = this.getClass().getResourceAsStream("example.properties")) { + Properties properties = new Properties(); + properties.load(resourceAsStream); + Context context = new InitialContext(properties); + Destination destination = (Destination) context.lookup(desinationJndiName); + context.close(); + return destination; + } + } +} + </pre><p> + </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-Message-Encryption-Receiving.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.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 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="/security.html">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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/d1947fd4/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html new file mode 100644 index 0000000..4036395 --- /dev/null +++ b/content/releases/qpid-java-6.1.7/jms-client-0-8/book/JMS-Client-Message-Encryption-Receiving.html @@ -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/broker-j/index.html">Broker-J</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-6.1.7/index.html">Qpid for Java 6.1.7</a></li><li><a href="/releases/qpid-java-6.1.7/jms-client-0-8/book/index.html">Apache 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-Message-Encryption-Example.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-Message-Encryption-Example.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%"> 9.4. Message Encryption Example</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="/security.html">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]
