org.kairosdb.client

Class AbstractClient

java.lang.Object

org.kairosdb.client.AbstractClient

All Implemented Interfaces:

Client

Direct Known Subclasses:

HttpClient

public abstract class AbstractClient
extends Object
implements Client

Base code used to send metrics to Kairos or query Kairos.

Method Summary

Modifier and Type	Method and Description
RollupResponse	createRollup(RollupBuilder builder)
Response	delete(QueryBuilder builder) Deletes data in KairosDB using the query built by the builder.
protected abstract org.kairosdb.client.ClientResponse	delete(String url)
Response	deleteMetric(String name) Deletes a metric.
Response	deleteRollup(String id)
Class	getDataPointValueClass(String groupType) Returns the data point value class for the given group type or null if one is not registered for the group type
GetResponse	getMetricNames() Returns a list of all metric names.
RollupResponse	getRollupTask(String id)
RollupResponse	getRollupTasks()
GetResponse	getStatus() Returns status of Kairos Instance.
GetResponse	getTagNames() Returns a list of all tag names.
GetResponse	getTagValues() Returns a list of all tag values.
protected abstract org.kairosdb.client.ClientResponse	postCompressedData(String json, String url)
protected abstract org.kairosdb.client.ClientResponse	postData(String json, String url)
Response	pushMetrics(MetricBuilder builder) Sends metrics from the builder to the KairosDB server.
QueryResponse	query(QueryBuilder builder) Queries KairosDB using the query built by the builder.
protected abstract org.kairosdb.client.ClientResponse	queryData(String url)
QueryTagResponse	queryTag(QueryTagBuilder builder) Queries KairosDB tags using the query built by the builder.
void	registerCustomDataType(String groupType, Class dataPointClass) Registers a new custom data type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kairosdb.client.Client

getRetryCount, shutdown

Method Detail

getMetricNames

public GetResponse getMetricNames()
                           throws IOException

Description copied from interface: Client

Returns a list of all metric names.

Specified by:

getMetricNames in interface Client

Returns:

list of all metric names

Throws:

IOException - if the JSON returned could not be properly processed

getTagNames

public GetResponse getTagNames()
                        throws IOException

Description copied from interface: Client

Returns a list of all tag names.

Specified by:

getTagNames in interface Client

Returns:

list of all tag names

Throws:

IOException - if the JSON returned could not be properly processed

getTagValues

public GetResponse getTagValues()
                         throws IOException

Description copied from interface: Client

Returns a list of all tag values.

Specified by:

getTagValues in interface Client

Returns:

list of all tag values

Throws:

IOException - if the JSON returned could not be properly processed

getStatus

public GetResponse getStatus()
                      throws IOException

Description copied from interface: Client

Returns status of Kairos Instance.

Specified by:

getStatus in interface Client

Returns:

status of Kairos instance

Throws:

IOException - if the JSON returned could not be properly processed

queryTag

public QueryTagResponse queryTag(QueryTagBuilder builder)
                          throws IOException

Description copied from interface: Client

Queries KairosDB tags using the query built by the builder.

Specified by:

queryTag in interface Client

Parameters:

builder - query tag builder

Returns:

response from the server

Throws:

IOException - problem occurred querying the server

query

public QueryResponse query(QueryBuilder builder)
                    throws IOException

Description copied from interface: Client

Queries KairosDB using the query built by the builder.

Specified by:

query in interface Client

Parameters:

builder - query builder

Returns:

response from the server

Throws:

IOException - problem occurred querying the server

createRollup

public RollupResponse createRollup(RollupBuilder builder)
                            throws IOException

Specified by:

createRollup in interface Client

Throws:

IOException

getRollupTask

public RollupResponse getRollupTask(String id)
                             throws IOException

Specified by:

getRollupTask in interface Client

Throws:

IOException

getRollupTasks

public RollupResponse getRollupTasks()
                              throws IOException

Specified by:

getRollupTasks in interface Client

Throws:

IOException

deleteRollup

public Response deleteRollup(String id)
                      throws IOException

Specified by:

deleteRollup in interface Client

Throws:

IOException

pushMetrics

public Response pushMetrics(MetricBuilder builder)
                     throws IOException

Description copied from interface: Client

Sends metrics from the builder to the KairosDB server.

Specified by:

pushMetrics in interface Client

Parameters:

builder - metrics builder

Returns:

response from the server

Throws:

IOException - problem occurred sending to the server

deleteMetric

public Response deleteMetric(String name)
                      throws IOException

Description copied from interface: Client

Deletes a metric. This is the metric and all its data points.

Specified by:

deleteMetric in interface Client

Parameters:

name - the metric to delete

Returns:

response from the server

Throws:

IOException - problem occurred sending to the server

delete

public Response delete(QueryBuilder builder)
                throws IOException

Description copied from interface: Client

Deletes data in KairosDB using the query built by the builder.

Specified by:

delete in interface Client

Parameters:

builder - query builder

Returns:

response from the server

Throws:

IOException - problem occurred querying the server

registerCustomDataType

public void registerCustomDataType(String groupType,
                                   Class dataPointClass)

Description copied from interface: Client

Registers a new custom data type. The assumption is that this data type already exists on the server. The dataPointValueClass is used to serialize and deserialize the custom type. This is simply a POJO.

Specified by:

registerCustomDataType in interface Client

Parameters:

groupType - type used to deserialize the json on the client

dataPointClass - class that is the value of a data point

getDataPointValueClass

public Class getDataPointValueClass(String groupType)

Description copied from interface: Client

Returns the data point value class for the given group type or null if one is not registered for the group type

Specified by:

getDataPointValueClass in interface Client

Parameters:

groupType - group type

Returns:

data point class associated with the group type

postData

protected abstract org.kairosdb.client.ClientResponse postData(String json,
                                                               String url)
                                                        throws IOException

Throws:

IOException

postCompressedData

protected abstract org.kairosdb.client.ClientResponse postCompressedData(String json,
                                                                         String url)
                                                                  throws IOException

Throws:

IOException

queryData

protected abstract org.kairosdb.client.ClientResponse queryData(String url)
                                                         throws IOException

Throws:

IOException

delete

protected abstract org.kairosdb.client.ClientResponse delete(String url)
                                                      throws IOException

Throws:

IOException