org.apache.jackrabbit.core.data
Class GarbageCollector

java.lang.Object
  org.apache.jackrabbit.core.data.GarbageCollector

All Implemented Interfaces:

org.apache.jackrabbit.api.management.DataStoreGarbageCollector

public class GarbageCollector
extends Object
implements org.apache.jackrabbit.api.management.DataStoreGarbageCollector

Garbage collector for DataStore. This implementation iterates through all nodes and reads the binary properties. To detect nodes that are moved while the scan runs, event listeners are started. Like the well known garbage collection in Java, the items that are still in use are marked. Currently this is achieved by updating the modified date of the entries. Newly added entries are detected because the modified date is changed when they are added.

Example code to run the data store garbage collection:

 JackrabbitRepositoryFactory jf = (JackrabbitRepositoryFactory) factory;
 RepositoryManager m = jf.getRepositoryManager((JackrabbitRepository) repository);
 GarbageCollector gc = m.createDataStoreGarbageCollector();
 try {
     gc.mark();
     gc.sweep();
 } finally {
     gc.close();
 }
 

Field Summary

protected int

testDelay

Constructor Summary

GarbageCollector(DataStore dataStore, IterablePersistenceManager[] list, SessionImpl[] sessionList)
Create a new garbage collector.

Method Summary

void	close()
int	deleteUnused() Deprecated. use sweep().
protected void	finalize() Auto-close in case the application didn't call it explicitly.
DataStore	getDataStore() Get the data store if one is used.
boolean	getPersistenceManagerScan() Deprecated. use isPersistenceManagerScan().
long	getSleepBetweenNodes()
boolean	isPersistenceManagerScan()
void	mark()
void	scan() Deprecated. use mark().
void	setMarkEventListener(org.apache.jackrabbit.api.management.MarkEventListener callback)
void	setPersistenceManagerScan(boolean allow)
void	setScanEventListener(ScanEventListener callback) Deprecated. use setMarkEventListener().
void	setSleepBetweenNodes(long millis)
void	setTestDelay(int testDelay) When testing the garbage collection, a delay is used instead of simulating concurrent access.
void	stopScan() Stop the observation listener if any are installed.
int	sweep()

Methods inherited from class java.lang.Object

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

Field Detail

testDelay

protected int testDelay

Constructor Detail

GarbageCollector

public GarbageCollector(DataStore dataStore,
                        IterablePersistenceManager[] list,
                        SessionImpl[] sessionList)

Create a new garbage collector. This method is usually not called by the application, it is called by SessionImpl.createDataStoreGarbageCollector().

Parameters:

dataStore - the data store to be garbage-collected

list - the persistence managers

sessionList - the sessions to access the workspaces

Method Detail

setSleepBetweenNodes

public void setSleepBetweenNodes(long millis)

Specified by:

setSleepBetweenNodes in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

getSleepBetweenNodes

public long getSleepBetweenNodes()

Specified by:

getSleepBetweenNodes in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

setTestDelay

public void setTestDelay(int testDelay)

When testing the garbage collection, a delay is used instead of simulating concurrent access.

Parameters:

testDelay - the delay in milliseconds

setScanEventListener

public void setScanEventListener(ScanEventListener callback)

Deprecated. use setMarkEventListener().

setMarkEventListener

public void setMarkEventListener(org.apache.jackrabbit.api.management.MarkEventListener callback)

Specified by:

setMarkEventListener in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

scan

public void scan()
          throws RepositoryException

Deprecated. use mark().

Throws:

RepositoryException

mark

public void mark()
          throws RepositoryException

Specified by:

mark in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

Throws:

RepositoryException

setPersistenceManagerScan

public void setPersistenceManagerScan(boolean allow)

Specified by:

setPersistenceManagerScan in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

isPersistenceManagerScan

public boolean isPersistenceManagerScan()

Specified by:

isPersistenceManagerScan in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

getPersistenceManagerScan

public boolean getPersistenceManagerScan()

Deprecated. use isPersistenceManagerScan().

stopScan

public void stopScan()
              throws RepositoryException

Stop the observation listener if any are installed.

Throws:

RepositoryException

deleteUnused

public int deleteUnused()
                 throws RepositoryException

Deprecated. use sweep().

Throws:

RepositoryException

sweep

public int sweep()
          throws RepositoryException

Specified by:

sweep in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

Throws:

RepositoryException

getDataStore

public DataStore getDataStore()

Get the data store if one is used.

Returns:

the data store, or null

close

public void close()

Specified by:

close in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector

finalize

protected void finalize()
                 throws Throwable

Auto-close in case the application didn't call it explicitly.

Overrides:

finalize in class Object

Throws:

Throwable