hera.client

Class AergoClientBuilder

java.lang.Object

hera.client.AergoClientBuilder

All Implemented Interfaces:

ClientConfiguer<AergoClientBuilder>

@ApiAudience.Public
 @ApiStability.Unstable
public class AergoClientBuilder
extends java.lang.Object
implements ClientConfiguer<AergoClientBuilder>

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration
protected org.slf4j.Logger	logger
protected static java.util.Map<java.lang.Class<?>,Strategy>	necessaryStrategyMap
static java.lang.String	SCOPE
protected java.util.Map<java.lang.Class<?>,Strategy>	strategyMap

Constructor Summary

Constructors

Constructor and Description
AergoClientBuilder()

Method Summary

Modifier and Type	Method and Description
AergoClientBuilder	addConfiguration(java.lang.String key, java.lang.String value) Add a configuration with key and value.
AergoClient	build() Build AergoClient with the current context.
protected Context	buildContext()
AergoClientBuilder	withBlockingConnect() Use blocking connection.
AergoClientBuilder	withEndpoint(java.lang.String endpoint) Provide an endpoint of aergo server.
AergoClientBuilder	withNonBlockingConnect() Use non-blocking connection.
AergoClientBuilder	withPlainText() Use plain text on connection.
AergoClientBuilder	withRetry(int count, long interval, java.util.concurrent.TimeUnit unit) If fails with non-connection error, after interval count times.
AergoClientBuilder	withTimeout(long timeout, java.util.concurrent.TimeUnit unit) Set timeout for each request.
AergoClientBuilder	withTransportSecurity(java.lang.String serverCommonName, java.io.InputStream serverCertInputStream, java.io.InputStream clientCertInputStream, java.io.InputStream clientKeyInputStream) Use transport security on connection.
AergoClientBuilder	withTransportSecurity(java.lang.String serverCommonName, java.lang.String serverCertPath, java.lang.String clientCertPath, java.lang.String clientKeyPath) Use transport security on connection.

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE

public static final java.lang.String SCOPE

See Also:

Constant Field Values

necessaryStrategyMap

protected static final java.util.Map<java.lang.Class<?>,Strategy> necessaryStrategyMap

logger

protected final org.slf4j.Logger logger

strategyMap

protected final java.util.Map<java.lang.Class<?>,Strategy> strategyMap

configuration

protected Configuration configuration

Constructor Detail

AergoClientBuilder

public AergoClientBuilder()

Method Detail

addConfiguration

public AergoClientBuilder addConfiguration(java.lang.String key,
                                           java.lang.String value)

Description copied from interface: ClientConfiguer

Add a configuration with key and value.

Specified by:

addConfiguration in interface ClientConfiguer<AergoClientBuilder>

Parameters:

key - a key

value - a value

Returns:

an instance of this

withEndpoint

public AergoClientBuilder withEndpoint(java.lang.String endpoint)

Description copied from interface: ClientConfiguer

Provide an endpoint of aergo server. eg. localhost:7845

Specified by:

withEndpoint in interface ClientConfiguer<AergoClientBuilder>

Parameters:

endpoint - aergo chain server endpoint

Returns:

an instance of this

withNonBlockingConnect

public AergoClientBuilder withNonBlockingConnect()

Description copied from interface: ClientConfiguer

Use non-blocking connection. If other ConnectStrategy is already set, that will be overridden.

Specified by:

withNonBlockingConnect in interface ClientConfiguer<AergoClientBuilder>

Returns:

an instance of this

withBlockingConnect

public AergoClientBuilder withBlockingConnect()

Description copied from interface: ClientConfiguer

Use blocking connection. If other ConnectStrategy is already set, that will be overridden. This method works for jdk 1.7 or higher.

Specified by:

withBlockingConnect in interface ClientConfiguer<AergoClientBuilder>

Returns:

an instance of this

withTimeout

public AergoClientBuilder withTimeout(long timeout,
                                      java.util.concurrent.TimeUnit unit)

Description copied from interface: ClientConfiguer

Set timeout for each request. If timeout is already set, that will be overridden.

Specified by:

withTimeout in interface ClientConfiguer<AergoClientBuilder>

Parameters:

timeout - time to time out

unit - time's unit

Returns:

an instance of this

withRetry

public AergoClientBuilder withRetry(int count,
                                    long interval,
                                    java.util.concurrent.TimeUnit unit)

Description copied from interface: ClientConfiguer

If fails with non-connection error, after interval count times. Default retry count : 0, default retry interval : 5000 milliseconds.

Specified by:

withRetry in interface ClientConfiguer<AergoClientBuilder>

Parameters:

count - retry count. If it is less than 0, set as 0

interval - interval value. If it's less than 0, set as 0

unit - interval unit

Returns:

an instance of this

withPlainText

public AergoClientBuilder withPlainText()

Description copied from interface: ClientConfiguer

Use plain text on connection.

Specified by:

withPlainText in interface ClientConfiguer<AergoClientBuilder>

Returns:

an instance of this

withTransportSecurity

public AergoClientBuilder withTransportSecurity(java.lang.String serverCommonName,
                                                java.lang.String serverCertPath,
                                                java.lang.String clientCertPath,
                                                java.lang.String clientKeyPath)

Description copied from interface: ClientConfiguer

Use transport security on connection.

Specified by:

withTransportSecurity in interface ClientConfiguer<AergoClientBuilder>

Parameters:

serverCommonName - a server common name

serverCertPath - a server certification path

clientCertPath - a client certification path

clientKeyPath - a client key path. Must be PKCS#8 format

Returns:

an instance of this

withTransportSecurity

public AergoClientBuilder withTransportSecurity(java.lang.String serverCommonName,
                                                java.io.InputStream serverCertInputStream,
                                                java.io.InputStream clientCertInputStream,
                                                java.io.InputStream clientKeyInputStream)

Description copied from interface: ClientConfiguer

Use transport security on connection.

Specified by:

withTransportSecurity in interface ClientConfiguer<AergoClientBuilder>

Parameters:

serverCommonName - a server common name

serverCertInputStream - a server certification stream

clientCertInputStream - a client certification stream

clientKeyInputStream - a client key stream. Must be PKCS#8 format

Returns:

an instance of this

build

public AergoClient build()

Build AergoClient with the current context. If necessary strategy is not provided,fill necessary strategy.

Returns:

AergoClient

buildContext

protected Context buildContext()