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

Class AbstractRemotableTree

java.lang.Object

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

All Implemented Interfaces:

Serializable, PublicationNode, PublicationTree

Direct Known Subclasses:

ClientRemotePublicationTree, ProxyTree

public abstract class AbstractRemotableTree
extends Object
implements PublicationTree

Abstract class for PublicationTree that delegates method calls to a remote service.

Author:

tiry

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configName
protected boolean	released
protected String	sessionId
protected RemotePublicationTreeManager	treeService

Constructor Summary

Constructors

Constructor and Description
AbstractRemotableTree()

Method Summary

Modifier and Type	Method and Description
boolean	canManagePublishing(PublishedDocument publishedDocument) Returns true if the current user can manage the publishing of the given publishedDocument, ie approve or reject the document.
boolean	canPublishTo(PublicationNode publicationNode) Returns true if the current user can publish to the specified publicationNode, false otherwise.
boolean	canUnpublish(PublishedDocument publishedDocument) Returns true if the current user can unpublish the given publishedDocument, false otherwise.
String	getConfigName()
List<PublishedDocument>	getExistingPublishedDocument(DocumentLocation docLoc)
PublicationNode	getNodeByPath(String path)
PublicationNode	getParent()
List<PublishedDocument>	getPublishedDocumentInNode(PublicationNode node)
protected abstract String	getServerTreeSessionId()
protected abstract String	getTargetTreeName()
protected abstract RemotePublicationTreeManager	getTreeService()
boolean	hasValidationTask(PublishedDocument publishedDocument)
boolean	isPublicationNode(DocumentModel documentModel) Returns true if the given documentModel is a PublicationNode of the current tree, false otherwise.
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
void	release()
void	setCurrentDocument(DocumentModel currentDocument) Sets the current document on which the tree will be based, if needed.
protected abstract PublicationNode	switchToClientNode(PublicationNode node)
protected List<PublicationNode>	switchToClientNodes(List<PublicationNode> nodes)
protected abstract PublicationNode	switchToServerNode(PublicationNode node)
void	unpublish(DocumentModel doc, PublicationNode targetNode)
void	unpublish(PublishedDocument publishedDocument)
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.
PublicationNode	wrapToPublicationNode(DocumentModel documentModel) Returns a PublicationNode for the current tree built on the given documentModel.
PublishedDocument	wrapToPublishedDocument(DocumentModel documentModel)

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.PublicationTree

getIconCollapsed, getIconExpanded, getTreeTitle, getTreeType, initTree

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

getChildrenDocuments, getChildrenNodes, getName, getNodeType, getPath, getSessionId, getTitle, getTreeConfigName, getType

Field Detail

treeService

protected RemotePublicationTreeManager treeService

sessionId

protected String sessionId

configName

protected String configName

released

protected boolean released

Constructor Detail

AbstractRemotableTree

public AbstractRemotableTree()

Method Detail

getTreeService

protected abstract RemotePublicationTreeManager getTreeService()

getTargetTreeName

protected abstract String getTargetTreeName()

getServerTreeSessionId

protected abstract String getServerTreeSessionId()

getExistingPublishedDocument

public List<PublishedDocument> getExistingPublishedDocument(DocumentLocation docLoc)

Specified by:

getExistingPublishedDocument in interface PublicationTree

getPublishedDocumentInNode

public List<PublishedDocument> getPublishedDocumentInNode(PublicationNode node)

Specified by:

getPublishedDocumentInNode in interface PublicationTree

publish

public PublishedDocument publish(DocumentModel doc,
                                 PublicationNode targetNode)

Specified by:

publish in interface PublicationTree

publish

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

Specified by:

publish in interface PublicationTree

unpublish

public void unpublish(DocumentModel doc,
                      PublicationNode targetNode)

Specified by:

unpublish in interface PublicationTree

unpublish

public void unpublish(PublishedDocument publishedDocument)

Specified by:

unpublish in interface PublicationTree

switchToClientNode

protected abstract PublicationNode switchToClientNode(PublicationNode node)

switchToServerNode

protected abstract PublicationNode switchToServerNode(PublicationNode node)

switchToClientNodes

protected List<PublicationNode> switchToClientNodes(List<PublicationNode> nodes)

getNodeByPath

public PublicationNode getNodeByPath(String path)

Specified by:

getNodeByPath in interface PublicationTree

getConfigName

public String getConfigName()

Specified by:

getConfigName in interface PublicationTree

getParent

public PublicationNode getParent()

Specified by:

getParent in interface PublicationNode

setCurrentDocument

public void setCurrentDocument(DocumentModel currentDocument)

Description copied from interface: PublicationTree

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 PublicationTree

Parameters:

currentDocument - the current document

release

public void release()

Specified by:

release in interface PublicationTree

validatorPublishDocument

public void validatorPublishDocument(PublishedDocument publishedDocument,
                                     String comment)

Description copied from interface: PublicationTree

A validator (the current user) approves the publication.

Specified by:

validatorPublishDocument in interface PublicationTree

Parameters:

publishedDocument - the current published document that will be approved

validatorRejectPublication

public void validatorRejectPublication(PublishedDocument publishedDocument,
                                       String comment)

Description copied from interface: PublicationTree

A validator (the current user) rejects the publication.

Specified by:

validatorRejectPublication in interface PublicationTree

Parameters:

publishedDocument - the currently published document that will be rejected

canPublishTo

public boolean canPublishTo(PublicationNode publicationNode)

Description copied from interface: PublicationTree

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

Specified by:

canPublishTo in interface PublicationTree

Returns:

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

canUnpublish

public boolean canUnpublish(PublishedDocument publishedDocument)

Description copied from interface: PublicationTree

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

Specified by:

canUnpublish in interface PublicationTree

Returns:

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

hasValidationTask

public boolean hasValidationTask(PublishedDocument publishedDocument)

Specified by:

hasValidationTask in interface PublicationTree

canManagePublishing

public boolean canManagePublishing(PublishedDocument publishedDocument)

Description copied from interface: PublicationTree

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

Specified by:

canManagePublishing in interface PublicationTree

wrapToPublishedDocument

public PublishedDocument wrapToPublishedDocument(DocumentModel documentModel)

Specified by:

wrapToPublishedDocument in interface PublicationTree

isPublicationNode

public boolean isPublicationNode(DocumentModel documentModel)

Description copied from interface: PublicationTree

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

Specified by:

isPublicationNode in interface PublicationTree

wrapToPublicationNode

public PublicationNode wrapToPublicationNode(DocumentModel documentModel)

Description copied from interface: PublicationTree

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

Specified by:

wrapToPublicationNode in interface PublicationTree