| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>TribesClusteringAgent (Apache Axis2)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TribesClusteringAgent (Apache Axis2)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TribesClusteringAgent.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"> |
| <li><a href="../../../../../org/apache/axis2/clustering/tribes/TribesAxisObserver.html" title="class in org.apache.axis2.clustering.tribes"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/axis2/clustering/tribes/TribesConstants.html" title="class in org.apache.axis2.clustering.tribes"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/axis2/clustering/tribes/TribesClusteringAgent.html" target="_top">Frames</a></li> |
| <li><a href="TribesClusteringAgent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </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><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.axis2.clustering.tribes</div> |
| <h2 title="Class TribesClusteringAgent" class="title">Class TribesClusteringAgent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis2.clustering.tribes.TribesClusteringAgent</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a>, <a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TribesClusteringAgent</span> |
| extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></pre> |
| <div class="block">The main ClusteringAgent class for the Tribes based clustering implementation</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#DEFAULT_SUB_DOMAIN">DEFAULT_SUB_DOMAIN</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#TribesClusteringAgent()">TribesClusteringAgent</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String)">addGroupManagementAgent</a></strong>(<a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> agent, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain)</code> |
| <div class="block">Set the load balance event handler which will be notified when load balance events occur.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String, java.lang.String)">addGroupManagementAgent</a></strong>(<a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> agent, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationSubDomain)</code> |
| <div class="block">Add a GroupManagementAgent to an application domain + sub-domain</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></strong>(<a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a> param)</code> |
| <div class="block">Method addParameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></strong>(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a> parameterElement)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#finalize()">finalize</a></strong>()</code> |
| <div class="block">Do cleanup & leave the cluster</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getAliveMemberCount()">getAliveMemberCount</a></strong>()</code> |
| <div class="block">Get the number of members alive.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getDomains()">getDomains</a></strong>()</code> |
| <div class="block">Get all the domains that this ClusteringAgent belongs to</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getGroupManagementAgent(java.lang.String)">getGroupManagementAgent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain)</code> |
| <div class="block">Get the GroupManagementAgent which corresponds to the <code>applicationDomain</code> |
| This will be valid only when this node is running in groupManagement</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getGroupManagementAgent(java.lang.String, java.lang.String)">getGroupManagementAgent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationSubDomain)</code> |
| <div class="block">Get the GroupManagementAgent which corresponds to the <code>applicationDomain + sub-domain</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/Member.html" title="class in org.apache.axis2.clustering">Member</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getMembers()">getMembers</a></strong>()</code> |
| <div class="block">Get the list of members in a |
| <a href="http://blog.afkham.org/2008/05/group-membership-management-schemes.html"> |
| static group |
| </a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getNodeManager()">getNodeManager</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getParameter(java.lang.String)">getParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Method getParameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getParameters()">getParameters</a></strong>()</code> |
| <div class="block">Gets all the parameters in a given description.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/axis2/clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#getStateManager()">getStateManager</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#init()">init</a></strong>()</code> |
| <div class="block">Initialize the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#isCoordinator()">isCoordinator</a></strong>()</code> |
| <div class="block">Checks whether this member is the coordinator for the cluster</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#isParameterLocked(java.lang.String)">isParameterLocked</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> parameterName)</code> |
| <div class="block">Checks whether the parameter is locked at any level.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></strong>(<a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a> param)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/ClusteringCommand.html" title="class in org.apache.axis2.clustering">ClusteringCommand</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#sendMessage(org.apache.axis2.clustering.ClusteringMessage, boolean)">sendMessage</a></strong>(<a href="../../../../../org/apache/axis2/clustering/ClusteringMessage.html" title="class in org.apache.axis2.clustering">ClusteringMessage</a> message, |
| boolean isRpcMessage)</code> |
| <div class="block">Send a message to all members in this member's primary cluster</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">setConfigurationContext</a></strong>(<a href="../../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</code> |
| <div class="block">Set the system's configuration context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#setMembers(java.util.List)">setMembers</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/Member.html" title="class in org.apache.axis2.clustering">Member</a>> members)</code> |
| <div class="block">Set the static members of the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#setNodeManager(org.apache.axis2.clustering.management.NodeManager)">setNodeManager</a></strong>(<a href="../../../../../org/apache/axis2/clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a> nodeManager)</code> |
| <div class="block">Set the NodeManager corresponding to this ClusteringAgent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#setStateManager(org.apache.axis2.clustering.state.StateManager)">setStateManager</a></strong>(<a href="../../../../../org/apache/axis2/clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a> stateManager)</code> |
| <div class="block">Set the StateManager corresponding to this ClusteringAgent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#shutdown()">shutdown</a></strong>()</code> |
| <div class="block">Shutdown the cluster.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html#synchronizeAllMembers()">synchronizeAllMembers</a></strong>()</code> |
| <div class="block">Method to check whether all members in the cluster have to be kept in sync at all times.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_SUB_DOMAIN"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_SUB_DOMAIN</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_SUB_DOMAIN</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.axis2.clustering.tribes.TribesClusteringAgent.DEFAULT_SUB_DOMAIN">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TribesClusteringAgent()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TribesClusteringAgent</h4> |
| <pre>public TribesClusteringAgent()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setMembers(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMembers</h4> |
| <pre>public void setMembers(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/Member.html" title="class in org.apache.axis2.clustering">Member</a>> members)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setMembers(java.util.List)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Set the static members of the cluster. This is used only with |
| <a href="http://blog.afkham.org/2008/05/group-membership-management-schemes.html"> |
| static group membership </a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setMembers(java.util.List)">setMembers</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>members</code> - Members to be added</dd></dl> |
| </li> |
| </ul> |
| <a name="getMembers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMembers</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/Member.html" title="class in org.apache.axis2.clustering">Member</a>> getMembers()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getMembers()">ClusteringAgent</a></code></strong></div> |
| <div class="block">Get the list of members in a |
| <a href="http://blog.afkham.org/2008/05/group-membership-management-schemes.html"> |
| static group |
| </a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getMembers()">getMembers</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The members if static group membership is used. If any other membership scheme is used, |
| the values returned may not be valid</dd></dl> |
| </li> |
| </ul> |
| <a name="getAliveMemberCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAliveMemberCount</h4> |
| <pre>public int getAliveMemberCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getAliveMemberCount()">ClusteringAgent</a></code></strong></div> |
| <div class="block">Get the number of members alive.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getAliveMemberCount()">getAliveMemberCount</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the number of members alive.</dd></dl> |
| </li> |
| </ul> |
| <a name="addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGroupManagementAgent</h4> |
| <pre>public void addGroupManagementAgent(<a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> agent, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Set the load balance event handler which will be notified when load balance events occur. |
| This will be valid only when this node is running in loadBalance mode</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String)">addGroupManagementAgent</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>agent</code> - The GroupManagementAgent to be added</dd><dd><code>applicationDomain</code> - The application domain which is handled by the GroupManagementAgent</dd></dl> |
| </li> |
| </ul> |
| <a name="addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGroupManagementAgent</h4> |
| <pre>public void addGroupManagementAgent(<a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> agent, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationSubDomain)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String, java.lang.String)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Add a GroupManagementAgent to an application domain + sub-domain</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent, java.lang.String, java.lang.String)">addGroupManagementAgent</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>agent</code> - The GroupManagementAgent to be added</dd><dd><code>applicationDomain</code> - The application domain which is handled by the GroupManagementAgent</dd><dd><code>applicationSubDomain</code> - The application sub-domain which is handled by the GroupManagementAgent</dd></dl> |
| </li> |
| </ul> |
| <a name="getGroupManagementAgent(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupManagementAgent</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> getGroupManagementAgent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getGroupManagementAgent(java.lang.String)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Get the GroupManagementAgent which corresponds to the <code>applicationDomain</code> |
| This will be valid only when this node is running in groupManagement</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getGroupManagementAgent(java.lang.String)">getGroupManagementAgent</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>applicationDomain</code> - The application domain to which the application nodes being |
| load balanced belong to</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>GroupManagementAgent which corresponds to the <code>applicationDomain</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getGroupManagementAgent(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupManagementAgent</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/clustering/management/GroupManagementAgent.html" title="interface in org.apache.axis2.clustering.management">GroupManagementAgent</a> getGroupManagementAgent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationDomain, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationSubDomain)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getGroupManagementAgent(java.lang.String, java.lang.String)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Get the GroupManagementAgent which corresponds to the <code>applicationDomain + sub-domain</code></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getGroupManagementAgent(java.lang.String, java.lang.String)">getGroupManagementAgent</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>applicationDomain</code> - The application domain which is handled by the GroupManagementAgent</dd><dd><code>applicationSubDomain</code> - The application sub-domain which is handled by the GroupManagementAgent</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>GroupManagementAgent which corresponds to the <code>applicationDomain + sub-domain</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getDomains()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDomains</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getDomains()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getDomains()">ClusteringAgent</a></code></strong></div> |
| <div class="block">Get all the domains that this ClusteringAgent belongs to</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getDomains()">getDomains</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the domains of this ClusteringAgent</dd></dl> |
| </li> |
| </ul> |
| <a name="getStateManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStateManager</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a> getStateManager()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getStateManager()">getStateManager</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The StateManager</dd></dl> |
| </li> |
| </ul> |
| <a name="getNodeManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeManager</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a> getNodeManager()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#getNodeManager()">getNodeManager</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The NodeManager</dd></dl> |
| </li> |
| </ul> |
| <a name="isCoordinator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCoordinator</h4> |
| <pre>public boolean isCoordinator()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#isCoordinator()">ClusteringAgent</a></code></strong></div> |
| <div class="block">Checks whether this member is the coordinator for the cluster</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#isCoordinator()">isCoordinator</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if this member is the coordinator, and false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="init()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void init() |
| throws <a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">Initialize the cluster.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#init()">init</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If initialization fails</dd></dl> |
| </li> |
| </ul> |
| <a name="finalize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finalize</h4> |
| <pre>public void finalize()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#finalize()">ClusteringAgent</a></code></strong></div> |
| <div class="block">Do cleanup & leave the cluster</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#finalize()">finalize</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a></code> in class <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendMessage(org.apache.axis2.clustering.ClusteringMessage, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/axis2/clustering/ClusteringCommand.html" title="class in org.apache.axis2.clustering">ClusteringCommand</a>> sendMessage(<a href="../../../../../org/apache/axis2/clustering/ClusteringMessage.html" title="class in org.apache.axis2.clustering">ClusteringMessage</a> message, |
| boolean isRpcMessage) |
| throws <a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#sendMessage(org.apache.axis2.clustering.ClusteringMessage, boolean)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Send a message to all members in this member's primary cluster</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#sendMessage(org.apache.axis2.clustering.ClusteringMessage, boolean)">sendMessage</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The message to be sent</dd><dd><code>isRpcMessage</code> - Indicates whether the message has to be sent in RPC mode</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A list of responses if the message is sent in RPC mode</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while sending the message</dd></dl> |
| </li> |
| </ul> |
| <a name="setNodeManager(org.apache.axis2.clustering.management.NodeManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNodeManager</h4> |
| <pre>public void setNodeManager(<a href="../../../../../org/apache/axis2/clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a> nodeManager)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setNodeManager(org.apache.axis2.clustering.management.NodeManager)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Set the NodeManager corresponding to this ClusteringAgent. This is an optional attribute. |
| We can have a cluster with no configuration management, in which case the configurationManager |
| will be null. This value is set by the <a href="../../../../../org/apache/axis2/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></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setNodeManager(org.apache.axis2.clustering.management.NodeManager)">setNodeManager</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>nodeManager</code> - The NodeManager instance</dd></dl> |
| </li> |
| </ul> |
| <a name="setStateManager(org.apache.axis2.clustering.state.StateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStateManager</h4> |
| <pre>public void setStateManager(<a href="../../../../../org/apache/axis2/clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a> stateManager)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setStateManager(org.apache.axis2.clustering.state.StateManager)">ClusteringAgent</a></code></strong></div> |
| <div class="block">Set the StateManager corresponding to this ClusteringAgent. This is an optional attribute. |
| We can have a cluster with no context replication, in which case the contextManager will be |
| null. This value is set by the <a href="../../../../../org/apache/axis2/deployment/ClusterBuilder.html" title="class in org.apache.axis2.deployment"><code>ClusterBuilder</code></a>, by |
| reading the "contextManager" element in the axis2.xml |
| <p/> |
| e.g. |
| <code> |
| <b> |
| <contextManager class="org.apache.axis2.cluster.configuration.TribesContextManager"> |
| </b> |
| </code></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setStateManager(org.apache.axis2.clustering.state.StateManager)">setStateManager</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>stateManager</code> - The StateManager instance</dd></dl> |
| </li> |
| </ul> |
| <a name="addParameter(org.apache.axis2.description.Parameter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addParameter</h4> |
| <pre>public void addParameter(<a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a> param) |
| throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">ParameterInclude</a></code></strong></div> |
| <div class="block">Method addParameter.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="deserializeParameters(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deserializeParameters</h4> |
| <pre>public void deserializeParameters(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a> parameterElement) |
| throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getParameter(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameter</h4> |
| <pre>public <a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a> getParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameter(java.lang.String)">ParameterInclude</a></code></strong></div> |
| <div class="block">Method getParameter.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameter(java.lang.String)">getParameter</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Returns Parameter.</dd></dl> |
| </li> |
| </ul> |
| <a name="getParameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameters</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> getParameters()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameters()">ParameterInclude</a></code></strong></div> |
| <div class="block">Gets all the parameters in a given description.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameters()">getParameters</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Returns ArrayList.</dd></dl> |
| </li> |
| </ul> |
| <a name="isParameterLocked(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isParameterLocked</h4> |
| <pre>public boolean isParameterLocked(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> parameterName)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#isParameterLocked(java.lang.String)">ParameterInclude</a></code></strong></div> |
| <div class="block">Checks whether the parameter is locked at any level.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#isParameterLocked(java.lang.String)">isParameterLocked</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeParameter(org.apache.axis2.description.Parameter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeParameter</h4> |
| <pre>public void removeParameter(<a href="../../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a> param) |
| throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></code> in interface <code><a href="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="shutdown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown() |
| throws <a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre> |
| <div class="block">Shutdown the cluster. This member will leave the cluster when this method is called.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#shutdown()">shutdown</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></code> - If an error occurs while shutting down</dd></dl> |
| </li> |
| </ul> |
| <a name="setConfigurationContext(org.apache.axis2.context.ConfigurationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigurationContext</h4> |
| <pre>public void setConfigurationContext(<a href="../../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">ClusteringAgent</a></code></strong></div> |
| <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">setConfigurationContext</a></code> in interface <code><a href="../../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>configurationContext</code> - The configuration context</dd></dl> |
| </li> |
| </ul> |
| <a name="synchronizeAllMembers()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>synchronizeAllMembers</h4> |
| <pre>public boolean synchronizeAllMembers()</pre> |
| <div class="block">Method to check whether all members in the cluster have to be kept in sync at all times. |
| Typically, this will require each member in the cluster to ACKnowledge receipt of a |
| particular message, which may have a significant performance hit.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true - if all members in the cluster should be kept in sync at all times, false |
| otherwise</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TribesClusteringAgent.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"> |
| <li><a href="../../../../../org/apache/axis2/clustering/tribes/TribesAxisObserver.html" title="class in org.apache.axis2.clustering.tribes"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/axis2/clustering/tribes/TribesConstants.html" title="class in org.apache.axis2.clustering.tribes"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/axis2/clustering/tribes/TribesClusteringAgent.html" target="_top">Frames</a></li> |
| <li><a href="TribesClusteringAgent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </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><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |