com.woorea.openstack.base.client

Class OpenStackClient

java.lang.Object

com.woorea.openstack.base.client.OpenStackClient

public class OpenStackClient
extends Object

Revisions

Added ability to specify the logger external to the client; added constant definition for properties used in the library to configure its operation; obtained properties to configure behavior

Change from JUL logging to slf4j for better integration with client applications.

Field Summary

Fields

Modifier and Type	Field and Description
protected OpenStackClientConnector	connector
protected OpenStackClientConnector	DEFAULT_CONNECTOR
protected String	endpoint
protected org.slf4j.Logger	logger
protected Properties	properties
protected OpenStackTokenProvider	tokenProvider

Constructor Summary

Constructors

Constructor and Description
OpenStackClient(String endpoint)
OpenStackClient(String endpoint, OpenStackClientConnector connector) Constructs the client for the specified endpoint and using the provided connector

Method Summary

Modifier and Type	Method and Description
<T> T	execute(OpenStackRequest<T> request)
<R> OpenStackRequest<R>	get(String path, Class<R> returnType)
org.slf4j.Logger	getLogger()
Properties	getProperties()
void	property(String property, String value)
<T> OpenStackResponse	request(OpenStackRequest<T> request)
void	setLogger(org.slf4j.Logger logger)
void	setTokenProvider(OpenStackTokenProvider tokenProvider)
void	token(String token)

Methods inherited from class java.lang.Object

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

Field Detail

endpoint

protected String endpoint

tokenProvider

protected OpenStackTokenProvider tokenProvider

connector

protected OpenStackClientConnector connector

properties

protected Properties properties

logger

protected org.slf4j.Logger logger

DEFAULT_CONNECTOR

protected OpenStackClientConnector DEFAULT_CONNECTOR

Constructor Detail

OpenStackClient

public OpenStackClient(String endpoint)

OpenStackClient

public OpenStackClient(String endpoint,
                       OpenStackClientConnector connector)

Constructs the client for the specified endpoint and using the provided connector

Parameters:

endpoint - The endpoint to connect to

connector - The connector to use. If null, the default connector is determined and loaded.

Method Detail

setLogger

public void setLogger(org.slf4j.Logger logger)

getLogger

public org.slf4j.Logger getLogger()

Returns:

The logger to be used by all connectors on this client

request

public <T> OpenStackResponse request(OpenStackRequest<T> request)
                              throws OpenStackConnectException,
                                     OpenStackResponseException

Parameters:

request - The request to be processed

Returns:

The entity returned by the request, if any

Throws:

OpenStackConnectException - If the connection to the provider cannot be established. This exception indicates that the provider is not reachable, or that some failure occurred attempting to open the connection to the provider.

OpenStackResponseException - If the provider responds with some form of error regarding the request, such as unauthorized. This is an indication that there is a problem with the request itself, not the connection. @see com.woorea.openstack .base.client.OpenStackClientConnector#request(com.woorea.openstack.base.client.OpenStackRequest)

execute

public <T> T execute(OpenStackRequest<T> request)
              throws OpenStackConnectException,
                     OpenStackResponseException

Parameters:

request - The request to be processed

Returns:

The entity returned from the request

Throws:

OpenStackConnectException - If the connection to the provider cannot be established. This exception indicates that the provider is not reachable, or that some failure occurred attempting to open the connection to the provider.

OpenStackResponseException - If the provider responds with some form of error regarding the request, such as unauthorized. This is an indication that there is a problem with the request itself, not the connection. @see com.woorea.openstack .base.client.OpenStackClientConnector#request(com.woorea.openstack.base.client.OpenStackRequest)

property

public void property(String property,
                     String value)

getProperties

public Properties getProperties()

Returns:

The properties that govern the operation of this client

setTokenProvider

public void setTokenProvider(OpenStackTokenProvider tokenProvider)

token

public void token(String token)

get

public <R> OpenStackRequest<R> get(String path,
                                   Class<R> returnType)