com.gluonhq.connect.gluoncloud

Class GluonClientBuilder

java.lang.Object

com.gluonhq.connect.gluoncloud.GluonClientBuilder

public class GluonClientBuilder
extends java.lang.Object

A utility class for building GluonClient instances.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GluonClientBuilder() Default constructor

Method Summary

Modifier and Type	Method and Description
GluonClientBuilder	authenticationMode(AuthenticationMode authenticationMode) Set the value of the authentication mode for the GluonClient instance constructed by this builder.
GluonClient	build() Make an instance of GluonClient based on the properties set on this builder.
static GluonClientBuilder	create() Create a new instance of GluonClientBuilder that can be used to build instances of GluonClient.
GluonClientBuilder	credentials(GluonCredentials credentials) Set the value of the credentials for the GluonClient instance constructed by this builder.
GluonClientBuilder	host(java.lang.String host) Sets the value of the hostname for the GluonClient instance constructed by this builder.
GluonClientBuilder	operationMode(OperationMode operationMode) Set the value of the operation mode for the GluonClient instance constructed by this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

GluonClientBuilder

protected GluonClientBuilder()

Default constructor

Method Detail

create

public static GluonClientBuilder create()

Create a new instance of GluonClientBuilder that can be used to build instances of GluonClient.

Returns:

a new instance of GluonClientBuilder

host

public GluonClientBuilder host(java.lang.String host)

Sets the value of the hostname for the GluonClient instance constructed by this builder. This method should only be called when not using the hosted Gluon CloudLink environment, for instance when you want to connect to an on premise installation of Gluon CloudLink.

When the provided host doesn't start with http, the host parameter will be prepended with http://. When the provided host ends with a slash, that slash will be removed.

Parameters:

host - the name of the host to use when connecting with Gluon CloudLink.

Returns:

A reference to this builder.

See Also:

GluonClient.getHost()

credentials

public GluonClientBuilder credentials(GluonCredentials credentials)

Set the value of the credentials for the GluonClient instance constructed by this builder.

Parameters:

credentials - the credentials used for authorizing with Gluon CloudLink.

Returns:

A reference to this builder.

See Also:

GluonClient.getCredentials()

authenticationMode

public GluonClientBuilder authenticationMode(AuthenticationMode authenticationMode)

Set the value of the authentication mode for the GluonClient instance constructed by this builder. When not specified, the default value is AuthenticationMode.PUBLIC.

Parameters:

authenticationMode - the authentication mode used when working with data from Gluon CloudLink

Returns:

A reference to this builder.

See Also:

GluonClient.getAuthenticationMode()

operationMode

public GluonClientBuilder operationMode(OperationMode operationMode)

Set the value of the operation mode for the GluonClient instance constructed by this builder. When not specified, the default value is OperationMode.CLOUD_FIRST.

Parameters:

operationMode - the operation mode used when working with data

Returns:

A reference to this builder.

See Also:

GluonClient.getOperationMode()

build

public GluonClient build()

Make an instance of GluonClient based on the properties set on this builder.

Returns:

The constructed GluonClient instance.