Package org.wildfly.clustering.singleton.service

Interface SingletonServiceBuilder<T>

All Superinterfaces:

ServiceBuilder<T>

public interface SingletonServiceBuilder<T>
extends ServiceBuilder<T>

A service builder for singleton service installation.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method	Description
SingletonServiceBuilder<T>	addListener(LifecycleListener listener)	Adds a service listener to be added to the service.
SingletonServiceController<T>	install()	Installs configured service into the container.
SingletonServiceBuilder<T>	requireQuorum(int quorum)	Defines the minimum number of members required before a singleton election will take place.
SingletonServiceBuilder<T>	setInitialMode(ServiceController.Mode mode)	Sets initial service mode.
SingletonServiceBuilder<T>	setInstance(Service service)	Sets service instance.
SingletonServiceBuilder<T>	withElectionListener(SingletonElectionListener listener)	Defines a listener to trigger following the election of a primary singleton provider.
SingletonServiceBuilder<T>	withElectionPolicy(SingletonElectionPolicy policy)	Defines the policy for electing a primary singleton provider.

Methods inherited from interface org.jboss.msc.service.ServiceBuilder

addAliases, addDependency, addMonitor, provides, requires

Method Details

install

SingletonServiceController<T> install()

Description copied from interface: ServiceBuilder

Installs configured service into the container.

Specified by:

install in interface ServiceBuilder<T>

Returns:

installed service controller

setInitialMode

SingletonServiceBuilder<T> setInitialMode(ServiceController.Mode mode)

Description copied from interface: ServiceBuilder

Sets initial service mode.

Specified by:

setInitialMode in interface ServiceBuilder<T>

Parameters:

mode - initial service mode

Returns:

this builder

setInstance

SingletonServiceBuilder<T> setInstance(Service service)

Description copied from interface: ServiceBuilder

Sets service instance. If ServiceBuilder.install() method call is issued without this method being called then NULL service will be installed into the container.

Once this method have been called then all subsequent calls of ServiceBuilder.requires(ServiceName), and ServiceBuilder.provides(ServiceName...) methods will fail because their return values should be provided to service instance.

Specified by:

setInstance in interface ServiceBuilder<T>

Parameters:

service - the service instance

Returns:

this configurator

addListener

SingletonServiceBuilder<T> addListener(LifecycleListener listener)

Description copied from interface: ServiceBuilder

Adds a service listener to be added to the service.

Specified by:

addListener in interface ServiceBuilder<T>

Parameters:

listener - the listener to add to the service

Returns:

this builder

requireQuorum

SingletonServiceBuilder<T> requireQuorum(int quorum)

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

Parameters:

quorum - the quorum required for electing a primary singleton provider

Returns:

a reference to this configurator

withElectionPolicy

SingletonServiceBuilder<T> withElectionPolicy(SingletonElectionPolicy policy)

Defines the policy for electing a primary singleton provider.

Parameters:

policy - an election policy

Returns:

a reference to this configurator

withElectionListener

SingletonServiceBuilder<T> withElectionListener(SingletonElectionListener listener)

Defines a listener to trigger following the election of a primary singleton provider.

Parameters:

listener - an election listener

Returns:

a reference to this configurator