| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>NodeManager (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NodeManager (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</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/NodeManager.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="../../../../../index-all.html">Index</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> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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.axis2.clustering.management</a></div> |
| <h2 title="Interface NodeManager" class="title">Interface NodeManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DefaultNodeManager.html" title="class in org.apache.axis2.clustering.management">DefaultNodeManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">NodeManager</span> |
| extends <a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></pre> |
| <div class="block"><p> |
| This interface is responsible for handling configuration management. Configuraion changes include |
| <p/> |
| <ul> |
| <li>Rebooting an entire cluster, in which case, all nodes have to load the new Axis2 configuration |
| in a consistent manner |
| </li> |
| <li> |
| Deploying a new service to a cluster or undeploying a service from a cluster |
| </li> |
| <li> |
| Changing the policies of a service deployed on the cluster |
| </li> |
| </ul> |
| </p> |
| <p> |
| It is not mandatory to have a NodeManager in a node. In which case the cluster may be |
| used only for <a href="http://blog.afkham.org/2008/05/definition-of-high-availability.html"> |
| High Availability</a> through context replication. However, it is difficult to imagine that |
| a cluster will be deployed in production with only context replication but without cluster |
| configuration management. |
| </p> |
| <p> |
| The implementation of this interface is set by the |
| <a href="../../deployment/ClusterBuilder.html" title="class in org.apache.axis2.deployment"><code>ClusterBuilder</code></a>, by |
| reading the "configurationManager" element in the axis2.xml |
| <p/> |
| e.g. |
| <code> |
| <b> |
| <configurationManager class="org.apache.axis2.cluster.configuration.TribesConfigurationManager"> |
| </b> |
| </code> |
| </p></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></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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit()">commit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Second phase of the 2-phase commit protocol.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exceptionOccurred(java.lang.Throwable)">exceptionOccurred</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> throwable)</code></th> |
| <td class="colLast"> |
| <div class="block">To notify other nodes that an Exception occurred, during the processing |
| of a <a href="NodeManagementCommand.html" title="class in org.apache.axis2.clustering.management"><code>NodeManagementCommand</code></a></div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare()">prepare</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">First phase of the 2-phase commit protocol.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollback()">rollback</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Rollback whatever was done</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="#sendMessage(org.apache.axis2.clustering.management.NodeManagementCommand)">sendMessage</a></span>​(<a href="NodeManagementCommand.html" title="class in org.apache.axis2.clustering.management">NodeManagementCommand</a> command)</code></th> |
| <td class="colLast"> |
| <div class="block">Execute a NodeManagementCommand</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">setConfigurationContext</a></span>​(<a href="../../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the system's configuration context.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.axis2.description.ParameterInclude"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axis2.description.<a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></h3> |
| <code><a href="../../description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a>, <a href="../../description/ParameterInclude.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a>, <a href="../../description/ParameterInclude.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../description/ParameterInclude.html#getParameters()">getParameters</a>, <a href="../../description/ParameterInclude.html#isParameterLocked(java.lang.String)">isParameterLocked</a>, <a href="../../description/ParameterInclude.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></code></li> |
| </ul> |
| </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="prepare()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre class="methodSignature">void prepare() |
| throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">First phase of the 2-phase commit protocol. |
| Notifies a node that it needs to prepare to switch to a new configuration.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while preparing to commit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollback()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre class="methodSignature">void rollback() |
| throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">Rollback whatever was done</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while rolling back a cluster configuration |
| transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">void commit() |
| throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">Second phase of the 2-phase commit protocol. |
| Notifies a node that it needs to switch to a new configuration.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while committing a cluster configuration |
| transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="exceptionOccurred(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exceptionOccurred</h4> |
| <pre class="methodSignature">void exceptionOccurred​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> throwable) |
| throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">To notify other nodes that an Exception occurred, during the processing |
| of a <a href="NodeManagementCommand.html" title="class in org.apache.axis2.clustering.management"><code>NodeManagementCommand</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>throwable</code> - The throwable which has to be propogated to other nodes</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while processing the |
| exception message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setConfigurationContext(org.apache.axis2.context.ConfigurationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigurationContext</h4> |
| <pre class="methodSignature">void setConfigurationContext​(<a href="../../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</pre> |
| <div class="block">Set the system's configuration context. This will be used by the clustering implementations |
| to get information about the Axis2 environment and to correspond with the Axis2 environment</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configurationContext</code> - The configuration context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendMessage(org.apache.axis2.clustering.management.NodeManagementCommand)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre class="methodSignature">void sendMessage​(<a href="NodeManagementCommand.html" title="class in org.apache.axis2.clustering.management">NodeManagementCommand</a> command) |
| throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">Execute a NodeManagementCommand</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - The command to be executed</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while sending the message</dd> |
| </dl> |
| </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/NodeManager.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="../../../../../index-all.html">Index</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 © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
