| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ManagementHelper (ActiveMQ Artemis Website 2.31.1 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="ManagementHelper (ActiveMQ Artemis Website 2.31.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/ManagementHelper.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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.management</a></div> |
| <h2 title="Class ManagementHelper" class="title">Class ManagementHelper</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.activemq.artemis.api.core.management.ManagementHelper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ManagementHelper</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">Helper class to use ActiveMQ Artemis Core messages to manage server resources.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ADDRESS">HDR_ADDRESS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ATTRIBUTE">HDR_ATTRIBUTE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_BINDING_ID">HDR_BINDING_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_BINDING_TYPE">HDR_BINDING_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CERT_SUBJECT_DN">HDR_CERT_SUBJECT_DN</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CHECK_TYPE">HDR_CHECK_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CLIENT_ID">HDR_CLIENT_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CLUSTER_NAME">HDR_CLUSTER_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CONNECTION_NAME">HDR_CONNECTION_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CONSUMER_COUNT">HDR_CONSUMER_COUNT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_CONSUMER_NAME">HDR_CONSUMER_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_DISTANCE">HDR_DISTANCE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_FILTERSTRING">HDR_FILTERSTRING</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_MESSAGE_ID">HDR_MESSAGE_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_NOTIFICATION_TIMESTAMP">HDR_NOTIFICATION_TIMESTAMP</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_NOTIFICATION_TYPE">HDR_NOTIFICATION_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_OPERATION_NAME">HDR_OPERATION_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_OPERATION_SUCCEEDED">HDR_OPERATION_SUCCEEDED</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_PROPOSAL_ALT_VALUE">HDR_PROPOSAL_ALT_VALUE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_PROPOSAL_GROUP_ID">HDR_PROPOSAL_GROUP_ID</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_PROPOSAL_VALUE">HDR_PROPOSAL_VALUE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_PROTOCOL_NAME">HDR_PROTOCOL_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_REMOTE_ADDRESS">HDR_REMOTE_ADDRESS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_RESOURCE_NAME">HDR_RESOURCE_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ROUTING_NAME">HDR_ROUTING_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_ROUTING_TYPE">HDR_ROUTING_TYPE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_SESSION_NAME">HDR_SESSION_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_USER">HDR_USER</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HDR_VALIDATED_USER">HDR_VALIDATED_USER</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doManagement(java.lang.String,java.lang.String,java.lang.String,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)">doManagement</a></span>​(<a href="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> uri, |
| <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> user, |
| <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> password, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doManagement(org.apache.activemq.artemis.api.core.client.ClientSession,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)">doManagement</a></span>​(<a href="../client/ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a> session, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed)</code></th> |
| <td class="colLast"> |
| <div class="block">Utility function to reuse a ClientSessionConnection and perform a single management operation via core.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doManagement(org.apache.activemq.artemis.api.core.client.ServerLocator,java.lang.String,java.lang.String,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)">doManagement</a></span>​(<a href="../client/ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> locator, |
| <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> user, |
| <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> password, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResult(org.apache.activemq.artemis.api.core.ICoreMessage)">getResult</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of an operation invocation or an attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResult(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.Class)">getResult</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a> desiredType)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of an operation invocation or an attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResults(org.apache.activemq.artemis.api.core.ICoreMessage)">getResults</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of an operation invocation or an attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasOperationSucceeded(org.apache.activemq.artemis.api.core.Message)">hasOperationSucceeded</a></span>​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the invocation of the management operation on the server resource succeeded.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAttributesResult(org.apache.activemq.artemis.api.core.Message)">isAttributesResult</a></span>​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the JMS message corresponds to the result of a management attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOperationResult(org.apache.activemq.artemis.api.core.Message)">isOperationResult</a></span>​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the JMS message corresponds to the result of a management operation invocation.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putAttribute(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String)">putAttribute</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> attribute)</code></th> |
| <td class="colLast"> |
| <div class="block">Stores a resource attribute in a message to retrieve the value from the server resource.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putOperationInvocation(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String)">putOperationInvocation</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> operationName)</code></th> |
| <td class="colLast"> |
| <div class="block">Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putOperationInvocation(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String,java.lang.Object...)">putOperationInvocation</a></span>​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> operationName, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#retrieveOperationParameters(org.apache.activemq.artemis.api.core.Message)">retrieveOperationParameters</a></span>​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</code></th> |
| <td class="colLast"> |
| <div class="block">Used by ActiveMQ Artemis management service.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeResult(org.apache.activemq.artemis.core.message.impl.CoreMessage,java.lang.Object)">storeResult</a></span>​(org.apache.activemq.artemis.core.message.impl.CoreMessage message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> result)</code></th> |
| <td class="colLast"> |
| <div class="block">Used by ActiveMQ Artemis management service.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="HDR_RESOURCE_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_RESOURCE_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_RESOURCE_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_ATTRIBUTE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ATTRIBUTE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ATTRIBUTE</pre> |
| </li> |
| </ul> |
| <a id="HDR_OPERATION_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_OPERATION_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_OPERATION_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_OPERATION_SUCCEEDED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_OPERATION_SUCCEEDED</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_OPERATION_SUCCEEDED</pre> |
| </li> |
| </ul> |
| <a id="HDR_NOTIFICATION_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_NOTIFICATION_TYPE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_NOTIFICATION_TYPE</pre> |
| </li> |
| </ul> |
| <a id="HDR_NOTIFICATION_TIMESTAMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_NOTIFICATION_TIMESTAMP</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_NOTIFICATION_TIMESTAMP</pre> |
| </li> |
| </ul> |
| <a id="HDR_ROUTING_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ROUTING_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ROUTING_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_CLUSTER_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CLUSTER_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CLUSTER_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ADDRESS</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ADDRESS</pre> |
| </li> |
| </ul> |
| <a id="HDR_ROUTING_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_ROUTING_TYPE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_ROUTING_TYPE</pre> |
| </li> |
| </ul> |
| <a id="HDR_BINDING_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_BINDING_ID</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_BINDING_ID</pre> |
| </li> |
| </ul> |
| <a id="HDR_BINDING_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_BINDING_TYPE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_BINDING_TYPE</pre> |
| </li> |
| </ul> |
| <a id="HDR_FILTERSTRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_FILTERSTRING</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_FILTERSTRING</pre> |
| </li> |
| </ul> |
| <a id="HDR_DISTANCE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_DISTANCE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_DISTANCE</pre> |
| </li> |
| </ul> |
| <a id="HDR_CONSUMER_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CONSUMER_COUNT</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CONSUMER_COUNT</pre> |
| </li> |
| </ul> |
| <a id="HDR_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_USER</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_USER</pre> |
| </li> |
| </ul> |
| <a id="HDR_VALIDATED_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_VALIDATED_USER</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_VALIDATED_USER</pre> |
| </li> |
| </ul> |
| <a id="HDR_CERT_SUBJECT_DN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CERT_SUBJECT_DN</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CERT_SUBJECT_DN</pre> |
| </li> |
| </ul> |
| <a id="HDR_CHECK_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CHECK_TYPE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CHECK_TYPE</pre> |
| </li> |
| </ul> |
| <a id="HDR_SESSION_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_SESSION_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_SESSION_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_REMOTE_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_REMOTE_ADDRESS</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_REMOTE_ADDRESS</pre> |
| </li> |
| </ul> |
| <a id="HDR_PROPOSAL_GROUP_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_PROPOSAL_GROUP_ID</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_PROPOSAL_GROUP_ID</pre> |
| </li> |
| </ul> |
| <a id="HDR_PROPOSAL_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_PROPOSAL_VALUE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_PROPOSAL_VALUE</pre> |
| </li> |
| </ul> |
| <a id="HDR_PROPOSAL_ALT_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_PROPOSAL_ALT_VALUE</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_PROPOSAL_ALT_VALUE</pre> |
| </li> |
| </ul> |
| <a id="HDR_CONSUMER_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CONSUMER_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CONSUMER_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_CONNECTION_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_CONNECTION_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CONNECTION_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_MESSAGE_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_MESSAGE_ID</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_MESSAGE_ID</pre> |
| </li> |
| </ul> |
| <a id="HDR_PROTOCOL_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HDR_PROTOCOL_NAME</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_PROTOCOL_NAME</pre> |
| </li> |
| </ul> |
| <a id="HDR_CLIENT_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HDR_CLIENT_ID</h4> |
| <pre>public static final <a href="../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a> HDR_CLIENT_ID</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="doManagement(java.lang.String,java.lang.String,java.lang.String,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doManagement</h4> |
| <pre class="methodSignature">public static void doManagement​(<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> uri, |
| <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> user, |
| <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> password, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed) |
| 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> |
| <dl> |
| <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="doManagement(org.apache.activemq.artemis.api.core.client.ServerLocator,java.lang.String,java.lang.String,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doManagement</h4> |
| <pre class="methodSignature">public static void doManagement​(<a href="../client/ServerLocator.html" title="interface in org.apache.activemq.artemis.api.core.client">ServerLocator</a> locator, |
| <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> user, |
| <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> password, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed) |
| 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> |
| <dl> |
| <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="doManagement(org.apache.activemq.artemis.api.core.client.ClientSession,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doManagement</h4> |
| <pre class="methodSignature">public static void doManagement​(<a href="../client/ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a> session, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> setup, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> ok, |
| <a href="ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a> failed) |
| 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">Utility function to reuse a ClientSessionConnection and perform a single management operation via core.</div> |
| <dl> |
| <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="putAttribute(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putAttribute</h4> |
| <pre class="methodSignature">public static void putAttribute​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> attribute)</pre> |
| <div class="block">Stores a resource attribute in a message to retrieve the value from the server resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - message</dd> |
| <dd><code>resourceName</code> - the name of the resource</dd> |
| <dd><code>attribute</code> - the name of the attribute</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ResourceNames.html" title="class in org.apache.activemq.artemis.api.core.management"><code>ResourceNames</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="putOperationInvocation(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putOperationInvocation</h4> |
| <pre class="methodSignature">public static void putOperationInvocation​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> operationName) |
| 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">Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - message</dd> |
| <dd><code>resourceName</code> - the name of the resource</dd> |
| <dd><code>operationName</code> - the name of the operation to invoke on the resource</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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ResourceNames.html" title="class in org.apache.activemq.artemis.api.core.management"><code>ResourceNames</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="putOperationInvocation(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.String,java.lang.String,java.lang.Object...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putOperationInvocation</h4> |
| <pre class="methodSignature">public static void putOperationInvocation​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <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> resourceName, |
| <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> operationName, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... parameters) |
| 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">Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - message</dd> |
| <dd><code>resourceName</code> - the name of the server resource</dd> |
| <dd><code>operationName</code> - the name of the operation to invoke on the server resource</dd> |
| <dd><code>parameters</code> - the parameters to use to invoke the server resource</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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ResourceNames.html" title="class in org.apache.activemq.artemis.api.core.management"><code>ResourceNames</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="retrieveOperationParameters(org.apache.activemq.artemis.api.core.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveOperationParameters</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] retrieveOperationParameters​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message) |
| 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">Used by ActiveMQ Artemis management service.</div> |
| <dl> |
| <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="isOperationResult(org.apache.activemq.artemis.api.core.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOperationResult</h4> |
| <pre class="methodSignature">public static boolean isOperationResult​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</pre> |
| <div class="block">Returns whether the JMS message corresponds to the result of a management operation invocation.</div> |
| </li> |
| </ul> |
| <a id="isAttributesResult(org.apache.activemq.artemis.api.core.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAttributesResult</h4> |
| <pre class="methodSignature">public static boolean isAttributesResult​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</pre> |
| <div class="block">Returns whether the JMS message corresponds to the result of a management attribute value.</div> |
| </li> |
| </ul> |
| <a id="storeResult(org.apache.activemq.artemis.core.message.impl.CoreMessage,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeResult</h4> |
| <pre class="methodSignature">public static void storeResult​(org.apache.activemq.artemis.core.message.impl.CoreMessage message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> result) |
| 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">Used by ActiveMQ Artemis management service.</div> |
| <dl> |
| <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="getResults(org.apache.activemq.artemis.api.core.ICoreMessage)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResults</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] getResults​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message) |
| 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">Returns the result of an operation invocation or an attribute value. |
| <br> |
| If an error occurred on the server, <a href="#hasOperationSucceeded(org.apache.activemq.artemis.api.core.Message)"><code>hasOperationSucceeded(Message)</code></a> will return <code>false</code>. |
| and the result will be a String corresponding to the server exception.</div> |
| <dl> |
| <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="getResult(org.apache.activemq.artemis.api.core.ICoreMessage)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getResult​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message) |
| 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">Returns the result of an operation invocation or an attribute value. |
| <br> |
| If an error occurred on the server, <a href="#hasOperationSucceeded(org.apache.activemq.artemis.api.core.Message)"><code>hasOperationSucceeded(Message)</code></a> will return <code>false</code>. |
| and the result will be a String corresponding to the server exception.</div> |
| <dl> |
| <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="getResult(org.apache.activemq.artemis.api.core.ICoreMessage,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getResult​(<a href="../ICoreMessage.html" title="interface in org.apache.activemq.artemis.api.core">ICoreMessage</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a> desiredType) |
| 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">Returns the result of an operation invocation or an attribute value. |
| <br> |
| If an error occurred on the server, <a href="#hasOperationSucceeded(org.apache.activemq.artemis.api.core.Message)"><code>hasOperationSucceeded(Message)</code></a> will return <code>false</code>. |
| and the result will be a String corresponding to the server exception.</div> |
| <dl> |
| <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="hasOperationSucceeded(org.apache.activemq.artemis.api.core.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hasOperationSucceeded</h4> |
| <pre class="methodSignature">public static boolean hasOperationSucceeded​(<a href="../Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> message)</pre> |
| <div class="block">Returns whether the invocation of the management operation on the server resource succeeded.</div> |
| </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/ManagementHelper.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |