org.wildfly.clustering.server.singleton

Class CacheSingletonServiceBuilder<T>

java.lang.Object

org.wildfly.clustering.server.singleton.CacheSingletonServiceBuilder<T>

All Implemented Interfaces:

org.jboss.msc.service.Service<T>, org.jboss.msc.value.Value<T>, ServiceProviderRegistration.Listener, SingletonContext<T>, Builder<T>, ServiceNameProvider, Singleton, SingletonServiceBuilder<T>

public class CacheSingletonServiceBuilder<T>
extends Object
implements SingletonServiceBuilder<T>, org.jboss.msc.service.Service<T>, ServiceProviderRegistration.Listener, SingletonContext<T>, Singleton

Decorates an MSC service ensuring that it is only started on one node in the cluster at any given time.

Author:

Paul Ferraro

Field Summary

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
CacheSingletonServiceBuilder(org.jboss.msc.service.ServiceName serviceName, org.jboss.msc.service.Service<T> service, String containerName, String cacheName)

Method Summary

Modifier and Type	Method and Description
org.jboss.msc.service.ServiceBuilder<T>	build(org.jboss.msc.service.ServiceTarget target) Builds a service into the specified target.
SingletonServiceBuilder<T>	electionPolicy(SingletonElectionPolicy electionPolicy) Defines the policy for electing a singleton master.
org.jboss.msc.service.ServiceName	getServiceName() Returns the associated service name
T	getValue()
AtomicReference<T>	getValueRef()
boolean	isMaster()
void	providersChanged(Set<Node> nodes) Indicates that the set of nodes providing a given service has changed.
SingletonServiceBuilder<T>	requireQuorum(int quorum) Defines the minimum number of members required before a singleton master election will take place.
void	start()
void	start(org.jboss.msc.service.StartContext context)
void	stop()
void	stop(org.jboss.msc.service.StopContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheSingletonServiceBuilder

public CacheSingletonServiceBuilder(org.jboss.msc.service.ServiceName serviceName,
                                    org.jboss.msc.service.Service<T> service,
                                    String containerName,
                                    String cacheName)

Method Detail

getServiceName

public org.jboss.msc.service.ServiceName getServiceName()

Description copied from interface: ServiceNameProvider

Returns the associated service name

Specified by:

getServiceName in interface ServiceNameProvider

Returns:

a service name

build

public org.jboss.msc.service.ServiceBuilder<T> build(org.jboss.msc.service.ServiceTarget target)

Description copied from interface: Builder

Builds a service into the specified target.

Specified by:

build in interface Builder<T>

Parameters:

target - the service installation target

Returns:

a service builder

requireQuorum

public SingletonServiceBuilder<T> requireQuorum(int quorum)

Description copied from interface: SingletonServiceBuilder

Defines the minimum number of members required before a singleton master election will take place.

Specified by:

requireQuorum in interface SingletonServiceBuilder<T>

Parameters:

quorum - the quorum required for electing a singleton master

Returns:

a reference to this builder

electionPolicy

public SingletonServiceBuilder<T> electionPolicy(SingletonElectionPolicy electionPolicy)

Description copied from interface: SingletonServiceBuilder

Defines the policy for electing a singleton master.

Specified by:

electionPolicy in interface SingletonServiceBuilder<T>

Parameters:

electionPolicy - an election policy

Returns:

a reference to this builder

start

public void start(org.jboss.msc.service.StartContext context)

Specified by:

start in interface org.jboss.msc.service.Service<T>

stop

public void stop(org.jboss.msc.service.StopContext context)

Specified by:

stop in interface org.jboss.msc.service.Service<T>

isMaster

public boolean isMaster()

Specified by:

isMaster in interface Singleton

providersChanged

public void providersChanged(Set<Node> nodes)

Description copied from interface: ServiceProviderRegistration.Listener

Indicates that the set of nodes providing a given service has changed.

Specified by:

providersChanged in interface ServiceProviderRegistration.Listener

Parameters:

nodes - the new set of nodes providing the given service

start

public void start()

Specified by:

start in interface SingletonContext<T>

stop

public void stop()

Specified by:

stop in interface SingletonContext<T>

getValue

public T getValue()

Specified by:

getValue in interface org.jboss.msc.value.Value<T>

getValueRef

public AtomicReference<T> getValueRef()

Specified by:

getValueRef in interface SingletonContext<T>