Package org.jppf.load.balancer.persistence

Class LoadBalancerPersistenceManager

java.lang.Object

org.jppf.load.balancer.persistence.LoadBalancerPersistenceManager

All Implemented Interfaces:

LoadBalancerPersistenceManagement, LoadBalancerPersistenceManagerMBean

public class LoadBalancerPersistenceManager
extends Object
implements LoadBalancerPersistenceManagerMBean

This class is a common facade to the load-balancer persistence for both drivers and clients. It is also a common implementation of the load-balancer persistence's management interface.

Since:

6.0

Author:

Laurent Cohen

Field Summary

Fields inherited from interface org.jppf.load.balancer.persistence.LoadBalancerPersistenceManagerMBean

MBEAN_NAME

Constructor Summary

Constructors

Constructor	Description
LoadBalancerPersistenceManager(JPPFBundlerFactory factory)	Intiialize with the specified bundler factory.

Method Summary

Modifier and Type	Method	Description
void	delete(String channelID, String algorithm)	Delete the specified algorithm state from the specified channel.
void	deleteAlgorithm(String algorithm)	Delete the specified algorithm state from all the channels that have it.
void	deleteAll()	Delete all entries in the persistece store.
void	deleteChannel(String channelID)	Delete all entries for the specified channel.
JPPFBundlerFactory	getFactory()
int	getUncompletedOperations()	Get the number of persistence operations, including load, store, delete and list, that have started but not yet completed.
boolean	hasAlgorithm(String channelID, String algorithm)	Determine whether the specified channel has an entry for the specified algorithm in the persistence store.
boolean	isPersistenceEnabled()
List<String>	listAlgorithms(String channelID)	List all the algorithms for which the specified channel has an entry in the persistence store.
List<String>	listAllChannels()	List all the channels that have an entry in the persistence store.
List<String>	listAllChannelsWithAlgorithm(String algorithm)	List all the channels that have an entry in the persistence store for the specified algorithm.
Pair<String,Bundler<?>>	loadBundler(Pair<String,String> channelId)	Load the bundler state for the specified node, with the currently configured algorithm.
void	storeBundler(Pair<String,String> channelId, Bundler<?> bundler, String algorithm)	Store the specified bundler's state for the specified channel, with the currently configured algorithm.

Methods inherited from class java.lang.Object

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

Constructor Details

LoadBalancerPersistenceManager

public LoadBalancerPersistenceManager(JPPFBundlerFactory factory)

Intiialize with the specified bundler factory.

Parameters:

factory - the load-balancer factory.

Method Details

isPersistenceEnabled

public boolean isPersistenceEnabled()

Specified by:

isPersistenceEnabled in interface LoadBalancerPersistenceManagement

Returns:

true if load-balancer persistence is enabled, false otherwise.

loadBundler

public Pair<String,Bundler<?>> loadBundler(Pair<String,String> channelId)

Load the bundler state for the specified node, with the currently configured algorithm.

Parameters:

channelId - identifier of the channel for which to load the load-balancer state.

Returns:

a Bundler instance.

storeBundler

public void storeBundler(Pair<String,String> channelId,
 Bundler<?> bundler,
 String algorithm)

Store the specified bundler's state for the specified channel, with the currently configured algorithm.

Parameters:

channelId - identifier of the channel for which to store the bundler state.

bundler - the load-balancer whose state to save.

algorithm - the bundler's algorithm.

listAllChannels

public List<String> listAllChannels()
                             throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

List all the channels that have an entry in the persistence store.

Specified by:

listAllChannels in interface LoadBalancerPersistenceManagement

Returns:

a list of channel identifiers, possibly empty, but never null.

Throws:

LoadBalancerPersistenceException - if any error occurs.

listAlgorithms

public List<String> listAlgorithms(String channelID)
                            throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

List all the algorithms for which the specified channel has an entry in the persistence store.

Specified by:

listAlgorithms in interface LoadBalancerPersistenceManagement

Parameters:

channelID - the identifier of the channel for which to list the algorithms.

Returns:

a list of algorithm names, possibly empty, but never null.

Throws:

LoadBalancerPersistenceException - if any error occurs.

listAllChannelsWithAlgorithm

public List<String> listAllChannelsWithAlgorithm(String algorithm)
                                          throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

List all the channels that have an entry in the persistence store for the specified algorithm.

Specified by:

listAllChannelsWithAlgorithm in interface LoadBalancerPersistenceManagement

Parameters:

algorithm - the name of the algorithm to lookup.

Returns:

a list of node identifiers, possibly empty, but never null.

Throws:

LoadBalancerPersistenceException - if any error occurs.

hasAlgorithm

public boolean hasAlgorithm(String channelID,
 String algorithm)
                     throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

Determine whether the specified channel has an entry for the specified algorithm in the persistence store.

Specified by:

hasAlgorithm in interface LoadBalancerPersistenceManagement

Parameters:

channelID - the identifier of the channel to check.

algorithm - the name of the algorithm to lookup.

Returns:

true if the node has an entry for the algorithm, false otherwise.

Throws:

LoadBalancerPersistenceException - if any error occurs.

deleteAll

public void deleteAll()
               throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

Delete all entries in the persistece store.

Specified by:

deleteAll in interface LoadBalancerPersistenceManagement

Throws:

LoadBalancerPersistenceException - if any error occurs.

deleteChannel

public void deleteChannel(String channelID)
                   throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

Delete all entries for the specified channel.

Specified by:

deleteChannel in interface LoadBalancerPersistenceManagement

Parameters:

channelID - identifier of the channel to delete.

Throws:

LoadBalancerPersistenceException - if any error occurs.

deleteAlgorithm

public void deleteAlgorithm(String algorithm)
                     throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

Delete the specified algorithm state from all the channels that have it.

Specified by:

deleteAlgorithm in interface LoadBalancerPersistenceManagement

Parameters:

algorithm - the name of the algorithm to delete.

Throws:

LoadBalancerPersistenceException - if any error occurs.

delete

public void delete(String channelID,
 String algorithm)
            throws LoadBalancerPersistenceException

Description copied from interface: LoadBalancerPersistenceManagement

Delete the specified algorithm state from the specified channel.

Specified by:

delete in interface LoadBalancerPersistenceManagement

Parameters:

channelID - identifier of the channel from which to delete the algorithm state.

algorithm - the name of the algorithm to delete.

Throws:

LoadBalancerPersistenceException - if any error occurs.

getFactory

public JPPFBundlerFactory getFactory()

Returns:

the load-balancer factory.

getUncompletedOperations

public int getUncompletedOperations()

Description copied from interface: LoadBalancerPersistenceManagement

Get the number of persistence operations, including load, store, delete and list, that have started but not yet completed.

Specified by:

getUncompletedOperations in interface LoadBalancerPersistenceManagement

Returns:

the number of uncompleted operations.