org.openstack4j.openstack.client

Class OSClientBuilder<R,T extends IOSClientBuilder<R,T>>

java.lang.Object

org.openstack4j.openstack.client.OSClientBuilder<R,T>

Type Parameters:

R - Client Type

T - Builder Type

All Implemented Interfaces:

IOSClientBuilder<R,T>

Direct Known Subclasses:

OSClientBuilder.ClientV2, OSClientBuilder.ClientV3

public abstract class OSClientBuilder<R,T extends IOSClientBuilder<R,T>>
extends Object
implements IOSClientBuilder<R,T>

Builder definitions for creating a Client

Author:

Jeremy Unruh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSClientBuilder.ClientV2
static class	OSClientBuilder.ClientV3

Nested classes/interfaces inherited from interface org.openstack4j.api.client.IOSClientBuilder

IOSClientBuilder.V2, IOSClientBuilder.V3

Constructor Summary

Constructors

Constructor and Description
OSClientBuilder()

Method Summary

Modifier and Type	Method and Description
T	credentials(String user, String password) The authentication credentials
T	endpoint(String endpoint) The identity endpoint to connect to
T	perspective(Facing perspective) Allows for a specific network perspective to be used.
T	useNonStrictSSLClient(boolean useNonStrictSSL) DEPRECATED: Use #applyConfig(Config) to configure SSL policies In some private environments self signed certificates are used.
T	withConfig(Config config) Associates the given configuration with this Client

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstack4j.api.client.IOSClientBuilder

authenticate

Constructor Detail

OSClientBuilder

public OSClientBuilder()

Method Detail

withConfig

public T withConfig(Config config)

Description copied from interface: IOSClientBuilder

Associates the given configuration with this Client

Specified by:

withConfig in interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

Parameters:

config - OpenStack4j configuration options

Returns:

self for method chaining

credentials

public T credentials(String user,
                     String password)

Description copied from interface: IOSClientBuilder

The authentication credentials

Specified by:

credentials in interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

Parameters:

user - the user to authenticate with

password - the password to authenticate with

Returns:

self for method chaining

endpoint

public T endpoint(String endpoint)

Description copied from interface: IOSClientBuilder

The identity endpoint to connect to

Specified by:

endpoint in interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

Parameters:

endpoint - the endpoint URL of the identity service

Returns:

self for method chaining

perspective

public T perspective(Facing perspective)

Description copied from interface: IOSClientBuilder

Allows for a specific network perspective to be used. For example to only use AdminURL Endpoints you would want to set the Facing.ADMIN as a facing perspective. NOTE: If you choose PUBLIC some features may not work that are normally admin based configuration/functionality. If you normally are not using these features PUBLIC works fine in most cases.

Specified by:

perspective in interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

Parameters:

perspective - the network facing perspective

Returns:

self for method chaining

useNonStrictSSLClient

public T useNonStrictSSLClient(boolean useNonStrictSSL)

Description copied from interface: IOSClientBuilder

DEPRECATED: Use #applyConfig(Config) to configure SSL policies In some private environments self signed certificates are used. If you are using HTTPS and using self-signed cerificates then set this to true. Otherwise the default strict hostname and properly signed validation based client will be used.

Specified by:

useNonStrictSSLClient in interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

Parameters:

useNonStrictSSL - true if an HTTPS self-signed environment

Returns:

self for method chaining