| |
| <!DOCTYPE HTML> |
| <html lang="" > |
| <head> |
| <title>Configuring Transports ยท ActiveMQ Artemis Documentation</title> |
| <meta charset="UTF-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> |
| <meta name="description" content=""> |
| <meta name="generator" content="GitBook 3.1.1"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/style.css"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <meta name="HandheldFriendly" content="true"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> |
| <meta name="apple-mobile-web-app-capable" content="yes"> |
| <meta name="apple-mobile-web-app-status-bar-style" content="black"> |
| <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> |
| <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> |
| |
| |
| <link rel="next" href="config-reload.html" /> |
| |
| |
| <link rel="prev" href="persistence.html" /> |
| |
| |
| </head> |
| <body> |
| |
| <div class="book"> |
| <div class="book-summary"> |
| |
| |
| <div id="book-search-input" role="search"> |
| <input type="text" placeholder="Type to search" /> |
| </div> |
| |
| |
| <nav role="navigation"> |
| |
| |
| |
| <ul class="summary"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="chapter " data-level="1.1" data-path="./"> |
| |
| <a href="./"> |
| |
| |
| Introduction |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.2" data-path="notice.html"> |
| |
| <a href="notice.html"> |
| |
| |
| Legal Notice |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.3" data-path="preface.html"> |
| |
| <a href="preface.html"> |
| |
| |
| Preface |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.4" data-path="project-info.html"> |
| |
| <a href="project-info.html"> |
| |
| |
| Project Info |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.5" data-path="versions.html"> |
| |
| <a href="versions.html"> |
| |
| |
| Versions |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.6" data-path="messaging-concepts.html"> |
| |
| <a href="messaging-concepts.html"> |
| |
| |
| Messaging Concepts |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7" data-path="architecture.html"> |
| |
| <a href="architecture.html"> |
| |
| |
| Architecture |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.8" data-path="using-server.html"> |
| |
| <a href="using-server.html"> |
| |
| |
| Using the Server |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.9" data-path="upgrading.html"> |
| |
| <a href="upgrading.html"> |
| |
| |
| Upgrading |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.10" data-path="address-model.html"> |
| |
| <a href="address-model.html"> |
| |
| |
| Address Model |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.11" data-path="using-jms.html"> |
| |
| <a href="using-jms.html"> |
| |
| |
| Using JMS |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.12" data-path="using-core.html"> |
| |
| <a href="using-core.html"> |
| |
| |
| Using Core |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.13" data-path="using-AMQP.html"> |
| |
| <a href="using-AMQP.html"> |
| |
| |
| Using AMQP |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.14" data-path="jms-core-mapping.html"> |
| |
| <a href="jms-core-mapping.html"> |
| |
| |
| Mapping JMS Concepts to the Core API |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.15" data-path="client-classpath.html"> |
| |
| <a href="client-classpath.html"> |
| |
| |
| The Client Classpath |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.16" data-path="examples.html"> |
| |
| <a href="examples.html"> |
| |
| |
| Examples |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.17" data-path="wildcard-routing.html"> |
| |
| <a href="wildcard-routing.html"> |
| |
| |
| Routing Messages With Wild Cards |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.18" data-path="wildcard-syntax.html"> |
| |
| <a href="wildcard-syntax.html"> |
| |
| |
| Understanding the Apache ActiveMQ Artemis Wildcard Syntax |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.19" data-path="filter-expressions.html"> |
| |
| <a href="filter-expressions.html"> |
| |
| |
| Filter Expressions |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.20" data-path="persistence.html"> |
| |
| <a href="persistence.html"> |
| |
| |
| Persistence |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter active" data-level="1.21" data-path="configuring-transports.html"> |
| |
| <a href="configuring-transports.html"> |
| |
| |
| Configuring Transports |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.22" data-path="config-reload.html"> |
| |
| <a href="config-reload.html"> |
| |
| |
| Configuration Reload |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.23" data-path="connection-ttl.html"> |
| |
| <a href="connection-ttl.html"> |
| |
| |
| Detecting Dead Connections |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.24" data-path="slow-consumers.html"> |
| |
| <a href="slow-consumers.html"> |
| |
| |
| Detecting Slow Consumers |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.25" data-path="network-isolation.html"> |
| |
| <a href="network-isolation.html"> |
| |
| |
| Avoiding Network Isolation |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.26" data-path="critical-analysis.html"> |
| |
| <a href="critical-analysis.html"> |
| |
| |
| Detecting Broker Issues (Critical Analysis) |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.27" data-path="transaction-config.html"> |
| |
| <a href="transaction-config.html"> |
| |
| |
| Resource Manager Configuration |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.28" data-path="flow-control.html"> |
| |
| <a href="flow-control.html"> |
| |
| |
| Flow Control |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.29" data-path="send-guarantees.html"> |
| |
| <a href="send-guarantees.html"> |
| |
| |
| Guarantees of sends and commits |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.30" data-path="undelivered-messages.html"> |
| |
| <a href="undelivered-messages.html"> |
| |
| |
| Message Redelivery and Undelivered Messages |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.31" data-path="message-expiry.html"> |
| |
| <a href="message-expiry.html"> |
| |
| |
| Message Expiry |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.32" data-path="large-messages.html"> |
| |
| <a href="large-messages.html"> |
| |
| |
| Large Messages |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.33" data-path="paging.html"> |
| |
| <a href="paging.html"> |
| |
| |
| Paging |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.34" data-path="scheduled-messages.html"> |
| |
| <a href="scheduled-messages.html"> |
| |
| |
| Scheduled Messages |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.35" data-path="last-value-queues.html"> |
| |
| <a href="last-value-queues.html"> |
| |
| |
| Last-Value Queues |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.36" data-path="exclusive-queues.html"> |
| |
| <a href="exclusive-queues.html"> |
| |
| |
| Exclusive Queues |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.37" data-path="message-grouping.html"> |
| |
| <a href="message-grouping.html"> |
| |
| |
| Message Grouping |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.38" data-path="pre-acknowledge.html"> |
| |
| <a href="pre-acknowledge.html"> |
| |
| |
| Extra Acknowledge Modes |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.39" data-path="management.html"> |
| |
| <a href="management.html"> |
| |
| |
| Management |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.40" data-path="management-console.html"> |
| |
| <a href="management-console.html"> |
| |
| |
| Management Console |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.41" data-path="security.html"> |
| |
| <a href="security.html"> |
| |
| |
| Security |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.42" data-path="masking-passwords.html"> |
| |
| <a href="masking-passwords.html"> |
| |
| |
| Masking Passwords |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.43" data-path="broker-plugins.html"> |
| |
| <a href="broker-plugins.html"> |
| |
| |
| Broker Plugins |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.44" data-path="resource-limits.html"> |
| |
| <a href="resource-limits.html"> |
| |
| |
| Resource Limits |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.45" data-path="jms-bridge.html"> |
| |
| <a href="jms-bridge.html"> |
| |
| |
| The JMS Bridge |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.46" data-path="client-reconnection.html"> |
| |
| <a href="client-reconnection.html"> |
| |
| |
| Client Reconnection and Session Reattachment |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.47" data-path="diverts.html"> |
| |
| <a href="diverts.html"> |
| |
| |
| Diverting and Splitting Message Flows |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.48" data-path="core-bridges.html"> |
| |
| <a href="core-bridges.html"> |
| |
| |
| Core Bridges |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.49" data-path="duplicate-detection.html"> |
| |
| <a href="duplicate-detection.html"> |
| |
| |
| Duplicate Message Detection |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.50" data-path="clusters.html"> |
| |
| <a href="clusters.html"> |
| |
| |
| Clusters |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.51" data-path="ha.html"> |
| |
| <a href="ha.html"> |
| |
| |
| High Availability and Failover |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.52" data-path="graceful-shutdown.html"> |
| |
| <a href="graceful-shutdown.html"> |
| |
| |
| Graceful Server Shutdown |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.53" data-path="libaio.html"> |
| |
| <a href="libaio.html"> |
| |
| |
| Libaio Native Libraries |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.54" data-path="thread-pooling.html"> |
| |
| <a href="thread-pooling.html"> |
| |
| |
| Thread management |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.55" data-path="logging.html"> |
| |
| <a href="logging.html"> |
| |
| |
| Logging |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.56" data-path="rest.html"> |
| |
| <a href="rest.html"> |
| |
| |
| REST Interface |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.57" data-path="embedding-activemq.html"> |
| |
| <a href="embedding-activemq.html"> |
| |
| |
| Embedding Apache ActiveMQ Artemis |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.58" data-path="karaf.html"> |
| |
| <a href="karaf.html"> |
| |
| |
| Apache Karaf |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.59" data-path="tomcat.html"> |
| |
| <a href="tomcat.html"> |
| |
| |
| Apache Tomcat |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.60" data-path="spring-integration.html"> |
| |
| <a href="spring-integration.html"> |
| |
| |
| Spring Integration |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.61" data-path="cdi-integration.html"> |
| |
| <a href="cdi-integration.html"> |
| |
| |
| CDI Integration |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.62" data-path="intercepting-operations.html"> |
| |
| <a href="intercepting-operations.html"> |
| |
| |
| Intercepting Operations |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.63" data-path="protocols-interoperability.html"> |
| |
| <a href="protocols-interoperability.html"> |
| |
| |
| Protocols and Interoperability |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.64" data-path="tools.html"> |
| |
| <a href="tools.html"> |
| |
| |
| Tools |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.65" data-path="maven-plugin.html"> |
| |
| <a href="maven-plugin.html"> |
| |
| |
| Maven Plugin |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.66" data-path="unit-testing.html"> |
| |
| <a href="unit-testing.html"> |
| |
| |
| Unit Testing |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.67" data-path="perf-tuning.html"> |
| |
| <a href="perf-tuning.html"> |
| |
| |
| Troubleshooting and Performance Tuning |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.68" data-path="configuration-index.html"> |
| |
| <a href="configuration-index.html"> |
| |
| |
| Configuration Reference |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| |
| |
| |
| <li class="divider"></li> |
| |
| <li> |
| <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> |
| Published with GitBook |
| </a> |
| </li> |
| </ul> |
| |
| |
| </nav> |
| |
| |
| </div> |
| |
| <div class="book-body"> |
| |
| <div class="body-inner"> |
| |
| |
| |
| <div class="book-header" role="navigation"> |
| |
| |
| <!-- Title --> |
| <h1> |
| <i class="fa fa-circle-o-notch fa-spin"></i> |
| <a href="." >Configuring Transports</a> |
| </h1> |
| </div> |
| |
| |
| |
| |
| <div class="page-wrapper" tabindex="-1" role="main"> |
| <div class="page-inner"> |
| |
| <div id="book-search-results"> |
| <div class="search-noresults"> |
| |
| <section class="normal markdown-section"> |
| |
| <h1 id="configuring-the-transport">Configuring the Transport</h1> |
| <p>In this chapter we'll describe the concepts required for understanding |
| Apache ActiveMQ Artemis transports and where and how they're configured.</p> |
| <h2 id="acceptors">Acceptors</h2> |
| <p>One of the most important concepts in Apache ActiveMQ Artemis transports is the |
| <em>acceptor</em>. Let's dive straight in and take a look at an acceptor |
| defined in xml in the configuration file <code>broker.xml</code>.</p> |
| <pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">acceptors</span>></span> |
| <span class="hljs-tag"><<span class="hljs-name">acceptor</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"netty"</span>></span>tcp://localhost:61617<span class="hljs-tag"></<span class="hljs-name">acceptor</span>></span> |
| <span class="hljs-tag"></<span class="hljs-name">acceptors</span>></span> |
| </code></pre> |
| <p>Acceptors are always defined inside an <code>acceptors</code> element. There can be |
| one or more acceptors defined in the <code>acceptors</code> element. There's no |
| upper limit to the number of acceptors per server.</p> |
| <p>Each acceptor defines a way in which connections can be made to the |
| Apache ActiveMQ Artemis server.</p> |
| <p>In the above example we're defining an acceptor that uses |
| <a href="https://netty.io/" target="_blank">Netty</a> to listen for connections at port |
| <code>61617</code>.</p> |
| <p>The <code>acceptor</code> element contains a <code>URL</code> that defines the kind of Acceptor |
| to create along with its configuration. The <code>schema</code> part of the <code>URL</code> |
| defines the Acceptor type which can either be <code>tcp</code> or <code>vm</code> which is |
| <code>Netty</code> or an In VM Acceptor respectively. For <code>Netty</code> the host and the |
| port of the <code>URL</code> define what host and port the <code>acceptor</code> will bind to. For |
| In VM the <code>Authority</code> part of the <code>URL</code> defines a unique server id.</p> |
| <p>The <code>acceptor</code> can also be configured with a set of key=value pairs |
| used to configure the specific transport, the set of |
| valid key=value pairs depends on the specific transport be used and are |
| passed straight through to the underlying transport. These are set on the |
| <code>URL</code> as part of the query, like so:</p> |
| <pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">acceptor</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"netty"</span>></span>tcp://localhost:61617?sslEnabled=true&keyStorePath=/path<span class="hljs-tag"></<span class="hljs-name">acceptor</span>></span> |
| </code></pre> |
| <h2 id="connectors">Connectors</h2> |
| <p>Whereas acceptors are used on the server to define how we accept |
| connections, connectors are used to define how to connect to a server.</p> |
| <p>Let's look at a connector defined in our <code>broker.xml</code> file:</p> |
| <pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">connectors</span>></span> |
| <span class="hljs-tag"><<span class="hljs-name">connector</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"netty"</span>></span>tcp://localhost:61617<span class="hljs-tag"></<span class="hljs-name">connector</span>></span> |
| <span class="hljs-tag"></<span class="hljs-name">connectors</span>></span> |
| </code></pre> |
| <p>Connectors can be defined inside a <code>connectors</code> element. There can be |
| one or more connectors defined in the <code>connectors</code> element. There's no |
| upper limit to the number of connectors per server.</p> |
| <p>A <code>connector</code> is used when the server acts as a client itself, e.g.:</p> |
| <ul> |
| <li>When one server is bridged to another</li> |
| <li>When a server takes part in a cluster</li> |
| </ul> |
| <p>In these cases the server needs to know how to connect to other servers. |
| That's defined by <code>connectors</code>.</p> |
| <h2 id="configuring-the-transport-directly-from-the-client">Configuring the Transport Directly from the Client</h2> |
| <p>How do we configure a core <code>ClientSessionFactory</code> with the information |
| that it needs to connect with a server?</p> |
| <p>Connectors are also used indirectly when configuring a core |
| <code>ClientSessionFactory</code> to directly talk to a server. Although in this |
| case there's no need to define such a connector in the server side |
| configuration, instead we just specify the appropriate URI.</p> |
| <p>Here's an example of creating a <code>ClientSessionFactory</code> which will |
| connect directly to the acceptor we defined earlier in this chapter, it |
| uses the standard Netty TCP transport and will try and connect on port |
| 61617 to localhost (default):</p> |
| <pre><code class="lang-java">ServerLocator locator = ActiveMQClient.createServerLocator(<span class="hljs-string">"tcp://localhost:61617"</span>); |
| |
| ClientSessionFactory sessionFactory = locator.createClientSessionFactory(); |
| |
| ClientSession session = sessionFactory.createSession(...); |
| </code></pre> |
| <p>Similarly, if you're using JMS, you can configure the JMS connection |
| factory directly on the client side:</p> |
| <pre><code class="lang-java">ConnectionFactory connectionFactory = <span class="hljs-keyword">new</span> ActiveMQConnectionFactory(<span class="hljs-string">"tcp://localhost:61617"</span>); |
| |
| Connection jmsConnection = connectionFactory.createConnection(); |
| </code></pre> |
| <h2 id="configuring-the-netty-transport">Configuring the Netty transport</h2> |
| <p>Out of the box, Apache ActiveMQ Artemis currently uses |
| <a href="https://netty.io/" target="_blank">Netty</a>, a high performance low level |
| network library.</p> |
| <p>Our Netty transport can be configured in several different ways; to use |
| straightforward TCP sockets, SSL, or to tunnel over HTTP or HTTPS..</p> |
| <p>We believe this caters for the vast majority of transport requirements.</p> |
| <h3 id="single-port-support">Single Port Support</h3> |
| <p>Apache ActiveMQ Artemis supports using a single port for all |
| protocols, Apache ActiveMQ Artemis will automatically detect which protocol is being |
| used CORE, AMQP, STOMP or OPENWIRE and use the appropriate Apache ActiveMQ Artemis |
| handler. It will also detect whether protocols such as HTTP or Web |
| Sockets are being used and also use the appropriate decoders</p> |
| <p>It is possible to limit which protocols are supported by using the |
| <code>protocols</code> parameter on the Acceptor like so:</p> |
| <pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">acceptor</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"netty"</span>></span>tcp://localhost:61617?protocols=CORE,AMQP<span class="hljs-tag"></<span class="hljs-name">acceptor</span>></span> |
| </code></pre> |
| <h3 id="configuring-netty-tcp">Configuring Netty TCP</h3> |
| <p>Netty TCP is a simple unencrypted TCP sockets based transport. If you're |
| running connections across an untrusted network please bear in |
| mind this transport is unencrypted. You may want to look at the SSL or |
| HTTPS configurations.</p> |
| <p>With the Netty TCP transport all connections are initiated from the |
| client side (i.e. the server does not initiate any connections to the |
| client). This works well with firewall policies that typically only allow |
| connections to be initiated in one direction.</p> |
| <p>All the valid keys for the <code>tcp</code> URL scheme used for Netty are defined in the |
| class <code>org.apache.activemq.artemis.core.remoting.impl.netty.TransportConstants</code>. |
| Most parameters can be used either with acceptors or connectors, some only |
| work with acceptors. The following parameters can be used to configure |
| Netty for simple TCP:</p> |
| <blockquote> |
| <p><strong>Note</strong></p> |
| <p>The <code>host</code> and <code>port</code> parameters are only used in the core API, in |
| XML configuration these are set in the URI host and port.</p> |
| </blockquote> |
| <ul> |
| <li><p><code>host</code>. This specifies the host name or IP address to connect to |
| (when configuring a connector) or to listen on (when configuring an |
| acceptor). The default value for this property is <code>localhost</code>. When |
| configuring acceptors, multiple hosts or IP addresses can be |
| specified by separating them with commas. It is also possible to |
| specify <code>0.0.0.0</code> to accept connection from all the host's network |
| interfaces. It's not valid to specify multiple addresses when |
| specifying the host for a connector; a connector makes a connection |
| to one specific address.</p> |
| <blockquote> |
| <p><strong>Note</strong></p> |
| <p>Don't forget to specify a host name or IP address! If you want |
| your server able to accept connections from other nodes you must |
| specify a hostname or IP address at which the acceptor will bind |
| and listen for incoming connections. The default is localhost |
| which of course is not accessible from remote nodes!</p> |
| </blockquote> |
| </li> |
| <li><p><code>port</code>. This specified the port to connect to (when configuring a |
| connector) or to listen on (when configuring an acceptor). The |
| default value for this property is <code>61616</code>.</p> |
| </li> |
| <li><p><code>tcpNoDelay</code>. If this is <code>true</code> then <a href="https://en.wikipedia.org/wiki/Nagle%27s_algorithm" target="_blank">Nagle's |
| algorithm</a> will be |
| disabled. This is a <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/net/socketOpt.html" target="_blank">Java (client) socket |
| option</a>. |
| The default value for this property is <code>true</code>.</p> |
| </li> |
| <li><p><code>tcpSendBufferSize</code>. This parameter determines the size of the |
| TCP send buffer in bytes. The default value for this property is |
| <code>32768</code> bytes (32KiB).</p> |
| <p>TCP buffer sizes should be tuned according to the bandwidth and |
| latency of your network. Here's a good link that explains the theory |
| behind <a href="http://www-didc.lbl.gov/TCP-tuning/" target="_blank">this</a>.</p> |
| <p>In summary TCP send/receive buffer sizes should be calculated as:</p> |
| <pre><code>buffer_size = bandwidth * RTT. |
| </code></pre><p>Where bandwidth is in <em>bytes per second</em> and network round trip time |
| (RTT) is in seconds. RTT can be easily measured using the <code>ping</code> |
| utility.</p> |
| <p>For fast networks you may want to increase the buffer sizes from the |
| defaults.</p> |
| </li> |
| <li><p><code>tcpReceiveBufferSize</code>. This parameter determines the size of the |
| TCP receive buffer in bytes. The default value for this property is |
| <code>32768</code> bytes (32KiB).</p> |
| </li> |
| <li><p><code>writeBufferLowWaterMark</code>. This parameter determines the low water mark of |
| the Netty write buffer. Once the number of bytes queued in the write buffer exceeded |
| the high water mark and then dropped down below this value, Netty's channel |
| will start to be writable again. The default value for this property is |
| <code>32768</code> bytes (32KiB).</p> |
| </li> |
| <li><p><code>writeBufferHighWaterMark</code>. This parameter determines the high water mark of |
| the Netty write buffer. If the number of bytes queued in the write buffer exceeds |
| this value, Netty's channel will start to be not writable. The default value for |
| this property is <code>131072</code> bytes (128KiB).</p> |
| </li> |
| <li><p><code>batchDelay</code>. Before writing packets to the transport, Apache ActiveMQ Artemis can |
| be configured to batch up writes for a maximum of <code>batchDelay</code> |
| milliseconds. This can increase overall throughput for very small |
| messages. It does so at the expense of an increase in average |
| latency for message transfer. The default value for this property is |
| <code>0</code> ms.</p> |
| </li> |
| <li><p><code>directDeliver</code>. When a message arrives on the server and is |
| delivered to waiting consumers, by default, the delivery is done on |
| the same thread as that on which the message arrived. This gives |
| good latency in environments with relatively small messages and a |
| small number of consumers, but at the cost of overall throughput and |
| scalability - especially on multi-core machines. If you want the |
| lowest latency and a possible reduction in throughput then you can |
| use the default value for <code>directDeliver</code> (i.e. <code>true</code>). If you are |
| willing to take some small extra hit on latency but want the highest |
| throughput set <code>directDeliver</code> to <code>false</code>.</p> |
| </li> |
| <li><p><code>nioRemotingThreads</code> This is deprecated. It is replaced by <code>remotingThreads</code>, |
| if you are using this please update your configuration</p> |
| </li> |
| <li><p><code>remotingThreads</code>. Apache ActiveMQ Artemis will, |
| by default, use a number of threads equal to three times the number |
| of cores (or hyper-threads) as reported by |
| <code>Runtime.getRuntime().availableProcessors()</code> for processing incoming |
| packets. If you want to override this value, you can set the number |
| of threads by specifying this parameter. The default value for this |
| parameter is <code>-1</code> which means use the value from |
| <code>Runtime.getRuntime().availableProcessors()</code> * 3.</p> |
| </li> |
| <li><p><code>localAddress</code>. When configured a Netty Connector it is possible to |
| specify which local address the client will use when connecting to |
| the remote address. This is typically used in the Application Server |
| or when running Embedded to control which address is used for |
| outbound connections. If the local-address is not set then the |
| connector will use any local address available</p> |
| </li> |
| <li><p><code>localPort</code>. When configured a Netty Connector it is possible to |
| specify which local port the client will use when connecting to the |
| remote address. This is typically used in the Application Server or |
| when running Embedded to control which port is used for outbound |
| connections. If the local-port default is used, which is 0, then the |
| connector will let the system pick up an ephemeral port. valid ports |
| are 0 to 65535</p> |
| </li> |
| <li><p><code>connectionsAllowed</code>. This is only valid for acceptors. It limits the |
| number of connections which the acceptor will allow. When this limit |
| is reached a DEBUG level message is issued to the log, and the connection |
| is refused. The type of client in use will determine what happens when |
| the connection is refused. In the case of a <code>core</code> client, it will |
| result in a <code>org.apache.activemq.artemis.api.core.ActiveMQConnectionTimedOutException</code>.</p> |
| </li> |
| <li><p><code>handshake-timeout</code>. Prevents an unauthorised client opening a large |
| number of connections and just keeping them open. As connections each |
| require a file handle this consumes resources that are then unavailable |
| to other clients. Once the connection is authenticated, the usual rules |
| can be enforced regarding resource consumption. Default value is set to |
| 10 seconds. Each integer is valid value. When set value to zero or |
| negative integer this feature is turned off. Changing value needs |
| to restart server to take effect.</p> |
| </li> |
| </ul> |
| <h3 id="configuring-netty-native-transport">Configuring Netty Native Transport</h3> |
| <p>Netty Native Transport support exists for selected OS platforms. |
| This allows Apache ActiveMQ Artemis to use native sockets/io instead of Java NIO.</p> |
| <p>These Native transports add features specific to a particular platform, |
| generate less garbage, and generally improve performance when compared to Java NIO based transport.</p> |
| <p>Both Clients and Server can benefit from this.</p> |
| <p>Current Supported Platforms.</p> |
| <ul> |
| <li>Linux running 64bit JVM</li> |
| <li>MacOS running 64bit JVM</li> |
| </ul> |
| <p>Apache ActiveMQ Artemis will by default enable the corresponding native transport if a supported platform is detected.</p> |
| <p>If running on an unsupported platform or any issues loading native libs, Apache ActiveMQ Artemis will fallback onto Java NIO.</p> |
| <h4 id="linux-native-transport">Linux Native Transport</h4> |
| <p>On supported Linux platforms Epoll is used, @see <a href="https://en.wikipedia.org/wiki/Epoll" target="_blank">https://en.wikipedia.org/wiki/Epoll</a>. </p> |
| <p>The following properties are specific to this native transport:</p> |
| <ul> |
| <li><code>useEpoll</code> enables the use of epoll if a supported linux platform is running a 64bit JVM is detected. |
| Setting this to <code>false</code> will force the use of Java NIO instead of epoll. Default is <code>true</code></li> |
| </ul> |
| <h4 id="macos-native-transport">MacOS Native Transport</h4> |
| <p>On supported MacOS platforms KQueue is used, @see <a href="https://en.wikipedia.org/wiki/Kqueue" target="_blank">https://en.wikipedia.org/wiki/Kqueue</a>. </p> |
| <p>The following properties are specific to this native transport:</p> |
| <ul> |
| <li><code>useKQueue</code> enables the use of kqueue if a supported MacOS platform running a 64bit JVM is detected. |
| Setting this to <code>false</code> will force the use of Java NIO instead of kqueue. Default is <code>true</code></li> |
| </ul> |
| <h3 id="configuring-netty-ssl">Configuring Netty SSL</h3> |
| <p>Netty SSL is similar to the Netty TCP transport but it provides |
| additional security by encrypting TCP connections using the Secure |
| Sockets Layer SSL</p> |
| <p>Please see the examples for a full working example of using Netty SSL.</p> |
| <p>Netty SSL uses all the same properties as Netty TCP but adds the |
| following additional properties:</p> |
| <ul> |
| <li><p><code>sslEnabled</code></p> |
| <p>Must be <code>true</code> to enable SSL. Default is <code>false</code>.</p> |
| </li> |
| <li><p><code>keyStorePath</code></p> |
| <p>When used on an <code>acceptor</code> this is the path to the SSL key store on |
| the server which holds the server's certificates (whether |
| self-signed or signed by an authority).</p> |
| <p>When used on a <code>connector</code> this is the path to the client-side SSL |
| key store which holds the client certificates. This is only relevant |
| for a <code>connector</code> if you are using 2-way SSL (i.e. mutual |
| authentication). Although this value is configured on the server, it |
| is downloaded and used by the client. If the client needs to use a |
| different path from that set on the server then it can override the |
| server-side setting by either using the customary |
| "javax.net.ssl.keyStore" system property or the ActiveMQ-specific |
| "org.apache.activemq.ssl.keyStore" system property. The |
| ActiveMQ-specific system property is useful if another component on |
| client is already making use of the standard, Java system property.</p> |
| </li> |
| <li><p><code>keyStorePassword</code></p> |
| <p>When used on an <code>acceptor</code> this is the password for the server-side |
| keystore.</p> |
| <p>When used on a <code>connector</code> this is the password for the client-side |
| keystore. This is only relevant for a <code>connector</code> if you are using |
| 2-way SSL (i.e. mutual authentication). Although this value can be |
| configured on the server, it is downloaded and used by the client. |
| If the client needs to use a different password from that set on the |
| server then it can override the server-side setting by either using |
| the customary "javax.net.ssl.keyStorePassword" system property or |
| the ActiveMQ-specific "org.apache.activemq.ssl.keyStorePassword" |
| system property. The ActiveMQ-specific system property is useful if |
| another component on client is already making use of the standard, |
| Java system property.</p> |
| </li> |
| <li><p><code>trustStorePath</code></p> |
| <p>When used on an <code>acceptor</code> this is the path to the server-side SSL |
| key store that holds the keys of all the clients that the server |
| trusts. This is only relevant for an <code>acceptor</code> if you are using |
| 2-way SSL (i.e. mutual authentication).</p> |
| <p>When used on a <code>connector</code> this is the path to the client-side SSL |
| key store which holds the public keys of all the servers that the |
| client trusts. Although this value can be configured on the server, |
| it is downloaded and used by the client. If the client needs to use |
| a different path from that set on the server then it can override |
| the server-side setting by either using the customary |
| "javax.net.ssl.trustStore" system property or the ActiveMQ-specific |
| "org.apache.activemq.ssl.trustStore" system property. The |
| ActiveMQ-specific system property is useful if another component on |
| client is already making use of the standard, Java system property.</p> |
| </li> |
| <li><p><code>trustStorePassword</code></p> |
| <p>When used on an <code>acceptor</code> this is the password for the server-side |
| trust store. This is only relevant for an <code>acceptor</code> if you are |
| using 2-way SSL (i.e. mutual authentication).</p> |
| <p>When used on a <code>connector</code> this is the password for the client-side |
| truststore. Although this value can be configured on the server, it |
| is downloaded and used by the client. If the client needs to use a |
| different password from that set on the server then it can override |
| the server-side setting by either using the customary |
| "javax.net.ssl.trustStorePassword" system property or the |
| ActiveMQ-specific "org.apache.activemq.ssl.trustStorePassword" |
| system property. The ActiveMQ-specific system property is useful if |
| another component on client is already making use of the standard, |
| Java system property.</p> |
| </li> |
| <li><p><code>enabledCipherSuites</code></p> |
| <p>Whether used on an <code>acceptor</code> or <code>connector</code> this is a comma |
| separated list of cipher suites used for SSL communication. The |
| default value is <code>null</code> which means the JVM's default will be used.</p> |
| </li> |
| <li><p><code>enabledProtocols</code></p> |
| <p>Whether used on an <code>acceptor</code> or <code>connector</code> this is a comma |
| separated list of protocols used for SSL communication. The default |
| value is <code>null</code> which means the JVM's default will be used.</p> |
| </li> |
| <li><p><code>needClientAuth</code></p> |
| <p>This property is only for an <code>acceptor</code>. It tells a client |
| connecting to this acceptor that 2-way SSL is required. Valid values |
| are <code>true</code> or <code>false</code>. Default is <code>false</code>.</p> |
| <p>Note that this property takes precedence over <code>wantClientAuth</code> and if |
| its value is set to true then <code>wantClientAuth</code> will be ignored.</p> |
| </li> |
| <li><p><code>wantClientAuth</code></p> |
| <p>This property is only for an <code>acceptor</code>. It tells a client |
| connecting to this acceptor that 2-way SSL is requested but not required. |
| Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>. </p> |
| <p>Note that if the property <code>needClientAuth</code> is set to true then that |
| property will take precedence and this property will be ignored.</p> |
| </li> |
| <li><p><code>verifyHost</code></p> |
| <p>When used on an <code>acceptor</code> the <code>CN</code> of the connecting client's SSL certificate |
| will be compared to its hostname to verify they match. This is useful |
| only for 2-way SSL.</p> |
| <p>When used on a <code>connector</code> the <code>CN</code> of the server's SSL certificate will be |
| compared to its hostname to verify they match. This is useful for both 1-way |
| and 2-way SSL.</p> |
| <p>Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>.</p> |
| </li> |
| <li><p><code>trustAll</code></p> |
| <p>When used on a <code>connector</code> the client will trust the provided server certificate |
| implicitly, regardless of any configured trust store. <strong>Warning:</strong> This setting is |
| primarily for testing purposes only and should not be used in production.</p> |
| <p>Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>. </p> |
| </li> |
| <li><p><code>useDefaultSslContext</code></p> |
| <p>Only valid on a <code>connector</code>. Allows the <code>connector</code> to use the "default" SSL |
| context (via <code>SSLContext.getDefault()</code>) which can be set programmatically by |
| the client (via <code>SSLContext.setDefault(SSLContext)</code>). If set to <code>true</code> all |
| other SSL related parameters except for <code>sslEnabled</code> are ignored.</p> |
| <p>Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>.</p> |
| </li> |
| <li><p><code>sslProvider</code></p> |
| <p>Used to change the SSL Provider between <code>JDK</code> and <code>OPENSSL</code>. The default is <code>JDK</code>. |
| If used with <code>OPENSSL</code> you can add <code>netty-tcnative</code> to your classpath to use the native |
| installed openssl. This can be useful if you want to use special ciphersuite - elliptic curve combinations |
| which are support through openssl but not through the JDK provider. See <a href="https://en.wikipedia.org/wiki/Comparison_of_TLS_implementations" target="_blank">https://en.wikipedia.org/wiki/Comparison_of_TLS_implementations</a> |
| for more information's.</p> |
| </li> |
| </ul> |
| <h3 id="configuring-netty-http">Configuring Netty HTTP</h3> |
| <p>Netty HTTP tunnels packets over the HTTP protocol. It can be useful in |
| scenarios where firewalls only allow HTTP traffic to pass.</p> |
| <p>Please see the examples for a full working example of using Netty HTTP.</p> |
| <p>Netty HTTP uses the same properties as Netty TCP but adds the following |
| additional properties:</p> |
| <ul> |
| <li><p><code>httpEnabled</code>. This is now no longer needed. With single port support |
| Apache ActiveMQ Artemis will now automatically detect if http is being |
| used and configure itself.</p> |
| </li> |
| <li><p><code>httpClientIdleTime</code>. How long a client can be idle before |
| sending an empty http request to keep the connection alive</p> |
| </li> |
| <li><p><code>httpClientIdleScanPeriod</code>. How often, in milliseconds, to scan |
| for idle clients</p> |
| </li> |
| <li><p><code>httpResponseTime</code>. How long the server can wait before sending an |
| empty http response to keep the connection alive</p> |
| </li> |
| <li><p><code>httpServerScanPeriod</code>. How often, in milliseconds, to scan for |
| clients needing responses</p> |
| </li> |
| <li><p><code>httpRequiresSessionId</code>. If <code>true</code> the client will wait after the |
| first call to receive a session id. Used the http connector is |
| connecting to servlet acceptor (not recommended)</p> |
| </li> |
| </ul> |
| |
| |
| </section> |
| |
| </div> |
| <div class="search-results"> |
| <div class="has-results"> |
| |
| <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> |
| <ul class="search-results-list"></ul> |
| |
| </div> |
| <div class="no-results"> |
| |
| <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> |
| |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| |
| <a href="persistence.html" class="navigation navigation-prev " aria-label="Previous page: Persistence"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| <a href="config-reload.html" class="navigation navigation-next " aria-label="Next page: Configuration Reload"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| |
| |
| </div> |
| |
| <script> |
| var gitbook = gitbook || []; |
| gitbook.push(function() { |
| gitbook.page.hasChanged({"page":{"title":"Configuring Transports","level":"1.21","depth":1,"next":{"title":"Configuration Reload","level":"1.22","depth":1,"path":"config-reload.md","ref":"config-reload.md","articles":[]},"previous":{"title":"Persistence","level":"1.20","depth":1,"path":"persistence.md","ref":"persistence.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"github":"apache/activemq-artemis","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/artemis","issues":"https://issues.apache.org/jira/browse/ARTEMIS","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis User Guide and Reference Documentation"},"file":{"path":"configuring-transports.md","mtime":"2018-05-16T14:50:27.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2018-05-22T13:57:43.612Z"},"basePath":".","book":{"language":""}}); |
| }); |
| </script> |
| </div> |
| |
| |
| <script src="gitbook/gitbook.js"></script> |
| <script src="gitbook/theme.js"></script> |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> |
| |
| |
| |
| </body> |
| </html> |
| |
