org.apache.axis2.clustering.context
Interface ContextManager

All Superinterfaces:
ParameterInclude
All Known Implementing Classes:
DefaultContextManager

public interface ContextManager
extends ParameterInclude


Method Summary
 java.util.Map getReplicationExcludePatterns()
          Get all the excluded context property name patterns
 boolean isContextClusterable(AbstractContext context)
           
 boolean isMessageAcknowledged(java.lang.String messageUniqueId)
          Indicates whether a particular message has been ACKed by all members of a cluster
 java.lang.String removeContext(AbstractContext context)
          This method is called when a new AbstractContext is removed from the system
 void setConfigurationContext(ConfigurationContext configurationContext)
           
 void setContextManagerListener(ContextManagerListener listener)
           
 void setReplicationExcludePatterns(java.lang.String contextType, java.util.List patterns)
          All properties in the context with type contextType which have names that match the specified pattern will be excluded from replication.
 java.lang.String updateContext(AbstractContext context)
          This method is called when properties in an AbstractContext are updated.
 java.lang.String updateContexts(AbstractContext[] contexts)
          This method is called when properties in a collection of AbstractContexts are updated.
 
Methods inherited from interface org.apache.axis2.description.ParameterInclude
addParameter, deserializeParameters, getParameter, getParameters, isParameterLocked, removeParameter
 

Method Detail

updateContext

java.lang.String updateContext(AbstractContext context)
                               throws ClusteringFault
This method is called when properties in an AbstractContext are updated. This could be addition of new properties, modifications of existing properties or removal of properties.

Parameters:
context -
Returns:
The UUID of the message that was sent to the group communications framework
Throws:
ClusteringFault

updateContexts

java.lang.String updateContexts(AbstractContext[] contexts)
                                throws ClusteringFault
This method is called when properties in a collection of AbstractContexts are updated. This could be addition of new properties, modifications of existing properties or removal of properties.

Parameters:
contexts -
Returns:
The UUID of the message that was sent to the group communications framework
Throws:
ClusteringFault

removeContext

java.lang.String removeContext(AbstractContext context)
                               throws ClusteringFault
This method is called when a new AbstractContext is removed from the system

Parameters:
context -
Returns:
The UUID of the message that was sent to the group communications framework
Throws:
ClusteringFault

isContextClusterable

boolean isContextClusterable(AbstractContext context)
Parameters:
context -
Returns:
True - if the provided AbstractContext is clusterable

isMessageAcknowledged

boolean isMessageAcknowledged(java.lang.String messageUniqueId)
                              throws ClusteringFault
Indicates whether a particular message has been ACKed by all members of a cluster

Parameters:
messageUniqueId -
Returns:
true - if all memebers have ACKed the message with ID messageUniqueId false - otherwise
Throws:
ClusteringFault

setContextManagerListener

void setContextManagerListener(ContextManagerListener listener)
Parameters:
listener -

setConfigurationContext

void setConfigurationContext(ConfigurationContext configurationContext)
Parameters:
configurationContext -

setReplicationExcludePatterns

void setReplicationExcludePatterns(java.lang.String contextType,
                                   java.util.List patterns)
All properties in the context with type contextType which have names that match the specified pattern will be excluded from replication.

Generally, we can use the context class name as the context type.

Parameters:
contextType -
patterns - The patterns

getReplicationExcludePatterns

java.util.Map getReplicationExcludePatterns()
Get all the excluded context property name patterns

Returns:
All the excluded pattern of all the contexts. The key of the Map is the the contextType. See setReplicationExcludePatterns(String,List). The values are of type List of String Objects, which are a collection of patterns to be excluded.


Copyright © 2007 Apache Web Services Project. All Rights Reserved.