com.cisco.oss.foundation.cluster.registry

Enum MasterSlaveRegistry

java.lang.Object

java.lang.Enum<MasterSlaveRegistry>

com.cisco.oss.foundation.cluster.registry.MasterSlaveRegistry

All Implemented Interfaces:

Serializable, Comparable<MasterSlaveRegistry>

public enum MasterSlaveRegistry
extends Enum<MasterSlaveRegistry>

Register your #MasterSlaveListener instances with this class. It is an enum and you access its method via the #INSTANCE member Created by Yair Ogen (yaogen) on 14/01/2016.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	addMasterSlaveListener(String jobName, MasterSlaveListener masterSlaveListener) starts a new thread to control master/slave state.
boolean	isAlive(String jobName)
boolean	removeMasterSlaveListener(String jobName) remove a listener and stop its thread.
static MasterSlaveRegistry	valueOf(String name) Returns the enum constant of this type with the specified name.
static MasterSlaveRegistry[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final MasterSlaveRegistry INSTANCE

Method Detail

values

public static MasterSlaveRegistry[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MasterSlaveRegistry c : MasterSlaveRegistry.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MasterSlaveRegistry valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

addMasterSlaveListener

public void addMasterSlaveListener(String jobName,
                                   MasterSlaveListener masterSlaveListener)

starts a new thread to control master/slave state. this method is idempotent and if you call it over and over with the same jobName - nothing will happen

Parameters:

jobName - - logical jobName of the work unit. you can call this method multiple times with different jobNames and listener and each unique call will create a new thread

masterSlaveListener - - the listener you implement to get callbacks

isAlive

public boolean isAlive(String jobName)

Parameters:

jobName - - the jobName

Returns:

true if there is a thread associated with this jobName and it is alive

removeMasterSlaveListener

public boolean removeMasterSlaveListener(String jobName)

remove a listener and stop its thread. calling this method will revert the work done in the #addMasterSlaveListener method

Parameters:

jobName - logical jobName of the work unit

Returns:

true if successful. will return false if this method was called without a prior listener being added to the registry or if this moethod is called more than once.