| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Uses of Interface org.apache.activemq.artemis.api.core.client.ServerLocator (ActiveMQ Artemis Website 2.30.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Uses of Interface org.apache.activemq.artemis.api.core.client.ServerLocator (ActiveMQ Artemis Website 2.30.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../../index.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h2 title="Uses of Interface org.apache.activemq.artemis.api.core.client.ServerLocator" class="title">Uses of Interface<br>org.apache.activemq.artemis.api.core.client.ServerLocator</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary"> |
| <caption><span>Packages that use <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.activemq.artemis.api.core.client">org.apache.activemq.artemis.api.core.client</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.activemq.artemis.api.core.management">org.apache.activemq.artemis.api.core.management</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.activemq.artemis.spi.core.remoting">org.apache.activemq.artemis.spi.core.remoting</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section><a id="org.apache.activemq.artemis.api.core.client"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> in <a href="../package-summary.html">org.apache.activemq.artemis.api.core.client</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.activemq.artemis.api.core.client</a> that return <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#addClusterTopologyListener(org.apache.activemq.artemis.api.core.client.ClusterTopologyListener)">addClusterTopologyListener</a></span>​(<a href="../ClusterTopologyListener.html" title="interface in org.apache.activemq.artemis.api.core.client">ClusterTopologyListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#addIncomingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)">addIncomingInterceptor</a></span>​(<a href="../../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an interceptor which will be executed <em>after packets are received from the server</em>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#addOutgoingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)">addOutgoingInterceptor</a></span>​(<a href="../../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an interceptor which will be executed <em>before packets are sent to the server</em>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocator(boolean,org.apache.activemq.artemis.api.core.DiscoveryGroupConfiguration)">createServerLocator</a></span>​(boolean ha, |
| <a href="../../DiscoveryGroupConfiguration.html" title="class in org.apache.activemq.artemis.api.core">DiscoveryGroupConfiguration</a> groupConfiguration)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which creates session factories from a set of live servers, no HA |
| backup information is propagated to the client The UDP address and port are used to listen for |
| live servers in the cluster</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocator(boolean,org.apache.activemq.artemis.api.core.TransportConfiguration...)">createServerLocator</a></span>​(boolean ha, |
| <a href="../../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a>... transportConfigurations)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which creates session factories using a static list of transportConfigurations, the ServerLocator is not updated automatically |
| as the cluster topology changes, and no HA backup information is propagated to the client</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocator(java.lang.String)">createServerLocator</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> url)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an ActiveMQConnectionFactory;</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocatorWithHA(org.apache.activemq.artemis.api.core.DiscoveryGroupConfiguration)">createServerLocatorWithHA</a></span>​(<a href="../../DiscoveryGroupConfiguration.html" title="class in org.apache.activemq.artemis.api.core">DiscoveryGroupConfiguration</a> groupConfiguration)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which will receive cluster topology updates from the cluster as servers |
| leave or join and new backups are appointed or removed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocatorWithHA(org.apache.activemq.artemis.api.core.TransportConfiguration...)">createServerLocatorWithHA</a></span>​(<a href="../../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a>... initialServers)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which will receive cluster topology updates from the cluster as servers |
| leave or join and new backups are appointed or removed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocatorWithoutHA(org.apache.activemq.artemis.api.core.DiscoveryGroupConfiguration)">createServerLocatorWithoutHA</a></span>​(<a href="../../DiscoveryGroupConfiguration.html" title="class in org.apache.activemq.artemis.api.core">DiscoveryGroupConfiguration</a> groupConfiguration)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which creates session factories from a set of live servers, no HA |
| backup information is propagated to the client</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ActiveMQClient.</span><code><span class="memberNameLink"><a href="../ActiveMQClient.html#createServerLocatorWithoutHA(org.apache.activemq.artemis.api.core.TransportConfiguration...)">createServerLocatorWithoutHA</a></span>​(<a href="../../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a>... transportConfigurations)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a ServerLocator which creates session factories using a static list of transportConfigurations, the ServerLocator is not updated automatically |
| as the cluster topology changes, and no HA backup information is propagated to the client</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#getServerLocator()">getServerLocator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setAckBatchSize(int)">setAckBatchSize</a></span>​(int ackBatchSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the acknowledgments batch size.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setAutoGroup(boolean)">setAutoGroup</a></span>​(boolean autoGroup)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether producers created through this factory will automatically |
| assign a group ID to the messages they sent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setBlockOnAcknowledge(boolean)">setBlockOnAcknowledge</a></span>​(boolean blockOnAcknowledge)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether consumers created through this factory will block while |
| sending message acknowledgments or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setBlockOnDurableSend(boolean)">setBlockOnDurableSend</a></span>​(boolean blockOnDurableSend)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setBlockOnNonDurableSend(boolean)">setBlockOnNonDurableSend</a></span>​(boolean blockOnNonDurableSend)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setCacheLargeMessagesClient(boolean)">setCacheLargeMessagesClient</a></span>​(boolean cached)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether large messages received by consumers created through this factory will be cached in temporary files or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setCallFailoverTimeout(long)">setCallFailoverTimeout</a></span>​(long callFailoverTimeout)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the blocking call failover timeout.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setCallTimeout(long)">setCallTimeout</a></span>​(long callTimeout)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the blocking call timeout.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setClientFailureCheckPeriod(long)">setClientFailureCheckPeriod</a></span>​(long clientFailureCheckPeriod)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the period (in milliseconds) used to check if a client has failed to receive pings from |
| the server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setCompressionLevel(int)">setCompressionLevel</a></span>​(int compressionLevel)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets what compressionLevel to use when compressing messages |
| Value must be -1 (default), or 0-9</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setCompressLargeMessage(boolean)">setCompressLargeMessage</a></span>​(boolean compressLargeMessages)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether to compress or not large messages.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setConfirmationWindowSize(int)">setConfirmationWindowSize</a></span>​(int confirmationWindowSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the size for the confirmation window buffer of clients using this factory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setConnectionLoadBalancingPolicyClassName(java.lang.String)">setConnectionLoadBalancingPolicyClassName</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> loadBalancingPolicyClassName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the class name of the connection load balancing policy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setConnectionTTL(long)">setConnectionTTL</a></span>​(long connectionTTL)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets this factory's connections <em>time-to-live</em>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setConsumerMaxRate(int)">setConsumerMaxRate</a></span>​(int consumerMaxRate)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum rate of message consumption for consumers created through this factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setConsumerWindowSize(int)">setConsumerWindowSize</a></span>​(int consumerWindowSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the window size for flow control of the consumers created through this factory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setFailoverAttempts(int)">setFailoverAttempts</a></span>​(int attempts)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of failover attempts to establish a connection to other live servers after a connection failure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setFailoverOnInitialConnection(boolean)">setFailoverOnInitialConnection</a></span>​(boolean failover)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setGroupID(java.lang.String)">setGroupID</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupID)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the group ID that will be set on each message sent through this factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setIncomingInterceptorList(java.lang.String)">setIncomingInterceptorList</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> interceptorList)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setInitialConnectAttempts(int)">setInitialConnectAttempts</a></span>​(int reconnectAttempts)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of attempts to establish an initial connection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setInitialMessagePacketSize(int)">setInitialMessagePacketSize</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the initial size of messages created through this factory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setMaxRetryInterval(long)">setMaxRetryInterval</a></span>​(long maxRetryInterval)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum retry interval.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setMinLargeMessageSize(int)">setMinLargeMessageSize</a></span>​(int minLargeMessageSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the large message size threshold.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setOutgoingInterceptorList(java.lang.String)">setOutgoingInterceptorList</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> interceptorList)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setPasswordCodec(java.lang.String)">setPasswordCodec</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> passwordCodec)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setPreAcknowledge(boolean)">setPreAcknowledge</a></span>​(boolean preAcknowledge)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets to <code>true</code> to pre-acknowledge consumed messages on the |
| server before they are sent to consumers, else set to <code>false</code> |
| to let clients acknowledge the message they consume.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setProducerMaxRate(int)">setProducerMaxRate</a></span>​(int producerMaxRate)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum rate of message production for producers created through this factory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setProducerWindowSize(int)">setProducerWindowSize</a></span>​(int producerWindowSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the window size for flow control of the producers created through this factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setProtocolManagerFactory(org.apache.activemq.artemis.spi.core.remoting.ClientProtocolManagerFactory)">setProtocolManagerFactory</a></span>​(<a href="../../../../spi/core/remoting/ClientProtocolManagerFactory.html" title="interface in org.apache.activemq.artemis.spi.core.remoting">ClientProtocolManagerFactory</a> protocolManager)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setReconnectAttempts(int)">setReconnectAttempts</a></span>​(int reconnectAttempts)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of attempts to retry connection in case of failure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setRetryInterval(long)">setRetryInterval</a></span>​(long retryInterval)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the time to retry connections created by this factory after failure.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setRetryIntervalMultiplier(double)">setRetryIntervalMultiplier</a></span>​(double retryIntervalMultiplier)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the multiplier to apply to successive retry intervals.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setScheduledThreadPoolMaxSize(int)">setScheduledThreadPoolMaxSize</a></span>​(int scheduledThreadPoolMaxSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum size of the scheduled thread pool.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setThreadPoolMaxSize(int)">setThreadPoolMaxSize</a></span>​(int threadPoolMaxSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum size of the thread pool.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setUseGlobalPools(boolean)">setUseGlobalPools</a></span>​(boolean useGlobalPools)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether this factory will use global thread pools (shared among all the factories in the same JVM) |
| or its own pools.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ServerLocator.</span><code><span class="memberNameLink"><a href="../ServerLocator.html#setUseTopologyForLoadBalancing(boolean)">setUseTopologyForLoadBalancing</a></span>​(boolean useTopologyForLoadBalancing)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section><a id="org.apache.activemq.artemis.api.core.management"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a> with parameters of type <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ManagementHelper.</span><code><span class="memberNameLink"><a href="../../management/ManagementHelper.html#doManagement(org.apache.activemq.artemis.api.core.client.ServerLocator,java.lang.String,java.lang.String,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)">doManagement</a></span>​(<a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> locator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> password, |
| <a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Constructors in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a> with parameters of type <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../management/ActiveMQManagementProxy.html#%3Cinit%3E(org.apache.activemq.artemis.api.core.client.ServerLocator,java.lang.String,java.lang.String)">ActiveMQManagementProxy</a></span>​(<a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> locator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> username, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> password)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section><a id="org.apache.activemq.artemis.spi.core.remoting"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> in <a href="../../../../spi/core/remoting/package-summary.html">org.apache.activemq.artemis.spi.core.remoting</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../../../spi/core/remoting/package-summary.html">org.apache.activemq.artemis.spi.core.remoting</a> that return <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientProtocolManagerFactory.</span><code><span class="memberNameLink"><a href="../../../../spi/core/remoting/ClientProtocolManagerFactory.html#getLocator()">getLocator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../../../spi/core/remoting/package-summary.html">org.apache.activemq.artemis.spi.core.remoting</a> with parameters of type <a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../spi/core/remoting/ClientProtocolManagerFactory.html" title="interface in org.apache.activemq.artemis.spi.core.remoting">ClientProtocolManagerFactory</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientProtocolManagerFactory.</span><code><span class="memberNameLink"><a href="../../../../spi/core/remoting/ClientProtocolManagerFactory.html#setLocator(org.apache.activemq.artemis.api.core.client.ServerLocator)">setLocator</a></span>​(<a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> locator)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../../index.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |