Package 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, Adaptable, Component, Extensible, TimestampedService

public class PublisherServiceImpl
extends DefaultComponent
implements PublisherService

POJO implementation of the publisher service.

Author:

tiry

Field Summary

Fields

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

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

lastModified, name

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

DOMAIN_NAME_KEY

Constructor Summary

Constructors

Constructor	Description
PublisherServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
protected PublicationTree	buildTree(String treeConfigName, CoreSession coreSession, Map<String,String> params)
protected Map<String,String>	computeAllParameters(PublicationTreeConfigDescriptor config, Map<String,String> params)
protected void	doApplicationStarted()
int	getApplicationStartedOrder()	The component notification order for Component.start(ComponentContext).
List<String>	getAvailablePublicationTree()
Map<String,String>	getAvailablePublicationTrees()	Returns a Map with tree name as key and tree title as value.
Map<String,String>	getParametersFor(String treeConfigName)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,String> params)
PublicationTree	getPublicationTree(String treeName, CoreSession coreSession, Map<String,String> params, DocumentModel currentDocument)
protected PublicationTree	getPublicationTree(PublicationTreeDescriptor treeDescriptor, CoreSession coreSession, Map<String,String> parameters, PublishedDocumentFactory factory, String configName, String treeTitle)
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)
RootSectionFinder	getRootSectionFinder(CoreSession session)
protected ValidatorsRule	getValidatorsRule(PublishedDocumentFactoryDescriptor factoryDesc)
boolean	isPublishedDocument(DocumentModel documentModel)
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	start(ComponentContext context)	Start the component.
void	unpublish(DocumentModel doc, PublicationNode targetNode)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unRegisterTreeConfigFor(String domainName)
void	unRegisterTreeConfigFor(DocumentModel domain)
PublicationNode	wrapToPublicationNode(DocumentModel documentModel, CoreSession coreSession)

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

addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, stop, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Details

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

rootSectionFinderFactory

protected RootSectionFinderFactory rootSectionFinderFactory

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 Details

PublisherServiceImpl

public PublisherServiceImpl()

Method Details

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.start(ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start 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

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

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)

Specified by:

getPublicationTree in interface PublisherService

getPublicationTree

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

Specified by:

getPublicationTree in interface PublisherService

buildTree

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

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,
 CoreSession coreSession,
 Map<String,String> parameters,
 PublishedDocumentFactory factory,
 String configName,
 String treeTitle)

publish

public PublishedDocument publish(DocumentModel doc,
 PublicationNode targetNode)

Specified by:

publish in interface PublisherService

publish

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

Specified by:

publish in interface PublisherService

unpublish

public void unpublish(DocumentModel doc,
 PublicationNode targetNode)

Specified by:

unpublish in interface PublisherService

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

wrapToPublicationNode

public PublicationNode wrapToPublicationNode(DocumentModel documentModel,
 CoreSession coreSession)

Specified by:

wrapToPublicationNode in interface PublisherService

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