io.atomix.protocols.raft.proxy

Class RaftProxyClient.Builder

java.lang.Object

io.atomix.protocols.raft.proxy.RaftProxyClient.Builder

All Implemented Interfaces:

io.atomix.utils.Builder<RaftProxyClient>

Enclosing interface:

RaftProxyClient

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

Raft session builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RaftProxyClient	build() Builds the proxy client.
abstract CompletableFuture<RaftProxyClient>	buildAsync() Returns a future to be completed once the proxy client has been connected.
RaftProxyClient.Builder	withCommunicationStrategy(CommunicationStrategy communicationStrategy) Sets the session's communication strategy.
RaftProxyClient.Builder	withMaxRetries(int maxRetries) Sets the maximum number of retries before an operation can be failed.
RaftProxyClient.Builder	withMaxTimeout(Duration timeout) Sets the session timeout.
RaftProxyClient.Builder	withMaxTimeout(long timeoutMillis) Sets the session timeout.
RaftProxyClient.Builder	withMinTimeout(Duration timeout) Sets the session timeout.
RaftProxyClient.Builder	withMinTimeout(long timeoutMillis) Sets the session timeout.
RaftProxyClient.Builder	withName(String name) Sets the session name.
RaftProxyClient.Builder	withReadConsistency(ReadConsistency consistency) Sets the session's read consistency level.
RaftProxyClient.Builder	withRecoveryStrategy(RecoveryStrategy recoveryStrategy) Sets the session recovery strategy.
RaftProxyClient.Builder	withRetryDelay(Duration retryDelay) Sets the operation retry delay.
RaftProxyClient.Builder	withRetryDelay(long retryDelay, TimeUnit timeUnit) Sets the operation retry delay.
RaftProxyClient.Builder	withRetryDelayMillis(long retryDelayMillis) Sets the operation retry delay.
RaftProxyClient.Builder	withServiceType(ServiceType serviceType) Sets the service type.
RaftProxyClient.Builder	withServiceType(String serviceType) Sets the service type.
RaftProxyClient.Builder	withTimeout(Duration timeout) Deprecated.
RaftProxyClient.Builder	withTimeout(long timeoutMillis) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withName

public RaftProxyClient.Builder withName(String name)

Sets the session name.

Parameters:

name - The service name.

Returns:

The session builder.

withServiceType

public RaftProxyClient.Builder withServiceType(String serviceType)

Sets the service type.

Parameters:

serviceType - The service type.

Returns:

The session builder.

withServiceType

public RaftProxyClient.Builder withServiceType(ServiceType serviceType)

Sets the service type.

Parameters:

serviceType - The service type.

Returns:

The session builder.

withReadConsistency

public RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.Builder withRetryDelayMillis(long retryDelayMillis)

Sets the operation retry delay.

Parameters:

retryDelayMillis - the delay between operation retries in milliseconds

Returns:

the proxy builder

withRetryDelay

public RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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 RaftProxyClient.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

build

public RaftProxyClient build()

Builds the proxy client.

Specified by:

build in interface io.atomix.utils.Builder<RaftProxyClient>

Returns:

the proxy client

buildAsync

public abstract CompletableFuture<RaftProxyClient> buildAsync()

Returns a future to be completed once the proxy client has been connected.

Returns:

a future to be completed once the proxy client has been connected