org.nuxeo.ecm.platform.publisher.remoting.restProxies

Class RemotePublicationTreeManagerRestProxy

java.lang.Object

org.nuxeo.ecm.platform.publisher.remoting.restProxies.RemotePublicationTreeManagerRestProxy

All Implemented Interfaces:

RemotePublicationTreeManager

public class RemotePublicationTreeManagerRestProxy
extends Object
implements RemotePublicationTreeManager

HTTP facade for the RemotePublicationTreeManager service. This facade uses a invoker to do the actual calls to the remote back-end.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseURL
protected RemotePublicationInvoker	invoker
protected RemotePublisherMarshaler	marshaler
protected String	password
protected String	userName

Constructor Summary

Constructors

Constructor and Description
RemotePublicationTreeManagerRestProxy(String baseURL, String userName, String password, RemotePublisherMarshaler marshaler)

Method Summary

Modifier and Type	Method and Description
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.
List<PublishedDocument>	getChildrenDocuments(PublicationNode node)
List<PublicationNode>	getChildrenNodes(PublicationNode node)
List<PublishedDocument>	getExistingPublishedDocument(String sid, DocumentLocation docLoc)
PublicationNode	getNodeByPath(String sid, String path)
PublicationNode	getParent(PublicationNode node)
List<PublishedDocument>	getPublishedDocumentInNode(PublicationNode node)
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.
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
void	release(String sid)
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	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(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 java.lang.Object

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

Field Detail

baseURL

protected String baseURL

userName

protected String userName

password

protected String password

marshaler

protected RemotePublisherMarshaler marshaler

invoker

protected RemotePublicationInvoker invoker

Constructor Detail

RemotePublicationTreeManagerRestProxy

public RemotePublicationTreeManagerRestProxy(String baseURL,
                                             String userName,
                                             String password,
                                             RemotePublisherMarshaler marshaler)

Method Detail

getChildrenDocuments

public List<PublishedDocument> getChildrenDocuments(PublicationNode node)

Specified by:

getChildrenDocuments in interface RemotePublicationTreeManager

getChildrenNodes

public List<PublicationNode> getChildrenNodes(PublicationNode node)

Specified by:

getChildrenNodes in interface RemotePublicationTreeManager

getExistingPublishedDocument

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

Specified by:

getExistingPublishedDocument in interface RemotePublicationTreeManager

getNodeByPath

public PublicationNode getNodeByPath(String sid,
                                     String path)

Specified by:

getNodeByPath in interface RemotePublicationTreeManager

getParent

public PublicationNode getParent(PublicationNode node)

Specified by:

getParent in interface RemotePublicationTreeManager

getPublishedDocumentInNode

public List<PublishedDocument> getPublishedDocumentInNode(PublicationNode node)

Specified by:

getPublishedDocumentInNode in interface RemotePublicationTreeManager

publish

public PublishedDocument publish(DocumentModel doc,
                                 PublicationNode targetNode)

Specified by:

publish in interface RemotePublicationTreeManager

publish

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

Specified by:

publish in interface RemotePublicationTreeManager

unpublish

public void unpublish(DocumentModel doc,
                      PublicationNode targetNode)

Specified by:

unpublish in interface RemotePublicationTreeManager

unpublish

public void unpublish(String sid,
                      PublishedDocument publishedDocument)

Specified by:

unpublish in interface RemotePublicationTreeManager

initRemoteSession

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

Specified by:

initRemoteSession 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

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

release

public void release(String sid)

Specified by:

release in interface RemotePublicationTreeManager