Google Git
Sign in
apache / axis-site / 2ab3d496f1b4574a7e5677efcc4511d2c8e4807c / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / clustering / state / DefaultStateManager.html
blob: 57b5de9f85559491d41eb4e6626ceb30f8ab9edb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DefaultStateManager (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="DefaultStateManager (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DefaultStateManager.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.axis2.clustering.state</a></div>
<h2 title="Class DefaultStateManager" class="title">Class DefaultStateManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/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.axis2.clustering.state.DefaultStateManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code>, <code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DefaultStateManager</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></pre>
<div class="block">This class is the defaut StateManager of the Apache Tribes based clustering implementation</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DefaultStateManager</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></span>&#8203;(<a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code></th>
<td class="colLast">
<div class="block">Method addParameter.</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="#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></span>&#8203;(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a>&nbsp;parameterElement)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameter(java.lang.String)">getParameter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Method getParameter.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameters()">getParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets all the parameters in a given description.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationExcludePatterns()">getReplicationExcludePatterns</a></span>()</code></th>
<td class="colLast">
<div class="block">Get all the excluded context property name patterns</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isContextClusterable(org.apache.axis2.context.AbstractContext)">isContextClusterable</a></span>&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">This is a check to see whether the properties in an instance of <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a>
should be replicated.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isParameterLocked(java.lang.String)">isParameterLocked</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parameterName)</code></th>
<td class="colLast">
<div class="block">Checks whether the parameter is locked at any level.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeContext(org.apache.axis2.context.AbstractContext)">removeContext</a></span>&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">This method is called when <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a> is removed from the system</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></span>&#8203;(<a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)">replicateState</a></span>&#8203;(<a href="StateClusteringCommand.html" title="class in org.apache.axis2.clustering.state">StateClusteringCommand</a>&nbsp;command)</code></th>
<td class="colLast">
<div class="block">Replicate state using a custom StateClusteringCommand</div>
</td>
</tr>
<tr id="i10" class="altColor">
<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>&#8203;(<a href="../../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;configurationContext)</code></th>
<td class="colLast">
<div class="block">Set the system's configuration context.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationExcludePatterns(java.lang.String,java.util.List)">setReplicationExcludePatterns</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;contextType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&nbsp;patterns)</code></th>
<td class="colLast">
<div class="block">
All properties in the context with type <code>contextType</code> which have
names that match the specified pattern will be excluded from replication.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSender(org.apache.axis2.clustering.tribes.ChannelSender)">setSender</a></span>&#8203;(<a href="../tribes/ChannelSender.html" title="class in org.apache.axis2.clustering.tribes">ChannelSender</a>&nbsp;sender)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateContext(org.apache.axis2.context.AbstractContext)">updateContext</a></span>&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">This method is called when properties in an <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a> are updated.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateContext(org.apache.axis2.context.AbstractContext,java.lang.String%5B%5D)">updateContext</a></span>&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;propertyNames)</code></th>
<td class="colLast">
<div class="block">This method is called when one need to update/replicate only certains properties in the
specified <code>context</code></div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateContexts(org.apache.axis2.context.AbstractContext%5B%5D)">updateContexts</a></span>&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>[]&nbsp;contexts)</code></th>
<td class="colLast">
<div class="block">This method is called when properties in a collection of <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a>s are updated.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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/javase/7/docs/api/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultStateManager</h4>
<pre>public&nbsp;DefaultStateManager()</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="setSender(org.apache.axis2.clustering.tribes.ChannelSender)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSender</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSender&#8203;(<a href="../tribes/ChannelSender.html" title="class in org.apache.axis2.clustering.tribes">ChannelSender</a>&nbsp;sender)</pre>
</li>
</ul>
<a id="updateContext(org.apache.axis2.context.AbstractContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateContext&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)
throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#updateContext(org.apache.axis2.context.AbstractContext)">StateManager</a></code></span></div>
<div class="block">This method is called when properties in an <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a> are updated.
This could be addition of new properties, modifications of existing properties or
removal of properties.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#updateContext(org.apache.axis2.context.AbstractContext)">updateContext</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The context to be replicated</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 replication fails</dd>
</dl>
</li>
</ul>
<a id="updateContext(org.apache.axis2.context.AbstractContext,java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateContext&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;propertyNames)
throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#updateContext(org.apache.axis2.context.AbstractContext,java.lang.String%5B%5D)">StateManager</a></code></span></div>
<div class="block">This method is called when one need to update/replicate only certains properties in the
specified <code>context</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#updateContext(org.apache.axis2.context.AbstractContext,java.lang.String%5B%5D)">updateContext</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The AbstractContext containing the properties to be replicated</dd>
<dd><code>propertyNames</code> - The names of the specific properties that should be replicated</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 replication fails</dd>
</dl>
</li>
</ul>
<a id="updateContexts(org.apache.axis2.context.AbstractContext[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContexts</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateContexts&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>[]&nbsp;contexts)
throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#updateContexts(org.apache.axis2.context.AbstractContext%5B%5D)">StateManager</a></code></span></div>
<div class="block">This method is called when properties in a collection of <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a>s are updated.
This could be addition of new properties, modifications of existing properties or
removal of properties.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#updateContexts(org.apache.axis2.context.AbstractContext%5B%5D)">updateContexts</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contexts</code> - The AbstractContexts containing the properties to be replicated</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 replication fails</dd>
</dl>
</li>
</ul>
<a id="replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replicateState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;replicateState&#8203;(<a href="StateClusteringCommand.html" title="class in org.apache.axis2.clustering.state">StateClusteringCommand</a>&nbsp;command)
throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)">StateManager</a></code></span></div>
<div class="block">Replicate state using a custom StateClusteringCommand</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)">replicateState</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - The custom StateClusteringCommand which can be used for replicating state</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 replication fails</dd>
</dl>
</li>
</ul>
<a id="removeContext(org.apache.axis2.context.AbstractContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeContext&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)
throws <a href="../ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#removeContext(org.apache.axis2.context.AbstractContext)">StateManager</a></code></span></div>
<div class="block">This method is called when <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a> is removed from the system</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#removeContext(org.apache.axis2.context.AbstractContext)">removeContext</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The AbstractContext to be removed</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 context removal fails</dd>
</dl>
</li>
</ul>
<a id="isContextClusterable(org.apache.axis2.context.AbstractContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isContextClusterable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isContextClusterable&#8203;(<a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#isContextClusterable(org.apache.axis2.context.AbstractContext)">StateManager</a></code></span></div>
<div class="block">This is a check to see whether the properties in an instance of <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a>
should be replicated. This allows an implementer to dissallow the replication of properties
stored in a certain type of context</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#isContextClusterable(org.apache.axis2.context.AbstractContext)">isContextClusterable</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The instance of AbstractContext under consideration</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True - if the provided <a href="../../context/AbstractContext.html" title="class in org.apache.axis2.context"><code>AbstractContext</code></a> is clusterable</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">public&nbsp;void&nbsp;setConfigurationContext&#8203;(<a href="../../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;configurationContext)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">StateManager</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">setConfigurationContext</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configurationContext</code> - The configuration context</dd>
</dl>
</li>
</ul>
<a id="setReplicationExcludePatterns(java.lang.String,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReplicationExcludePatterns</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReplicationExcludePatterns&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;contextType,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&nbsp;patterns)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#setReplicationExcludePatterns(java.lang.String,java.util.List)">StateManager</a></code></span></div>
<div class="block"><p>
All properties in the context with type <code>contextType</code> which have
names that match the specified pattern will be excluded from replication.
</p>
<p/>
<p>
Only prefixes and suffixes are allowed. e.g. the local_* pattern indicates that
all property names starting with local_ should be omitted from replication. *_local pattern
indicated that all property names ending with _local should be omitted from replication.
* pattern indicates that all properties should be excluded.
</p>
<p>
Generally, we can use the context class name as the context type.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#setReplicationExcludePatterns(java.lang.String,java.util.List)">setReplicationExcludePatterns</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contextType</code> - The type of the context such as
org.apache.axis2.context.ConfigurationContext,
org.apache.axis2.context.ServiceGroupContext &
org.apache.axis2.context.ServiceContext.
Also "defaults" is a special type, which will apply to all contexts</dd>
<dd><code>patterns</code> - The patterns</dd>
</dl>
</li>
</ul>
<a id="getReplicationExcludePatterns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplicationExcludePatterns</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&nbsp;getReplicationExcludePatterns()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="StateManager.html#getReplicationExcludePatterns()">StateManager</a></code></span></div>
<div class="block">Get all the excluded context property name patterns</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateManager.html#getReplicationExcludePatterns()">getReplicationExcludePatterns</a></code>&nbsp;in interface&nbsp;<code><a href="StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>All the excluded pattern of all the contexts. The key of the Map is the
the <code>contextType</code>. See <a href="StateManager.html#setReplicationExcludePatterns(java.lang.String,java.util.List)"><code>StateManager.setReplicationExcludePatterns(String,List)</code></a>.
The values are of type <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> of <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> Objects,
which are a collection of patterns to be excluded.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="StateManager.html#setReplicationExcludePatterns(java.lang.String,java.util.List)"><code>StateManager.setReplicationExcludePatterns(String, java.util.List)</code></a></dd>
</dl>
</li>
</ul>
<a id="addParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addParameter&#8203;(<a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">ParameterInclude</a></code></span></div>
<div class="block">Method addParameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="removeParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeParameter&#8203;(<a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre class="methodSignature">public&nbsp;<a href="../../description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../description/ParameterInclude.html#getParameter(java.lang.String)">ParameterInclude</a></code></span></div>
<div class="block">Method getParameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#getParameter(java.lang.String)">getParameter</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns Parameter.</dd>
</dl>
</li>
</ul>
<a id="getParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&nbsp;getParameters()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../description/ParameterInclude.html#getParameters()">ParameterInclude</a></code></span></div>
<div class="block">Gets all the parameters in a given description.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#getParameters()">getParameters</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns ArrayList.</dd>
</dl>
</li>
</ul>
<a id="isParameterLocked(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isParameterLocked</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isParameterLocked&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parameterName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../description/ParameterInclude.html#isParameterLocked(java.lang.String)">ParameterInclude</a></code></span></div>
<div class="block">Checks whether the parameter is locked at any level.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#isParameterLocked(java.lang.String)">isParameterLocked</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
</dl>
</li>
</ul>
<a id="deserializeParameters(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deserializeParameters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deserializeParameters&#8203;(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a>&nbsp;parameterElement)
throws <a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../description/ParameterInclude.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></code>&nbsp;in interface&nbsp;<code><a href="../../description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></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/DefaultStateManager.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>