Package io.hekate.election

Class CandidateConfig

java.lang.Object

io.hekate.election.CandidateConfig

public class CandidateConfig
extends Object

Configuration for Candidate.

Instances of this class can be registered within the ElectionServiceFactory.

For more details about leader elections please see the documentation of the ElectionService interface.

See Also:

ElectionServiceFactory.withCandidate(CandidateConfig)

Constructor Summary

Constructors

Constructor	Description
CandidateConfig()	Default constructor.
CandidateConfig(String group)	Constructs new instance.

Method Summary

Modifier and Type	Method	Description
Candidate	getCandidate()	Returns the leader election candidate (see setCandidate(Candidate)).
String	getGroup()	Returns the election group name (see setGroup(String)).
void	setCandidate(Candidate candidate)	Sets the leader election candidate that should be notified upon group leader election results.
void	setGroup(String group)	Sets the election group name.
String	toString()
CandidateConfig	withCandidate(Candidate candidate)	Fluent-style version of setCandidate(Candidate).
CandidateConfig	withGroup(String group)	Fluent-style version of setGroup(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

CandidateConfig

public CandidateConfig()

Default constructor.

CandidateConfig

public CandidateConfig(String group)

Constructs new instance.

Parameters:

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

Method Detail

getGroup

public String getGroup()

Returns the election group name (see setGroup(String)).

Returns:

Election group name.

setGroup

public void setGroup(String group)

Sets the election group name. Can contain only alpha-numeric characters and non-repeatable dots/hyphens.

Only one candidate among all candidates that are registered with the same group name will be elected as a leader and all other candidates will remain in the follower state. If candidates are registered with different group names then they will form completely independent groups with each group having its own leader.

Value of this parameter is mandatory and must be unique across all configurations registered within the ElectionServiceFactory.

Parameters:

group - Group name (can contain only alpha-numeric characters and non-repeatable dots/hyphens).

withGroup

public CandidateConfig withGroup(String group)

Fluent-style version of setGroup(String).

Parameters:

group - Group name.

Returns:

This instance.

getCandidate

public Candidate getCandidate()

Returns the leader election candidate (see setCandidate(Candidate)).

Returns:

Leader election candidate.

setCandidate

public void setCandidate(Candidate candidate)

Sets the leader election candidate that should be notified upon group leader election results.

Parameters:

candidate - Leader election candidate.

withCandidate

public CandidateConfig withCandidate(Candidate candidate)

Fluent-style version of setCandidate(Candidate).

Parameters:

candidate - Leader election candidate.

Returns:

This instance.

toString

public String toString()

Overrides:

toString in class Object