de.cinovo.cloudconductor.api.lib.helper

Class AbstractApiHandler

java.lang.Object

de.cinovo.cloudconductor.api.lib.helper.AbstractApiHandler

Direct Known Subclasses:

AgentHandler, ConfigValueHandler, DefaultRestHandler, IOModuleHandler

public abstract class AbstractApiHandler
extends Object

Copyright 2013 Cinovo AG

Superclass for manager classes. Contains utility methods for the exclusive use by the concrete manager classes.

Author:

psigloch, mhilbert

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.databind.ObjectMapper	mapper object mapper for JSON (de)serialization

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApiHandler(String cloudconductorUrl)
protected	AbstractApiHandler(String cloudconductorUrl, String username, String password)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_delete(String path)
protected <T> T	_get(String path, Class<T> type)
protected Object	_get(String path, com.fasterxml.jackson.databind.JavaType type)
protected org.apache.http.HttpResponse	_post(String path, Object post)
protected <T> T	_post(String path, Object post, Class<T> type)
protected <T> T	_post(String path, Object post, com.fasterxml.jackson.databind.JavaType type)
protected org.apache.http.HttpResponse	_put(String path)
protected org.apache.http.HttpResponse	_put(String path, Object put)
protected <T> T	_put(String path, Object put, Class<T> type)
protected <T> T	_put(String path, Object put, com.fasterxml.jackson.databind.JavaType type)
protected static void	assertSuccess(String path, org.apache.http.HttpResponse response)
protected String	dataFromResponse(org.apache.http.HttpResponse response) Returns the plain text data returned in the given response.
protected com.fasterxml.jackson.databind.JavaType	getSetType(Class<?> clazz)
protected <T> T	objectFromResponse(org.apache.http.HttpResponse response, Class<T> type) Creates an object from the given HTTP response.
protected <T> T	objectFromResponse(org.apache.http.HttpResponse response, com.fasterxml.jackson.databind.JavaType type) Creates an object from the given HTTP response.
protected String	pathGenerator(String path, String... replace)
protected de.taimos.httputils.HTTPRequest	request(String path) Creates HTTP request for the given path.
protected de.taimos.httputils.HTTPRequest	request(String path, Object obj) Creates HTTP request for the given path with the given object as the body.
protected de.taimos.httputils.HTTPRequest	request(String path, Object obj, com.fasterxml.jackson.databind.JavaType type)

Methods inherited from class java.lang.Object

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

Field Detail

mapper

public static final com.fasterxml.jackson.databind.ObjectMapper mapper

object mapper for JSON (de)serialization

Constructor Detail

AbstractApiHandler

protected AbstractApiHandler(String cloudconductorUrl)

AbstractApiHandler

protected AbstractApiHandler(String cloudconductorUrl,
                  String username,
                  String password)

Method Detail

_get

protected final Object _get(String path,
          com.fasterxml.jackson.databind.JavaType type)
                     throws CloudConductorException

Throws:

CloudConductorException

_get

protected final <T> T _get(String path,
         Class<T> type)
                throws CloudConductorException

Throws:

CloudConductorException

_put

protected final org.apache.http.HttpResponse _put(String path)
                                           throws CloudConductorException

Throws:

CloudConductorException

_put

protected final org.apache.http.HttpResponse _put(String path,
                                Object put)
                                           throws CloudConductorException

Throws:

CloudConductorException

_put

protected final <T> T _put(String path,
         Object put,
         com.fasterxml.jackson.databind.JavaType type)
                throws CloudConductorException

Throws:

CloudConductorException

_put

protected final <T> T _put(String path,
         Object put,
         Class<T> type)
                throws CloudConductorException

Throws:

CloudConductorException

_post

protected final org.apache.http.HttpResponse _post(String path,
                                 Object post)
                                            throws CloudConductorException

Throws:

CloudConductorException

_post

protected final <T> T _post(String path,
          Object post,
          com.fasterxml.jackson.databind.JavaType type)
                 throws CloudConductorException

Throws:

CloudConductorException

_post

protected final <T> T _post(String path,
          Object post,
          Class<T> type)
                 throws CloudConductorException

Throws:

CloudConductorException

_delete

protected final void _delete(String path)
                      throws CloudConductorException

Throws:

CloudConductorException

objectFromResponse

protected final <T> T objectFromResponse(org.apache.http.HttpResponse response,
                       Class<T> type)
                              throws SerializationException

Creates an object from the given HTTP response.

Parameters:

response - the HTTP response

type - the expected Java type of the object

Returns:

the Java object

Throws:

SerializationException - if the mapping was unsuccessful

objectFromResponse

protected final <T> T objectFromResponse(org.apache.http.HttpResponse response,
                       com.fasterxml.jackson.databind.JavaType type)
                              throws SerializationException

Creates an object from the given HTTP response.

Parameters:

response - the HTTP response

type - the expected Java type of the object

Returns:

the Java object

Throws:

SerializationException - if the mapping was unsuccessful

dataFromResponse

protected final String dataFromResponse(org.apache.http.HttpResponse response)

Returns the plain text data returned in the given response.

Parameters:

response - the HTTP response

Returns:

the plain text data.

request

protected final de.taimos.httputils.HTTPRequest request(String path)

Creates HTTP request for the given path.

Parameters:

path - the path to the resource

Returns:

the HTTP request

request

protected final de.taimos.httputils.HTTPRequest request(String path,
                                      Object obj)
                                                 throws SerializationException

Creates HTTP request for the given path with the given object as the body.

Parameters:

path - the path to the resource

obj - the object

Returns:

the HTTP request

Throws:

SerializationException - if the object could not be mapped to a JSON string

request

protected final de.taimos.httputils.HTTPRequest request(String path,
                                      Object obj,
                                      com.fasterxml.jackson.databind.JavaType type)
                                                 throws SerializationException

Throws:

SerializationException

assertSuccess

protected static final void assertSuccess(String path,
                 org.apache.http.HttpResponse response)
                                   throws ClientErrorException,
                                          ServerErrorException

Throws:

ClientErrorException

ServerErrorException

getSetType

protected final com.fasterxml.jackson.databind.JavaType getSetType(Class<?> clazz)

pathGenerator

protected String pathGenerator(String path,
                   String... replace)