org.openstack4j.openstack

Class OSFactory<T extends OSFactory<T>>

java.lang.Object

org.openstack4j.openstack.OSFactory<T>

public abstract class OSFactory<T extends OSFactory<T>>
extends Object

A Factory which sets up the APIs to be used a previously non-expired authorization or new authorization.

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
static IOSClientBuilder.V2	builder() Creates builder for OpenStack V2 based authentication
static IOSClientBuilder.V3	builderV3() Creates builder for OpenStack V3 based authentication
static OSClient	clientFromAccess(Access access) Skips Authentication and created the API around a previously cached Access object.
static OSClient	clientFromAccess(Access access, Config config) Skips Authentication and created the API around a previously cached Access object.
static OSClient	clientFromAccess(Access access, Facing perspective) Skips Authentication and created the API around a previously cached Access object.
static OSClient	clientFromAccess(Access access, Facing perspective, Config config) Skips Authentication and created the API around a previously cached Access object.
static void	enableHttpLoggingFilter(boolean enabled) Globally enables or disables verbose HTTP Request and Response logging useful for debugging
static void	enableLegacyEndpointHandling(boolean enabled) As of 2.0 of OpenStack4j we have removed a workaround for endpoints that have the admin URL configured wrong by substituting the host from the original Keystone connection.
static void	useJDKLogger() Unless a logger plugin is declared the default logger is console.

Methods inherited from class java.lang.Object

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

Method Detail

clientFromAccess

public static OSClient clientFromAccess(Access access)

Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments or scenarios where a client should not be re-authenticated due to a token lasting 24 hours

Parameters:

access - an authorized access entity which is to be used to create the API

Returns:

the OSCLient

clientFromAccess

public static OSClient clientFromAccess(Access access,
                                        Facing perspective)

Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments or scenarios where a client should not be re-authenticated due to a token lasting 24 hours

Parameters:

access - an authorized access entity which is to be used to create the API

perspective - the current endpoint perspective to use

Returns:

the OSCLient

clientFromAccess

public static OSClient clientFromAccess(Access access,
                                        Config config)

Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments or scenarios where a client should not be re-authenticated due to a token lasting 24 hours

Parameters:

access - an authorized access entity which is to be used to create the API

config - OpenStack4j configuration options

Returns:

the OSCLient

clientFromAccess

public static OSClient clientFromAccess(Access access,
                                        Facing perspective,
                                        Config config)

Skips Authentication and created the API around a previously cached Access object. This can be useful in multi-threaded environments or scenarios where a client should not be re-authenticated due to a token lasting 24 hours

Parameters:

access - an authorized access entity which is to be used to create the API

perspective - the current endpoint perspective to use

config - OpenStack4j configuration options

Returns:

the OSCLient

enableHttpLoggingFilter

public static void enableHttpLoggingFilter(boolean enabled)

Globally enables or disables verbose HTTP Request and Response logging useful for debugging

Parameters:

enabled - true to enable, false to enable

enableLegacyEndpointHandling

public static void enableLegacyEndpointHandling(boolean enabled)

As of 2.0 of OpenStack4j we have removed a workaround for endpoints that have the admin URL configured wrong by substituting the host from the original Keystone connection. This is not up to specification so we have removed this functionality by default. As a result it has broken some users with development based environments. Turn this on to go back to original behaviour.

Parameters:

enabled -

useJDKLogger

public static void useJDKLogger()

Unless a logger plugin is declared the default logger is console. By invoking this method the default console is replaced by the JDK based Logger

builder

public static IOSClientBuilder.V2 builder()

Creates builder for OpenStack V2 based authentication

Returns:

V2 Authentication builder

builderV3

public static IOSClientBuilder.V3 builderV3()

Creates builder for OpenStack V3 based authentication

Returns:

V3 Authentication builder