Package io.hekate.cluster.seed.jclouds

Class CloudStoreSeedNodeProvider

java.lang.Object

io.hekate.cluster.seed.jclouds.CloudStoreSeedNodeProvider

All Implemented Interfaces:

SeedNodeProvider, ConfigReportSupport

public class CloudStoreSeedNodeProvider
extends Object
implements SeedNodeProvider, ConfigReportSupport

Cloud store-based implementation of SeedNodeProvider interface.

This provider uses a cloud storage (f.e. Amazon S3) to keep track of active seed nodes.

When provider starts discovering other nodes it uses BlobStore to creates a new empty blob whose name contains local node's host address and port. Such blob is stored in a configurable container (aka bucket) under /[namepsace]/ folder. In order to find other seed nodes it reads the list of all blobs in that folder and parses addresses from their names.

Please see the documentation of CloudStoreSeedNodeProviderConfig class for details about the available configuration options.

See Also:

ClusterServiceFactory.setSeedNodeProvider(SeedNodeProvider), SeedNodeProvider

Constructor Summary

Constructors

Constructor	Description
CloudStoreSeedNodeProvider(CloudStoreSeedNodeProviderConfig cfg)	Constructs new instance.

Method Summary

Modifier and Type	Method	Description
long	cleanupInterval()	Returns the time interval in milliseconds for the cluster service to perform the stale data cleaning.
String	container()	Cloud store container.
List<InetSocketAddress>	findSeedNodes(String namespace)	Returns the list of known seed node addresses.
Properties	properties()	Cloud store provider properties.
String	provider()	Cloud store provider.
void	registerRemote(String namespace, InetSocketAddress node)	Registered the specified addresses within this provider.
void	report(ConfigReporter report)	Report configuration.
void	startDiscovery(String namespace, InetSocketAddress node)	Registers the local node address and starts this provider.
void	stopDiscovery(String namespace, InetSocketAddress node)	Unregisters the local node address and stops this provider.
void	suspendDiscovery()	Suspends discovery activities.
String	toString()
void	unregisterRemote(String namespace, InetSocketAddress node)	Unregisters the specified address from this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudStoreSeedNodeProvider

public CloudStoreSeedNodeProvider(CloudStoreSeedNodeProviderConfig cfg)

Constructs new instance.

Parameters:

cfg - Configuration.

Method Detail

report

public void report(ConfigReporter report)

Description copied from interface: ConfigReportSupport

Report configuration.

Specified by:

report in interface ConfigReportSupport

Parameters:

report - Reporter.

provider

public String provider()

Cloud store provider.

Returns:

Cloud store provider.

See Also:

CloudStoreSeedNodeProviderConfig.setProvider(String)

container

public String container()

Cloud store container.

Returns:

Cloud store container.

See Also:

CloudStoreSeedNodeProviderConfig.setContainer(String)

properties

public Properties properties()

Cloud store provider properties.

Returns:

Cloud provider properties.

See Also:

CloudStoreSeedNodeProviderConfig.setProperties(Properties)

startDiscovery

public void startDiscovery(String namespace,
                           InetSocketAddress node)
                    throws HekateException

Description copied from interface: SeedNodeProvider

Registers the local node address and starts this provider.

Specified by:

startDiscovery in interface SeedNodeProvider

Parameters:

namespace - Cluster namespace (see ClusterServiceFactory.setNamespace(String)).

node - Local node address.

Throws:

HekateException - If failed to start discovery due to the system failure.

stopDiscovery

public void stopDiscovery(String namespace,
                          InetSocketAddress node)
                   throws HekateException

Description copied from interface: SeedNodeProvider

Unregisters the local node address and stops this provider.

Specified by:

stopDiscovery in interface SeedNodeProvider

Parameters:

namespace - Cluster namespace (see ClusterServiceFactory.setNamespace(String)).

node - Local node address.

Throws:

HekateException - If failed to stop discovery due to the system failure.

findSeedNodes

public List<InetSocketAddress> findSeedNodes(String namespace)
                                      throws HekateException

Description copied from interface: SeedNodeProvider

Returns the list of known seed node addresses.

Specified by:

findSeedNodes in interface SeedNodeProvider

Parameters:

namespace - Cluster namespace (see ClusterServiceFactory.setNamespace(String)).

Returns:

List of known seed node addresses.

Throws:

HekateException - if failed to provide seed node addresses information due to the system failure.

registerRemote

public void registerRemote(String namespace,
                           InetSocketAddress node)
                    throws HekateException

Description copied from interface: SeedNodeProvider

Registered the specified addresses within this provider.

This method is the part of a stale data cleanup activity and is performed by the cluster service if it detects that particular node is within its cluster topology but is not registered within this provider (i.e. not returned from SeedNodeProvider.findSeedNodes(String) method).

Specified by:

registerRemote in interface SeedNodeProvider

Parameters:

namespace - Cluster namespace (see ClusterServiceFactory.setNamespace(String)).

node - Node address that should be registered.

Throws:

HekateException - If node couldn't be registered due to the system failure.

unregisterRemote

public void unregisterRemote(String namespace,
                             InetSocketAddress node)
                      throws HekateException

Description copied from interface: SeedNodeProvider

Unregisters the specified address from this provider.

This method is the part of a stale data cleanup activity and is called by the cluster service if it detects that there is no cluster node running at the specified address while this address is still registered within this provider (i.e. is returned from SeedNodeProvider.findSeedNodes(String) method).

Specified by:

unregisterRemote in interface SeedNodeProvider

Parameters:

namespace - Cluster namespace (see ClusterServiceFactory.setNamespace(String)).

node - Node address that should be unregistered.

Throws:

HekateException - If node couldn't be unregistered due to the system failure.

suspendDiscovery

public void suspendDiscovery()
                      throws HekateException

Description copied from interface: SeedNodeProvider

Suspends discovery activities.

Specified by:

suspendDiscovery in interface SeedNodeProvider

Throws:

HekateException - If failed to suspend discovery activities due to some system failure.

cleanupInterval

public long cleanupInterval()

Description copied from interface: SeedNodeProvider

Returns the time interval in milliseconds for the cluster service to perform the stale data cleaning. If the returned value if less than or equals to zero then stale data cleaning will be disabled.

Specified by:

cleanupInterval in interface SeedNodeProvider

Returns:

Time interval in milliseconds.

toString

public String toString()

Overrides:

toString in class Object