com.gluonhq.charm.connect

Class GluonClientBuilder

java.lang.Object

com.gluonhq.charm.connect.GluonClientBuilder

public class GluonClientBuilder
extends java.lang.Object

A utility class for building GluonClient instances.

Since:

1.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GluonClientBuilder() Default constructor

Method Summary

Modifier and Type	Method and Description
GluonClient	build() Make an instance of GluonClient based on the properties set on this builder.
static GluonClientBuilder	create() Create a new instance of GluonClientBuilder
GluonClientBuilder	credentials(GluonCredentials credentials) Set the value of the credentials for the GluonClient instance constructed by this builder.
GluonClientBuilder	host(java.lang.String host) Set the value of the hostname 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

Returns:

a new instance of GluonClientBuilder

host

public GluonClientBuilder host(java.lang.String host)

Set the value of the hostname for the GluonClient instance constructed by this builder. When the provided host doesn't start with http, the string http:// will be prepended. When the provided host ends with a slash, it will be removed.

Parameters:

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

Returns:

An instance of the builder.

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 Cloud.

Returns:

An instance of the builder.

build

public GluonClient build()

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

Returns:

The constructed GluonClient instance.