org.influxdb.impl

Class InfluxDBImpl

java.lang.Object

org.influxdb.impl.InfluxDBImpl

All Implemented Interfaces:

InfluxDB

public class InfluxDBImpl
extends Object
implements InfluxDB

Implementation of a InluxDB API.

Author:

stefan.majer [at] gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.influxdb.InfluxDB

InfluxDB.LogLevel

Constructor Summary

Constructors

Constructor and Description
InfluxDBImpl(String url, String username, String password) Constructor which should only be used from the InfluxDBFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	alterDatabasePrivilege(String database, String name, boolean isAdmin, String... permissions) Alter the admin privilege of a given database user.
void	authenticateDatabaseUser(String database, String user, String userPassword) Authenticate with the given credentials against the database.
void	createClusterAdmin(String name, String adminPassword) Create a new cluster admin.
void	createDatabase(String name, int replicationFactor) Create a new Database.
void	createDatabaseUser(String database, String name, String userPassword, String... permissions) Create a new regular database user.
void	createScheduledDelete(String database, ScheduledDelete delete) Create a new scheduled deletion.
void	deleteClusterAdmin(String name) Delete a cluster admin.
void	deleteContinuousQuery(String database, int id) Delete a continous query.
void	deleteDatabase(String name) Delete a database.
void	deleteDatabaseUser(String database, String name) Delete a database user.
void	deletePoints(String database, String serieName) Delete all points of a serie.
void	deleteScheduledDelete(String database, int id) Delete a scheduled deletion.
List<User>	describeClusterAdmins() Describe all cluster admins.
List<ContinuousQuery>	describeContinuousQueries(String database) Describe all contious queries in a database.
List<Database>	describeDatabases() Describe all available databases.
List<User>	describeDatabaseUsers(String database) Describe all database users allowed to acces the given database.
List<ScheduledDelete>	describeScheduledDeletes(String database) Describe all scheduled deletes.
Pong	ping() Ping this influxDB-
List<Serie>	Query(String database, String query, TimeUnit precision) Execute a query agains a database.
InfluxDB	setLogLevel(InfluxDB.LogLevel logLevel) Set the loglevel which is used for REST related actions.
void	updateClusterAdmin(String name, String adminPassword) Update the password of the given admin.
void	updateDatabaseUser(String database, String name, String newPassword, String... permissions) Update the password and/or the permissions of a database user.
void	write(String database, TimeUnit precision, Serie... series) Write a Series to the given database.

Methods inherited from class java.lang.Object

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

Constructor Detail

InfluxDBImpl

public InfluxDBImpl(String url,
            String username,
            String password)

Constructor which should only be used from the InfluxDBFactory.

Parameters:

url - the url where the influxdb is accessible.

username - the user to connect.

password - the password for this user.

Method Detail

setLogLevel

public InfluxDB setLogLevel(InfluxDB.LogLevel logLevel)

Description copied from interface: InfluxDB

Set the loglevel which is used for REST related actions.

Specified by:

setLogLevel in interface InfluxDB

Parameters:

logLevel - the loglevel to set.

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

ping

public Pong ping()

Description copied from interface: InfluxDB

Ping this influxDB-

Specified by:

ping in interface InfluxDB

Returns:

the response of the ping execution.

write

public void write(String database,
         TimeUnit precision,
         Serie... series)

Description copied from interface: InfluxDB

Write a Series to the given database.

Specified by:

write in interface InfluxDB

Parameters:

database - the name of the database to write to.

precision - the precision used for the values.

series - a Array of Series to write.

Query

public List<Serie> Query(String database,
                String query,
                TimeUnit precision)

Description copied from interface: InfluxDB

Execute a query agains a database.

Specified by:

Query in interface InfluxDB

Parameters:

database - the name of the database.

query - the query to execute, for language specification please see http://influxdb.org/docs/query_language

precision - the precision used for the values.

Returns:

a List of Series which matched the query.

createDatabase

public void createDatabase(String name,
                  int replicationFactor)

Description copied from interface: InfluxDB

Create a new Database.

Specified by:

createDatabase in interface InfluxDB

Parameters:

name - the name of the new database.

replicationFactor - the replicationfactor to use, must be >= 1.

deleteDatabase

public void deleteDatabase(String name)

Description copied from interface: InfluxDB

Delete a database.

Specified by:

deleteDatabase in interface InfluxDB

Parameters:

name - the name of the database to delete.

describeDatabases

public List<Database> describeDatabases()

Description copied from interface: InfluxDB

Describe all available databases.

Specified by:

describeDatabases in interface InfluxDB

Returns:

a List of all Databases.

createClusterAdmin

public void createClusterAdmin(String name,
                      String adminPassword)

Description copied from interface: InfluxDB

Create a new cluster admin.

Specified by:

createClusterAdmin in interface InfluxDB

Parameters:

name - the name of the new admin.

adminPassword - the password for the new admin.

deleteClusterAdmin

public void deleteClusterAdmin(String name)

Description copied from interface: InfluxDB

Delete a cluster admin.

Specified by:

deleteClusterAdmin in interface InfluxDB

Parameters:

name - the name of the admin to delete.

describeClusterAdmins

public List<User> describeClusterAdmins()

Description copied from interface: InfluxDB

Describe all cluster admins.

Specified by:

describeClusterAdmins in interface InfluxDB

Returns:

a list of all admins.

updateClusterAdmin

public void updateClusterAdmin(String name,
                      String adminPassword)

Description copied from interface: InfluxDB

Update the password of the given admin.

Specified by:

updateClusterAdmin in interface InfluxDB

Parameters:

name - the name of the admin for which the password should be updated.

adminPassword - the new password for the given admin.

createDatabaseUser

public void createDatabaseUser(String database,
                      String name,
                      String userPassword,
                      String... permissions)

Description copied from interface: InfluxDB

Create a new regular database user. Without any given permissions the new user is allowed to read and write to the database. The permission must be specified in regex which will match for the series. You have to specify either no permissions or both (readFrom and writeTo) permissions.

Specified by:

createDatabaseUser in interface InfluxDB

Parameters:

database - the name of the database where this user is allowed.

name - the name of the new database user.

userPassword - the password for this user.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

deleteDatabaseUser

public void deleteDatabaseUser(String database,
                      String name)

Description copied from interface: InfluxDB

Delete a database user.

Specified by:

deleteDatabaseUser in interface InfluxDB

Parameters:

database - the name of the database the given user should be removed from.

name - the name of the user to remove.

describeDatabaseUsers

public List<User> describeDatabaseUsers(String database)

Description copied from interface: InfluxDB

Describe all database users allowed to acces the given database.

Specified by:

describeDatabaseUsers in interface InfluxDB

Parameters:

database - the name of the database for which all users should be described.

Returns:

a list of all users.

updateDatabaseUser

public void updateDatabaseUser(String database,
                      String name,
                      String newPassword,
                      String... permissions)

Description copied from interface: InfluxDB

Update the password and/or the permissions of a database user.

Specified by:

updateDatabaseUser in interface InfluxDB

Parameters:

database - the name of the database where this user is allowed.

name - the name of the existing database user.

newPassword - the password for this user.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

alterDatabasePrivilege

public void alterDatabasePrivilege(String database,
                          String name,
                          boolean isAdmin,
                          String... permissions)

Description copied from interface: InfluxDB

Alter the admin privilege of a given database user.

Specified by:

alterDatabasePrivilege in interface InfluxDB

Parameters:

database - the name of the database where this user is allowed.

name - the name of the existing database user.

isAdmin - if set to true this user is a database admin, otherwise it isnt.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

authenticateDatabaseUser

public void authenticateDatabaseUser(String database,
                            String user,
                            String userPassword)

Description copied from interface: InfluxDB

Authenticate with the given credentials against the database.

Specified by:

authenticateDatabaseUser in interface InfluxDB

Parameters:

database - the name of the database where this user is allowed.

user - the name of the existing database user.

userPassword - the password for this user.

describeContinuousQueries

public List<ContinuousQuery> describeContinuousQueries(String database)

Description copied from interface: InfluxDB

Describe all contious queries in a database.

Specified by:

describeContinuousQueries in interface InfluxDB

Parameters:

database - the name of the database for which all continous queries should be described.

Returns:

a list of all contious queries.

deleteContinuousQuery

public void deleteContinuousQuery(String database,
                         int id)

Description copied from interface: InfluxDB

Delete a continous query.

Specified by:

deleteContinuousQuery in interface InfluxDB

Parameters:

database - the name of the database for which this query should be deleted.

id - the id of the query.

deletePoints

public void deletePoints(String database,
                String serieName)

Description copied from interface: InfluxDB

Delete all points of a serie.

Specified by:

deletePoints in interface InfluxDB

Parameters:

database - the database in which the given points should be deleted.

serieName - the name of the serie.

createScheduledDelete

public void createScheduledDelete(String database,
                         ScheduledDelete delete)

Description copied from interface: InfluxDB

Create a new scheduled deletion.

Specified by:

createScheduledDelete in interface InfluxDB

Parameters:

database - the name of the database.

delete - the query which describes what to delete.

describeScheduledDeletes

public List<ScheduledDelete> describeScheduledDeletes(String database)

Description copied from interface: InfluxDB

Describe all scheduled deletes.

Specified by:

describeScheduledDeletes in interface InfluxDB

Parameters:

database - the name of the database for which all scheduled deletes should be described.

Returns:

a list of all scheduled deletes.

deleteScheduledDelete

public void deleteScheduledDelete(String database,
                         int id)

Description copied from interface: InfluxDB

Delete a scheduled deletion.

Specified by:

deleteScheduledDelete in interface InfluxDB

Parameters:

database - the name of the database for which this scheduled deletes should be deleted-.

id - the id of the delete.