org.norther.tammi.root.rt
Interface VariableRootMBean

All Superinterfaces:

ReferableMBean, Relation, RelationMBean, RelationSupportMBean, RepositoryClient, Startable, VariableTreeMBean

All Known Implementing Classes:

VariableRoot

public interface VariableRootMBean
extends VariableTreeMBean, RepositoryClient, Startable

VariableRootMBean extends VariableTreeMBean and provides a root for variable trees that need persistency. The root maintains its tree through the specified persister.

Author:

Ilkka Priha

Field Summary

Fields inherited from interface org.norther.tammi.core.rt.VariableTreeMBean

BEAN_TREE_RELATION, ROLE_BASE, ROLE_BRANCH, ROLE_LEAF

Fields inherited from interface org.norther.tammi.core.base.ReferableMBean

DEFAULT_ID, ID, MBEAN, MBEAN_DESCRIPTION, TYPE

Method Summary

void	clearSubBranches() Clears the tree by removing leaves from the root itself and both branches and leaves from its branches.
String	dump(String path) Dumps the contents of this tree to a dump file.
void	load(String path) Loads the contents of a dump file to this tree.

Methods inherited from interface org.norther.tammi.core.rt.VariableTreeMBean

addBranchName, addBranchNames, addLeafName, addLeafNames, clearBranchNames, clearLeafNames, containsBranchName, containsLeafName, getBase, getBaseName, getBranch, getBranches, getBranchNames, getLeaf, getLeafNames, getLeaves, isUnregisterRemovedActors, notifyVariableTree, removeBranchName, removeBranchNames, removeLeafName, removeLeafNames, setBaseName, setUnregisterRemovedActors

Methods inherited from interface org.norther.tammi.core.relation.RelationMBean

addActorName, addActorName, addActorNames, addToService, clearRole, getActor, getActor, getActor, getActorName, getActorName, getRelationService, getRoleActors, isNamedActorInRole, removeActorName, removeActorName, removeActorNames, removeFromService, retrieveRole, setActorName, setActorName

Methods inherited from interface javax.management.relation.RelationSupportMBean

isInRelationService, setRelationServiceManagementFlag

Methods inherited from interface javax.management.relation.Relation

getAllRoles, getReferencedMBeans, getRelationId, getRelationServiceName, getRelationTypeName, getRole, getRoleCardinality, getRoles, handleMBeanUnregistration, retrieveAllRoles, setRole, setRoles

Methods inherited from interface org.norther.tammi.core.base.ReferableMBean

getMBean

Methods inherited from interface org.norther.tammi.root.db.RepositoryClient

acquirePersister, acquirePersister, acquirePersister, getAuthenticatedPasswordKey, getAuthenticatedUsernameKey, getAuthenticationConnectionKey, getConnectionKey, getConnectionUsername, getPersisterClassName, isConnectionAuthenticated, setAuthenticationConnection, setConnectionAuthenticated, setConnectionKey, setConnectionPassword, setConnectionUsername, setPersisterClassName

Methods inherited from interface org.norther.tammi.core.base.Startable

isStarted, start, stop

Method Detail

clearSubBranches

void clearSubBranches()

Clears the tree by removing leaves from the root itself and both branches and leaves from its branches. Its own branches are not removed as they are considered crucial for business logic.

Note that the record file is also cleared.

load

void load(String path)
          throws LogException

Loads the contents of a dump file to this tree. Loaded objects are merged to existing ones.

Parameters:

path - the pathname of the file.

Throws:

LogException - on errors.

dump

String dump(String path)
            throws LogException

Dumps the contents of this tree to a dump file. The file must be a new one.

Parameters:

path - the pathname of the file.

Returns:

the full pathname of the dump file.

Throws:

LogException - on errors.