Package org.apache.jackrabbit.vault.fs.api

Interface AggregateManager

All Superinterfaces:

NodeTypesCollector

All Known Implementing Classes:

AggregateManagerImpl

public interface AggregateManager
extends NodeTypesCollector

AggregateManager...

Method Summary

Modifier and Type	Method	Description
void	dumpConfig(PrintWriter out)	Dumps the configuration to the given writer for debugging purposes.
Aggregator	getAggregator(javax.jcr.Node node, String path)	Returns the aggregator for the given node or null if none found.
VaultFsConfig	getConfig()	Returns the config
RepositoryAddress	getMountpoint()	Returns the repository address of the mountpoint of this artifacts node tree.
Aggregate	getRoot()	Returns the root aggregate of the tree
javax.jcr.Session	getSession()	Returns the session of this manager.
String	getUserId()	Returns the user id of the session of this manager.
String	getWorkspace()	Returns the name of the workspace of this manager.
WorkspaceFilter	getWorkspaceFilter()	Returns the workspace filter.
boolean	isMounted()	Checks if this tree is still mounted and if the attached session is still live.
void	startTracking(ProgressTrackerListener listener)	Starts tracking aggregate lifecycles
void	stopTracking()	Stops tracking of aggregate lifecycle
void	unmount()	Releases all resources attached to this artifact manager

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.NodeTypesCollector

addNodeTypes, getNodeTypes

Method Detail

unmount

void unmount()
      throws javax.jcr.RepositoryException

Releases all resources attached to this artifact manager

Throws:

javax.jcr.RepositoryException - if an error occurs.

getRoot

Aggregate getRoot()
           throws javax.jcr.RepositoryException

Returns the root aggregate of the tree

Returns:

the root aggregate.

Throws:

javax.jcr.RepositoryException - if an error occurs.

getMountpoint

RepositoryAddress getMountpoint()

Returns the repository address of the mountpoint of this artifacts node tree.

Returns:

the mountpoint

getAggregator

Aggregator getAggregator(javax.jcr.Node node,
                         String path)
                  throws javax.jcr.RepositoryException

Returns the aggregator for the given node or null if none found.

Parameters:

node - for which the aggregator is to be returned

path - the path of the node or null

Returns:

the aggregator or null

Throws:

javax.jcr.RepositoryException - if a repository error occurs.

getWorkspaceFilter

WorkspaceFilter getWorkspaceFilter()

Returns the workspace filter.

Returns:

the workspace filter.

isMounted

boolean isMounted()

Checks if this tree is still mounted and if the attached session is still live.

Returns:

true if still mounted

getUserId

String getUserId()
          throws javax.jcr.RepositoryException

Returns the user id of the session of this manager.

Returns:

the user id.

Throws:

javax.jcr.RepositoryException - if an error occurs.

getWorkspace

String getWorkspace()
             throws javax.jcr.RepositoryException

Returns the name of the workspace of this manager.

Returns:

the name of the workspace.

Throws:

javax.jcr.RepositoryException - if an error occurs.

getSession

javax.jcr.Session getSession()

Returns the session of this manager.

Returns:

the jcr session

getConfig

VaultFsConfig getConfig()

Returns the config

Returns:

the config

dumpConfig

void dumpConfig(PrintWriter out)
         throws IOException

Dumps the configuration to the given writer for debugging purposes.

Parameters:

out - the writer

Throws:

IOException - if an I/O error occurs

startTracking

void startTracking(ProgressTrackerListener listener)

Starts tracking aggregate lifecycles

Parameters:

listener - optional listener

stopTracking

void stopTracking()

Stops tracking of aggregate lifecycle