Package org.alfresco.repo.copy

Class AbstractCopyBehaviourCallback

java.lang.Object

org.alfresco.repo.copy.AbstractCopyBehaviourCallback

All Implemented Interfaces:

CopyBehaviourCallback

Direct Known Subclasses:

CompoundCopyBehaviourCallback, DefaultCopyBehaviourCallback, DoNothingCopyBehaviourCallback

public abstract class AbstractCopyBehaviourCallback
extends Object
implements CopyBehaviourCallback

Abstract implementation to allow for easier migration if the interface changes.

Since:

3.2

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.copy.CopyBehaviourCallback

CopyBehaviourCallback.AssocCopySourceAction, CopyBehaviourCallback.AssocCopyTargetAction, CopyBehaviourCallback.ChildAssocCopyAction, CopyBehaviourCallback.ChildAssocRecurseAction, CopyBehaviourCallback.CopyAssociationDetails, CopyBehaviourCallback.CopyChildAssociationDetails

Constructor Summary

Constructors

Constructor	Description
AbstractCopyBehaviourCallback()

Method Summary

Modifier and Type	Method	Description
Pair<CopyBehaviourCallback.AssocCopySourceAction,CopyBehaviourCallback.AssocCopyTargetAction>	getAssociationCopyAction(QName classQName, CopyDetails copyDetails, CopyBehaviourCallback.CopyAssociationDetails assocCopyDetails)	Determine the copy behaviour associated with a given peer association.
CopyBehaviourCallback.ChildAssocRecurseAction	getChildAssociationRecurseAction(QName classQName, CopyDetails copyDetails, CopyBehaviourCallback.CopyChildAssociationDetails childAssocCopyDetails)	Once the child association copy action has been chosen, the policy callback can dictate whether or not to force further recursion.
boolean	isTopLevelCanBeRenamed(QName classQName, CopyDetails copyDetails)	By default it is forbidden for top-level nodes to be renamed
void	recordNodeRefsForRepointing(NodeRef sourceNodeRef, Map<QName,Serializable> properties, QName propertyQName)	Helper method to transactionally record NodeRef properties so that they can later be fixed up to point to the relative, after-copy locations.
void	repointNodeRefs(NodeRef sourceNodeRef, NodeRef targetNodeRef, QName propertyQName, Map<NodeRef,NodeRef> copyMap, NodeService nodeService)	The second stage of the NodeRef repointing.
protected void	throwExceptionForUnexpectedBehaviour(CopyDetails copyDetails, String... otherDetails)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.copy.CopyBehaviourCallback

getChildAssociationCopyAction, getCopyProperties, getMustCopy

Constructor Detail

AbstractCopyBehaviourCallback

public AbstractCopyBehaviourCallback()

Method Detail

getAssociationCopyAction

public Pair<CopyBehaviourCallback.AssocCopySourceAction,CopyBehaviourCallback.AssocCopyTargetAction> getAssociationCopyAction(QName classQName,
                                                                                                                                    CopyDetails copyDetails,
                                                                                                                                    CopyBehaviourCallback.CopyAssociationDetails assocCopyDetails)

Description copied from interface: CopyBehaviourCallback

Determine the copy behaviour associated with a given peer association.

Specified by:

getAssociationCopyAction in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

assocCopyDetails - all other details relating to the association

Returns:

Returns CopyBehaviourCallback.AssocCopySourceAction.COPY_REMOVE_EXISTING and CopyBehaviourCallback.AssocCopyTargetAction.USE_COPIED_TARGET

getChildAssociationRecurseAction

public CopyBehaviourCallback.ChildAssocRecurseAction getChildAssociationRecurseAction(QName classQName,
                                                                                      CopyDetails copyDetails,
                                                                                      CopyBehaviourCallback.CopyChildAssociationDetails childAssocCopyDetails)

Description copied from interface: CopyBehaviourCallback

Once the child association copy action has been chosen, the policy callback can dictate whether or not to force further recursion. This cannot prevent behaviour further down the hierarchy from stopping the copy.

Specified by:

getChildAssociationRecurseAction in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

childAssocCopyDetails - all other details relating to the child association

Returns:

Returns ChildAssocRecurseAction.RESPECT_RECURSE_FLAG

See Also:

CopyBehaviourCallback.getChildAssociationCopyAction(QName, CopyDetails, CopyChildAssociationDetails)

throwExceptionForUnexpectedBehaviour

protected void throwExceptionForUnexpectedBehaviour(CopyDetails copyDetails,
                                                    String... otherDetails)

Throws:

IllegalStateException - always

recordNodeRefsForRepointing

public void recordNodeRefsForRepointing(NodeRef sourceNodeRef,
                                        Map<QName,Serializable> properties,
                                        QName propertyQName)

Helper method to transactionally record NodeRef properties so that they can later be fixed up to point to the relative, after-copy locations.

When the copy has been completed, the second stage of the process can be applied.

Parameters:

sourceNodeRef - the node that is being copied

properties - the node properties being copied

propertyQName - the qualified name of the property to check

See Also:

repointNodeRefs(NodeRef, NodeRef, QName, Map, NodeService)

repointNodeRefs

public void repointNodeRefs(NodeRef sourceNodeRef,
                            NodeRef targetNodeRef,
                            QName propertyQName,
                            Map<NodeRef,NodeRef> copyMap,
                            NodeService nodeService)

The second stage of the NodeRef repointing. Call this method to have any NodeRef properties readjusted to reflect the copied node hierarchy. Only use this method if it a requirement for the particular type or aspect that you are coding for.

Parameters:

sourceNodeRef - the source node

propertyQName - the target node i.e. the copy of the source node

copyMap - the full hierarchy copy map of source to copies

See Also:

recordNodeRefsForRepointing(NodeRef, Map, QName)

isTopLevelCanBeRenamed

public boolean isTopLevelCanBeRenamed(QName classQName,
                                      CopyDetails copyDetails)

By default it is forbidden for top-level nodes to be renamed

Specified by:

isTopLevelCanBeRenamed in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

Returns:

true if the top-level node with type or aspect can be renamed during copy.