Package io.hekate.coordinate

Class CoordinationProcessConfig

java.lang.Object

io.hekate.coordinate.CoordinationProcessConfig

public class CoordinationProcessConfig
extends Object

Configuration for CoordinationProcess.

Instances of this class can be registered via CoordinationServiceFactory.setProcesses(List) method.

See Also:

CoordinationService

Constructor Summary

Constructors

Constructor	Description
CoordinationProcessConfig()	Default constructor.
CoordinationProcessConfig(String name)	Constructs new instance.

Method Summary

Modifier and Type	Method	Description
CoordinationHandler	getHandler()	Returns the coordination process handler (see setHandler(CoordinationHandler)).
CodecFactory<Object>	getMessageCodec()	Returns the codec that should be used for messages serialization (see setMessageCodec(CodecFactory)).
String	getName()	Returns the coordination process name (see setName(String)).
boolean	isAsyncInit()	Returns the flag that controls the timing of initial coordination (see setAsyncInit(boolean)).
void	setAsyncInit(boolean asyncInit)	Sets the flag that controls the timing of initial coordination.
void	setHandler(CoordinationHandler handler)	Sets the coordination process handler.
void	setMessageCodec(CodecFactory<Object> messageCodec)	Sets the codec that should be used for messages serialization.
void	setName(String name)	Sets the coordination process name.
String	toString()
CoordinationProcessConfig	withAsyncInit(boolean asyncInit)	Fluent-style version of setAsyncInit(boolean).
CoordinationProcessConfig	withHandler(CoordinationHandler handler)	Fluent-style version of setHandler(CoordinationHandler).
CoordinationProcessConfig	withMessageCodec(CodecFactory<Object> messageCodec)	Fluent-style version of setMessageCodec(CodecFactory).
CoordinationProcessConfig	withName(String name)	Fluent-style version of setName(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinationProcessConfig

public CoordinationProcessConfig()

Default constructor.

CoordinationProcessConfig

public CoordinationProcessConfig(String name)

Constructs new instance.

Parameters:

name - Process name (see setName(String)).

Method Detail

getName

public String getName()

Returns the coordination process name (see setName(String)).

Returns:

Coordination process name.

setName

public void setName(String name)

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

This name must be the same on all of the cluster nodes that participate in this coordination process.

Parameters:

name - Process name.

See Also:

CoordinationService.process(String)

withName

public CoordinationProcessConfig withName(String name)

Fluent-style version of setName(String).

Parameters:

name - Process name.

Returns:

This instance.

isAsyncInit

public boolean isAsyncInit()

Returns the flag that controls the timing of initial coordination (see setAsyncInit(boolean)).

Returns:

true if Hekate.join() will be blocked until the initial coordination is complete.

setAsyncInit

public void setAsyncInit(boolean asyncInit)

Sets the flag that controls the timing of initial coordination.

• If set to true then initial coordination will be performed asynchronously and will not block Hekate.join()
• If set to false then Hekate.join() will be blocked until the initial coordination is complete

Default value of this parameter is true (i.e. Hekate.join() will not wait for the initial coordination).

Parameters:

asyncInit - true to block Hekate.join() until initial coordination is complete.

withAsyncInit

public CoordinationProcessConfig withAsyncInit(boolean asyncInit)

Fluent-style version of setAsyncInit(boolean).

Parameters:

asyncInit - true to block Hekate.join() until initial coordination is complete.

Returns:

This instance.

getHandler

public CoordinationHandler getHandler()

Returns the coordination process handler (see setHandler(CoordinationHandler)).

Returns:

Coordination handler.

setHandler

public void setHandler(CoordinationHandler handler)

Sets the coordination process handler.

Parameters:

handler - Coordination process handler.

withHandler

public CoordinationProcessConfig withHandler(CoordinationHandler handler)

Fluent-style version of setHandler(CoordinationHandler).

Parameters:

handler - Coordination process handler.

Returns:

This instance.

getMessageCodec

public CodecFactory<Object> getMessageCodec()

Returns the codec that should be used for messages serialization (see setMessageCodec(CodecFactory)).

Returns:

Codec.

setMessageCodec

public void setMessageCodec(CodecFactory<Object> messageCodec)

Sets the codec that should be used for messages serialization.

This parameter is optional and if not specified then default codec will be used.

Parameters:

messageCodec - Codec.

withMessageCodec

public CoordinationProcessConfig withMessageCodec(CodecFactory<Object> messageCodec)

Fluent-style version of setMessageCodec(CodecFactory).

Parameters:

messageCodec - Codec.

Returns:

This instance.

toString

public String toString()

Overrides:

toString in class Object