com.prosyst.mprm.backend.database.tree

Interface TransactionalTreeDatabase

public interface TransactionalTreeDatabase

The interface is used to maintain the gateways tree structure.

Author:

Ivajlo Iliev

Method Summary

Modifier and Type	Method and Description
void	addNode(java.sql.Connection con, com.prosyst.mprm.data.tree.NodeInfo node, long timestamp) Adds a node(gateway group) into gateways tree as an immediate descendant of the node identified by the parentPath field of the node parameter.
Enumerator	enumerateDeletedGroups(java.sql.Connection con, java.lang.String path) Enumerates all the gateway groups which are immediate descendants of the node identified by path parameter and are removed from tree.
Enumerator<java.lang.String,DatabaseException>	enumerateExplicitlyConfiguredNodes(java.sql.Connection con, java.lang.String path, java.lang.String property) Returns the nodes from the subtree starting with path that has explicitly set values for the property.
Enumerator	enumerateGroups(java.sql.Connection con, java.lang.String path, long timestamp) Enumerates all the gateway groups which are immediate descendants of the node identified by path parameter.
Enumerator	enumerateManagedObjects(java.sql.Connection con, java.lang.String path, long timestamp) Enumerates all the gateways which are immediate descendants of the node identified by the path parameter.
java.lang.String	getManagedObjectInfoPath(java.sql.Connection con, java.lang.String moId, long timestamp) This method returns the path of a managed object in the tree of managed objects by its identifier.
com.prosyst.mprm.data.tree.NodeInfo	getNode(java.sql.Connection con, java.lang.String path, long timestamp) Returns the node identified by the path parameter.
com.prosyst.mprm.data.tree.NodeInfo	getNode(java.sql.ResultSet resultSet) Returns the node retrieved from the result set after execution of an SQL query.
ExternalizableDictionary	getNodeProperties(java.sql.Connection con, java.lang.String path, long timestamp) Returns properties for a node identified by the path parameter.
com.prosyst.mprm.data.tree.NodeInfo	getParent(java.sql.Connection con, java.lang.String path) Returns the parent node of the node identified by path parameter.
boolean	hasDescendants(java.sql.Connection con, java.lang.String path, long timestamp) Checks whether a given node has descendants.
void	invalidateAndSetNodeProperties(java.sql.Connection con, java.lang.String path, java.util.Dictionary properties) Deprecated.
void	invalidateNode(java.sql.Connection con, java.lang.String path, long timestamp) Invalidates the record for a node with specified node path.
boolean	isInstanceOf(java.sql.Connection con, java.lang.String path, java.lang.String nType) Checks whether a node is of a specified type.
boolean	nodeExists(java.sql.Connection con, java.lang.String path, long timestamp) Checks whether a node with the specified path is stored in the database.
boolean	removeNode(java.sql.Connection con, java.lang.String path) Removes a node identified by the path parameter.
void	retrieveNode(java.sql.ResultSet resultSet, com.prosyst.mprm.data.tree.ManagedObjectInfo managedObjectInfo) Retrieves a node from a result set and returns the result in the ManagedObjectInfo
void	setNodeProperties(java.sql.Connection con, java.lang.String path, java.util.Dictionary properties) Sets properties for a node identified by the path parameter.
void	updateDisplayName(java.sql.Connection con, java.lang.String path, java.lang.String displayName) Updates the display name of a node with certain path.

Method Detail

addNode

void addNode(java.sql.Connection con,
             com.prosyst.mprm.data.tree.NodeInfo node,
             long timestamp)
      throws DatabaseException

Adds a node(gateway group) into gateways tree as an immediate descendant of the node identified by the parentPath field of the node parameter.

Parameters:

con - Connection object holding connection to database server.

node - the gateway group to be added.

Note: If node.parentPath equals null or empty string we consider node.parentPath refers the root of the gateways tree.

timestamp - long number specifying the time the node was valid in milliseconds. If the value of passed parameter is -1 we consider it the current time.

Throws:

DatabaseException - is thrown if an error occurs while adding the node into the database.

getNode

com.prosyst.mprm.data.tree.NodeInfo getNode(java.sql.Connection con,
                                            java.lang.String path,
                                            long timestamp)
                                     throws DatabaseException

Returns the node identified by the path parameter.

Parameters:

path - the unique path of the node.

Note: If path equals null or empty string we consider path refers the root of the gateways tree.

con - Connection object, managing connection to tree database server.

timestamp - time indicating when the entry was valid in milliseconds.

Note: For retrieval of the current valid entry -1 is used.

Returns:

NodeInfo or GatewayInfo object identified by the path parameter or null if the path is not presented in the gateways tree.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data.

removeNode

boolean removeNode(java.sql.Connection con,
                   java.lang.String path)
            throws DatabaseException

Removes a node identified by the path parameter.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

Returns:

true if the gateway group is successfully removed, false otherwise.

Throws:

DatabaseException - is thrown if an error occurs while modifying the database, or if the node has subentries.

invalidateNode

void invalidateNode(java.sql.Connection con,
                    java.lang.String path,
                    long timestamp)
             throws DatabaseException

Invalidates the record for a node with specified node path.

Parameters:

con - Connection object, managing connection to tree database server.

path - path of object containing information about node to be invalidated.

timestamp - Timestamp to be set as expire date of invalidated record.

Throws:

DatabaseException - is thrown if an error occurs while invalidating the node into the database.

updateDisplayName

void updateDisplayName(java.sql.Connection con,
                       java.lang.String path,
                       java.lang.String displayName)
                throws DatabaseException

Updates the display name of a node with certain path.

Parameters:

con - connection to database server.

path - path of the node.

displayName - the new display name of node.

Note: If display name starts or ends with intervals, DatabaseException will be thrown.

Throws:

DatabaseException - is thrown if an error occurs while modifying the node record.

invalidateAndSetNodeProperties

@Deprecated
void invalidateAndSetNodeProperties(java.sql.Connection con,
                                                 java.lang.String path,
                                                 java.util.Dictionary properties)
                                          throws DatabaseException

Deprecated.

Invalidates the old properties specified for the specified node, if the gateways history recording is on

Parameters:

con - Connection object, managing connection to tree database server.

path - path of node.

properties - dictionary containing properties for the specified node.

Throws:

DatabaseException - is thrown if error while modifying properties records in database occurs of if path does not refer tree node.

setNodeProperties

void setNodeProperties(java.sql.Connection con,
                       java.lang.String path,
                       java.util.Dictionary properties)
                throws DatabaseException

Sets properties for a node identified by the path parameter.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

properties - dictionary containing the properties of the specified node

Throws:

DatabaseException - is thrown if error while saving properties in database occurs.

getNodeProperties

ExternalizableDictionary getNodeProperties(java.sql.Connection con,
                                           java.lang.String path,
                                           long timestamp)
                                    throws DatabaseException

Returns properties for a node identified by the path parameter.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

timestamp - the time when entry is valid in milliseconds.

Note: for retrieval of the properties of the current entry -1 is used.

Returns:

ExternalizableDictionary object containing properties stored for specified node, null if no properties are stored.

Throws:

DatabaseException - is thrown if error while retrieving data occurs.

nodeExists

boolean nodeExists(java.sql.Connection con,
                   java.lang.String path,
                   long timestamp)
            throws DatabaseException

Checks whether a node with the specified path is stored in the database.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

timestamp - the time the entry was valid in milliseconds.

Note: for check of the current valid entry -1 is used.

Returns:

true if the specified node is presented, false otherwise.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

hasDescendants

boolean hasDescendants(java.sql.Connection con,
                       java.lang.String path,
                       long timestamp)
                throws DatabaseException

Checks whether a given node has descendants.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

Note: If path equals null or empty string we consider path refers the root of the gateways tree.

timestamp - the time the entry was valid in milliseconds.

Note: for check of the current valid entry -1 is used.

Returns:

true if the node has descendants.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

isInstanceOf

boolean isInstanceOf(java.sql.Connection con,
                     java.lang.String path,
                     java.lang.String nType)
              throws DatabaseException

Checks whether a node is of a specified type.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

nType - type of node, which the node should be checked for.

Returns:

true if node is instance of specified type, false otherwise.

Throws:

DatabaseException - is thrown if error while retrieving data from database occurs.

java.lang.IllegalArgumentException - is thrown if nodePath does not refer tree node.

getParent

com.prosyst.mprm.data.tree.NodeInfo getParent(java.sql.Connection con,
                                              java.lang.String path)
                                       throws DatabaseException

Returns the parent node of the node identified by path parameter.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

Returns:

the parent node or null if path refers the root of gateways tree or if node with parent path does not exist in database.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

java.lang.IllegalArgumentException - is thrown if the path is not a valid node path.

enumerateGroups

Enumerator enumerateGroups(java.sql.Connection con,
                           java.lang.String path,
                           long timestamp)
                    throws DatabaseException

Enumerates all the gateway groups which are immediate descendants of the node identified by path parameter.

Parameters:

path - the unique path of the node.

Note: If path equals null or empty string we consider path refers the root of the gateways tree.

con - Connection object, managing connection to tree database server.

timestamp - the time the returned entries were valid in milliseconds.

Note: For retrieval of the current valid entry -1 is used.

Returns:

an enumeration of GroupInfo objects that are immediate descendants of the node identified by path and represent gateway groups. If path refers leaf node an emtpy enumeration is returned.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

enumerateDeletedGroups

Enumerator enumerateDeletedGroups(java.sql.Connection con,
                                  java.lang.String path)
                           throws DatabaseException

Enumerates all the gateway groups which are immediate descendants of the node identified by path parameter and are removed from tree.

Parameters:

con - Connection object, managing connection to tree database server.

path - the unique path of the node.

Note: If path equals null or empty string we consider path refers the root of the gateways tree.

Returns:

an enumeration of GroupInfo objects that are immediate descendants of the node identified by the path and represent gateway groups.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

enumerateManagedObjects

Enumerator enumerateManagedObjects(java.sql.Connection con,
                                   java.lang.String path,
                                   long timestamp)
                            throws DatabaseException

Enumerates all the gateways which are immediate descendants of the node identified by the path parameter.

Parameters:

con - Connection object, managing connection to tree database server.

path - the path of the parent node.

Note: If path equals null or empty string we consider path refers the root of the gateways tree.

timestamp - the time the returned entries were valid in milliseconds.

Note: For retrieval of the current valid entries -1 is used.

Returns:

enumeration of ManagedObjectInfo objects representing gateway nodes which have been subentries of given node

Throws:

DatabaseException - is thrown if an error occurs while retrieving data from the database.

java.lang.IllegalArgumentException - is thrown if the path does not refer tree node.

enumerateExplicitlyConfiguredNodes

Enumerator<java.lang.String,DatabaseException> enumerateExplicitlyConfiguredNodes(java.sql.Connection con,
                                                                                  java.lang.String path,
                                                                                  java.lang.String property)
                                                                           throws DatabaseException

Returns the nodes from the subtree starting with path that has explicitly set values for the property.

Parameters:

con - Connection object, managing connection to tree database server.

path - subtree path

property - changed property

Returns:

enumeration of node pats

Throws:

DatabaseException

getNode

com.prosyst.mprm.data.tree.NodeInfo getNode(java.sql.ResultSet resultSet)
                                     throws DatabaseException

Returns the node retrieved from the result set after execution of an SQL query.

Parameters:

resultSet - java.sql.ResultSet object containing result of execution of a sql query.

Returns:

NodeInfo object representing a node, which has been retrieved from the result set after execution of an SQL query.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data.

retrieveNode

void retrieveNode(java.sql.ResultSet resultSet,
                  com.prosyst.mprm.data.tree.ManagedObjectInfo managedObjectInfo)
           throws DatabaseException

Retrieves a node from a result set and returns the result in the ManagedObjectInfo

Parameters:

resultSet - java.sql.ResultSet object containing result of execution of an sql query.

managedObjectInfo - ManagedObjectInfo object where information retrieved from the resultSet will be stored.

Throws:

DatabaseException - is thrown if an error occurs while retrieving data.

getManagedObjectInfoPath

java.lang.String getManagedObjectInfoPath(java.sql.Connection con,
                                          java.lang.String moId,
                                          long timestamp)
                                   throws DatabaseException

This method returns the path of a managed object in the tree of managed objects by its identifier. null if no object with specified id is stored in database.

Parameters:

con - Connection object, managing connection to tree database server.

moId - identifier of the managed object.

timestamp - the time when the managed object was active in milliseconds.

Returns:

path of the managed object, null if no managed object is stored in database.

Throws:

DatabaseException - is thrown if error while retrieving data from database occurs.

java.lang.IllegalArgumentException - is thrown if moId is not a valid managed object info identifier.