io.atomix.protocols.raft.proxy

Class RaftProxy.Builder

java.lang.Object

io.atomix.protocols.raft.proxy.RaftProxy.Builder

All Implemented Interfaces:

io.atomix.utils.Builder<RaftProxy>

Enclosing interface:

RaftProxy

public abstract static class RaftProxy.Builder
extends Object
implements io.atomix.utils.Builder<RaftProxy>

Raft session builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RaftProxy.Builder	withCommunicationStrategy(CommunicationStrategy communicationStrategy) Sets the session's communication strategy.
RaftProxy.Builder	withExecutor(Executor executor) Sets the executor with which to complete proxy futures.
RaftProxy.Builder	withMaxRetries(int maxRetries) Sets the maximum number of retries before an operation can be failed.
RaftProxy.Builder	withMaxTimeout(Duration timeout) Sets the session timeout.
RaftProxy.Builder	withMaxTimeout(long timeoutMillis) Sets the session timeout.
RaftProxy.Builder	withMinTimeout(Duration timeout) Sets the session timeout.
RaftProxy.Builder	withMinTimeout(long timeoutMillis) Sets the session timeout.
RaftProxy.Builder	withName(String name) Sets the session name.
RaftProxy.Builder	withReadConsistency(ReadConsistency consistency) Sets the session's read consistency level.
RaftProxy.Builder	withRecoveryStrategy(RecoveryStrategy recoveryStrategy) Sets the session recovery strategy.
RaftProxy.Builder	withRetryDelay(Duration retryDelay) Sets the operation retry delay.
RaftProxy.Builder	withRetryDelay(long retryDelay, TimeUnit timeUnit) Sets the operation retry delay.
RaftProxy.Builder	withRetryDelayMillis(long retryDelayMillis) Sets the operation retry delay.
RaftProxy.Builder	withServiceType(ServiceType serviceType) Sets the service type.
RaftProxy.Builder	withServiceType(String serviceType) Sets the service type.
RaftProxy.Builder	withTimeout(Duration timeout) Deprecated.
RaftProxy.Builder	withTimeout(long timeoutMillis) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.atomix.utils.Builder

build

Constructor Detail

Builder

public Builder()

Method Detail

withName

public RaftProxy.Builder withName(String name)

Sets the session name.

Parameters:

name - The service name.

Returns:

The session builder.

withServiceType

public RaftProxy.Builder withServiceType(String serviceType)

Sets the service type.

Parameters:

serviceType - The service type.

Returns:

The session builder.

withServiceType

public RaftProxy.Builder withServiceType(ServiceType serviceType)

Sets the service type.

Parameters:

serviceType - The service type.

Returns:

The session builder.

withReadConsistency

public RaftProxy.Builder withReadConsistency(ReadConsistency consistency)

Sets the session's read consistency level.

Parameters:

consistency - the session's read consistency level

Returns:

the proxy builder

withCommunicationStrategy

public RaftProxy.Builder withCommunicationStrategy(CommunicationStrategy communicationStrategy)

Sets the session's communication strategy.

Parameters:

communicationStrategy - The session's communication strategy.

Returns:

The session builder.

Throws:

NullPointerException - if the communication strategy is null

withMaxRetries

public RaftProxy.Builder withMaxRetries(int maxRetries)

Sets the maximum number of retries before an operation can be failed.

Parameters:

maxRetries - the maximum number of retries before an operation can be failed

Returns:

the proxy builder

withRetryDelayMillis

public RaftProxy.Builder withRetryDelayMillis(long retryDelayMillis)

Sets the operation retry delay.

Parameters:

retryDelayMillis - the delay between operation retries in milliseconds

Returns:

the proxy builder

withRetryDelay

public RaftProxy.Builder withRetryDelay(long retryDelay,
                                        TimeUnit timeUnit)

Sets the operation retry delay.

Parameters:

retryDelay - the delay between operation retries

timeUnit - the delay time unit

Returns:

the proxy builder

Throws:

NullPointerException - if the time unit is null

withRetryDelay

public RaftProxy.Builder withRetryDelay(Duration retryDelay)

Sets the operation retry delay.

Parameters:

retryDelay - the delay between operation retries

Returns:

the proxy builder

Throws:

NullPointerException - if the delay is null

withRecoveryStrategy

public RaftProxy.Builder withRecoveryStrategy(RecoveryStrategy recoveryStrategy)

Sets the session recovery strategy.

Parameters:

recoveryStrategy - the session recovery strategy

Returns:

the proxy builder

Throws:

NullPointerException - if the strategy is null

withMinTimeout

public RaftProxy.Builder withMinTimeout(long timeoutMillis)

Sets the session timeout.

Parameters:

timeoutMillis - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

withMinTimeout

public RaftProxy.Builder withMinTimeout(Duration timeout)

Sets the session timeout.

Parameters:

timeout - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

NullPointerException - if the timeout is null

withTimeout

@Deprecated
public RaftProxy.Builder withTimeout(long timeoutMillis)

Deprecated.

Sets the session timeout.

Parameters:

timeoutMillis - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

withTimeout

@Deprecated
public RaftProxy.Builder withTimeout(Duration timeout)

Deprecated.

Sets the session timeout.

Parameters:

timeout - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

NullPointerException - if the timeout is null

withMaxTimeout

public RaftProxy.Builder withMaxTimeout(long timeoutMillis)

Sets the session timeout.

Parameters:

timeoutMillis - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

withMaxTimeout

public RaftProxy.Builder withMaxTimeout(Duration timeout)

Sets the session timeout.

Parameters:

timeout - The session timeout.

Returns:

The session builder.

Throws:

IllegalArgumentException - if the session timeout is not positive

NullPointerException - if the timeout is null

withExecutor

public RaftProxy.Builder withExecutor(Executor executor)

Sets the executor with which to complete proxy futures.

Parameters:

executor - The executor with which to complete proxy futures.

Returns:

The proxy builder.

Throws:

NullPointerException - if the executor is null