org.dsa.iot.historian.database

Class DatabaseProvider

java.lang.Object

org.dsa.iot.historian.database.DatabaseProvider

public abstract class DatabaseProvider
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DatabaseProvider()

Method Summary

Modifier and Type	Method and Description
Database	createAndInitDb(org.dsa.iot.dslink.node.Node node) Creates the database and typically used in the action handler of createDbAction(org.dsa.iot.dslink.node.Permission) after createDbNode(java.lang.String, org.dsa.iot.dslink.node.actions.ActionResult) has been called.
protected abstract Database	createDb(org.dsa.iot.dslink.node.Node node)
abstract org.dsa.iot.dslink.node.actions.Action	createDbAction(org.dsa.iot.dslink.node.Permission perm) The action handler must set the database settings onto the node configurations.
org.dsa.iot.dslink.node.NodeBuilder	createDbNode(java.lang.String name, org.dsa.iot.dslink.node.actions.ActionResult res) Called before actually creating the database and typically used in the action handler of createDbAction(org.dsa.iot.dslink.node.Permission).
abstract org.dsa.iot.dslink.node.Permission	dbPermission() Required permission level to create and modify databases.
void	deleteDb(org.dsa.iot.dslink.node.Node node)
abstract void	deleteRange(Watch watch, long fromTs, long toTs)
SubscriptionPool	getPool()
protected void	onWatchAdded(Watch watch) Override to handle newly created watches.
void	setPool(SubscriptionPool pool)
void	subscribe(org.dsa.iot.dslink.node.Node node) When the requester is connected, subscribe to all the paths.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseProvider

public DatabaseProvider()

Method Detail

setPool

public void setPool(SubscriptionPool pool)

getPool

public SubscriptionPool getPool()

createDbAction

public abstract org.dsa.iot.dslink.node.actions.Action createDbAction(org.dsa.iot.dslink.node.Permission perm)

The action handler must set the database settings onto the node configurations.

Parameters:

perm - Designated permission of the action.

Returns:

The action with parameters necessary to create a database.

createDb

protected abstract Database createDb(org.dsa.iot.dslink.node.Node node)

Parameters:

node - Node with initialized database connection settings.

Returns:

A provided database to operate on.

dbPermission

public abstract org.dsa.iot.dslink.node.Permission dbPermission()

Required permission level to create and modify databases.

Returns:

Required permission level.

onWatchAdded

protected void onWatchAdded(Watch watch)

Override to handle newly created watches. Can be used to add custom actions to the watch.

Parameters:

watch - Watch that was added.

createDbNode

public org.dsa.iot.dslink.node.NodeBuilder createDbNode(java.lang.String name,
                                                        org.dsa.iot.dslink.node.actions.ActionResult res)

Called before actually creating the database and typically used in the action handler of createDbAction(org.dsa.iot.dslink.node.Permission).

Parameters:

name - Name of the database.

res - Invocation result to retrieve the necessary node to create the database node.

Returns:

An incomplete node builder that must be built after initialized.

createAndInitDb

public Database createAndInitDb(org.dsa.iot.dslink.node.Node node)

Creates the database and typically used in the action handler of createDbAction(org.dsa.iot.dslink.node.Permission) after createDbNode(java.lang.String, org.dsa.iot.dslink.node.actions.ActionResult) has been called.

Parameters:

node - Database node to initialize.

Returns:

An initialized database that has been connected to.

See Also:

For creating the node.

subscribe

public void subscribe(org.dsa.iot.dslink.node.Node node)

When the requester is connected, subscribe to all the paths.

Parameters:

node - Database node.

deleteRange

public abstract void deleteRange(Watch watch,
                                 long fromTs,
                                 long toTs)

deleteDb

public void deleteDb(org.dsa.iot.dslink.node.Node node)