java.lang.Object
- io.hekate.coordinate.CoordinationServiceFactory

All Implemented Interfaces:

ServiceFactory<CoordinationService>
```
public class CoordinationServiceFactory
extends Object
implements ServiceFactory<CoordinationService>
```
Factory for CoordinationService.
This class represents a configurable factory for CoordinationService. Instances of this class can be registered within the HekateBootstrap in order to customize options of the CoordinationService.

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

See Also:

CoordinationService

Field Summary

Fields
Modifier and Type	Field	Description
`static long`	`DEFAULT_IDLE_SOCKET_TIMEOUT`	Default value in milliseconds (=60000L) for `setIdleSocketTimeout(long)`.
`static int`	`DEFAULT_RETRY_INTERVAL`	Default value in milliseconds (=50) for `setRetryInterval(long)`.

Constructor Summary

Constructors
Constructor Description

CoordinationServiceFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CoordinationService`	`createService()`	Constructs a new service instance based on the configuration options of this factory.
`List<CoordinationConfigProvider>`	`getConfigProviders()`	Returns the list of coordination process configuration providers (see `setConfigProviders(List)`).
`long`	`getIdleSocketTimeout()`	Returns the idle socket timeout in milliseconds (see `setIdleSocketTimeout(long)`).
`int`	`getNioThreads()`	Returns the size of a thread pool for handling NIO-based socket connections.
`List<CoordinationProcessConfig>`	`getProcesses()`	Returns the list of coordination process configurations that should be automatically registered during the coordination service startup (see `setProcesses(List)`).
`long`	`getRetryInterval()`	Returns the time interval in milliseconds between retry attempts in case of network communication failures (see `setRetryInterval(long)`).
`void`	`setConfigProviders(List<CoordinationConfigProvider> configProviders)`	Sets the list of coordination process configuration providers.
`void`	`setIdleSocketTimeout(long idleSocketTimeout)`	Sets idle socket timeout in milliseconds.
`void`	`setNioThreads(int nioThreads)`	Sets the size of a thread pool for handling NIO-based socket connections.
`void`	`setProcesses(List<CoordinationProcessConfig> processes)`	Sets the list of coordination process configurations that should be automatically registered during the coordination service startup.
`void`	`setRetryInterval(long retryInterval)`	Sets the time interval in milliseconds between retry attempts in case of network communication failures.
`CoordinationServiceFactory`	`withConfigProvider(CoordinationConfigProvider configProvider)`	Fluent-style version of `setConfigProviders(List)`.
`CoordinationServiceFactory`	`withIdleSocketTimeout(long idleTimeout)`	Fluent-style version of `setIdleSocketTimeout(long)`.
`CoordinationServiceFactory`	`withNioThreads(int nioThreads)`	Fluent-style version of `setNioThreads(int)`.
`CoordinationServiceFactory`	`withProcess(CoordinationProcessConfig process)`	Fluent-style version of `setProcesses(List)`.
`CoordinationProcessConfig`	`withProcess(String name)`	Fluent-style shortcut to register a new `CoordinationProcessConfig` with the specified `name`.
`CoordinationServiceFactory`	`withRetryInterval(long retryInterval)`	Fluent-style version of `setRetryInterval(long)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_RETRY_INTERVAL
```
public static final int DEFAULT_RETRY_INTERVAL
```
    Default value in milliseconds (=50) for setRetryInterval(long).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IDLE_SOCKET_TIMEOUT
```
public static final long DEFAULT_IDLE_SOCKET_TIMEOUT
```
    Default value in milliseconds (=60000L) for setIdleSocketTimeout(long).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CoordinationServiceFactory
```
public CoordinationServiceFactory()
```
- Method Detail
  - getNioThreads
```
public int getNioThreads()
```
    Returns the size of a thread pool for handling NIO-based socket connections.
    
    Returns:
    
    Size of a thread pool for handling NIO-based socket connections.
  - setNioThreads
```
public void setNioThreads(int nioThreads)
```
    Sets the size of a thread pool for handling NIO-based socket connections.
    If this parameter is less than or equals to zero (default value) then this channel will use the core thread pool of NetworkService (see NetworkServiceFactory.setNioThreads(int)).
    
    Parameters:
    
    nioThreads - Size of a thread pool for handling NIO-based socket connections.
  - withNioThreads
```
public CoordinationServiceFactory withNioThreads(int nioThreads)
```
    Fluent-style version of setNioThreads(int).
    
    Parameters:
    
    nioThreads - Size of a thread pool for handling NIO-based socket connections.
    
    Returns:
    
    This instance.
  - getRetryInterval
```
public long getRetryInterval()
```
    Returns the time interval in milliseconds between retry attempts in case of network communication failures (see setRetryInterval(long)).
    
    Returns:
    
    Time interval in milliseconds.
  - setRetryInterval
```
public void setRetryInterval(long retryInterval)
```
    Sets the time interval in milliseconds between retry attempts in case of network communication failures.
    Value of this parameter must be above zero. Default value is 50.
    
    Parameters:
    
    retryInterval - Time interval in milliseconds.
  - withRetryInterval
```
public CoordinationServiceFactory withRetryInterval(long retryInterval)
```
    Fluent-style version of setRetryInterval(long).
    
    Parameters:
    
    retryInterval - Time interval in milliseconds.
    
    Returns:
    
    This instance.
  - getProcesses
```
public List<CoordinationProcessConfig> getProcesses()
```
    Returns the list of coordination process configurations that should be automatically registered during the coordination service startup (see setProcesses(List)).
    
    Returns:
    
    Coordination processes configuration.
  - setProcesses
```
public void setProcesses(List<CoordinationProcessConfig> processes)
```
    Sets the list of coordination process configurations that should be automatically registered during the coordination service startup.
    
    Parameters:
    
    processes - Coordination processes configuration..
  - withProcess
```
public CoordinationServiceFactory withProcess(CoordinationProcessConfig process)
```
    Fluent-style version of setProcesses(List).
    
    Parameters:
    
    process - Coordination process configuration.
    
    Returns:
    
    This instance.
  - withProcess
```
public CoordinationProcessConfig withProcess(String name)
```
    Fluent-style shortcut to register a new CoordinationProcessConfig with the specified name.
    
    Parameters:
    
    name - Process name (see CoordinationProcessConfig.setName(String)).
    
    Returns:
    
    New coordination process configuration.
  - getConfigProviders
```
public List<CoordinationConfigProvider> getConfigProviders()
```
    Returns the list of coordination process configuration providers (see setConfigProviders(List)).
    
    Returns:
    
    Coordination process configuration providers.
  - setConfigProviders
```
public void setConfigProviders(List<CoordinationConfigProvider> configProviders)
```
    Sets the list of coordination process configuration providers.
    
    Parameters:
    
    configProviders - Coordination process configuration providers.
    
    See Also:
    
    CoordinationConfigProvider
  - withConfigProvider
```
public CoordinationServiceFactory withConfigProvider(CoordinationConfigProvider configProvider)
```
    Fluent-style version of setConfigProviders(List).
    
    Parameters:
    
    configProvider - Coordination process configuration provider.
    
    Returns:
    
    This instance.
  - getIdleSocketTimeout
```
public long getIdleSocketTimeout()
```
    Returns the idle socket timeout in milliseconds (see setIdleSocketTimeout(long)).
    
    Returns:
    
    Idle socket timeout in milliseconds.
  - setIdleSocketTimeout
```
public void setIdleSocketTimeout(long idleSocketTimeout)
```
    Sets idle socket timeout in milliseconds.
    If there were no communication with some remote node for the duration of this time interval then all sockets connections with such node will be closed in order to save system resource. Connections will be automatically reestablish on the next attempt to send a message to that node.
    
    If value of this parameter is less than or equals to zero then connections will not be closed while remote node stays alive.
    
    Default value of this parameter is 60000L.
    
    Parameters:
    
    idleSocketTimeout - Timeout in milliseconds.
  - withIdleSocketTimeout
```
public CoordinationServiceFactory withIdleSocketTimeout(long idleTimeout)
```
    Fluent-style version of setIdleSocketTimeout(long).
    
    Parameters:
    
    idleTimeout - Timeout in milliseconds.
    
    Returns:
    
    This instance.
  - createService
```
public CoordinationService 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<CoordinationService>
    
    Returns:
    
    New service instance.

Class CoordinationServiceFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_RETRY_INTERVAL

DEFAULT_IDLE_SOCKET_TIMEOUT

Constructor Detail

CoordinationServiceFactory

Method Detail

getNioThreads

setNioThreads

withNioThreads

getRetryInterval

setRetryInterval

withRetryInterval

getProcesses

setProcesses

withProcess

withProcess

getConfigProviders

setConfigProviders

withConfigProvider

getIdleSocketTimeout

setIdleSocketTimeout

withIdleSocketTimeout

createService