Package org.nuxeo.ecm.platform.publisher.task

Class CoreProxyWithWorkflowFactory

java.lang.Object

org.nuxeo.ecm.platform.publisher.api.AbstractBasePublishedDocumentFactory

org.nuxeo.ecm.platform.publisher.impl.core.CoreProxyFactory

org.nuxeo.ecm.platform.publisher.task.CoreProxyWithWorkflowFactory

All Implemented Interfaces:

PublishedDocumentFactory

Direct Known Subclasses:

FolderishProxyFactory, RenditionPublicationFactory

public class CoreProxyWithWorkflowFactory
extends CoreProxyFactory
implements PublishedDocumentFactory

Implementation of the PublishedDocumentFactory for core implementation using native proxy system with validation workflow.

Author:

Thomas Roger, Thierry Martins, Antoine Taillefer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CoreProxyWithWorkflowFactory.DocumentPublisherUnrestricted

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACL_NAME
static String	JBPM_ACL_NAME
static String	LOOKUP_STATE_PARAM_BYACL
static String	LOOKUP_STATE_PARAM_BYTASK
static String	LOOKUP_STATE_PARAM_KEY
protected LookupState	lookupState
static String	PUBLISH_TASK_TYPE
static String	TASK_NAME

Fields inherited from class org.nuxeo.ecm.platform.publisher.api.AbstractBasePublishedDocumentFactory

coreSession, ENABLE_SNAPSHOT, eventProducer, parameters, publicationTree, TARGET_PUBLISHED_DOCUMENT_STATE, validatorsRule

Constructor Summary

Constructors

Constructor	Description
CoreProxyWithWorkflowFactory()

Method Summary

Modifier and Type	Method	Description
boolean	canManagePublishing(PublishedDocument publishedDocument)
protected void	createTask(DocumentModel document, CoreSession session, NuxeoPrincipal principal)
protected void	endTask(DocumentModel document, NuxeoPrincipal currentUser, CoreSession session, String comment, PublishingEvent event)
protected DocumentModel	getLiveDocument(CoreSession session, DocumentModel proxy)
protected TaskService	getTaskService()
protected boolean	hasValidationTask(DocumentModel proxy, NuxeoPrincipal currentUser)
boolean	hasValidationTask(PublishedDocument publishedDocument)
void	init(CoreSession coreSession, ValidatorsRule validatorsRule, Map<String,String> parameters)
protected boolean	isPublished(PublishedDocument publishedDocument, CoreSession session)
protected boolean	isPublishedDocWaitingForPublication(DocumentModel doc, CoreSession session)
protected boolean	isValidator(DocumentModel document, NuxeoPrincipal principal)
PublishedDocument	publishDocument(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
protected void	removeACL(DocumentModel document, CoreSession coreSession)
protected void	removeExistingProxiesOnPreviousVersions(DocumentModel newProxy)
protected void	removeProxy(DocumentModel doc, CoreSession coreSession)
protected void	restrictPermission(DocumentModel newProxy, NuxeoPrincipal principal, CoreSession coreSession, ACL acl)
void	setLookupByACL()
void	setLookupByTask()
void	validatorPublishDocument(PublishedDocument publishedDocument, String comment)	A validator (the current user) approves the publication.
void	validatorRejectPublication(PublishedDocument publishedDocument, String comment)	A validator (the current user) rejects the publication.
PublishedDocument	wrapDocumentModel(DocumentModel doc)

Methods inherited from class org.nuxeo.ecm.platform.publisher.impl.core.CoreProxyFactory

snapshotDocumentBeforePublish, unwrapPublishedDocument

Methods inherited from class org.nuxeo.ecm.platform.publisher.api.AbstractBasePublishedDocumentFactory

getEventProducer, getName, getParameter, getTargetPublishedDocumentState, getValidatorsFor, getValidatorsRule, init, isSnapshotingEnabled, needToVersionDocument, notifyEvent, notifyEvent, publishDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.publisher.api.PublishedDocumentFactory

getName, getValidatorsFor, getValidatorsRule, init, publishDocument, snapshotDocumentBeforePublish

Field Detail

TASK_NAME

public static final String TASK_NAME

See Also:

Constant Field Values

ACL_NAME

public static final String ACL_NAME

See Also:

Constant Field Values

JBPM_ACL_NAME

public static final String JBPM_ACL_NAME

See Also:

Constant Field Values

PUBLISH_TASK_TYPE

public static final String PUBLISH_TASK_TYPE

See Also:

Constant Field Values

LOOKUP_STATE_PARAM_KEY

public static final String LOOKUP_STATE_PARAM_KEY

See Also:

Constant Field Values

LOOKUP_STATE_PARAM_BYACL

public static final String LOOKUP_STATE_PARAM_BYACL

See Also:

Constant Field Values

LOOKUP_STATE_PARAM_BYTASK

public static final String LOOKUP_STATE_PARAM_BYTASK

See Also:

Constant Field Values

lookupState

protected LookupState lookupState

Constructor Detail

CoreProxyWithWorkflowFactory

public CoreProxyWithWorkflowFactory()

Method Detail

init

public void init(CoreSession coreSession,
                 ValidatorsRule validatorsRule,
                 Map<String,String> parameters)

Specified by:

init in interface PublishedDocumentFactory

Overrides:

init in class AbstractBasePublishedDocumentFactory

setLookupByTask

public void setLookupByTask()

setLookupByACL

public void setLookupByACL()

publishDocument

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

Specified by:

publishDocument in interface PublishedDocumentFactory

Overrides:

publishDocument in class CoreProxyFactory

isPublishedDocWaitingForPublication

protected boolean isPublishedDocWaitingForPublication(DocumentModel doc,
                                                      CoreSession session)

isValidator

protected boolean isValidator(DocumentModel document,
                              NuxeoPrincipal principal)

restrictPermission

protected void restrictPermission(DocumentModel newProxy,
                                  NuxeoPrincipal principal,
                                  CoreSession coreSession,
                                  ACL acl)

createTask

protected void createTask(DocumentModel document,
                          CoreSession session,
                          NuxeoPrincipal principal)

getTaskService

protected TaskService getTaskService()

removeExistingProxiesOnPreviousVersions

protected void removeExistingProxiesOnPreviousVersions(DocumentModel newProxy)

validatorPublishDocument

public void validatorPublishDocument(PublishedDocument publishedDocument,
                                     String comment)

Description copied from interface: PublishedDocumentFactory

A validator (the current user) approves the publication.

Specified by:

validatorPublishDocument in interface PublishedDocumentFactory

Overrides:

validatorPublishDocument in class AbstractBasePublishedDocumentFactory

Parameters:

publishedDocument - the current published document that will be approved

removeACL

protected void removeACL(DocumentModel document,
                         CoreSession coreSession)

endTask

protected void endTask(DocumentModel document,
                       NuxeoPrincipal currentUser,
                       CoreSession session,
                       String comment,
                       PublishingEvent event)

getLiveDocument

protected DocumentModel getLiveDocument(CoreSession session,
                                        DocumentModel proxy)

validatorRejectPublication

public void validatorRejectPublication(PublishedDocument publishedDocument,
                                       String comment)

Description copied from interface: PublishedDocumentFactory

A validator (the current user) rejects the publication.

Specified by:

validatorRejectPublication in interface PublishedDocumentFactory

Overrides:

validatorRejectPublication in class AbstractBasePublishedDocumentFactory

Parameters:

publishedDocument - the currently published document that will be rejected

removeProxy

protected void removeProxy(DocumentModel doc,
                           CoreSession coreSession)

wrapDocumentModel

public PublishedDocument wrapDocumentModel(DocumentModel doc)

Specified by:

wrapDocumentModel in interface PublishedDocumentFactory

Overrides:

wrapDocumentModel in class CoreProxyFactory

isPublished

protected boolean isPublished(PublishedDocument publishedDocument,
                              CoreSession session)

canManagePublishing

public boolean canManagePublishing(PublishedDocument publishedDocument)

Specified by:

canManagePublishing in interface PublishedDocumentFactory

Overrides:

canManagePublishing in class AbstractBasePublishedDocumentFactory

hasValidationTask

protected boolean hasValidationTask(DocumentModel proxy,
                                    NuxeoPrincipal currentUser)

hasValidationTask

public boolean hasValidationTask(PublishedDocument publishedDocument)

Specified by:

hasValidationTask in interface PublishedDocumentFactory

Overrides:

hasValidationTask in class AbstractBasePublishedDocumentFactory