org.nuxeo.ecm.platform.publisher.impl.service

Class PublisherServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl

All Implemented Interfaces:

PublisherService, RemotePublicationTreeManager, Adaptable, Component, Extensible, TimestampedService

public class PublisherServiceImpl
extends DefaultComponent
implements PublisherService, RemotePublicationTreeManager

POJO implementation of the publisher service Implements both PublisherService and RemotePublicationTreeManager.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACTORY_EP
protected Map<String,PublishedDocumentFactoryDescriptor>	factoryDescriptors
protected Map<String,PublicationTree>	liveTrees
protected Map<String,PublicationTreeConfigDescriptor>	pendingDescriptors
protected static String	RELATIVE_ROOT_PATH_KEY
protected Map<String,String>	remoteLiveTrees
protected static String	ROOT_PATH_KEY
static String	ROOT_SECTION_FINDER_FACTORY_EP
protected RootSectionFinderFactory	rootSectionFinderFactory
static String	TREE_CONFIG_EP
static String	TREE_EP
protected Map<String,PublicationTreeConfigDescriptor>	treeConfigDescriptors
protected Map<String,PublicationTreeDescriptor>	treeDescriptors
static String	VALIDATORS_RULE_EP
protected Map<String,ValidatorsRuleDescriptor>	validatorsRuleDescriptors

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Fields inherited from interface org.nuxeo.ecm.platform.publisher.api.PublisherService

DOMAIN_NAME_KEY

Constructor Summary

Constructors

Constructor and Description
PublisherServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
protected PublicationTree	buildTree(String sid, String treeConfigName, CoreSession coreSession, Map<String,String> params)
boolean	canManagePublishing(String sid, PublishedDocument publishedDocument) Returns true if the current user can manage the publishing of the given published document, ie.
boolean	canPublishTo(String sid, PublicationNode publicationNode) Returns true if the current user can publish to the specified publicationNode, false otherwise.
boolean	canUnpublish(String sid, PublishedDocument publishedDocument) Returns true if the current user can unpublish the given publishedDocument, false otherwise.
protected Map<String,String>	computeAllParameters(PublicationTreeConfigDescriptor config, Map<String,String> params)
protected String	computeTreeSessionId(String treeConfigName, CoreSession coreSession)
protected String	computeTreeSessionId(String treeConfigName, String sid)
protected void	doApplicationStarted()
List<String>	getAvailablePublicationTree()
Map<String,String>	getAvailablePublicationTrees() Returns a Map with tree name as key and tree title as value.
List<PublishedDocument>	getChildrenDocuments(PublicationNode node)
List<PublicationNode>	getChildrenNodes(PublicationNode node)
List<PublishedDocument>	getExistingPublishedDocument(String sid, DocumentLocation docLoc)
int	getLiveTreeCount()
PublicationNode	getNodeByPath(String sid, String path)
protected PublicationTree	getOrBuildTree(String treeConfigName, CoreSession coreSession, Map<String,String> params)
Map<String,String>	getParametersFor(String treeConfigName)
PublicationNode	getParent(PublicationNode node)
protected PublicationTree	getPublicationTree(PublicationTreeDescriptor treeDescriptor, String sid, CoreSession coreSession, Map<String,String> parameters, PublishedDocumentFactory factory, String configName, String treeTitle)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,String> params)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,String> params, DocumentModel currentDocument)
protected PublicationTreeConfigDescriptor	getPublicationTreeConfigDescriptor(String treeConfigName)
protected PublicationTreeDescriptor	getPublicationTreeDescriptor(PublicationTreeConfigDescriptor config)
PublicationTree	getPublicationTreeFor(DocumentModel doc, CoreSession coreSession)
protected PublishedDocumentFactory	getPublishedDocumentFactory(PublicationTreeConfigDescriptor config, PublicationTreeDescriptor treeDescriptor, CoreSession coreSession, Map<String,String> params)
protected PublishedDocumentFactoryDescriptor	getPublishedDocumentFactoryDescriptor(PublicationTreeConfigDescriptor config, PublicationTreeDescriptor treeDescriptor)
List<PublishedDocument>	getPublishedDocumentInNode(PublicationNode node)
RootSectionFinder	getRootSectionFinder(CoreSession session)
PublicationTree	getTreeBySid(String sid)
protected ValidatorsRule	getValidatorsRule(PublishedDocumentFactoryDescriptor factoryDesc)
boolean	hasValidationTask(String sid, PublishedDocument publishedDocument)
Map<String,String>	initRemoteSession(String treeConfigName, Map<String,String> params)
boolean	isPublicationNode(String sid, DocumentModel documentModel) Returns true if the given documentModel is a PublicationNode of the current tree, false otherwise.
boolean	isPublishedDocument(DocumentModel documentModel)
protected List<PublicationNode>	makeRemotable(List<PublicationNode> nodes, String sid)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	registerPendingDescriptors()
protected void	registerTreeConfig(PublicationTreeConfigDescriptor desc)
void	registerTreeConfigFor(DocumentModel domain)
void	release(String sid)
void	releaseAllTrees(String sessionId)
void	setCurrentDocument(String sid, DocumentModel currentDocument) Sets the current document on which the tree will be based, if needed.
void	unpublish(DocumentModel doc, PublicationNode targetNode)
void	unpublish(String sid, PublishedDocument publishedDocument)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unRegisterTreeConfigFor(DocumentModel domain)
void	unRegisterTreeConfigFor(String domainName)
void	validatorPublishDocument(String sid, PublishedDocument publishedDocument, String comment) A validator (the current user) approves the publication.
void	validatorRejectPublication(String sid, PublishedDocument publishedDocument, String comment) A validator (the current user) rejects the publication.
PublicationNode	wrapToPublicationNode(DocumentModel documentModel, CoreSession coreSession)
PublicationNode	wrapToPublicationNode(String sid, DocumentModel documentModel) Returns a PublicationNode for the current tree built on the given documentModel.
PublishedDocument	wrapToPublishedDocument(String sid, DocumentModel documentModel)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

treeDescriptors

protected Map<String,PublicationTreeDescriptor> treeDescriptors

factoryDescriptors

protected Map<String,PublishedDocumentFactoryDescriptor> factoryDescriptors

treeConfigDescriptors

protected Map<String,PublicationTreeConfigDescriptor> treeConfigDescriptors

validatorsRuleDescriptors

protected Map<String,ValidatorsRuleDescriptor> validatorsRuleDescriptors

pendingDescriptors

protected Map<String,PublicationTreeConfigDescriptor> pendingDescriptors

liveTrees

protected Map<String,PublicationTree> liveTrees

rootSectionFinderFactory

protected RootSectionFinderFactory rootSectionFinderFactory

remoteLiveTrees

protected Map<String,String> remoteLiveTrees

TREE_EP

public static final String TREE_EP

See Also:

Constant Field Values

TREE_CONFIG_EP

public static final String TREE_CONFIG_EP

See Also:

Constant Field Values

VALIDATORS_RULE_EP

public static final String VALIDATORS_RULE_EP

See Also:

Constant Field Values

FACTORY_EP

public static final String FACTORY_EP

See Also:

Constant Field Values

ROOT_SECTION_FINDER_FACTORY_EP

public static final String ROOT_SECTION_FINDER_FACTORY_EP

See Also:

Constant Field Values

ROOT_PATH_KEY

protected static final String ROOT_PATH_KEY

See Also:

Constant Field Values

RELATIVE_ROOT_PATH_KEY

protected static final String RELATIVE_ROOT_PATH_KEY

See Also:

Constant Field Values

Constructor Detail

PublisherServiceImpl

public PublisherServiceImpl()

Method Detail

applicationStarted

public void applicationStarted(ComponentContext context)

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.

Specified by:

applicationStarted in interface Component

Overrides:

applicationStarted in class DefaultComponent

doApplicationStarted

protected void doApplicationStarted()

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

getLiveTreeCount

public int getLiveTreeCount()

getTreeBySid

public PublicationTree getTreeBySid(String sid)

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

registerTreeConfig

protected void registerTreeConfig(PublicationTreeConfigDescriptor desc)

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

computeTreeSessionId

protected String computeTreeSessionId(String treeConfigName,
                                      CoreSession coreSession)

computeTreeSessionId

protected String computeTreeSessionId(String treeConfigName,
                                      String sid)

getAvailablePublicationTree

public List<String> getAvailablePublicationTree()

Specified by:

getAvailablePublicationTree in interface PublisherService

getAvailablePublicationTrees

public Map<String,String> getAvailablePublicationTrees()

Description copied from interface: PublisherService

Returns a Map with tree name as key and tree title as value.

Specified by:

getAvailablePublicationTrees in interface PublisherService

getPublicationTree

public PublicationTree getPublicationTree(String treeName,
                                          CoreSession coreSession,
                                          Map<String,String> params)
                                   throws PublicationTreeNotAvailable

Specified by:

getPublicationTree in interface PublisherService

Throws:

PublicationTreeNotAvailable

getPublicationTree

public PublicationTree getPublicationTree(String treeName,
                                          CoreSession coreSession,
                                          Map<String,String> params,
                                          DocumentModel currentDocument)
                                   throws PublicationTreeNotAvailable

Specified by:

getPublicationTree in interface PublisherService

Throws:

PublicationTreeNotAvailable

initRemoteSession

public Map<String,String> initRemoteSession(String treeConfigName,
                                            Map<String,String> params)

Specified by:

initRemoteSession in interface RemotePublicationTreeManager

release

public void release(String sid)

Specified by:

release in interface RemotePublicationTreeManager

releaseAllTrees

public void releaseAllTrees(String sessionId)

Specified by:

releaseAllTrees in interface PublisherService

getOrBuildTree

protected PublicationTree getOrBuildTree(String treeConfigName,
                                         CoreSession coreSession,
                                         Map<String,String> params)
                                  throws PublicationTreeNotAvailable

Throws:

PublicationTreeNotAvailable

buildTree

protected PublicationTree buildTree(String sid,
                                    String treeConfigName,
                                    CoreSession coreSession,
                                    Map<String,String> params)
                             throws PublicationTreeNotAvailable

Throws:

PublicationTreeNotAvailable

computeAllParameters

protected Map<String,String> computeAllParameters(PublicationTreeConfigDescriptor config,
                                                  Map<String,String> params)

getPublishedDocumentFactory

protected PublishedDocumentFactory getPublishedDocumentFactory(PublicationTreeConfigDescriptor config,
                                                               PublicationTreeDescriptor treeDescriptor,
                                                               CoreSession coreSession,
                                                               Map<String,String> params)

getValidatorsRule

protected ValidatorsRule getValidatorsRule(PublishedDocumentFactoryDescriptor factoryDesc)

getPublishedDocumentFactoryDescriptor

protected PublishedDocumentFactoryDescriptor getPublishedDocumentFactoryDescriptor(PublicationTreeConfigDescriptor config,
                                                                                   PublicationTreeDescriptor treeDescriptor)

getPublicationTreeConfigDescriptor

protected PublicationTreeConfigDescriptor getPublicationTreeConfigDescriptor(String treeConfigName)

getPublicationTreeDescriptor

protected PublicationTreeDescriptor getPublicationTreeDescriptor(PublicationTreeConfigDescriptor config)

getPublicationTree

protected PublicationTree getPublicationTree(PublicationTreeDescriptor treeDescriptor,
                                             String sid,
                                             CoreSession coreSession,
                                             Map<String,String> parameters,
                                             PublishedDocumentFactory factory,
                                             String configName,
                                             String treeTitle)
                                      throws PublicationTreeNotAvailable

Throws:

PublicationTreeNotAvailable

publish

public PublishedDocument publish(DocumentModel doc,
                                 PublicationNode targetNode)

Specified by:

publish in interface PublisherService

Specified by:

publish in interface RemotePublicationTreeManager

publish

public PublishedDocument publish(DocumentModel doc,
                                 PublicationNode targetNode,
                                 Map<String,String> params)

Specified by:

publish in interface PublisherService

Specified by:

publish in interface RemotePublicationTreeManager

unpublish

public void unpublish(DocumentModel doc,
                      PublicationNode targetNode)

Specified by:

unpublish in interface PublisherService

Specified by:

unpublish in interface RemotePublicationTreeManager

unpublish

public void unpublish(String sid,
                      PublishedDocument publishedDocument)

Specified by:

unpublish in interface RemotePublicationTreeManager

getChildrenDocuments

public List<PublishedDocument> getChildrenDocuments(PublicationNode node)

Specified by:

getChildrenDocuments in interface RemotePublicationTreeManager

makeRemotable

protected List<PublicationNode> makeRemotable(List<PublicationNode> nodes,
                                              String sid)

getChildrenNodes

public List<PublicationNode> getChildrenNodes(PublicationNode node)

Specified by:

getChildrenNodes in interface RemotePublicationTreeManager

getParent

public PublicationNode getParent(PublicationNode node)

Specified by:

getParent in interface RemotePublicationTreeManager

getNodeByPath

public PublicationNode getNodeByPath(String sid,
                                     String path)

Specified by:

getNodeByPath in interface RemotePublicationTreeManager

getExistingPublishedDocument

public List<PublishedDocument> getExistingPublishedDocument(String sid,
                                                            DocumentLocation docLoc)

Specified by:

getExistingPublishedDocument in interface RemotePublicationTreeManager

getPublishedDocumentInNode

public List<PublishedDocument> getPublishedDocumentInNode(PublicationNode node)

Specified by:

getPublishedDocumentInNode in interface RemotePublicationTreeManager

setCurrentDocument

public void setCurrentDocument(String sid,
                               DocumentModel currentDocument)

Description copied from interface: RemotePublicationTreeManager

Sets the current document on which the tree will be based, if needed. Can be useful for some implementations that need to know on which document the user is.

Specified by:

setCurrentDocument in interface RemotePublicationTreeManager

currentDocument - the current document

validatorPublishDocument

public void validatorPublishDocument(String sid,
                                     PublishedDocument publishedDocument,
                                     String comment)

Description copied from interface: RemotePublicationTreeManager

A validator (the current user) approves the publication.

Specified by:

validatorPublishDocument in interface RemotePublicationTreeManager

publishedDocument - the current published document that will be approved

validatorRejectPublication

public void validatorRejectPublication(String sid,
                                       PublishedDocument publishedDocument,
                                       String comment)

Description copied from interface: RemotePublicationTreeManager

A validator (the current user) rejects the publication.

Specified by:

validatorRejectPublication in interface RemotePublicationTreeManager

publishedDocument - the currently published document that will be rejected

canPublishTo

public boolean canPublishTo(String sid,
                            PublicationNode publicationNode)

Description copied from interface: RemotePublicationTreeManager

Returns true if the current user can publish to the specified publicationNode, false otherwise.

Specified by:

canPublishTo in interface RemotePublicationTreeManager

Returns:

true if the current user can publish to the specified publicationNode, false otherwise.

canUnpublish

public boolean canUnpublish(String sid,
                            PublishedDocument publishedDocument)

Description copied from interface: RemotePublicationTreeManager

Returns true if the current user can unpublish the given publishedDocument, false otherwise.

Specified by:

canUnpublish in interface RemotePublicationTreeManager

Returns:

true if the current user can unpublish the given publishedDocument, false otherwise.

canManagePublishing

public boolean canManagePublishing(String sid,
                                   PublishedDocument publishedDocument)

Description copied from interface: RemotePublicationTreeManager

Returns true if the current user can manage the publishing of the given published document, ie. approve or reject the document.

Specified by:

canManagePublishing in interface RemotePublicationTreeManager

isPublishedDocument

public boolean isPublishedDocument(DocumentModel documentModel)

Specified by:

isPublishedDocument in interface PublisherService

getPublicationTreeFor

public PublicationTree getPublicationTreeFor(DocumentModel doc,
                                             CoreSession coreSession)

Specified by:

getPublicationTreeFor in interface PublisherService

hasValidationTask

public boolean hasValidationTask(String sid,
                                 PublishedDocument publishedDocument)

Specified by:

hasValidationTask in interface RemotePublicationTreeManager

wrapToPublishedDocument

public PublishedDocument wrapToPublishedDocument(String sid,
                                                 DocumentModel documentModel)

Specified by:

wrapToPublishedDocument in interface RemotePublicationTreeManager

isPublicationNode

public boolean isPublicationNode(String sid,
                                 DocumentModel documentModel)

Description copied from interface: RemotePublicationTreeManager

Returns true if the given documentModel is a PublicationNode of the current tree, false otherwise.

Specified by:

isPublicationNode in interface RemotePublicationTreeManager

wrapToPublicationNode

public PublicationNode wrapToPublicationNode(String sid,
                                             DocumentModel documentModel)

Description copied from interface: RemotePublicationTreeManager

Returns a PublicationNode for the current tree built on the given documentModel.

Specified by:

wrapToPublicationNode in interface RemotePublicationTreeManager

wrapToPublicationNode

public PublicationNode wrapToPublicationNode(DocumentModel documentModel,
                                             CoreSession coreSession)
                                      throws PublicationTreeNotAvailable

Specified by:

wrapToPublicationNode in interface PublisherService

Throws:

PublicationTreeNotAvailable

registerPendingDescriptors

protected void registerPendingDescriptors()

registerTreeConfigFor

public void registerTreeConfigFor(DocumentModel domain)

unRegisterTreeConfigFor

public void unRegisterTreeConfigFor(DocumentModel domain)

unRegisterTreeConfigFor

public void unRegisterTreeConfigFor(String domainName)

Since:

7.3

getParametersFor

public Map<String,String> getParametersFor(String treeConfigName)

Specified by:

getParametersFor in interface PublisherService

getRootSectionFinder

public RootSectionFinder getRootSectionFinder(CoreSession session)

Specified by:

getRootSectionFinder in interface PublisherService