com.budjb.spring.distributed.cluster

Class AbstractClusterManager

java.lang.Object

com.budjb.spring.distributed.cluster.AbstractClusterManager

All Implemented Interfaces:

ClusterManager

Direct Known Subclasses:

StandaloneClusterManager

public abstract class AbstractClusterManager
extends java.lang.Object
implements ClusterManager

A (slightly opinionated) base implementation of ClusterManager. This implementation assumes that distributed properties are contained in some distributed Map.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClusterManager(ClusterConfigurationProperties clusterConfigurationProperties) Constructor.

Method Summary

Modifier and Type	Method and Description
protected ClusterConfigurationProperties	getClusterConfigurationProperties() Returns the cluster configuration properties.
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns the map that backs distributed properties.
java.lang.String	getProperty(java.lang.String name) Retrieves a distributed property.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> clazz) Retrieves a distributed property.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> clazz, T defaultValue) Retrieves a distributed property.
void	setProperty(java.lang.String name, java.lang.Object value) Sets a distributed property and syncs it with all cluster members.
protected abstract <T> java.util.concurrent.Future<? extends T>	submitInstruction(ClusterMember clusterMember, Instruction<? extends T> instruction) Submits the given instruction to the given cluster member.
<T> java.util.Map<ClusterMember,T>	submitInstruction(Instruction<? extends T> instruction) Submits an instruction to all cluster members.
<T> java.util.Map<ClusterMember,T>	submitInstructions(java.util.Map<ClusterMember,? extends Instruction<? extends T>> instructions) Submits instructions to members of the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.budjb.spring.distributed.cluster.ClusterManager

getClusterMembers

Constructor Detail

AbstractClusterManager

protected AbstractClusterManager(ClusterConfigurationProperties clusterConfigurationProperties)

Constructor.

Parameters:

clusterConfigurationProperties - Scheduler configuration properties.

Method Detail

submitInstruction

protected abstract <T> java.util.concurrent.Future<? extends T> submitInstruction(ClusterMember clusterMember,
                                                                                  Instruction<? extends T> instruction)

Submits the given instruction to the given cluster member.

Type Parameters:

T - The return type of the instruction.

Parameters:

clusterMember - Cluster member to run the instruction on.

instruction - Instruction to run.

Returns:

Results of the instruction.

getProperties

protected abstract java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns the map that backs distributed properties.

Returns:

The map that backs distributed properties.

submitInstruction

public <T> java.util.Map<ClusterMember,T> submitInstruction(Instruction<? extends T> instruction)
                                                     throws java.util.concurrent.ExecutionException,
                                                            java.lang.InterruptedException

Submits an instruction to all cluster members.

Specified by:

submitInstruction in interface ClusterManager

Type Parameters:

T - The return type of the instruction.

Parameters:

instruction - instructions to run on all cluster members.

Returns:

the results of the instructions, mapped to the member that generated them.

Throws:

java.util.concurrent.ExecutionException - when an error during execution occurs.

java.lang.InterruptedException - when the processes is interrupted.

submitInstructions

public <T> java.util.Map<ClusterMember,T> submitInstructions(java.util.Map<ClusterMember,? extends Instruction<? extends T>> instructions)
                                                      throws java.util.concurrent.ExecutionException,
                                                             java.lang.InterruptedException

Submits instructions to members of the cluster.

Specified by:

submitInstructions in interface ClusterManager

Type Parameters:

T - The return type of the instruction.

Parameters:

instructions - instructions to run on cluster members.

Returns:

the results of the instructions, mapped to the member that generated them.

Throws:

java.util.concurrent.ExecutionException - when an error during execution occurs.

java.lang.InterruptedException - when the processes is interrupted.

getProperty

public java.lang.String getProperty(java.lang.String name)

Retrieves a distributed property.

Note that just as with accessing shared state between threads, access to properties should be synchronized across all cluster members through some sort of locking mechanism.

Specified by:

getProperty in interface ClusterManager

Parameters:

name - Name of the property.

Returns:

The value of the property, or null if it is not set.

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.Class<T> clazz)

Retrieves a distributed property.

The value of the property, if it exists, must be of the requested type. If it does not exist, or the value does match the type, null is returned.

Note that just as with accessing shared state between threads, access to properties should be synchronized across all cluster members through some sort of locking mechanism.

Specified by:

getProperty in interface ClusterManager

Type Parameters:

T - Requested value type.

Parameters:

name - Name of the property.

clazz - Required class type of the property.

Returns:

The value of the property, or null if it is not set or is not of the correct type.

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.Class<T> clazz,
                         T defaultValue)

Retrieves a distributed property.

The value of the property, if it exists, must be of the requested type. If it does not exist, or the value does match the type, the default value is returned.

Note that just as with accessing shared state between threads, access to properties should be synchronized across all cluster members through some sort of locking mechanism.

Specified by:

getProperty in interface ClusterManager

Type Parameters:

T - Requested value type.

Parameters:

name - Name of the property.

clazz - Required class type of the property.

defaultValue - Default value to return if the property isn't set or is of the wrong type.

Returns:

The value of the property, or the default value if it is not set or is not of the correct type.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets a distributed property and syncs it with all cluster members.

Note that just as with accessing shared state between threads, access to properties should be synchronized across all cluster members through some sort of locking mechanism.

Specified by:

setProperty in interface ClusterManager

Parameters:

name - Name of the property.

value - Value of the property.

getClusterConfigurationProperties

protected ClusterConfigurationProperties getClusterConfigurationProperties()

Returns the cluster configuration properties.

Returns:

The cluster configuration properties.