org.alfresco.repo.publishing

Class ChannelHelper

java.lang.Object

org.alfresco.repo.publishing.ChannelHelper

public class ChannelHelper
extends Object

Since:

4.0

Author:

Nick Smith

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ChannelHelper()
ChannelHelper(ServiceRegistry serviceRegistry, PublishingEventHelper eventHelper)

Method Summary

Modifier and Type	Method and Description
void	addPublishedAspect(org.alfresco.service.cmr.repository.NodeRef publishedNode, org.alfresco.service.cmr.repository.NodeRef channelNode)
Channel	buildChannelObject(org.alfresco.service.cmr.repository.NodeRef nodeRef, ChannelService channelService)
boolean	canPublish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish, ChannelType type)
org.alfresco.service.cmr.repository.NodeRef	createChannelNode(org.alfresco.service.cmr.repository.NodeRef parent, ChannelType channelType, String channelName, Map<org.alfresco.service.namespace.QName,Serializable> props)
org.alfresco.service.cmr.repository.AssociationRef	createMapping(org.alfresco.service.cmr.repository.NodeRef source, org.alfresco.service.cmr.repository.NodeRef publishedNode)
List<Channel>	filterAuthorisedChannels(Collection<Channel> channels)
org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String>	findChannelAndType(org.alfresco.service.cmr.repository.NodeRef node) Finds the Channel NodeRef and ChannelType id for a given node, if such a Channel exists.
List<Channel>	getAllChannels(org.alfresco.service.cmr.repository.NodeRef channelContainer, ChannelService channelService)
Map<org.alfresco.service.namespace.QName,Serializable>	getChannelProperties(org.alfresco.service.cmr.repository.NodeRef channel)
List<Channel>	getChannelsByType(org.alfresco.service.cmr.repository.NodeRef containerNode, String channelTypeId, ChannelService channelService, boolean checkPermissions)
List<Channel>	getChannelsForTypes(org.alfresco.service.cmr.repository.NodeRef containerNode, List<ChannelType> types, ChannelService channelService, boolean checkPermissions)
List<ChannelType>	getReleventChannelTypes(org.alfresco.service.cmr.repository.NodeRef nodeToPublish, Collection<ChannelType> channelTypes)
List<ChannelType>	getStatusUpdateChannelTypes(Collection<ChannelType> channelTypes)
boolean	hasPublishPermissions(org.alfresco.service.cmr.repository.NodeRef channelNode)
boolean	isChannelAuthorised(org.alfresco.service.cmr.repository.NodeRef channelNode)
org.alfresco.service.cmr.repository.NodeRef	mapEnvironmentToSource(org.alfresco.service.cmr.repository.NodeRef publishedNode) Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib).
static org.alfresco.service.cmr.repository.NodeRef	mapEnvironmentToSource(org.alfresco.service.cmr.repository.NodeRef publishedNode, org.alfresco.service.cmr.repository.NodeService nodeService) Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib).
org.alfresco.service.cmr.repository.NodeRef	mapSourceToEnvironment(org.alfresco.service.cmr.repository.NodeRef source, org.alfresco.service.cmr.repository.NodeRef channelNode) Given a noderef from the editorial space (e.g.
static org.alfresco.service.cmr.repository.NodeRef	mapSourceToEnvironment(org.alfresco.service.cmr.repository.NodeRef source, org.alfresco.service.cmr.repository.NodeRef channelNode, org.alfresco.service.cmr.repository.NodeService nodeService) Given a noderef from the editorial space (e.g.
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEventHelper(PublishingEventHelper eventHelper)
void	setFileFolderService(FileFolderService fileFolderService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ChannelHelper

public ChannelHelper()

ChannelHelper

public ChannelHelper(ServiceRegistry serviceRegistry,
                     PublishingEventHelper eventHelper)

Method Detail

createChannelNode

public org.alfresco.service.cmr.repository.NodeRef createChannelNode(org.alfresco.service.cmr.repository.NodeRef parent,
                                                                     ChannelType channelType,
                                                                     String channelName,
                                                                     Map<org.alfresco.service.namespace.QName,Serializable> props)

buildChannelObject

public Channel buildChannelObject(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                  ChannelService channelService)

mapSourceToEnvironment

public org.alfresco.service.cmr.repository.NodeRef mapSourceToEnvironment(org.alfresco.service.cmr.repository.NodeRef source,
                                                                          org.alfresco.service.cmr.repository.NodeRef channelNode)

Given a noderef from the editorial space (e.g. the doclib), this returns the corresponding noderef published to the specified channel.

Parameters:

source - NodeRef

channelNode - NodeRef

Returns:

NodeRef

mapSourceToEnvironment

public static org.alfresco.service.cmr.repository.NodeRef mapSourceToEnvironment(org.alfresco.service.cmr.repository.NodeRef source,
                                                                                 org.alfresco.service.cmr.repository.NodeRef channelNode,
                                                                                 org.alfresco.service.cmr.repository.NodeService nodeService)

Given a noderef from the editorial space (e.g. the doclib), this returns the corresponding noderef published to the specified channel.

Parameters:

source - NodeRef

channelNode - NodeRef

nodeService - NodeService

Returns:

NodeRef

mapEnvironmentToSource

public org.alfresco.service.cmr.repository.NodeRef mapEnvironmentToSource(org.alfresco.service.cmr.repository.NodeRef publishedNode)

Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib).

Parameters:

publishedNode - NodeRef

Returns:

NodeRef

mapEnvironmentToSource

public static org.alfresco.service.cmr.repository.NodeRef mapEnvironmentToSource(org.alfresco.service.cmr.repository.NodeRef publishedNode,
                                                                                 org.alfresco.service.cmr.repository.NodeService nodeService)

Given a published noderef, this returns the corresponding source noderef in the editorial space (doclib).

Parameters:

publishedNode - NodeRef

nodeService - NodeService

Returns:

NodeRef

findChannelAndType

public org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String> findChannelAndType(org.alfresco.service.cmr.repository.NodeRef node)

Finds the Channel NodeRef and ChannelType id for a given node, if such a Channel exists.

Parameters:

node - NodeRef

Returns:

a Pair containing the Channel NodeRef and ChannelType Id.

getChannelProperties

public Map<org.alfresco.service.namespace.QName,Serializable> getChannelProperties(org.alfresco.service.cmr.repository.NodeRef channel)

createMapping

public org.alfresco.service.cmr.repository.AssociationRef createMapping(org.alfresco.service.cmr.repository.NodeRef source,
                                                                        org.alfresco.service.cmr.repository.NodeRef publishedNode)

canPublish

public boolean canPublish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish,
                          ChannelType type)

getAllChannels

public List<Channel> getAllChannels(org.alfresco.service.cmr.repository.NodeRef channelContainer,
                                    ChannelService channelService)

getChannelsForTypes

public List<Channel> getChannelsForTypes(org.alfresco.service.cmr.repository.NodeRef containerNode,
                                         List<ChannelType> types,
                                         ChannelService channelService,
                                         boolean checkPermissions)

getChannelsByType

public List<Channel> getChannelsByType(org.alfresco.service.cmr.repository.NodeRef containerNode,
                                       String channelTypeId,
                                       ChannelService channelService,
                                       boolean checkPermissions)

filterAuthorisedChannels

public List<Channel> filterAuthorisedChannels(Collection<Channel> channels)

getReleventChannelTypes

public List<ChannelType> getReleventChannelTypes(org.alfresco.service.cmr.repository.NodeRef nodeToPublish,
                                                 Collection<ChannelType> channelTypes)

getStatusUpdateChannelTypes

public List<ChannelType> getStatusUpdateChannelTypes(Collection<ChannelType> channelTypes)

addPublishedAspect

public void addPublishedAspect(org.alfresco.service.cmr.repository.NodeRef publishedNode,
                               org.alfresco.service.cmr.repository.NodeRef channelNode)

hasPublishPermissions

public boolean hasPublishPermissions(org.alfresco.service.cmr.repository.NodeRef channelNode)

isChannelAuthorised

public boolean isChannelAuthorised(org.alfresco.service.cmr.repository.NodeRef channelNode)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Parameters:

nodeService - the nodeService to set

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Parameters:

dictionaryService - the dictionaryService to set

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

Parameters:

fileFolderService - the fileFolderService to set

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

Parameters:

permissionService - the permissionService to set

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setEventHelper

public void setEventHelper(PublishingEventHelper eventHelper)