Package org.openstack4j.openstack.client
Class OSClientBuilder<R,T extends IOSClientBuilder<R,T>>
- java.lang.Object
-
- org.openstack4j.openstack.client.OSClientBuilder<R,T>
-
- 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 Description static classOSClientBuilder.ClientV2static classOSClientBuilder.ClientV3-
Nested classes/interfaces inherited from interface org.openstack4j.api.client.IOSClientBuilder
IOSClientBuilder.V2, IOSClientBuilder.V3
-
-
Constructor Summary
Constructors Constructor Description OSClientBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Tcredentials(String user, String password)The authentication credentialsTendpoint(String endpoint)The identity endpoint to connect toTperspective(Facing perspective)Allows for a specific network perspective to be used.Tprovider(CloudProvider provider)The OpenStack cloud provider which helps determine compatibility within requestsTuseNonStrictSSLClient(boolean useNonStrictSSL)DEPRECATED: Use#applyConfig(Config)to configure SSL policiesTwithConfig(Config config)Associates the given configuration with this Client-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.openstack4j.api.client.IOSClientBuilder
authenticate
-
-
-
-
Method Detail
-
withConfig
public T withConfig(Config config)
Description copied from interface:IOSClientBuilderAssociates the given configuration with this Client- Specified by:
withConfigin interfaceIOSClientBuilder<R,T extends IOSClientBuilder<R,T>>- Parameters:
config- OpenStack4j configuration options- Returns:
- self for method chaining
-
provider
public T provider(CloudProvider provider)
Description copied from interface:IOSClientBuilderThe OpenStack cloud provider which helps determine compatibility within requests- Specified by:
providerin interfaceIOSClientBuilder<R,T extends IOSClientBuilder<R,T>>- Parameters:
provider- the cloud provider- Returns:
- self for method chaining
-
credentials
public T credentials(String user, String password)
Description copied from interface:IOSClientBuilderThe authentication credentials- Specified by:
credentialsin interfaceIOSClientBuilder<R,T extends IOSClientBuilder<R,T>>- Parameters:
user- the user id to authenticate withpassword- the password to authenticate with- Returns:
- self for method chaining
-
endpoint
public T endpoint(String endpoint)
Description copied from interface:IOSClientBuilderThe identity endpoint to connect to- Specified by:
endpointin interfaceIOSClientBuilder<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:IOSClientBuilderAllows for a specific network perspective to be used. For example to only use AdminURL Endpoints you would want to set theFacing.ADMINas 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:
perspectivein interfaceIOSClientBuilder<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:IOSClientBuilderDEPRECATED: Use#applyConfig(Config)to configure SSL policiesIn 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:
useNonStrictSSLClientin interfaceIOSClientBuilder<R,T extends IOSClientBuilder<R,T>>- Parameters:
useNonStrictSSL- true if an HTTPS self-signed environment- Returns:
- self for method chaining
-
-