io.orchestrate.client

Class OrchestrateClient.Builder

java.lang.Object

io.orchestrate.client.OrchestrateClient.Builder

Enclosing class:

OrchestrateClient

public static final class OrchestrateClient.Builder
extends java.lang.Object

Builder used to create Client instances.

Usage:

 Client client = OrchestrateClient.builder("your api key")
         .host("https://api.orchestrate.io")  // optional
         .port(80)           // optional
         .poolSize(Runtime.getRuntime().availableProcessors()) // optional
         .maxPoolSize(15)    // optional
         .build();
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_HOST The default host for the Orchestrate.io service.
static int	DEFAULT_PORT The default port for the Orchestrate.io service.

Method Summary

Methods

Modifier and Type	Method and Description
OrchestrateClient	build()
OrchestrateClient.Builder	host(java.lang.String host) Set the hostname for the Orchestrate.io service, defaults to Builder.DEFAULT_HOST.
OrchestrateClient.Builder	mapper(JacksonMapper.Builder mapperBuilder) A Builder used to build the JacksonMapper to use when marshalling data to and from the service.
OrchestrateClient.Builder	mapper(JacksonMapper mapper) A JacksonMapper to use when marshalling data to and from the service.
OrchestrateClient.Builder	mapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) The Jackson JSON ObjectMapper to use when marshalling data to and from the service, defaults to JacksonMapper.builder().
OrchestrateClient.Builder	maxPoolSize(int maxPoolSize) The maximum number of threads to use with the client, defaults to Integer.MAX_VALUE.
OrchestrateClient.Builder	poolSize(int poolSize) The initial number of threads to use with the client, defaults to Runtime.availableProcessors().
OrchestrateClient.Builder	port(int port) Set the port for the Orchestrate.io service, defaults to Builder.DEFAULT_PORT.
OrchestrateClient.Builder	userAgent(java.lang.String userAgent) Set a custom value to be appended to the User-Agent header being sent to Orchestrate.
OrchestrateClient.Builder	useSSL(boolean useSSL) Enable or disable SSL when connecting to the service, this value defaults to true.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST

The default host for the Orchestrate.io service.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port for the Orchestrate.io service.

See Also:

Constant Field Values

Method Detail

host

public OrchestrateClient.Builder host(java.lang.String host)

Set the hostname for the Orchestrate.io service, defaults to Builder.DEFAULT_HOST.

Parameters:

host - The hostname for the Orchestrate.io service.

Returns:

This builder.

See Also:

DEFAULT_HOST

port

public OrchestrateClient.Builder port(int port)

Set the port for the Orchestrate.io service, defaults to Builder.DEFAULT_PORT.

Parameters:

port - The port for the Orchestrate.io service.

Returns:

This builder.

See Also:

DEFAULT_PORT

poolSize

public OrchestrateClient.Builder poolSize(int poolSize)

The initial number of threads to use with the client, defaults to Runtime.availableProcessors().

Parameters:

poolSize - The size of the thread pool to start with.

Returns:

This builder.

maxPoolSize

public OrchestrateClient.Builder maxPoolSize(int maxPoolSize)

The maximum number of threads to use with the client, defaults to Integer.MAX_VALUE.

Parameters:

maxPoolSize - The maximum size to grow the thread pool to.

Returns:

This builder.

mapper

public OrchestrateClient.Builder mapper(@NonNull
                               com.fasterxml.jackson.databind.ObjectMapper objectMapper)

The Jackson JSON ObjectMapper to use when marshalling data to and from the service, defaults to JacksonMapper.builder().

Parameters:

objectMapper - A Jackson JSON ObjectMapper.

Returns:

This builder.

mapper

public OrchestrateClient.Builder mapper(@NonNull
                               JacksonMapper.Builder mapperBuilder)

A Builder used to build the JacksonMapper to use when marshalling data to and from the service.

Parameters:

mapperBuilder - A JacksonMapper.Builder.

Returns:

This builder.

mapper

public OrchestrateClient.Builder mapper(@NonNull
                               JacksonMapper mapper)

A JacksonMapper to use when marshalling data to and from the service.

Parameters:

mapper - A JacksonMapper.

Returns:

This builder.

useSSL

public OrchestrateClient.Builder useSSL(boolean useSSL)

Enable or disable SSL when connecting to the service, this value defaults to true.

Parameters:

useSSL - If true enable SSL when connecting to the service.

Returns:

This builder.

userAgent

public OrchestrateClient.Builder userAgent(@NonNull
                                  java.lang.String userAgent)

Set a custom value to be appended to the User-Agent header being sent to Orchestrate.

This is useful for custom client implementations or libraries that build on top of the Orchestrate client to help identify usage of those implementations and libraries.

Parameters:

userAgent - The value to append as the "user-agent" request header.

Returns:

This builder.

build

public OrchestrateClient build()