com.woorea.openstack.base.client

Class OpenStackRequest<R>

java.lang.Object

com.woorea.openstack.base.client.OpenStackRequest<R>

public class OpenStackRequest<R>
extends Object

Revisions

Added accessor to obtain reference to OpenStack Client object to obtain configuration properties and logger to use.

Constructor Summary

Constructors

Constructor and Description
OpenStackRequest()
OpenStackRequest(OpenStackClient client, HttpMethod method, CharSequence path, Entity<?> entity, Class<R> returnType)

Method Summary

Modifier and Type	Method and Description
protected static String	buildPath(String... elements)
String	endpoint()
OpenStackRequest<R>	endpoint(String endpoint)
Entity<?>	entity()
<T> Entity<T>	entity(T entity, String contentType)
R	execute() Executes the request that has been constructed
OpenStackClient	getOpenStackClient()
OpenStackRequest<R>	header(String name, Object value)
Map<String,List<Object>>	headers()
<T> Entity<T>	json(T entity)
HttpMethod	method()
OpenStackRequest<R>	method(HttpMethod method)
String	path()
OpenStackRequest<R>	path(String path)
OpenStackRequest<R>	queryParam(String key, Object value)
Map<String,List<Object>>	queryParams()
OpenStackRequest<R>	queryString(String queryString) This method will parse the query string which is a collection of name value pairs and put then in queryParam hash map
OpenStackResponse	request()
Class<R>	returnType()
void	returnType(Class<R> returnType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenStackRequest

public OpenStackRequest()

OpenStackRequest

public OpenStackRequest(OpenStackClient client,
                        HttpMethod method,
                        CharSequence path,
                        Entity<?> entity,
                        Class<R> returnType)

Method Detail

endpoint

public OpenStackRequest<R> endpoint(String endpoint)

getOpenStackClient

public OpenStackClient getOpenStackClient()

Returns:

The openStackClient object

endpoint

public String endpoint()

method

public OpenStackRequest<R> method(HttpMethod method)

method

public HttpMethod method()

path

public OpenStackRequest<R> path(String path)

path

public String path()

header

public OpenStackRequest<R> header(String name,
                                  Object value)

headers

public Map<String,List<Object>> headers()

entity

public <T> Entity<T> entity(T entity,
                            String contentType)

entity

public Entity<?> entity()

json

public <T> Entity<T> json(T entity)

returnType

public void returnType(Class<R> returnType)

returnType

public Class<R> returnType()

execute

public R execute()
          throws OpenStackConnectException,
                 OpenStackResponseException

Executes the request that has been constructed

Returns:

The response 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.

request

public OpenStackResponse request()
                          throws OpenStackConnectException,
                                 OpenStackResponseException

Returns:

The response to the request execution

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)

toString

public String toString()

Overrides:

toString in class Object

queryParams

public Map<String,List<Object>> queryParams()

queryParam

public OpenStackRequest<R> queryParam(String key,
                                      Object value)

buildPath

protected static String buildPath(String... elements)

queryString

public OpenStackRequest<R> queryString(String queryString)

This method will parse the query string which is a collection of name value pairs and put then in queryParam hash map

Parameters:

queryString - The query string to be parsed

Returns:

The request object