| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ServerLocator (ActiveMQ Artemis Website 2.32.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="ServerLocator (ActiveMQ Artemis Website 2.32.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":38,"i10":50,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":38,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":38,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServerLocator.html">Use</a></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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.activemq.artemis.api.core.client</a></div> |
| <h2 title="Interface ServerLocator" class="title">Interface ServerLocator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ServerLocator</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></pre> |
| <div class="block">The serverLocator locates a server, but beyond that it locates a server based on a list. |
| <p> |
| If you are using straight TCP on the configuration, and if you configure your serverLocator to be |
| HA, the locator will always get an updated list of members to the server, the server will send |
| the updated list to the client. |
| <p> |
| If you use UDP or JGroups (exclusively JGroups or UDP), the initial discovery is done by the |
| grouping finder, after the initial connection is made the server will always send updates to the |
| client. But the listeners will listen for updates on grouping.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></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> |
| <tr id="i0" 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"><code><span class="memberNameLink"><a href="#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 id="i1" 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"><code><span class="memberNameLink"><a href="#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 id="i2" 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"><code><span class="memberNameLink"><a href="#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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allInVM()">allInVM</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Verify if all of the transports are using inVM.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Closes this factory and release all its resources</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionFactory()">createSessionFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a ClientSessionFactory using whatever load balancing policy is in force</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionFactory(java.lang.String)">createSessionFactory</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> nodeID)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration)">createSessionFactory</a></span>​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration,int)">createSessionFactory</a></span>​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration, |
| int reconnectAttempts)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration,int,boolean)">createSessionFactory</a></span>​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration, |
| int reconnectAttempts, |
| boolean failoverOnInitialConnection)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">This method is no longer acceptable to create a client session factory.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disableFinalizeCheck()">disableFinalizeCheck</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAckBatchSize()">getAckBatchSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the acknowledgments batch size.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCallFailoverTimeout()">getCallFailoverTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the blocking calls failover timeout when the client is awaiting failover, |
| this is over and above the normal call timeout.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCallTimeout()">getCallTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the blocking calls timeout.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientFailureCheckPeriod()">getClientFailureCheckPeriod</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the period used to check if a client has failed to receive pings from the server.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompressionLevel()">getCompressionLevel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">What compression level is in use</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfirmationWindowSize()">getConfirmationWindowSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the size for the confirmation window of clients using this factory.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionLoadBalancingPolicyClassName()">getConnectionLoadBalancingPolicyClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the class name of the connection load balancing policy.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionTTL()">getConnectionTTL</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the connection <em>time-to-live</em>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsumerMaxRate()">getConsumerMaxRate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum rate of message consumption for consumers created through this factory.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsumerWindowSize()">getConsumerWindowSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the window size for flow control of the consumers created through this factory.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../DiscoveryGroupConfiguration.html" title="class in org.apache.activemq.artemis.api.core">DiscoveryGroupConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDiscoveryGroupConfiguration()">getDiscoveryGroupConfiguration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The discovery group configuration</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFailoverAttempts()">getFailoverAttempts</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlowControlThreadPoolMaxSize()">getFlowControlThreadPoolMaxSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum size of the flow-control thread pool.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupID()">getGroupID</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the group ID that will be eventually set on each message for the property <a href="../Message.html#HDR_GROUP_ID"><code>Message.HDR_GROUP_ID</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncomingInterceptorList()">getIncomingInterceptorList</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialConnectAttempts()">getInitialConnectAttempts</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialMessagePacketSize()">getInitialMessagePacketSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the initial size of messages created through this factory.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../config/ServerLocatorConfig.html" title="class in org.apache.activemq.artemis.api.config">ServerLocatorConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocatorConfig()">getLocatorConfig</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxRetryInterval()">getMaxRetryInterval</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum retry interval (in the case a retry interval multiplier has been specified).</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinLargeMessageSize()">getMinLargeMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the large message size threshold.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutgoingInterceptorList()">getOutgoingInterceptorList</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPasswordCodec()">getPasswordCodec</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProducerMaxRate()">getProducerMaxRate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum rate of message production for producers created through this factory.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProducerWindowSize()">getProducerWindowSize</a></span>()</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 id="i35" class="rowColor"> |
| <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"><code><span class="memberNameLink"><a href="#getProtocolManagerFactory()">getProtocolManagerFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReconnectAttempts()">getReconnectAttempts</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum number of attempts to retry connection in case of failure.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetryInterval()">getRetryInterval</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the time to retry connections created by this factory after failure.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetryIntervalMultiplier()">getRetryIntervalMultiplier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the multiplier to apply to successive retry intervals.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduledThreadPoolMaxSize()">getScheduledThreadPoolMaxSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum size of the scheduled thread pool.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStaticTransportConfigurations()">getStaticTransportConfigurations</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of TransportConfigurations representing the static list of servers used |
| when creating this object</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThreadPoolMaxSize()">getThreadPoolMaxSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum size of the thread pool.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>org.apache.activemq.artemis.core.client.impl.Topology</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopology()">getTopology</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Exposes the Topology used by this ServerLocator.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUseTopologyForLoadBalancing()">getUseTopologyForLoadBalancing</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This will only instantiate internal objects such as the topology</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAutoGroup()">isAutoGroup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether producers created through this factory will automatically |
| assign a group ID to the messages they sent.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockOnAcknowledge()">isBlockOnAcknowledge</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether consumers created through this factory will block while |
| sending message acknowledgments or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockOnDurableSend()">isBlockOnDurableSend</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockOnNonDurableSend()">isBlockOnNonDurableSend</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCacheLargeMessagesClient()">isCacheLargeMessagesClient</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">When <code>true</code>, consumers created through this factory will create temporary files to |
| cache large messages.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClosed()">isClosed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if close was already called</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCompressLargeMessage()">isCompressLargeMessage</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether to compress large messages.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFailoverOnInitialConnection()">isFailoverOnInitialConnection</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHA()">isHA</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether this server receives topology notifications from the cluster as servers join or leave |
| the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPreAcknowledge()">isPreAcknowledge</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUseGlobalPools()">isUseGlobalPools</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns 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 id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeClusterTopologyListener(org.apache.activemq.artemis.api.core.client.ClusterTopologyListener)">removeClusterTopologyListener</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 id="i57" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeIncomingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)">removeIncomingInterceptor</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">Removes an incoming interceptor.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeOutgoingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)">removeOutgoingInterceptor</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">Removes an outgoing interceptor.</div> |
| </td> |
| </tr> |
| <tr id="i59" 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"><code><span class="memberNameLink"><a href="#setAckBatchSize(int)">setAckBatchSize</a></span>​(int ackBatchSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the acknowledgments batch size.</div> |
| </td> |
| </tr> |
| <tr id="i60" 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"><code><span class="memberNameLink"><a href="#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 id="i61" 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"><code><span class="memberNameLink"><a href="#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 id="i62" 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"><code><span class="memberNameLink"><a href="#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 id="i63" 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"><code><span class="memberNameLink"><a href="#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 id="i64" 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"><code><span class="memberNameLink"><a href="#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 id="i65" 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"><code><span class="memberNameLink"><a href="#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 id="i66" 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"><code><span class="memberNameLink"><a href="#setCallTimeout(long)">setCallTimeout</a></span>​(long callTimeout)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the blocking call timeout.</div> |
| </td> |
| </tr> |
| <tr id="i67" 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"><code><span class="memberNameLink"><a href="#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 id="i68" 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"><code><span class="memberNameLink"><a href="#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 id="i69" 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"><code><span class="memberNameLink"><a href="#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 id="i70" 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"><code><span class="memberNameLink"><a href="#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 id="i71" 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"><code><span class="memberNameLink"><a href="#setConnectionLoadBalancingPolicyClassName(java.lang.String)">setConnectionLoadBalancingPolicyClassName</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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 id="i72" 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"><code><span class="memberNameLink"><a href="#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 id="i73" 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"><code><span class="memberNameLink"><a href="#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 id="i74" 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"><code><span class="memberNameLink"><a href="#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 id="i75" 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"><code><span class="memberNameLink"><a href="#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 primary servers after a connection failure.</div> |
| </td> |
| </tr> |
| <tr id="i76" 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"><code><span class="memberNameLink"><a href="#setFailoverOnInitialConnection(boolean)">setFailoverOnInitialConnection</a></span>​(boolean failover)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i77" 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"><code><span class="memberNameLink"><a href="#setFlowControlThreadPoolMaxSize(int)">setFlowControlThreadPoolMaxSize</a></span>​(int flowControlThreadPoolMaxSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum size of the flow-control thread pool.</div> |
| </td> |
| </tr> |
| <tr id="i78" 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"><code><span class="memberNameLink"><a href="#setGroupID(java.lang.String)">setGroupID</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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 id="i79" 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"><code><span class="memberNameLink"><a href="#setIncomingInterceptorList(java.lang.String)">setIncomingInterceptorList</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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 id="i80" 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"><code><span class="memberNameLink"><a href="#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 id="i81" 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"><code><span class="memberNameLink"><a href="#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 id="i82" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLocatorConfig(org.apache.activemq.artemis.api.config.ServerLocatorConfig)">setLocatorConfig</a></span>​(<a href="../../config/ServerLocatorConfig.html" title="class in org.apache.activemq.artemis.api.config">ServerLocatorConfig</a> serverLocatorConfig)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i83" 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"><code><span class="memberNameLink"><a href="#setMaxRetryInterval(long)">setMaxRetryInterval</a></span>​(long maxRetryInterval)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum retry interval.</div> |
| </td> |
| </tr> |
| <tr id="i84" 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"><code><span class="memberNameLink"><a href="#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 id="i85" 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"><code><span class="memberNameLink"><a href="#setOutgoingInterceptorList(java.lang.String)">setOutgoingInterceptorList</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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 id="i86" 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"><code><span class="memberNameLink"><a href="#setPasswordCodec(java.lang.String)">setPasswordCodec</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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 id="i87" 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"><code><span class="memberNameLink"><a href="#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 id="i88" 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"><code><span class="memberNameLink"><a href="#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 id="i89" 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"><code><span class="memberNameLink"><a href="#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 id="i90" 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"><code><span class="memberNameLink"><a href="#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 id="i91" 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"><code><span class="memberNameLink"><a href="#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 id="i92" 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"><code><span class="memberNameLink"><a href="#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 id="i93" 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"><code><span class="memberNameLink"><a href="#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 id="i94" 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"><code><span class="memberNameLink"><a href="#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 id="i95" 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"><code><span class="memberNameLink"><a href="#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 id="i96" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setThreadPools(java.util.concurrent.Executor,java.util.concurrent.ScheduledExecutorService,java.util.concurrent.Executor)">setThreadPools</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a> threadPool, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a> scheduledThreadPoolExecutor, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a> flowControlThreadPool)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i97" 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"><code><span class="memberNameLink"><a href="#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 id="i98" 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"><code><span class="memberNameLink"><a href="#setUseTopologyForLoadBalancing(boolean)">setUseTopologyForLoadBalancing</a></span>​(boolean useTopologyForLoadBalancing)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="isClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosed</h4> |
| <pre class="methodSignature">boolean isClosed()</pre> |
| <div class="block">Returns true if close was already called</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if closed, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disableFinalizeCheck()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableFinalizeCheck</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| default void disableFinalizeCheck()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Just kept for compatibility.</div> |
| </li> |
| </ul> |
| <a id="createSessionFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionFactory</h4> |
| <pre class="methodSignature"><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a> createSessionFactory() |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a ClientSessionFactory using whatever load balancing policy is in force</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The ClientSessionFactory</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSessionFactory(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionFactory</h4> |
| <pre class="methodSignature"><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a> createSessionFactory​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> nodeID) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server. The server must already be known |
| about by this ServerLocator. This method allows the user to make a connection to a specific |
| server bypassing any load balancing policy in force</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeID</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a ClientSessionFactory instance or <code>null</code> if the node is not present on the |
| topology</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if a failure happened in creating the ClientSessionFactory or the |
| ServerLocator does not know about the passed in transportConfiguration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionFactory</h4> |
| <pre class="methodSignature"><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a> createSessionFactory​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server. The server must already be known |
| about by this ServerLocator. This method allows the user to make a connection to a specific |
| server bypassing any load balancing policy in force</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transportConfiguration</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if a failure happened in creating the ClientSessionFactory or the |
| ServerLocator does not know about the passed in transportConfiguration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionFactory</h4> |
| <pre class="methodSignature"><a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a> createSessionFactory​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration, |
| int reconnectAttempts) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server. The server must already be known |
| about by this ServerLocator. This method allows the user to make a connection to a specific |
| server bypassing any load balancing policy in force</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transportConfiguration</code> - </dd> |
| <dd><code>reconnectAttempts</code> - number of attempts of reconnection to perform</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if a failure happened in creating the ClientSessionFactory or the |
| ServerLocator does not know about the passed in transportConfiguration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration,int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionFactory</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSessionFactory</a> createSessionFactory​(<a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a> transportConfiguration, |
| int reconnectAttempts, |
| boolean failoverOnInitialConnection) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">This method is no longer acceptable to create a client session factory. |
| Replaced by <a href="#createSessionFactory(org.apache.activemq.artemis.api.core.TransportConfiguration,int)"><code>createSessionFactory(TransportConfiguration, int)</code></a>.</div> |
| </div> |
| <div class="block">Creates a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> to a specific server. The server must already be known |
| about by this ServerLocator. This method allows the user to make a connection to a specific |
| server bypassing any load balancing policy in force</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transportConfiguration</code> - </dd> |
| <dd><code>reconnectAttempts</code> - number of attempts of reconnection to perform</dd> |
| <dd><code>failoverOnInitialConnection</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="ClientSessionFactory.html" title="interface in org.apache.activemq.artemis.api.core.client"><code>ClientSessionFactory</code></a> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if a failure happened in creating the ClientSessionFactory or the |
| ServerLocator does not know about the passed in transportConfiguration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClientFailureCheckPeriod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientFailureCheckPeriod</h4> |
| <pre class="methodSignature">long getClientFailureCheckPeriod()</pre> |
| <div class="block">Returns the period used to check if a client has failed to receive pings from the server. |
| <p> |
| Period is in milliseconds, default value is |
| <a href="ActiveMQClient.html#DEFAULT_CLIENT_FAILURE_CHECK_PERIOD"><code>ActiveMQClient.DEFAULT_CLIENT_FAILURE_CHECK_PERIOD</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the period used to check if a client has failed to receive pings from the server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setClientFailureCheckPeriod(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClientFailureCheckPeriod</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setClientFailureCheckPeriod​(long clientFailureCheckPeriod)</pre> |
| <div class="block">Sets the period (in milliseconds) used to check if a client has failed to receive pings from |
| the server. |
| <p> |
| Value must be -1 (to disable) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clientFailureCheckPeriod</code> - the period to check failure</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCacheLargeMessagesClient()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCacheLargeMessagesClient</h4> |
| <pre class="methodSignature">boolean isCacheLargeMessagesClient()</pre> |
| <div class="block">When <code>true</code>, consumers created through this factory will create temporary files to |
| cache large messages. |
| <p> |
| There is 1 temporary file created for each large message. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_CACHE_LARGE_MESSAGE_CLIENT"><code>ActiveMQClient.DEFAULT_CACHE_LARGE_MESSAGE_CLIENT</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if consumers created through this factory will cache large messages |
| in temporary files, <code>false</code> else</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCacheLargeMessagesClient(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheLargeMessagesClient</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setCacheLargeMessagesClient​(boolean cached)</pre> |
| <div class="block">Sets whether large messages received by consumers created through this factory will be cached in temporary files or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cached</code> - <code>true</code> to cache large messages in temporary files, <code>false</code> else</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConnectionTTL()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionTTL</h4> |
| <pre class="methodSignature">long getConnectionTTL()</pre> |
| <div class="block">Returns the connection <em>time-to-live</em>. |
| <p> |
| This TTL determines how long the server will keep a connection alive in the absence of any |
| data arriving from the client. Value is in milliseconds, default value is |
| <a href="ActiveMQClient.html#DEFAULT_CONNECTION_TTL"><code>ActiveMQClient.DEFAULT_CONNECTION_TTL</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the connection time-to-live in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConnectionTTL(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionTTL</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setConnectionTTL​(long connectionTTL)</pre> |
| <div class="block">Sets this factory's connections <em>time-to-live</em>. |
| <p> |
| Value must be -1 (to disable) or greater or equals to 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionTTL</code> - period in milliseconds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCallTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallTimeout</h4> |
| <pre class="methodSignature">long getCallTimeout()</pre> |
| <div class="block">Returns the blocking calls timeout. |
| <p> |
| If client's blocking calls to the server take more than this timeout, the call will throw a |
| <a href="../ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core"><code>ActiveMQException</code></a> with the code <a href="../ActiveMQExceptionType.html#CONNECTION_TIMEDOUT"><code>ActiveMQExceptionType.CONNECTION_TIMEDOUT</code></a>. Value |
| is in milliseconds, default value is <a href="ActiveMQClient.html#DEFAULT_CALL_TIMEOUT"><code>ActiveMQClient.DEFAULT_CALL_TIMEOUT</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the blocking calls timeout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCallTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallTimeout</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setCallTimeout​(long callTimeout)</pre> |
| <div class="block">Sets the blocking call timeout. |
| <p> |
| Value must be greater or equals to 0</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callTimeout</code> - blocking call timeout in milliseconds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCallFailoverTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallFailoverTimeout</h4> |
| <pre class="methodSignature">long getCallFailoverTimeout()</pre> |
| <div class="block">Returns the blocking calls failover timeout when the client is awaiting failover, |
| this is over and above the normal call timeout. |
| <p> |
| If client is in the process of failing over when a blocking call is called then the client will wait this long before |
| actually trying the send.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the blocking calls failover timeout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCallFailoverTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallFailoverTimeout</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setCallFailoverTimeout​(long callFailoverTimeout)</pre> |
| <div class="block">Sets the blocking call failover timeout. |
| <p> |
| When the client is awaiting failover, this is over and above the normal call timeout. |
| <p> |
| Value must be greater or equals to -1, -1 means forever</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callFailoverTimeout</code> - blocking call timeout in milliseconds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMinLargeMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinLargeMessageSize</h4> |
| <pre class="methodSignature">int getMinLargeMessageSize()</pre> |
| <div class="block">Returns the large message size threshold. |
| <p> |
| Messages whose size is if greater than this value will be handled as <em>large messages</em>. |
| Value is in bytes, default value is <a href="ActiveMQClient.html#DEFAULT_MIN_LARGE_MESSAGE_SIZE"><code>ActiveMQClient.DEFAULT_MIN_LARGE_MESSAGE_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message size threshold to treat messages as large messages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMinLargeMessageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinLargeMessageSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setMinLargeMessageSize​(int minLargeMessageSize)</pre> |
| <div class="block">Sets the large message size threshold. |
| <p> |
| Value must be greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minLargeMessageSize</code> - large message size threshold in bytes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConsumerWindowSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConsumerWindowSize</h4> |
| <pre class="methodSignature">int getConsumerWindowSize()</pre> |
| <div class="block">Returns the window size for flow control of the consumers created through this factory. |
| <p> |
| Value is in bytes, default value is <a href="ActiveMQClient.html#DEFAULT_CONSUMER_WINDOW_SIZE"><code>ActiveMQClient.DEFAULT_CONSUMER_WINDOW_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the window size used for consumer flow control</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConsumerWindowSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConsumerWindowSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setConsumerWindowSize​(int consumerWindowSize)</pre> |
| <div class="block">Sets the window size for flow control of the consumers created through this factory. |
| <p> |
| Value must be -1 (to disable flow control), 0 (to not buffer any messages) or greater than 0 |
| (to set the maximum size of the buffer)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumerWindowSize</code> - window size (in bytes) used for consumer flow control</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConsumerMaxRate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConsumerMaxRate</h4> |
| <pre class="methodSignature">int getConsumerMaxRate()</pre> |
| <div class="block">Returns the maximum rate of message consumption for consumers created through this factory. |
| <p> |
| This value controls the rate at which a consumer can consume messages. A consumer will never consume messages at a rate faster than the rate specified. |
| <p> |
| Value is -1 (to disable) or a positive integer corresponding to the maximum desired message consumption rate specified in units of messages per second. |
| Default value is <a href="ActiveMQClient.html#DEFAULT_CONSUMER_MAX_RATE"><code>ActiveMQClient.DEFAULT_CONSUMER_MAX_RATE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the consumer max rate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConsumerMaxRate(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConsumerMaxRate</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setConsumerMaxRate​(int consumerMaxRate)</pre> |
| <div class="block">Sets the maximum rate of message consumption for consumers created through this factory. |
| <p> |
| Value must -1 (to disable) or a positive integer corresponding to the maximum desired message consumption rate specified in units of messages per second.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumerMaxRate</code> - maximum rate of message consumption (in messages per seconds)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConfirmationWindowSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfirmationWindowSize</h4> |
| <pre class="methodSignature">int getConfirmationWindowSize()</pre> |
| <div class="block">Returns the size for the confirmation window of clients using this factory. |
| <p> |
| Value is in bytes or -1 (to disable the window). Default value is |
| <a href="ActiveMQClient.html#DEFAULT_CONFIRMATION_WINDOW_SIZE"><code>ActiveMQClient.DEFAULT_CONFIRMATION_WINDOW_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the size for the confirmation window of clients using this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConfirmationWindowSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfirmationWindowSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setConfirmationWindowSize​(int confirmationWindowSize)</pre> |
| <div class="block">Sets the size for the confirmation window buffer of clients using this factory. |
| <p> |
| Value must be -1 (to disable the window) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>confirmationWindowSize</code> - size of the confirmation window (in bytes)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProducerWindowSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProducerWindowSize</h4> |
| <pre class="methodSignature">int getProducerWindowSize()</pre> |
| <div class="block">Returns the window size for flow control of the producers created through this factory. |
| <p> |
| Value must be -1 (to disable flow control) or greater than 0 to determine the maximum amount of bytes at any give time (to prevent overloading the connection). |
| Default value is <a href="ActiveMQClient.html#DEFAULT_PRODUCER_WINDOW_SIZE"><code>ActiveMQClient.DEFAULT_PRODUCER_WINDOW_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the window size for flow control of the producers created through this factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProducerWindowSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProducerWindowSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setProducerWindowSize​(int producerWindowSize)</pre> |
| <div class="block">Returns the window size for flow control of the producers created through this factory. |
| <p> |
| Value must be -1 (to disable flow control) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>producerWindowSize</code> - window size (in bytest) for flow control of the producers created through this factory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProducerMaxRate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProducerMaxRate</h4> |
| <pre class="methodSignature">int getProducerMaxRate()</pre> |
| <div class="block">Returns the maximum rate of message production for producers created through this factory. |
| <p> |
| This value controls the rate at which a producer can produce messages. A producer will never produce messages at a rate faster than the rate specified. |
| <p> |
| Value is -1 (to disable) or a positive integer corresponding to the maximum desired message production rate specified in units of messages per second. |
| Default value is <a href="ActiveMQClient.html#DEFAULT_PRODUCER_MAX_RATE"><code>ActiveMQClient.DEFAULT_PRODUCER_MAX_RATE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum rate of message production (in messages per seconds)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProducerMaxRate(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProducerMaxRate</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setProducerMaxRate​(int producerMaxRate)</pre> |
| <div class="block">Sets the maximum rate of message production for producers created through this factory. |
| <p> |
| Value must -1 (to disable) or a positive integer corresponding to the maximum desired message production rate specified in units of messages per second.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>producerMaxRate</code> - maximum rate of message production (in messages per seconds)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isBlockOnAcknowledge()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBlockOnAcknowledge</h4> |
| <pre class="methodSignature">boolean isBlockOnAcknowledge()</pre> |
| <div class="block">Returns whether consumers created through this factory will block while |
| sending message acknowledgments or do it asynchronously. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_BLOCK_ON_ACKNOWLEDGE"><code>ActiveMQClient.DEFAULT_BLOCK_ON_ACKNOWLEDGE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether consumers will block while sending message |
| acknowledgments or do it asynchronously</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBlockOnAcknowledge(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBlockOnAcknowledge</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setBlockOnAcknowledge​(boolean blockOnAcknowledge)</pre> |
| <div class="block">Sets whether consumers created through this factory will block while |
| sending message acknowledgments or do it asynchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>blockOnAcknowledge</code> - <code>true</code> to block when sending message |
| acknowledgments or <code>false</code> to send them |
| asynchronously</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isBlockOnDurableSend()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBlockOnDurableSend</h4> |
| <pre class="methodSignature">boolean isBlockOnDurableSend()</pre> |
| <div class="block">Returns whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously. |
| <br> |
| If the session is configured to send durable message asynchronously, the client can set a SendAcknowledgementHandler on the ClientSession |
| to be notified once the message has been handled by the server. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_BLOCK_ON_DURABLE_SEND"><code>ActiveMQClient.DEFAULT_BLOCK_ON_DURABLE_SEND</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether producers will block while sending persistent messages or do it asynchronously</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBlockOnDurableSend(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBlockOnDurableSend</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setBlockOnDurableSend​(boolean blockOnDurableSend)</pre> |
| <div class="block">Sets whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>blockOnDurableSend</code> - <code>true</code> to block when sending durable messages or <code>false</code> to send them asynchronously</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isBlockOnNonDurableSend()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBlockOnNonDurableSend</h4> |
| <pre class="methodSignature">boolean isBlockOnNonDurableSend()</pre> |
| <div class="block">Returns whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously. |
| <br> |
| If the session is configured to send non-durable message asynchronously, the client can set a SendAcknowledgementHandler on the ClientSession |
| to be notified once the message has been handled by the server. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_BLOCK_ON_NON_DURABLE_SEND"><code>ActiveMQClient.DEFAULT_BLOCK_ON_NON_DURABLE_SEND</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether producers will block while sending non-durable messages or do it asynchronously</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBlockOnNonDurableSend(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBlockOnNonDurableSend</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setBlockOnNonDurableSend​(boolean blockOnNonDurableSend)</pre> |
| <div class="block">Sets whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>blockOnNonDurableSend</code> - <code>true</code> to block when sending non-durable messages or <code>false</code> to send them asynchronously</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAutoGroup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAutoGroup</h4> |
| <pre class="methodSignature">boolean isAutoGroup()</pre> |
| <div class="block">Returns whether producers created through this factory will automatically |
| assign a group ID to the messages they sent. |
| <p> |
| if <code>true</code>, a random unique group ID is created and set on each message for the property |
| <a href="../Message.html#HDR_GROUP_ID"><code>Message.HDR_GROUP_ID</code></a>. |
| Default value is <a href="ActiveMQClient.html#DEFAULT_AUTO_GROUP"><code>ActiveMQClient.DEFAULT_AUTO_GROUP</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether producers will automatically assign a group ID to their messages</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAutoGroup(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAutoGroup</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setAutoGroup​(boolean autoGroup)</pre> |
| <div class="block">Sets whether producers created through this factory will automatically |
| assign a group ID to the messages they sent.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>autoGroup</code> - <code>true</code> to automatically assign a group ID to each messages sent through this factory, <code>false</code> else</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGroupID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupID</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getGroupID()</pre> |
| <div class="block">Returns the group ID that will be eventually set on each message for the property <a href="../Message.html#HDR_GROUP_ID"><code>Message.HDR_GROUP_ID</code></a>. |
| <p> |
| Default value is is <code>null</code> and no group ID will be set on the messages.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the group ID that will be eventually set on each message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setGroupID(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGroupID</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setGroupID​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> groupID)</pre> |
| <div class="block">Sets the group ID that will be set on each message sent through this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupID</code> - the group ID to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isPreAcknowledge()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPreAcknowledge</h4> |
| <pre class="methodSignature">boolean isPreAcknowledge()</pre> |
| <div class="block">Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_PRE_ACKNOWLEDGE"><code>ActiveMQClient.DEFAULT_PRE_ACKNOWLEDGE</code></a></div> |
| </li> |
| </ul> |
| <a id="setPreAcknowledge(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPreAcknowledge</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setPreAcknowledge​(boolean preAcknowledge)</pre> |
| <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> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>preAcknowledge</code> - <code>true</code> to enable pre-acknowledgment, |
| <code>false</code> else</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAckBatchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAckBatchSize</h4> |
| <pre class="methodSignature">int getAckBatchSize()</pre> |
| <div class="block">Returns the acknowledgments batch size. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_ACK_BATCH_SIZE"><code>ActiveMQClient.DEFAULT_ACK_BATCH_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the acknowledgments batch size</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAckBatchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAckBatchSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setAckBatchSize​(int ackBatchSize)</pre> |
| <div class="block">Sets the acknowledgments batch size. |
| <p> |
| Value must be equal or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ackBatchSize</code> - acknowledgments batch size</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStaticTransportConfigurations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStaticTransportConfigurations</h4> |
| <pre class="methodSignature"><a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core">TransportConfiguration</a>[] getStaticTransportConfigurations()</pre> |
| <div class="block">Returns an array of TransportConfigurations representing the static list of servers used |
| when creating this object</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>array with all static <a href="../TransportConfiguration.html" title="class in org.apache.activemq.artemis.api.core"><code>TransportConfiguration</code></a>s</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDiscoveryGroupConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiscoveryGroupConfiguration</h4> |
| <pre class="methodSignature"><a href="../DiscoveryGroupConfiguration.html" title="class in org.apache.activemq.artemis.api.core">DiscoveryGroupConfiguration</a> getDiscoveryGroupConfiguration()</pre> |
| <div class="block">The discovery group configuration</div> |
| </li> |
| </ul> |
| <a id="isUseGlobalPools()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUseGlobalPools</h4> |
| <pre class="methodSignature">boolean isUseGlobalPools()</pre> |
| <div class="block">Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) |
| or its own pools. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_USE_GLOBAL_POOLS"><code>ActiveMQClient.DEFAULT_USE_GLOBAL_POOLS</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this factory uses global thread pools, <code>false</code> else</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUseGlobalPools(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseGlobalPools</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setUseGlobalPools​(boolean useGlobalPools)</pre> |
| <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> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>useGlobalPools</code> - <code>true</code> to let this factory uses global thread pools, <code>false</code> else</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getScheduledThreadPoolMaxSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledThreadPoolMaxSize</h4> |
| <pre class="methodSignature">int getScheduledThreadPoolMaxSize()</pre> |
| <div class="block">Returns the maximum size of the scheduled thread pool. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE"><code>ActiveMQClient.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of the scheduled thread pool.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setScheduledThreadPoolMaxSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScheduledThreadPoolMaxSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setScheduledThreadPoolMaxSize​(int scheduledThreadPoolMaxSize)</pre> |
| <div class="block">Sets the maximum size of the scheduled thread pool. |
| <p> |
| This setting is relevant only if this factory does not use global pools. |
| Value must be greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scheduledThreadPoolMaxSize</code> - maximum size of the scheduled thread pool.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThreadPoolMaxSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThreadPoolMaxSize</h4> |
| <pre class="methodSignature">int getThreadPoolMaxSize()</pre> |
| <div class="block">Returns the maximum size of the thread pool. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_THREAD_POOL_MAX_SIZE"><code>ActiveMQClient.DEFAULT_THREAD_POOL_MAX_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of the thread pool.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setThreadPoolMaxSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setThreadPoolMaxSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setThreadPoolMaxSize​(int threadPoolMaxSize)</pre> |
| <div class="block">Sets the maximum size of the thread pool. |
| <p> |
| This setting is relevant only if this factory does not use global pools. |
| Value must be -1 (for unlimited thread pool) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>threadPoolMaxSize</code> - maximum size of the thread pool.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFlowControlThreadPoolMaxSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlowControlThreadPoolMaxSize</h4> |
| <pre class="methodSignature">int getFlowControlThreadPoolMaxSize()</pre> |
| <div class="block">Returns the maximum size of the flow-control thread pool. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_FLOW_CONTROL_THREAD_POOL_MAX_SIZE"><code>ActiveMQClient.DEFAULT_FLOW_CONTROL_THREAD_POOL_MAX_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size of the flow-control thread pool.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFlowControlThreadPoolMaxSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFlowControlThreadPoolMaxSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setFlowControlThreadPoolMaxSize​(int flowControlThreadPoolMaxSize)</pre> |
| <div class="block">Sets the maximum size of the flow-control thread pool. |
| <p> |
| This setting is relevant only if this factory does not use global pools. |
| Value must be -1 (for unlimited thread pool) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flowControlThreadPoolMaxSize</code> - maximum size of the flow-control thread pool.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRetryInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetryInterval</h4> |
| <pre class="methodSignature">long getRetryInterval()</pre> |
| <div class="block">Returns the time to retry connections created by this factory after failure. |
| <p> |
| Value is in milliseconds, default is <a href="ActiveMQClient.html#DEFAULT_RETRY_INTERVAL"><code>ActiveMQClient.DEFAULT_RETRY_INTERVAL</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time to retry connections created by this factory after failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRetryInterval(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRetryInterval</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setRetryInterval​(long retryInterval)</pre> |
| <div class="block">Sets the time to retry connections created by this factory after failure. |
| <p> |
| Value must be greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>retryInterval</code> - time (in milliseconds) to retry connections created by this factory after failure</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRetryIntervalMultiplier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetryIntervalMultiplier</h4> |
| <pre class="methodSignature">double getRetryIntervalMultiplier()</pre> |
| <div class="block">Returns the multiplier to apply to successive retry intervals. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_RETRY_INTERVAL_MULTIPLIER"><code>ActiveMQClient.DEFAULT_RETRY_INTERVAL_MULTIPLIER</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the multiplier to apply to successive retry intervals</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRetryIntervalMultiplier(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRetryIntervalMultiplier</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setRetryIntervalMultiplier​(double retryIntervalMultiplier)</pre> |
| <div class="block">Sets the multiplier to apply to successive retry intervals. |
| <p> |
| Value must be positive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>retryIntervalMultiplier</code> - multiplier to apply to successive retry intervals</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxRetryInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxRetryInterval</h4> |
| <pre class="methodSignature">long getMaxRetryInterval()</pre> |
| <div class="block">Returns the maximum retry interval (in the case a retry interval multiplier has been specified). |
| <p> |
| Value is in milliseconds, default value is <a href="ActiveMQClient.html#DEFAULT_MAX_RETRY_INTERVAL"><code>ActiveMQClient.DEFAULT_MAX_RETRY_INTERVAL</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum retry interval</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxRetryInterval(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxRetryInterval</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setMaxRetryInterval​(long maxRetryInterval)</pre> |
| <div class="block">Sets the maximum retry interval. |
| <p> |
| Value must be greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxRetryInterval</code> - maximum retry interval to apply in the case a retry interval multiplier |
| has been specified</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getReconnectAttempts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReconnectAttempts</h4> |
| <pre class="methodSignature">int getReconnectAttempts()</pre> |
| <div class="block">Returns the maximum number of attempts to retry connection in case of failure. |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_RECONNECT_ATTEMPTS"><code>ActiveMQClient.DEFAULT_RECONNECT_ATTEMPTS</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of attempts to retry connection in case of failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setReconnectAttempts(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReconnectAttempts</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setReconnectAttempts​(int reconnectAttempts)</pre> |
| <div class="block">Sets the maximum number of attempts to retry connection in case of failure. |
| <p> |
| Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reconnectAttempts</code> - maximum number of attempts to retry connection in case of failure</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setInitialConnectAttempts(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialConnectAttempts</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setInitialConnectAttempts​(int reconnectAttempts)</pre> |
| <div class="block">Sets the maximum number of attempts to establish an initial connection. |
| <p> |
| Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reconnectAttempts</code> - maximum number of attempts for the initial connection</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInitialConnectAttempts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialConnectAttempts</h4> |
| <pre class="methodSignature">int getInitialConnectAttempts()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of attempts to be made for first initial connection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFailoverAttempts(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFailoverAttempts</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setFailoverAttempts​(int attempts)</pre> |
| <div class="block">Sets the maximum number of failover attempts to establish a connection to other primary servers after a connection failure. |
| <p> |
| Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attempts</code> - maximum number of failover attempts after a connection failure</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFailoverAttempts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFailoverAttempts</h4> |
| <pre class="methodSignature">int getFailoverAttempts()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of failover attempts after a connection failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFailoverOnInitialConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFailoverOnInitialConnection</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| boolean isFailoverOnInitialConnection()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns true if the client will automatically attempt to connect to the backup server if the initial |
| connection to the primary server fails |
| <p> |
| Default value is <a href="ActiveMQClient.html#DEFAULT_FAILOVER_ON_INITIAL_CONNECTION"><code>ActiveMQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION</code></a>.</div> |
| </li> |
| </ul> |
| <a id="setFailoverOnInitialConnection(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFailoverOnInitialConnection</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| <a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setFailoverOnInitialConnection​(boolean failover)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets the value for FailoverOnInitialReconnection</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>failover</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConnectionLoadBalancingPolicyClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnectionLoadBalancingPolicyClassName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getConnectionLoadBalancingPolicyClassName()</pre> |
| <div class="block">Returns the class name of the connection load balancing policy. |
| <p> |
| Default value is "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the class name of the connection load balancing policy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConnectionLoadBalancingPolicyClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConnectionLoadBalancingPolicyClassName</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setConnectionLoadBalancingPolicyClassName​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> loadBalancingPolicyClassName)</pre> |
| <div class="block">Sets the class name of the connection load balancing policy. |
| <p> |
| Value must be the name of a class implementing <a href="loadbalance/ConnectionLoadBalancingPolicy.html" title="interface in org.apache.activemq.artemis.api.core.client.loadbalance"><code>ConnectionLoadBalancingPolicy</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loadBalancingPolicyClassName</code> - class name of the connection load balancing policy</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInitialMessagePacketSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialMessagePacketSize</h4> |
| <pre class="methodSignature">int getInitialMessagePacketSize()</pre> |
| <div class="block">Returns the initial size of messages created through this factory. |
| <p> |
| Value is in bytes, default value is <a href="ActiveMQClient.html#DEFAULT_INITIAL_MESSAGE_PACKET_SIZE"><code>ActiveMQClient.DEFAULT_INITIAL_MESSAGE_PACKET_SIZE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the initial size of messages created through this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setInitialMessagePacketSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialMessagePacketSize</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setInitialMessagePacketSize​(int size)</pre> |
| <div class="block">Sets the initial size of messages created through this factory. |
| <p> |
| Value must be greater than 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - initial size of messages created through this factory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIncomingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncomingInterceptor</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> addIncomingInterceptor​(<a href="../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</pre> |
| <div class="block">Adds an interceptor which will be executed <em>after packets are received from the server</em>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interceptor</code> - an Interceptor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addOutgoingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOutgoingInterceptor</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> addOutgoingInterceptor​(<a href="../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</pre> |
| <div class="block">Adds an interceptor which will be executed <em>before packets are sent to the server</em>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interceptor</code> - an Interceptor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeIncomingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeIncomingInterceptor</h4> |
| <pre class="methodSignature">boolean removeIncomingInterceptor​(<a href="../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</pre> |
| <div class="block">Removes an incoming interceptor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interceptor</code> - interceptor to remove</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the incoming interceptor is removed from this factory, <code>false</code> else</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeOutgoingInterceptor(org.apache.activemq.artemis.api.core.Interceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeOutgoingInterceptor</h4> |
| <pre class="methodSignature">boolean removeOutgoingInterceptor​(<a href="../Interceptor.html" title="interface in org.apache.activemq.artemis.api.core">Interceptor</a> interceptor)</pre> |
| <div class="block">Removes an outgoing interceptor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interceptor</code> - interceptor to remove</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the outgoing interceptor is removed from this factory, <code>false</code> else</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">Closes this factory and release all its resources</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUseTopologyForLoadBalancing(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseTopologyForLoadBalancing</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setUseTopologyForLoadBalancing​(boolean useTopologyForLoadBalancing)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>useTopologyForLoadBalancing</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUseTopologyForLoadBalancing()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUseTopologyForLoadBalancing</h4> |
| <pre class="methodSignature">boolean getUseTopologyForLoadBalancing()</pre> |
| </li> |
| </ul> |
| <a id="getTopology()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopology</h4> |
| <pre class="methodSignature">org.apache.activemq.artemis.core.client.impl.Topology getTopology()</pre> |
| <div class="block">Exposes the Topology used by this ServerLocator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>topology</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isHA()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHA</h4> |
| <pre class="methodSignature">boolean isHA()</pre> |
| <div class="block">Whether this server receives topology notifications from the cluster as servers join or leave |
| the cluster.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the locator receives topology updates from the cluster</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allInVM()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allInVM</h4> |
| <pre class="methodSignature">boolean allInVM()</pre> |
| <div class="block">Verify if all of the transports are using inVM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the locator has all inVM transports.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCompressLargeMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCompressLargeMessage</h4> |
| <pre class="methodSignature">boolean isCompressLargeMessage()</pre> |
| <div class="block">Whether to compress large messages.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCompressLargeMessage(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressLargeMessage</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setCompressLargeMessage​(boolean compressLargeMessages)</pre> |
| <div class="block">Sets whether to compress or not large messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressLargeMessages</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCompressionLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompressionLevel</h4> |
| <pre class="methodSignature">int getCompressionLevel()</pre> |
| <div class="block">What compression level is in use</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCompressionLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressionLevel</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setCompressionLevel​(int compressionLevel)</pre> |
| <div class="block">Sets what compressionLevel to use when compressing messages |
| Value must be -1 (default), or 0-9</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressionLevel</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ServerLocator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addClusterTopologyListener(org.apache.activemq.artemis.api.core.client.ClusterTopologyListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addClusterTopologyListener</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> addClusterTopologyListener​(<a href="ClusterTopologyListener.html" title="interface in org.apache.activemq.artemis.api.core.client">ClusterTopologyListener</a> listener)</pre> |
| </li> |
| </ul> |
| <a id="removeClusterTopologyListener(org.apache.activemq.artemis.api.core.client.ClusterTopologyListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeClusterTopologyListener</h4> |
| <pre class="methodSignature">void removeClusterTopologyListener​(<a href="ClusterTopologyListener.html" title="interface in org.apache.activemq.artemis.api.core.client">ClusterTopologyListener</a> listener)</pre> |
| </li> |
| </ul> |
| <a id="getProtocolManagerFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocolManagerFactory</h4> |
| <pre class="methodSignature"><a href="../../../spi/core/remoting/ClientProtocolManagerFactory.html" title="interface in org.apache.activemq.artemis.spi.core.remoting">ClientProtocolManagerFactory</a> getProtocolManagerFactory()</pre> |
| </li> |
| </ul> |
| <a id="setProtocolManagerFactory(org.apache.activemq.artemis.spi.core.remoting.ClientProtocolManagerFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProtocolManagerFactory</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setProtocolManagerFactory​(<a href="../../../spi/core/remoting/ClientProtocolManagerFactory.html" title="interface in org.apache.activemq.artemis.spi.core.remoting">ClientProtocolManagerFactory</a> protocolManager)</pre> |
| </li> |
| </ul> |
| <a id="setIncomingInterceptorList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncomingInterceptorList</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setIncomingInterceptorList​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> interceptorList)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interceptorList</code> - a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncomingInterceptorList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncomingInterceptorList</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getIncomingInterceptorList()</pre> |
| </li> |
| </ul> |
| <a id="setOutgoingInterceptorList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutgoingInterceptorList</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setOutgoingInterceptorList​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> interceptorList)</pre> |
| </li> |
| </ul> |
| <a id="getOutgoingInterceptorList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutgoingInterceptorList</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getOutgoingInterceptorList()</pre> |
| </li> |
| </ul> |
| <a id="setThreadPools(java.util.concurrent.Executor,java.util.concurrent.ScheduledExecutorService,java.util.concurrent.Executor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setThreadPools</h4> |
| <pre class="methodSignature">boolean setThreadPools​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a> threadPool, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a> scheduledThreadPoolExecutor, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a> flowControlThreadPool)</pre> |
| </li> |
| </ul> |
| <a id="initialize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">void initialize() |
| throws <a href="../ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></pre> |
| <div class="block">This will only instantiate internal objects such as the topology</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ActiveMQException.html" title="class in org.apache.activemq.artemis.api.core">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocatorConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocatorConfig</h4> |
| <pre class="methodSignature"><a href="../../config/ServerLocatorConfig.html" title="class in org.apache.activemq.artemis.api.config">ServerLocatorConfig</a> getLocatorConfig()</pre> |
| </li> |
| </ul> |
| <a id="setLocatorConfig(org.apache.activemq.artemis.api.config.ServerLocatorConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocatorConfig</h4> |
| <pre class="methodSignature">void setLocatorConfig​(<a href="../../config/ServerLocatorConfig.html" title="class in org.apache.activemq.artemis.api.config">ServerLocatorConfig</a> serverLocatorConfig)</pre> |
| </li> |
| </ul> |
| <a id="setPasswordCodec(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPasswordCodec</h4> |
| <pre class="methodSignature"><a href="ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> setPasswordCodec​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> passwordCodec)</pre> |
| </li> |
| </ul> |
| <a id="getPasswordCodec()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPasswordCodec</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getPasswordCodec()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServerLocator.html">Use</a></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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |