org.ametiste.gdc.provider

Class HttpDashboardProvider

java.lang.Object

org.ametiste.gdc.provider.HttpDashboardProvider

All Implemented Interfaces:

DashboardProvider

public class HttpDashboardProvider
extends java.lang.Object
implements DashboardProvider

Default implementation of DashboardProvider interface that provides communication with Graphite instance via HTTP API for common dashboard operations like create/update, load, delete, find.

HttpDashboardProvider uses Apache HttpClient as http client and gson library for parsing Graphite responses.

Provider use authentication with username and password parameters if both are set. If username and password not set provider will operate without authentication.

Constructor Summary

Constructors

Constructor and Description
HttpDashboardProvider(java.lang.String graphiteHost, int connectTimeout, int readTimeout) Create new instance of HttpDashboardProvider for communication with Graphite instance with specified host and connection parameters, without authentication.
HttpDashboardProvider(java.lang.String graphiteHost, java.lang.String username, java.lang.String password, int connectTimeout, int readTimeout) Create new instance of HttpDashboardProvider for communication with Graphite instance with specified host, connection parameters and authentication credentials.

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String name) Delete dashboard from Graphite instance.
java.util.List<java.lang.String>	find(java.lang.String query) Find dashboards in Graphite instance that match query.
java.lang.String	load(java.lang.String name) Load dashboard with specified name from Graphite instance.
org.ametiste.gdc.data.dashboard.Dashboard	load(java.lang.String name, com.google.gson.JsonDeserializer<org.ametiste.gdc.data.dashboard.Dashboard> deserializer) Load dashboard with specified name from Graphite instance.
void	save(java.lang.String name, java.lang.String dashboard) Save dashboard in Graphite instance or create new if dashboard with target name not exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpDashboardProvider

public HttpDashboardProvider(java.lang.String graphiteHost,
                             int connectTimeout,
                             int readTimeout)

Create new instance of HttpDashboardProvider for communication with Graphite instance with specified host and connection parameters, without authentication.

Parameters:

graphiteHost - host of target Graphite instance. Must be valid URL.

connectTimeout - connection timeout in milliseconds.

readTimeout - read timeout in milliseconds.

HttpDashboardProvider

public HttpDashboardProvider(java.lang.String graphiteHost,
                             java.lang.String username,
                             java.lang.String password,
                             int connectTimeout,
                             int readTimeout)

Create new instance of HttpDashboardProvider for communication with Graphite instance with specified host, connection parameters and authentication credentials.

Parameters:

graphiteHost - host of target Graphite instance. Must be valid URL.

username - username for authentication on graphite host.

password - password for authentication on graphite host.

connectTimeout - connection timeout in milliseconds.

readTimeout - read timeout in milliseconds.

Method Detail

save

public void save(java.lang.String name,
                 java.lang.String dashboard)
          throws GraphiteOperationException

Description copied from interface: DashboardProvider

Save dashboard in Graphite instance or create new if dashboard with target name not exists.

Specified by:

save in interface DashboardProvider

Parameters:

name - dashboard name.

dashboard - dashboard description. Must be valid json structure that describe dashboard structure.

Throws:

GraphiteOperationException - when error occurred during communication with Graphite instance or Graphite return error response.

load

public java.lang.String load(java.lang.String name)
                      throws GraphiteOperationException

Description copied from interface: DashboardProvider

Load dashboard with specified name from Graphite instance.

Specified by:

load in interface DashboardProvider

Parameters:

name - name of target dashboard.

Returns:

string with json object that describes dashboard structure.

Throws:

GraphiteOperationException - when error occurred during communication with Graphite instance or Graphite returns response with error massage (in most cases that dashboard not found). In last case exception contains message from response.

load

public org.ametiste.gdc.data.dashboard.Dashboard load(java.lang.String name,
                                                      com.google.gson.JsonDeserializer<org.ametiste.gdc.data.dashboard.Dashboard> deserializer)
                                               throws GraphiteOperationException

Description copied from interface: DashboardProvider

Load dashboard with specified name from Graphite instance.

Specified by:

load in interface DashboardProvider

Parameters:

name - name of target dashboard.

deserializer - JsonDeserializer object that helps deserialize string description to Dashboard object.

Returns:

Dashboard object that represents json description.

Throws:

GraphiteOperationException - when error occurred during communication with Graphite instance or Graphite returns response with error massage (in most cases that dashboard not found). In last case exception contains message from response. Also exception may be throws when returned json string has wrong syntax.

delete

public void delete(java.lang.String name)
            throws GraphiteOperationException

Description copied from interface: DashboardProvider

Delete dashboard from Graphite instance.

Specified by:

delete in interface DashboardProvider

Parameters:

name - name of dashboard to delete.

Throws:

GraphiteOperationException - when error occurred during communication with Graphite instance or if dashboard with specified name not exists.

find

public java.util.List<java.lang.String> find(java.lang.String query)
                                      throws GraphiteOperationException

Description copied from interface: DashboardProvider

Find dashboards in Graphite instance that match query.

Specified by:

find in interface DashboardProvider

Parameters:

query - query string for filtering search result. Query contains phrases separated by whitespace. Result list will contain only those dashboards that contains all phases from query.

Returns:

List of dashboards names that match query. If no dashboards match method returns empty list.

Throws:

GraphiteOperationException - when error occurred during communication with Graphite instance.