Package org.alfresco.repo.tagging

Class TaggingServiceImpl

java.lang.Object

org.alfresco.repo.tagging.TaggingServiceImpl

All Implemented Interfaces:

CopyServicePolicies.BeforeCopyPolicy, CopyServicePolicies.OnCopyCompletePolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnMoveNodePolicy, ClassPolicy, Policy, TransactionListener, TaggingService, TransactionListener

public class TaggingServiceImpl
extends Object
implements TaggingService, TransactionListener, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnMoveNodePolicy, CopyServicePolicies.OnCopyCompletePolicy, CopyServicePolicies.BeforeCopyPolicy

Tagging service implementation

Author:

Roy Wetherall

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields

Modifier and Type	Field	Description
static String	TAG_UPDATES
protected static String	TAGGING_AUDIT_APPLICATION_NAME
protected static String	TAGGING_AUDIT_KEY_NODEREF
protected static String	TAGGING_AUDIT_KEY_TAGS
protected static String	TAGGING_AUDIT_ROOT_PATH

Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.BeforeCopyPolicy

QNAME

Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.OnCopyCompletePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnMoveNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor	Description
TaggingServiceImpl()

Method Summary

Modifier and Type	Method	Description
NodeRef	addTag(NodeRef nodeRef, String tagName)	Add a tag to a node.
List<Pair<String,NodeRef>>	addTags(NodeRef nodeRef, List<String> tags)	Adds a list of tags to a node.
void	addTagScope(NodeRef nodeRef)	Adds a tag scope to the specified node
void	afterCheckOut(NodeRef workingCopy)
void	afterCommit()	Invoked after transaction commit.
void	afterRollback()	Invoked after transaction rollback.
void	beforeCommit(boolean readOnly)	Called before a transaction is committed.
void	beforeCompletion()	Invoked before transaction commit/rollback.
void	beforeCopy(QName classRef, NodeRef sourceNodeRef, NodeRef targetNodeRef)	Fired once per node, before a copy overrides one node (which is possibly newly created) with the contents of another one.
void	beforeDeleteNode(NodeRef nodeRef)	Called before a node is deleted.
NodeRef	changeTag(StoreRef storeRef, String existingTag, String newTag)
void	clearTags(NodeRef nodeRef)	Clears all tags from an already tagged node.
NodeRef	createTag(StoreRef storeRef, String tag)	Create a new tag
void	createTags(ChildAssociationRef childAssocRef)
void	deleteTag(StoreRef storeRef, String tag)	Delete an existing tag and any references to it(cascade delete).
List<TagScope>	findAllTagScopes(NodeRef nodeRef)	Finds all the tag scopes for the specified node.
List<NodeRef>	findTaggedNodes(StoreRef storeRef, String tag)	Find all nodes that have been tagged with the specified tag.
List<NodeRef>	findTaggedNodes(StoreRef storeRef, String tag, NodeRef nodeRef)	Find all nodes that have been tagged with the specified tag and reside within the context of the node reference provided.
List<Pair<String,Integer>>	findTaggedNodesAndCountByTagName(StoreRef storeRef)	Get tagged nodes and count of nodes group by tag name
TagScope	findTagScope(NodeRef nodeRef)	Finds the 'nearest' tag scope for the specified node.
void	flush()
Pair<List<String>,Integer>	getPagedTags(StoreRef storeRef, int fromTag, int pageSize)	Get page of the tags currently available
Pair<List<String>,Integer>	getPagedTags(StoreRef storeRef, String filter, int fromTag, int pageSize)
String	getTagName(NodeRef nodeRef)
NodeRef	getTagNodeRef(StoreRef storeRef, String tag)	Gets the node reference for a given tag.
List<String>	getTags(NodeRef nodeRef)	Get all the tags on a node
PagingResults<Pair<NodeRef,String>>	getTags(NodeRef nodeRef, PagingRequest pagingRequest)	Get a paged list of all the tags on a node
List<String>	getTags(StoreRef storeRef)	Get all the tags currently available
List<String>	getTags(StoreRef storeRef, String filter)	Get all the tags currently available that match the provided filter.
PagingResults<Pair<NodeRef,String>>	getTags(StoreRef storeRef, PagingRequest pagingRequest)	Get a paged list of all the tags currently available
boolean	hasTag(NodeRef nodeRef, String tag)	Indicates whether a node has the specified tag or not.
void	init()	Init method
boolean	isTag(StoreRef storeRef, String tag)	Indicates whether the tag already exists
boolean	isTagScope(NodeRef nodeRef)	Indicates whether the node reference is a tag scope
void	onCopyComplete(QName classRef, NodeRef sourceNodeRef, NodeRef targetNodeRef, boolean copyToNewNode, Map<NodeRef,NodeRef> copyMap)	Fired once per node that was copied, after the copy has completed.
void	onMoveNode(ChildAssociationRef oldChildAssocRef, ChildAssociationRef newChildAssocRef)	Called when a node has been moved.
void	refreshTagScope(NodeRef nodeRef, boolean async)	Refreshes the tag count of the passed tag scope by recounting all the tags of the children of the scope.
void	removeTag(NodeRef nodeRef, String tag)	Remove a tag from a node.
void	removeTags(NodeRef nodeRef, List<String> tags)	Removes a list of tags from a node.
void	removeTagScope(NodeRef nodeRef)	Removes a tag scope from a specified node.
void	setActionService(ActionService actionService)	Set the action service
void	setAuditComponent(AuditComponent auditComponent)	Set the audit component
void	setCategoryService(CategoryService categoryService)	Set the cateogry service
void	setContentService(ContentService contentService)	Set the content service
void	setNamespaceService(NamespaceService namespaceService)	Set the namespace service
void	setNodeService(NodeService nodeService)	Set the node service
void	setNodeServiceInternal(NodeService nodeServiceInternal)
void	setPolicyComponent(PolicyComponent policyComponent)	Policy component
void	setSearchService(SearchService searchService)	Set the search service
void	setTags(NodeRef nodeRef, List<String> tags)	Sets the list of tags that are applied to a node, replaces any existing tags with those provided.
void	updateTags(NodeRef nodeRef, Map<QName,Serializable> before, Map<QName,Serializable> after)	Update tag policy behaviour

Methods inherited from class java.lang.Object

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

Field Detail

TAGGING_AUDIT_APPLICATION_NAME

protected static final String TAGGING_AUDIT_APPLICATION_NAME

See Also:

Constant Field Values

TAGGING_AUDIT_ROOT_PATH

protected static final String TAGGING_AUDIT_ROOT_PATH

See Also:

Constant Field Values

TAGGING_AUDIT_KEY_NODEREF

protected static final String TAGGING_AUDIT_KEY_NODEREF

See Also:

Constant Field Values

TAGGING_AUDIT_KEY_TAGS

protected static final String TAGGING_AUDIT_KEY_TAGS

See Also:

Constant Field Values

TAG_UPDATES

public static final String TAG_UPDATES

See Also:

Constant Field Values

Constructor Detail

TaggingServiceImpl

public TaggingServiceImpl()

Method Detail

setCategoryService

public void setCategoryService(CategoryService categoryService)

Set the cateogry service

setNodeService

public void setNodeService(NodeService nodeService)

Set the node service

setNodeServiceInternal

public void setNodeServiceInternal(NodeService nodeServiceInternal)

Parameters:

nodeServiceInternal - service to use when permission checks are not required

setSearchService

public void setSearchService(SearchService searchService)

Set the search service

setActionService

public void setActionService(ActionService actionService)

Set the action service

setContentService

public void setContentService(ContentService contentService)

Set the content service

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

Set the namespace service

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

Policy component

setAuditComponent

public void setAuditComponent(AuditComponent auditComponent)

Set the audit component

init

public void init()

Init method

beforeDeleteNode

public void beforeDeleteNode(NodeRef nodeRef)

Description copied from interface: NodeServicePolicies.BeforeDeleteNodePolicy

Called before a node is deleted.

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

Parameters:

nodeRef - the node reference

See Also:

NodeServicePolicies.BeforeDeleteNodePolicy.beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef)

beforeCopy

public void beforeCopy(QName classRef,
                       NodeRef sourceNodeRef,
                       NodeRef targetNodeRef)

Fired once per node, before a copy overrides one node (which is possibly newly created) with the contents of another one. We should remove any tags from the scope, as they'll shortly be overwritten.

Specified by:

beforeCopy in interface CopyServicePolicies.BeforeCopyPolicy

Parameters:

classRef - the type of the node that will be copied

sourceNodeRef - the original node

targetNodeRef - the destination node

onCopyComplete

public void onCopyComplete(QName classRef,
                           NodeRef sourceNodeRef,
                           NodeRef targetNodeRef,
                           boolean copyToNewNode,
                           Map<NodeRef,NodeRef> copyMap)

Fired once per node that was copied, after the copy has completed. We need to add in all the tags to the scope.

Specified by:

onCopyComplete in interface CopyServicePolicies.OnCopyCompletePolicy

Parameters:

classRef - the type of the node that was copied

sourceNodeRef - the original node

targetNodeRef - the destination node

copyMap - a map containing all the nodes that have been created during the copy

onMoveNode

public void onMoveNode(ChildAssociationRef oldChildAssocRef,
                       ChildAssociationRef newChildAssocRef)

Description copied from interface: NodeServicePolicies.OnMoveNodePolicy

Called when a node has been moved.

Specified by:

onMoveNode in interface NodeServicePolicies.OnMoveNodePolicy

Parameters:

oldChildAssocRef - the child association reference prior to the move

newChildAssocRef - the child association reference after the move

createTags

public void createTags(ChildAssociationRef childAssocRef)

updateTags

public void updateTags(NodeRef nodeRef,
                       Map<QName,Serializable> before,
                       Map<QName,Serializable> after)

Update tag policy behaviour

getTagName

public String getTagName(NodeRef nodeRef)

Specified by:

getTagName in interface TaggingService

isTag

public boolean isTag(StoreRef storeRef,
                     String tag)

Description copied from interface: TaggingService

Indicates whether the tag already exists

Specified by:

isTag in interface TaggingService

Parameters:

storeRef - store reference

tag - tag name

Returns:

boolean true if the tag exists, false otherwise

See Also:

TaggingService.isTag(StoreRef, java.lang.String)

createTag

public NodeRef createTag(StoreRef storeRef,
                         String tag)

Description copied from interface: TaggingService

Create a new tag

Specified by:

createTag in interface TaggingService

Parameters:

storeRef - store reference

tag - tag name

See Also:

TaggingService.createTag(StoreRef, java.lang.String)

deleteTag

public void deleteTag(StoreRef storeRef,
                      String tag)

Description copied from interface: TaggingService

Delete an existing tag and any references to it(cascade delete).

Specified by:

deleteTag in interface TaggingService

Parameters:

storeRef - store reference

tag - tag name

See Also:

TaggingService.deleteTag(org.alfresco.service.cmr.repository.StoreRef, java.lang.String)

changeTag

public NodeRef changeTag(StoreRef storeRef,
                         String existingTag,
                         String newTag)

Specified by:

changeTag in interface TaggingService

getTags

public List<String> getTags(StoreRef storeRef)

Description copied from interface: TaggingService

Get all the tags currently available

Specified by:

getTags in interface TaggingService

Returns:

list of tags

See Also:

TaggingService.getTags(StoreRef)

getPagedTags

public Pair<List<String>,Integer> getPagedTags(StoreRef storeRef,
                                                     int fromTag,
                                                     int pageSize)

Description copied from interface: TaggingService

Get page of the tags currently available

Specified by:

getPagedTags in interface TaggingService

Parameters:

storeRef - node reference

fromTag - offset

pageSize - page size

Returns:

pair of tag names and total count

getTags

public List<String> getTags(StoreRef storeRef,
                            String filter)

Description copied from interface: TaggingService

Get all the tags currently available that match the provided filter.

Specified by:

getTags in interface TaggingService

Parameters:

storeRef - store reference

filter - tag filter

Returns:

list of tags

See Also:

TaggingService.getTags(org.alfresco.service.cmr.repository.StoreRef, java.lang.String)

getPagedTags

public Pair<List<String>,Integer> getPagedTags(StoreRef storeRef,
                                                     String filter,
                                                     int fromTag,
                                                     int pageSize)

Specified by:

getPagedTags in interface TaggingService

Parameters:

storeRef - node reference

filter - tag filter

fromTag - page offset

pageSize - page size

Returns:

pair of tag names and total count

hasTag

public boolean hasTag(NodeRef nodeRef,
                      String tag)

Description copied from interface: TaggingService

Indicates whether a node has the specified tag or not.

Specified by:

hasTag in interface TaggingService

Parameters:

nodeRef - node reference

tag - tag name

Returns:

boolean true if the node has the tag, false otherwise

See Also:

TaggingService.hasTag(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

addTag

public NodeRef addTag(NodeRef nodeRef,
                      String tagName)

Description copied from interface: TaggingService

Add a tag to a node. Creating the tag if it does not already exist.

Specified by:

addTag in interface TaggingService

Parameters:

nodeRef - node reference

tagName - tag name

See Also:

TaggingService.addTag(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

addTags

public List<Pair<String,NodeRef>> addTags(NodeRef nodeRef,
                                                List<String> tags)

Description copied from interface: TaggingService

Adds a list of tags to a node.

Tags are created if they do not exist.

Specified by:

addTags in interface TaggingService

Parameters:

nodeRef - node reference

tags - list of tags

See Also:

TaggingService.addTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

getTagNodeRef

public NodeRef getTagNodeRef(StoreRef storeRef,
                             String tag)

Gets the node reference for a given tag.

Returns null if tag is not present.

Specified by:

getTagNodeRef in interface TaggingService

Parameters:

storeRef - store reference

tag - tag

Returns:

NodeRef tag node reference or null not exist

removeTag

public void removeTag(NodeRef nodeRef,
                      String tag)

Description copied from interface: TaggingService

Remove a tag from a node.

Specified by:

removeTag in interface TaggingService

Parameters:

nodeRef - node reference

tag - tag name

See Also:

TaggingService.removeTag(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

removeTags

public void removeTags(NodeRef nodeRef,
                       List<String> tags)

Description copied from interface: TaggingService

Removes a list of tags from a node.

Specified by:

removeTags in interface TaggingService

Parameters:

nodeRef - node reference

tags - list of tags

See Also:

TaggingService.removeTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

getTags

public PagingResults<Pair<NodeRef,String>> getTags(NodeRef nodeRef,
                                                         PagingRequest pagingRequest)

Description copied from interface: TaggingService

Get a paged list of all the tags on a node

Specified by:

getTags in interface TaggingService

Parameters:

nodeRef - node reference

Returns:

list of tags on the node

See Also:

TaggingService.getTags(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.query.PagingRequest)

getTags

public PagingResults<Pair<NodeRef,String>> getTags(StoreRef storeRef,
                                                         PagingRequest pagingRequest)

Description copied from interface: TaggingService

Get a paged list of all the tags currently available

Specified by:

getTags in interface TaggingService

Parameters:

storeRef - StoreRef

pagingRequest - PagingRequest

Returns:

PagingResults

See Also:

TaggingService.getTags(org.alfresco.service.cmr.repository.StoreRef, org.alfresco.query.PagingRequest)

getTags

public List<String> getTags(NodeRef nodeRef)

Description copied from interface: TaggingService

Get all the tags on a node

Specified by:

getTags in interface TaggingService

Parameters:

nodeRef - node reference

Returns:

list of tags on the node

See Also:

TaggingService.getTags(org.alfresco.service.cmr.repository.NodeRef)

setTags

public void setTags(NodeRef nodeRef,
                    List<String> tags)

Description copied from interface: TaggingService

Sets the list of tags that are applied to a node, replaces any existing tags with those provided.

Specified by:

setTags in interface TaggingService

Parameters:

nodeRef - node reference

tags - list of tags

See Also:

TaggingService.setTags(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

clearTags

public void clearTags(NodeRef nodeRef)

Description copied from interface: TaggingService

Clears all tags from an already tagged node.

Specified by:

clearTags in interface TaggingService

Parameters:

nodeRef - node reference

See Also:

TaggingService.clearTags(org.alfresco.service.cmr.repository.NodeRef)

isTagScope

public boolean isTagScope(NodeRef nodeRef)

Description copied from interface: TaggingService

Indicates whether the node reference is a tag scope

Specified by:

isTagScope in interface TaggingService

Parameters:

nodeRef - node reference

Returns:

boolean true if node is a tag scope, false otherwise

See Also:

TaggingService.isTagScope(org.alfresco.service.cmr.repository.NodeRef)

addTagScope

public void addTagScope(NodeRef nodeRef)

Description copied from interface: TaggingService

Adds a tag scope to the specified node

Specified by:

addTagScope in interface TaggingService

Parameters:

nodeRef - node reference

See Also:

TaggingService.addTagScope(org.alfresco.service.cmr.repository.NodeRef)

refreshTagScope

public void refreshTagScope(NodeRef nodeRef,
                            boolean async)

Description copied from interface: TaggingService

Refreshes the tag count of the passed tag scope by recounting all the tags of the children of the scope.

Specified by:

refreshTagScope in interface TaggingService

Parameters:

nodeRef - tag scope node reference

async - indicates whether the tag scope refresh should happen asynchronously or not

See Also:

TaggingService.refreshTagScope(org.alfresco.service.cmr.repository.NodeRef, boolean)

removeTagScope

public void removeTagScope(NodeRef nodeRef)

Description copied from interface: TaggingService

Removes a tag scope from a specified node. Note that any tag count information will be lost when the scope if removed.

Specified by:

removeTagScope in interface TaggingService

Parameters:

nodeRef - node reference

See Also:

TaggingService.removeTagScope(org.alfresco.service.cmr.repository.NodeRef)

findTagScope

public TagScope findTagScope(NodeRef nodeRef)

Description copied from interface: TaggingService

Finds the 'nearest' tag scope for the specified node.

The 'nearest' tag scope is discovered by walking up the primary parent path until a tag scope is found or the root node is reached.

If no tag scope if found then a null value is returned.

Specified by:

findTagScope in interface TaggingService

Parameters:

nodeRef - node reference

Returns:

the 'nearest' tag scope or null if none found

See Also:

TaggingService.findTagScope(org.alfresco.service.cmr.repository.NodeRef)

findAllTagScopes

public List<TagScope> findAllTagScopes(NodeRef nodeRef)

Description copied from interface: TaggingService

Finds all the tag scopes for the specified node.

The resulting list of tag scopes is ordered with the 'nearest' at the bedining of the list.

If no tag scopes are found an empty list is returned.

Specified by:

findAllTagScopes in interface TaggingService

Parameters:

nodeRef - node reference

Returns:

list of tag scopes

See Also:

TaggingService.findAllTagScopes(org.alfresco.service.cmr.repository.NodeRef)

findTaggedNodes

public List<NodeRef> findTaggedNodes(StoreRef storeRef,
                                     String tag)

Description copied from interface: TaggingService

Find all nodes that have been tagged with the specified tag.

Specified by:

findTaggedNodes in interface TaggingService

tag - tag name

Returns:

list of nodes tagged with specified tag, empty of none found

See Also:

TaggingService.findTaggedNodes(StoreRef, java.lang.String)

findTaggedNodes

public List<NodeRef> findTaggedNodes(StoreRef storeRef,
                                     String tag,
                                     NodeRef nodeRef)

Description copied from interface: TaggingService

Find all nodes that have been tagged with the specified tag and reside within the context of the node reference provided.

Specified by:

findTaggedNodes in interface TaggingService

tag - tag name

nodeRef - node providing context for the search

Returns:

list of nodes tagged in the context specified, empty if none found

See Also:

TaggingService.findTaggedNodes(StoreRef, java.lang.String, org.alfresco.service.cmr.repository.NodeRef)

afterCommit

public void afterCommit()

Description copied from interface: TransactionListener

Invoked after transaction commit.

Any exceptions generated here will only be logged and will have no effect on the state of the transaction.

Although all transaction resources are still available, this method should be used only for cleaning up resources after a commit has occured.

Specified by:

afterCommit in interface TransactionListener

Specified by:

afterCommit in interface TransactionListener

See Also:

TransactionListener.afterCommit()

afterRollback

public void afterRollback()

Description copied from interface: TransactionListener

Invoked after transaction rollback.

Any exceptions generated here will only be logged and will have no effect on the state of the transaction.

Although all transaction resources are still available, this method should be used only for cleaning up resources after a rollback has occured.

Specified by:

afterRollback in interface TransactionListener

Specified by:

afterRollback in interface TransactionListener

See Also:

TransactionListener.afterRollback()

beforeCommit

public void beforeCommit(boolean readOnly)

Description copied from interface: TransactionListener

Called before a transaction is committed.

All transaction resources are still available.

Specified by:

beforeCommit in interface TransactionListener

Specified by:

beforeCommit in interface TransactionListener

Parameters:

readOnly - true if the transaction is read-only

See Also:

TransactionListener.beforeCommit(boolean)

beforeCompletion

public void beforeCompletion()

Description copied from interface: TransactionListener

Invoked before transaction commit/rollback. Will be called after TransactionListener.beforeCommit(boolean) even if TransactionListener.beforeCommit(boolean) failed.

All transaction resources are still available.

Specified by:

beforeCompletion in interface TransactionListener

Specified by:

beforeCompletion in interface TransactionListener

See Also:

TransactionListener.beforeCompletion()

flush

public void flush()

Specified by:

flush in interface TransactionListener

See Also:

TransactionListener.flush()

afterCheckOut

public void afterCheckOut(NodeRef workingCopy)

findTaggedNodesAndCountByTagName

public List<Pair<String,Integer>> findTaggedNodesAndCountByTagName(StoreRef storeRef)

Description copied from interface: TaggingService

Get tagged nodes and count of nodes group by tag name

Specified by:

findTaggedNodesAndCountByTagName in interface TaggingService

Returns:

See Also:

TaggingService.findTaggedNodesAndCountByTagName(StoreRef)