| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_22) on Tue Apr 17 18:33:29 IST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| StateManager (Apache Axis2 - Root 1.6.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-04-17"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StateManager (Apache Axis2 - Root 1.6.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StateManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/axis2/clustering/state/StateClusteringCommandFactory.html" title="class in org.apache.axis2.clustering.state"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/axis2/clustering/state/StateManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StateManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.axis2.clustering.state</FONT> |
| <BR> |
| Interface StateManager</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/axis2/clustering/state/DefaultStateManager.html" title="class in org.apache.axis2.clustering.state">DefaultStateManager</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>StateManager</B><DT>extends <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</A></DL> |
| </PRE> |
| |
| <P> |
| <p> |
| This interface is responsible for handling context replication. The property changes in the |
| <a href="http://www.ibm.com/developerworks/webservices/library/ws-apacheaxis2/"> |
| Axis2 context hierarchy |
| </a> in this node, are propagated to all other nodes in the cluster. |
| </p> |
| <p> |
| It is not mandatory to have a StateManager in a node. If we are not interested in |
| <a href="http://blog.afkham.org/2008/05/definition-of-high-availability.html"> |
| High Availability</a>, we may disable context replication by commenting out the "contextManager" |
| section in the axis2.xml cluster configuration section. In such a scenatio, the cluster will be |
| used only for the purpose of |
| <a href="http://blog.afkham.org/2008/05/definition-of-scalability.html">Scalability</a> |
| </p> |
| <p> |
| The implementation of this interface 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> |
| </p> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#getReplicationExcludePatterns()">getReplicationExcludePatterns</A></B>()</CODE> |
| |
| <BR> |
| Get all the excluded context property name patterns</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#isContextClusterable(org.apache.axis2.context.AbstractContext)">isContextClusterable</A></B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context)</CODE> |
| |
| <BR> |
| This is a check to see whether the properties in an instance of <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A> |
| should be replicated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#removeContext(org.apache.axis2.context.AbstractContext)">removeContext</A></B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context)</CODE> |
| |
| <BR> |
| This method is called when <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A> is removed from the system</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)">replicateState</A></B>(<A HREF="../../../../../org/apache/axis2/clustering/state/StateClusteringCommand.html" title="class in org.apache.axis2.clustering.state">StateClusteringCommand</A> command)</CODE> |
| |
| <BR> |
| Replicate state using a custom StateClusteringCommand</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#setConfigurationContext(org.apache.axis2.context.ConfigurationContext)">setConfigurationContext</A></B>(<A HREF="../../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</A> configurationContext)</CODE> |
| |
| <BR> |
| Set the system's configuration context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#setReplicationExcludePatterns(java.lang.String, java.util.List)">setReplicationExcludePatterns</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contextType, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> patterns)</CODE> |
| |
| <BR> |
| |
| All properties in the context with type <code>contextType</code> which have |
| names that match the specified pattern will be excluded from replication.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#updateContext(org.apache.axis2.context.AbstractContext)">updateContext</A></B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context)</CODE> |
| |
| <BR> |
| This method is called when properties in an <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A> are updated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#updateContext(org.apache.axis2.context.AbstractContext, java.lang.String[])">updateContext</A></B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] propertyNames)</CODE> |
| |
| <BR> |
| This method is called when one need to update/replicate only certains properties in the |
| specified <code>context</code></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#updateContexts(org.apache.axis2.context.AbstractContext[])">updateContexts</A></B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A>[] contexts)</CODE> |
| |
| <BR> |
| This method is called when properties in a collection of <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A>s are updated.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.axis2.description.ParameterInclude"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.axis2.description.<A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html" title="interface in org.apache.axis2.description">ParameterInclude</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</A>, <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</A>, <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameter(java.lang.String)">getParameter</A>, <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#getParameters()">getParameters</A>, <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#isParameterLocked(java.lang.String)">isParameterLocked</A>, <A HREF="../../../../../org/apache/axis2/description/ParameterInclude.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="updateContext(org.apache.axis2.context.AbstractContext)"><!-- --></A><H3> |
| updateContext</H3> |
| <PRE> |
| void <B>updateContext</B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context) |
| throws <A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></PRE> |
| <DL> |
| <DD>This method is called when properties in an <A HREF="../../../../../org/apache/axis2/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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context to be replicated |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></CODE> - If replication fails</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="updateContext(org.apache.axis2.context.AbstractContext, java.lang.String[])"><!-- --></A><H3> |
| updateContext</H3> |
| <PRE> |
| void <B>updateContext</B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] propertyNames) |
| throws <A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></PRE> |
| <DL> |
| <DD>This method is called when one need to update/replicate only certains properties in the |
| specified <code>context</code> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - The AbstractContext containing the properties to be replicated<DD><CODE>propertyNames</CODE> - The names of the specific properties that should be replicated |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></CODE> - If replication fails</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="updateContexts(org.apache.axis2.context.AbstractContext[])"><!-- --></A><H3> |
| updateContexts</H3> |
| <PRE> |
| void <B>updateContexts</B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A>[] contexts) |
| throws <A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></PRE> |
| <DL> |
| <DD>This method is called when properties in a collection of <A HREF="../../../../../org/apache/axis2/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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contexts</CODE> - The AbstractContexts containing the properties to be replicated |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></CODE> - If replication fails</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="replicateState(org.apache.axis2.clustering.state.StateClusteringCommand)"><!-- --></A><H3> |
| replicateState</H3> |
| <PRE> |
| void <B>replicateState</B>(<A HREF="../../../../../org/apache/axis2/clustering/state/StateClusteringCommand.html" title="class in org.apache.axis2.clustering.state">StateClusteringCommand</A> command) |
| throws <A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></PRE> |
| <DL> |
| <DD>Replicate state using a custom StateClusteringCommand |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>command</CODE> - The custom StateClusteringCommand which can be used for replicating state |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></CODE> - If replication fails</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeContext(org.apache.axis2.context.AbstractContext)"><!-- --></A><H3> |
| removeContext</H3> |
| <PRE> |
| void <B>removeContext</B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context) |
| throws <A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></PRE> |
| <DL> |
| <DD>This method is called when <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A> is removed from the system |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - The AbstractContext to be removed |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../org/apache/axis2/clustering/ClusteringFault.html" title="class in org.apache.axis2.clustering">ClusteringFault</A></CODE> - If context removal fails</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isContextClusterable(org.apache.axis2.context.AbstractContext)"><!-- --></A><H3> |
| isContextClusterable</H3> |
| <PRE> |
| boolean <B>isContextClusterable</B>(<A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context">AbstractContext</A> context)</PRE> |
| <DL> |
| <DD>This is a check to see whether the properties in an instance of <A HREF="../../../../../org/apache/axis2/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 |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - The instance of AbstractContext under consideration |
| <DT><B>Returns:</B><DD>True - if the provided <A HREF="../../../../../org/apache/axis2/context/AbstractContext.html" title="class in org.apache.axis2.context"><CODE>AbstractContext</CODE></A> is clusterable</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfigurationContext(org.apache.axis2.context.ConfigurationContext)"><!-- --></A><H3> |
| setConfigurationContext</H3> |
| <PRE> |
| void <B>setConfigurationContext</B>(<A HREF="../../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</A> configurationContext)</PRE> |
| <DL> |
| <DD>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 |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>configurationContext</CODE> - The configuration context</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReplicationExcludePatterns(java.lang.String, java.util.List)"><!-- --></A><H3> |
| setReplicationExcludePatterns</H3> |
| <PRE> |
| void <B>setReplicationExcludePatterns</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contextType, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> patterns)</PRE> |
| <DL> |
| <DD><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> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><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><CODE>patterns</CODE> - The patterns</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getReplicationExcludePatterns()"><!-- --></A><H3> |
| getReplicationExcludePatterns</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> <B>getReplicationExcludePatterns</B>()</PRE> |
| <DL> |
| <DD>Get all the excluded context property name patterns |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>All the excluded pattern of all the contexts. The key of the Map is the |
| the <code>contextType</code>. See <A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#setReplicationExcludePatterns(java.lang.String, java.util.List)"><CODE>setReplicationExcludePatterns(String,List)</CODE></A>. |
| The values are of type <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><CODE>String</CODE></A> Objects, |
| which are a collection of patterns to be excluded.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/axis2/clustering/state/StateManager.html#setReplicationExcludePatterns(java.lang.String, java.util.List)"><CODE>setReplicationExcludePatterns(String, java.util.List)</CODE></A></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StateManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/axis2/clustering/state/StateClusteringCommandFactory.html" title="class in org.apache.axis2.clustering.state"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/axis2/clustering/state/StateManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StateManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
