org.jahia.services.history

Class NodeVersionHistoryHelper

java.lang.Object

org.jahia.services.history.NodeVersionHistoryHelper

public final class NodeVersionHistoryHelper
extends Object

Version history utility class for purging all version entries of the specified node.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	PURGE_HISTORY_CHUNK

Method Summary

Modifier and Type	Method and Description
static OrphanedVersionHistoryCheckStatus	checkOrphaned(long maxOrphans, boolean deleteOrphans, Writer statusOut) Triggers the process of orphaned version histories check.
static UnusedVersionCheckStatus	checkUnused(long maxUnused, boolean deleteUnused, long purgeOlderThanTimestamp, Writer statusOut) Triggers the process of unused versions check.
static void	forceStopOrphanedCheck() Forces stop of the orphaned version history check process if it is currently running.
static void	forceStopUnusedCheck() Forces stop of the unused versions check process if it is currently running.
static boolean	isCheckingOrphans() Returns true if the process for checking orphans is currently running.
static boolean	isCheckingUnused() Returns true if the process for checking unused versions is currently running.
static VersionHistoryCheckStatus	purgeVersionHistoryForNodes(javax.jcr.NodeIterator nodes, Writer statusOut) Performs the removal of unused versions for the specified nodes.
static VersionHistoryCheckStatus	purgeVersionHistoryForNodes(Set<String> nodeIdentifiers) Performs the removal of unused versions for the specified nodes.
static VersionHistoryCheckStatus	purgeVersionHistoryForNodes(Set<String> nodeIdentifiers, Writer statusOut) Performs the removal of unused versions for the specified nodes.

Methods inherited from class java.lang.Object

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

Field Detail

PURGE_HISTORY_CHUNK

protected static final int PURGE_HISTORY_CHUNK

Method Detail

checkOrphaned

public static OrphanedVersionHistoryCheckStatus checkOrphaned(long maxOrphans,
                                                              boolean deleteOrphans,
                                                              Writer statusOut)
                                                       throws javax.jcr.RepositoryException

Triggers the process of orphaned version histories check. If the deleteOrphans is set to true also performs the purge of found orphaned version histories. This method ensures that only one check process runs at a time.

Parameters:

maxOrphans - the maximum number of orphaned histories found at which the process is stopped

deleteOrphans - if set to true performs the purge of found orphaned version histories; in case of false only the found orphaned version history count is reported, but no removal is done

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check

Throws:

javax.jcr.RepositoryException - in case of JCR errors

checkUnused

public static UnusedVersionCheckStatus checkUnused(long maxUnused,
                                                   boolean deleteUnused,
                                                   long purgeOlderThanTimestamp,
                                                   Writer statusOut)
                                            throws javax.jcr.RepositoryException

Triggers the process of unused versions check. If the deleteUnused is set to true also performs the purge of found unused versions. This method ensures that only one check process runs at a time.

Parameters:

maxUnused - the maximum number of unused versions found at which the process is stopped

deleteUnused - if set to true performs the purge of found unused versions; in case of false only the found unused versions count is reported, but no removal is done

purgeOlderThanTimestamp - if positive value is provided checks that the unused versions are older than the specified date (timestamp in milliseconds UTC); if 0 value is provided all found unused versions are considered in the process

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check

Throws:

javax.jcr.RepositoryException - in case of JCR errors

forceStopOrphanedCheck

public static void forceStopOrphanedCheck()

Forces stop of the orphaned version history check process if it is currently running.

forceStopUnusedCheck

public static void forceStopUnusedCheck()

Forces stop of the unused versions check process if it is currently running.

isCheckingOrphans

public static boolean isCheckingOrphans()

Returns true if the process for checking orphans is currently running.

Returns:

true if the process for checking orphans is currently running; false otherwise

isCheckingUnused

public static boolean isCheckingUnused()

Returns true if the process for checking unused versions is currently running.

Returns:

true if the process for checking unused versions is currently running; false otherwise

purgeVersionHistoryForNodes

public static VersionHistoryCheckStatus purgeVersionHistoryForNodes(javax.jcr.NodeIterator nodes,
                                                                    Writer statusOut)
                                                             throws javax.jcr.RepositoryException

Performs the removal of unused versions for the specified nodes. All unused versions are removed, no mater the "age" of the version.

Parameters:

nodes - an instance of NodeIterator for processing nodes

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check

Throws:

javax.jcr.RepositoryException - in case of JCR errors

purgeVersionHistoryForNodes

public static VersionHistoryCheckStatus purgeVersionHistoryForNodes(Set<String> nodeIdentifiers)

Performs the removal of unused versions for the specified nodes. All unused versions are removed, no mater the "age" of the version.

Parameters:

nodeIdentifiers - a set of node IDs to process

Returns:

the status object to indicate the result of the check

purgeVersionHistoryForNodes

public static VersionHistoryCheckStatus purgeVersionHistoryForNodes(Set<String> nodeIdentifiers,
                                                                    Writer statusOut)

Performs the removal of unused versions for the specified nodes. All unused versions are removed, no mater the "age" of the version.

Parameters:

nodeIdentifiers - a set of node IDs to process

statusOut - a writer to log current processing status into

Returns:

the status object to indicate the result of the check