org.jahia.services.content

Class JCRVersionService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.content.JCRVersionService

public class JCRVersionService
extends JahiaService

Version listing and retrieval service. This service offers tools to list the versions in a user-friendly way, collapsing internal versions into date-related changes, retrieving comments, etc...

Author:

loom Date: Mar 10, 2010 Time: 10:06:02 AM

Field Summary

Fields

Modifier and Type	Field and Description
static org.joda.time.format.DateTimeFormatter	DATE_FORMAT

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JCRVersionService()

Method Summary

Modifier and Type	Method and Description
void	addVersionLabel(JCRNodeWrapper node, String label)
void	addVersionLabel(List<String> allUuids, String label, String workspace)
static javax.jcr.version.Version	findClosestVersion(javax.jcr.version.VersionHistory vh, Date versionDate) Finds the closest version in a version history to a specific date.
static javax.jcr.version.Version	findVersionByLabel(javax.jcr.version.VersionHistory vh, String label)
static JCRVersionService	getInstance() Get the singleton instance of the JCRPublicationService
List<VersionInfo>	getLinearVersionInfos(javax.jcr.Session session, JCRNodeWrapper node)
Set<String>	getVersionedTypes()
List<VersionInfo>	getVersionInfos(javax.jcr.Session session, JCRNodeWrapper node) Retrieves the list of versions, ignoring internal version created in the publication process.
void	restoreVersionLabel(JCRNodeWrapper node, Date versionDate, String label, boolean allSubTree)
void	setMixinsToRemoveOnDestination(Set<String> mixinsToRemoveOnDestination)
void	setVersionedTypes(String versionedTypes)
void	start()
void	stop()

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

public static final org.joda.time.format.DateTimeFormatter DATE_FORMAT

Constructor Detail

JCRVersionService

public JCRVersionService()

Method Detail

getInstance

public static JCRVersionService getInstance()

Get the singleton instance of the JCRPublicationService

Returns:

the singleton instance of the JCRPublicationService

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException

setVersionedTypes

public void setVersionedTypes(String versionedTypes)

getVersionedTypes

public Set<String> getVersionedTypes()

getVersionInfos

public List<VersionInfo> getVersionInfos(javax.jcr.Session session,
                                         JCRNodeWrapper node)
                                  throws javax.jcr.RepositoryException

Retrieves the list of versions, ignoring internal version created in the publication process.

Parameters:

session - the session to use to retrieve the versions

node - the node for which to retrieve the versions

Returns:

a List of VersionInfo objects containing the resolved versions, as well as extra information such as the checkinDate if available.

Throws:

javax.jcr.RepositoryException - happens if there was a problem retrieving the list of versions.

getLinearVersionInfos

public List<VersionInfo> getLinearVersionInfos(javax.jcr.Session session,
                                               JCRNodeWrapper node)
                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

findClosestVersion

public static javax.jcr.version.Version findClosestVersion(javax.jcr.version.VersionHistory vh,
                                                           Date versionDate)
                                                    throws javax.jcr.RepositoryException

Finds the closest version in a version history to a specific date.

Parameters:

vh - the version history in which to lookup versions

versionDate - the date to compare with. Note that it will find the closest version at OR BEFORE the date

Returns:

the closest version at or before the date specified.

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

restoreVersionLabel

public void restoreVersionLabel(JCRNodeWrapper node,
                                Date versionDate,
                                String label,
                                boolean allSubTree)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

findVersionByLabel

public static javax.jcr.version.Version findVersionByLabel(javax.jcr.version.VersionHistory vh,
                                                           String label)
                                                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addVersionLabel

public void addVersionLabel(JCRNodeWrapper node,
                            String label)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addVersionLabel

public void addVersionLabel(List<String> allUuids,
                            String label,
                            String workspace)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setMixinsToRemoveOnDestination

public void setMixinsToRemoveOnDestination(Set<String> mixinsToRemoveOnDestination)