org.wso2.carbon.analytics.dataservice.clustering

Interface AnalyticsClusterManager

All Known Implementing Classes:

AnalyticsClusterManagerImpl

public interface AnalyticsClusterManager

This interface represents the analytics clustering related operations.

Method Summary

Methods

Modifier and Type	Method and Description
<T> List<T>	execute(String groupId, Callable<T> callable) Executes the given Callable in all the nodes in the group, including the current one.
Serializable	getProperty(String groupId, String name) Retrieves a property local to a given group.
boolean	isClusteringEnabled() Checks if the server is in clustered mode.
void	joinGroup(String groupId, GroupEventListener groupEventListener) Joins a given group.
void	setProperty(String groupId, String name, Serializable value) Sets a property local to the given group.

Method Detail

joinGroup

void joinGroup(String groupId,
             GroupEventListener groupEventListener)
               throws AnalyticsClusterException

Joins a given group.

Parameters:

groupId - The group id of the group

groupEventListener - The listener class to listen for group events

Throws:

AnalyticsClusterException

execute

<T> List<T> execute(String groupId,
                  Callable<T> callable)
                throws AnalyticsClusterException

Executes the given Callable in all the nodes in the group, including the current one. This method executes even if clustering is not enabled, where then it will simply execute it in the current node and return a single response.

Parameters:

groupId - The group id of the group

callable - The implementation to be executed

Returns:

The aggregation of results from all the nodes

Throws:

AnalyticsClusterException

setProperty

void setProperty(String groupId,
               String name,
               Serializable value)

Sets a property local to the given group.

Parameters:

groupId - The group id of the group

name - The name of the property

value - The property value

getProperty

Serializable getProperty(String groupId,
                       String name)

Retrieves a property local to a given group.

Parameters:

groupId - The group id of the group

name - THe name of the property

Returns:

The property value

isClusteringEnabled

boolean isClusteringEnabled()

Checks if the server is in clustered mode.

Returns:

True if in clustered mode