Package io.hekate.election

Class ElectionServiceFactory

java.lang.Object

io.hekate.election.ElectionServiceFactory

All Implemented Interfaces:

ServiceFactory<ElectionService>

public class ElectionServiceFactory
extends Object
implements ServiceFactory<ElectionService>

Factory for ElectionService.

This class represents a configurable factory for ElectionService. Instances of this class can be registered within the HekateBootstrap in order to customize options of the ElectionService.

For more details about the ElectionService and its capabilities please see the documentation of ElectionService interface.

See Also:

ElectionService

Constructor Summary

Constructors

Constructor	Description
ElectionServiceFactory()

Method Summary

Modifier and Type	Method	Description
ElectionService	createService()	Constructs a new service instance based on the configuration options of this factory.
List<CandidateConfig>	getCandidates()	Returns the list of election candidate configurations that should be automatically registered during the leader election service startup (see setCandidates(List)).
List<CandidateConfigProvider>	getConfigProviders()	Returns the list of leader election configuration providers (see setConfigProviders(List)).
void	setCandidates(List<CandidateConfig> candidates)	Sets the list of election candidate configurations that should be automatically registered during the leader election service startup.
void	setConfigProviders(List<CandidateConfigProvider> configProviders)	Sets the list of leader election configuration providers.
String	toString()
ElectionServiceFactory	withCandidate(CandidateConfig candidate)	Fluent-style version of setCandidates(List).
CandidateConfig	withCandidate(String group)	Fluent-style shortcut to register a new CandidateConfig with the specified group.
ElectionServiceFactory	withConfigProvider(CandidateConfigProvider configProvider)	Fluent-style version of setConfigProviders(List).

Methods inherited from class java.lang.Object

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

Constructor Detail

ElectionServiceFactory

public ElectionServiceFactory()

Method Detail

getCandidates

public List<CandidateConfig> getCandidates()

Returns the list of election candidate configurations that should be automatically registered during the leader election service startup (see setCandidates(List)).

Returns:

List of election candidate configurations.

setCandidates

public void setCandidates(List<CandidateConfig> candidates)

Sets the list of election candidate configurations that should be automatically registered during the leader election service startup.

Parameters:

candidates - Election candidate configurations.

withCandidate

public ElectionServiceFactory withCandidate(CandidateConfig candidate)

Fluent-style version of setCandidates(List).

Parameters:

candidate - Election candidate configurations.

Returns:

This instance.

withCandidate

public CandidateConfig withCandidate(String group)

Fluent-style shortcut to register a new CandidateConfig with the specified group.

Parameters:

group - Group name (see CandidateConfig.setGroup(String)).

Returns:

New configuration.

getConfigProviders

public List<CandidateConfigProvider> getConfigProviders()

Returns the list of leader election configuration providers (see setConfigProviders(List)).

Returns:

Leader election configuration providers.

setConfigProviders

public void setConfigProviders(List<CandidateConfigProvider> configProviders)

Sets the list of leader election configuration providers.

Parameters:

configProviders - Leader election configuration providers.

See Also:

CandidateConfigProvider

withConfigProvider

public ElectionServiceFactory withConfigProvider(CandidateConfigProvider configProvider)

Fluent-style version of setConfigProviders(List).

Parameters:

configProvider - Leader election configuration provider.

Returns:

This instance.

createService

public ElectionService createService()

Description copied from interface: ServiceFactory

Constructs a new service instance based on the configuration options of this factory.

Specified by:

createService in interface ServiceFactory<ElectionService>

Returns:

New service instance.

toString

public String toString()

Overrides:

toString in class Object