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:

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

Field Summary

Fields

Modifier and Type	Field and 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
static String	PUBLISH_TASK_TYPE
static String	TASK_NAME

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

ENABLE_SNAPSHOT, TARGET_PUBLISHED_DOCUMENT_STATE

Constructor Summary

Constructors

Constructor and Description
CoreProxyWithWorkflowFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canManagePublishing(PublishedDocument publishedDocument)
boolean	hasValidationTask(PublishedDocument publishedDocument)
void	init(CoreSession coreSession, ValidatorsRule validatorsRule, Map<String,String> parameters)
PublishedDocument	publishDocument(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
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

getName, getValidatorsFor, getValidatorsRule, init, publishDocument

Methods inherited from class java.lang.Object

equals, 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

Constructor Detail

CoreProxyWithWorkflowFactory

public CoreProxyWithWorkflowFactory()

Method Detail

init

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

Specified by:

init in interface PublishedDocumentFactory

Overrides:

init in class AbstractBasePublishedDocumentFactory

Throws:

ClientException

setLookupByTask

public void setLookupByTask()

setLookupByACL

public void setLookupByACL()

publishDocument

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

Specified by:

publishDocument in interface PublishedDocumentFactory

Overrides:

publishDocument in class CoreProxyFactory

Throws:

ClientException

validatorPublishDocument

public void validatorPublishDocument(PublishedDocument publishedDocument,
                            String comment)
                              throws PublishingException

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

Throws:

PublishingException

validatorRejectPublication

public void validatorRejectPublication(PublishedDocument publishedDocument,
                              String comment)
                                throws PublishingException

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

Throws:

PublishingException

wrapDocumentModel

public PublishedDocument wrapDocumentModel(DocumentModel doc)
                                    throws ClientException

Specified by:

wrapDocumentModel in interface PublishedDocumentFactory

Overrides:

wrapDocumentModel in class CoreProxyFactory

Throws:

ClientException

canManagePublishing

public boolean canManagePublishing(PublishedDocument publishedDocument)
                            throws ClientException

Specified by:

canManagePublishing in interface PublishedDocumentFactory

Overrides:

canManagePublishing in class AbstractBasePublishedDocumentFactory

Throws:

ClientException

hasValidationTask

public boolean hasValidationTask(PublishedDocument publishedDocument)
                          throws ClientException

Specified by:

hasValidationTask in interface PublishedDocumentFactory

Overrides:

hasValidationTask in class AbstractBasePublishedDocumentFactory

Throws:

ClientException