Package org.openstack4j.api.client

Interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

All Known Subinterfaces:

IOSClientBuilder.V2, IOSClientBuilder.V3

All Known Implementing Classes:

OSClientBuilder, OSClientBuilder.ClientV2, OSClientBuilder.ClientV3

public interface IOSClientBuilder<R,T extends IOSClientBuilder<R,T>>

OpenStack4j Client Builder

Author:

Jeremy Unruh

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IOSClientBuilder.V2	OpenStack4j Client builder which authenticates against version V3
static interface	IOSClientBuilder.V3	OpenStack4j Client builder which authenticates against version V3

Method Summary

Modifier and Type	Method	Description
R	authenticate()	Attempts to connect, authenticated and obtain an authorization access entity which contains a token, service catalog and endpoints from the controller.
T	credentials(String userId, 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	provider(CloudProvider provider)	The OpenStack cloud provider which helps determine compatibility within requests
T	useNonStrictSSLClient(boolean useNonStrictSSL)	Deprecated.
T	withConfig(Config config)	Associates the given configuration with this Client

Method Detail

withConfig

T withConfig(Config config)

Associates the given configuration with this Client

Parameters:

config - OpenStack4j configuration options

Returns:

self for method chaining

credentials

T credentials(String userId,
              String password)

The authentication credentials

Parameters:

userId - the user id to authenticate with

password - the password to authenticate with

Returns:

self for method chaining

endpoint

T endpoint(String endpoint)

The identity endpoint to connect to

Parameters:

endpoint - the endpoint URL of the identity service

Returns:

self for method chaining

provider

T provider(CloudProvider provider)

The OpenStack cloud provider which helps determine compatibility within requests

Parameters:

provider - the cloud provider

Returns:

self for method chaining

perspective

T perspective(Facing perspective)

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.

Parameters:

perspective - the network facing perspective

Returns:

self for method chaining

useNonStrictSSLClient

@Deprecated
T useNonStrictSSLClient(boolean useNonStrictSSL)

Deprecated.

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.

Parameters:

useNonStrictSSL - true if an HTTPS self-signed environment

Returns:

self for method chaining

authenticate

R authenticate()
        throws AuthenticationException

Attempts to connect, authenticated and obtain an authorization access entity which contains a token, service catalog and endpoints from the controller. As a result a client will be returned encapsulating the authorized access and corresponding API access

Returns:

the authenticated client

Throws:

AuthenticationException - if the credentials or default tenant is invalid