org.jahia.services.content

Class JCRPublicationService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.content.JCRPublicationService

public class JCRPublicationService
extends JahiaService

This is a Jahia service, which offers functionality to publish, unpublish or get publication info of JCR nodes

Author:

toto

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Method Summary

Modifier and Type	Method and Description
void	addPropertiesToSkipForReferences(String propertiesToSkipForReferences)
void	addReferencedNodeTypesToSkip(String referencedNodeTypesToSkip)
protected void	addRemovedLabel(JCRNodeWrapper node, String label)
static JCRPublicationService	getInstance() Get the singleton instance of the JCRPublicationService
List<PublicationInfo>	getPublicationInfo(String uuid, Set<String> languages, boolean includesReferences, boolean includesSubnodes, boolean allsubtree, JCRSessionWrapper sourceSession, JCRSessionWrapper destinationSession)
List<PublicationInfo>	getPublicationInfo(String uuid, Set<String> languages, boolean includesReferences, boolean includesSubnodes, boolean allsubtree, String sourceWorkspace, String destinationWorkspace) Gets the publication info for the current node and if acquired also for referenced nodes and subnodes.
List<PublicationInfo>	getPublicationInfos(List<String> uuids, Set<String> languages, boolean includesReferences, boolean includesSubnodes, boolean allsubtree, String sourceWorkspace, String destinationWorkspace)
JCRSessionFactory	getSessionFactory() Get the JCR session factory
int	getStatus(JCRNodeWrapper node, JCRSessionWrapper destinationSession, Set<String> languages) Get the publication status of a specific node
int	getStatus(JCRNodeWrapper node, JCRSessionWrapper destinationSession, Set<String> languages, Set<String> includedUuids) Get the publication status of a specific node, taking into account nodes being published at the same time (used for conflict detection)
boolean	hasIndependantPublication(JCRNodeWrapper node)
void	lockForPublication(List<String> publicationInfo, String workspace, String key)
void	print(javax.jcr.version.VersionHistory vh)
void	print(javax.jcr.version.Version v, int indent)
void	publish(List<String> uuids, String sourceWorkspace, String destinationWorkspace, boolean checkPermissions, boolean updateMetadata, List<String> comments)
void	publish(List<String> uuids, String sourceWorkspace, String destinationWorkspace, boolean checkPermissions, List<String> comments)
void	publish(List<String> uuids, String sourceWorkspace, String destinationWorkspace, List<String> comments)
void	publishByInfoList(List<PublicationInfo> publicationInfos, String sourceWorkspace, String destinationWorkspace, boolean checkPermissions, List<String> comments)
void	publishByInfoList(List<PublicationInfo> publicationInfos, String sourceWorkspace, String destinationWorkspace, List<String> comments)
void	publishByMainId(String uuid) Publish a node sub-tree from default into the live workspace.
void	publishByMainId(String uuid, String sourceWorkspace, String destinationWorkspace, Set<String> languages, boolean allSubTree, List<String> comments) Publish a node into the live workspace.
void	registerListener(PublicationEventListener listener) Register a listener of publication events.
void	setBatchSize(int batchSize)
void	setLoggingService(MetricsLoggingService loggingService)
void	setPropertiesToSkipForReferences(String propertiesToSkipForReferences)
void	setReferencedNodeTypesToSkip(String referencedNodeTypesToSkip)
void	setSessionFactory(JCRSessionFactory sessionFactory) Set the JCR session factory
void	setVersionedTypes(String versionedTypes)
void	start()
void	stop()
static boolean	supportsPublication(JCRSessionWrapper sourceSession, JCRNodeWrapper node)
void	unlockForPublication(List<String> publicationInfo, String workspace, String key)
List<String>	unpublish(List<String> uuids) Unpublish a node from live workspace.
List<String>	unpublish(List<String> uuids, boolean checkPermissions) Unpublish a node from live workspace.
void	unregisterListener(PublicationEventListener listener) Unregister a listener of publication events.

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

Method Detail

getSessionFactory

public JCRSessionFactory getSessionFactory()

Get the JCR session factory

Returns:

The JCR session factory

setSessionFactory

public void setSessionFactory(JCRSessionFactory sessionFactory)

Set the JCR session factory

Parameters:

sessionFactory - The JCR session factory

setLoggingService

public void setLoggingService(MetricsLoggingService loggingService)

getInstance

public static JCRPublicationService getInstance()

Get the singleton instance of the JCRPublicationService

Returns:

the singleton instance of the JCRPublicationService

hasIndependantPublication

public boolean hasIndependantPublication(JCRNodeWrapper node)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

lockForPublication

public void lockForPublication(List<String> publicationInfo,
                               String workspace,
                               String key)
                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

unlockForPublication

public void unlockForPublication(List<String> publicationInfo,
                                 String workspace,
                                 String key)
                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

publishByMainId

public void publishByMainId(String uuid)
                     throws javax.jcr.RepositoryException

Publish a node sub-tree from default into the live workspace. Referenced nodes will also be published. Parent node must be published, or will be published if publishParent is true.

Parameters:

uuid - UUID of the node to publish

Throws:

javax.jcr.RepositoryException - in case of error

publishByMainId

public void publishByMainId(String uuid,
                            String sourceWorkspace,
                            String destinationWorkspace,
                            Set<String> languages,
                            boolean allSubTree,
                            List<String> comments)
                     throws javax.jcr.RepositoryException

Publish a node into the live workspace. Referenced nodes will also be published. Parent node must be published, or will be published if publishParent is true.

Parameters:

uuid - Uuid of the node to publish

sourceWorkspace - the source workspace of the publication

destinationWorkspace - the destination workspace of the publication

languages - set of languages you wish to publish

allSubTree -

comments - an optional List of comments that will be used to log the publication in the metrics service.

Throws:

javax.jcr.RepositoryException - in case of error

publishByInfoList

public void publishByInfoList(List<PublicationInfo> publicationInfos,
                              String sourceWorkspace,
                              String destinationWorkspace,
                              List<String> comments)
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

publishByInfoList

public void publishByInfoList(List<PublicationInfo> publicationInfos,
                              String sourceWorkspace,
                              String destinationWorkspace,
                              boolean checkPermissions,
                              List<String> comments)
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

publish

public void publish(List<String> uuids,
                    String sourceWorkspace,
                    String destinationWorkspace,
                    List<String> comments)
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

publish

public void publish(List<String> uuids,
                    String sourceWorkspace,
                    String destinationWorkspace,
                    boolean checkPermissions,
                    List<String> comments)
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

publish

public void publish(List<String> uuids,
                    String sourceWorkspace,
                    String destinationWorkspace,
                    boolean checkPermissions,
                    boolean updateMetadata,
                    List<String> comments)
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

unpublish

public List<String> unpublish(List<String> uuids)
                       throws javax.jcr.RepositoryException

Unpublish a node from live workspace. Referenced Node will not be unpublished.

Parameters:

uuids - uuids of the node to unpublish

Returns:

the list of node UUIDs that the unpublish action was executed for

Throws:

javax.jcr.RepositoryException - in case of an error during this operation

unpublish

public List<String> unpublish(List<String> uuids,
                              boolean checkPermissions)
                       throws javax.jcr.RepositoryException

Unpublish a node from live workspace. Referenced Node will not be unpublished.

Parameters:

uuids - uuids of the node to unpublish

checkPermissions - do we need to check publish permissions on the provided nodes?

Returns:

the list of node UUIDs that the unpublish action was executed for

Throws:

javax.jcr.RepositoryException - in case of an error during this operation

getPublicationInfos

public List<PublicationInfo> getPublicationInfos(List<String> uuids,
                                                 Set<String> languages,
                                                 boolean includesReferences,
                                                 boolean includesSubnodes,
                                                 boolean allsubtree,
                                                 String sourceWorkspace,
                                                 String destinationWorkspace)
                                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getPublicationInfo

public List<PublicationInfo> getPublicationInfo(String uuid,
                                                Set<String> languages,
                                                boolean includesReferences,
                                                boolean includesSubnodes,
                                                boolean allsubtree,
                                                String sourceWorkspace,
                                                String destinationWorkspace)
                                         throws javax.jcr.RepositoryException

Gets the publication info for the current node and if acquired also for referenced nodes and subnodes. The returned PublicationInfo has the publication info for the current node (NOT_PUBLISHED, PUBLISHED, MODIFIED, UNPUBLISHABLE) and if requested you will be able to get the infos also for the subnodes and the referenced nodes. As language dependent data is always stored in subnodes you need to set includesSubnodes to true, if you also specify a list of languages.

Parameters:

uuid - The uuid of the node to get publication info

languages - Languages list to use for publication info, or null for all languages (only appplied if includesSubnodes is true)

includesReferences - If true include info for referenced nodes

includesSubnodes - If true include info for subnodes

Returns:

the PublicationInfo for the requested node(s)

Throws:

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

getPublicationInfo

public List<PublicationInfo> getPublicationInfo(String uuid,
                                                Set<String> languages,
                                                boolean includesReferences,
                                                boolean includesSubnodes,
                                                boolean allsubtree,
                                                JCRSessionWrapper sourceSession,
                                                JCRSessionWrapper destinationSession)
                                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getStatus

public int getStatus(JCRNodeWrapper node,
                     JCRSessionWrapper destinationSession,
                     Set<String> languages)
              throws javax.jcr.RepositoryException

Get the publication status of a specific node

Throws:

javax.jcr.RepositoryException

getStatus

public int getStatus(JCRNodeWrapper node,
                     JCRSessionWrapper destinationSession,
                     Set<String> languages,
                     Set<String> includedUuids)
              throws javax.jcr.RepositoryException

Get the publication status of a specific node, taking into account nodes being published at the same time (used for conflict detection)

Throws:

javax.jcr.RepositoryException

supportsPublication

public static boolean supportsPublication(JCRSessionWrapper sourceSession,
                                          JCRNodeWrapper node)
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addRemovedLabel

protected void addRemovedLabel(JCRNodeWrapper node,
                               String label)
                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

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

print

public void print(javax.jcr.version.VersionHistory vh)
           throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

print

public void print(javax.jcr.version.Version v,
                  int indent)
           throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setPropertiesToSkipForReferences

public void setPropertiesToSkipForReferences(String propertiesToSkipForReferences)

setReferencedNodeTypesToSkip

public void setReferencedNodeTypesToSkip(String referencedNodeTypesToSkip)

setVersionedTypes

public void setVersionedTypes(String versionedTypes)

addReferencedNodeTypesToSkip

public void addReferencedNodeTypesToSkip(String referencedNodeTypesToSkip)

addPropertiesToSkipForReferences

public void addPropertiesToSkipForReferences(String propertiesToSkipForReferences)

setBatchSize

public void setBatchSize(int batchSize)

registerListener

public void registerListener(PublicationEventListener listener)

Register a listener of publication events.

Parameters:

listener - Publication events listener to register.

unregisterListener

public void unregisterListener(PublicationEventListener listener)

Unregister a listener of publication events.

Parameters:

listener - Publication events listener to unregister.