alfresco-community-repo/source/java/org/alfresco/repo/copy/DefaultCopyBehaviourCallback.java
Derek Hulley d6586351c1 Fixed MOB-426: Refactor CopyService: Apply new pattern to existing policy handlers
Fallout:
1. Policy handling for 'onCopy' has been changed to 'getCopyCallback'
2. All existing policy usage was refactored to control behaviour more closely
3. The default child association behaviour has changed:
3.1 Types and aspects control their own child association behaviour
3.2 cm:folder recurses into primary children, but merely copies the secondary association
3.3 cm:rule recurses into primary children
3.4 unless behaviour is defined for a child association, there is no recursion or copying
4. Node association behavior has changed
4.1 There is no copying of node associations.  Each type and aspect must handle this by
    recording nodes and fixing up the required associations in the onCopyComplete.
4.2 If there is a requirement, this can be added to the callback later

See 'org.alfresco.repo.copy.AbstractCopyBehaviourCallback' and derived classes for examples.

Areas to test with particular attention:
1. Normal copy behaviour
2. Copy of documents with discussions
3. Check-in check-out
4. Check-in, check-out of documents where a discussion was added to working copy
5. Copies of documents with thumbnails
6. Copies of documents with rules
7. Copying of hierarchies that contain rules to copy to another location within the hierarchy
8. Copying into folders where named children already exist


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13915 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2009-04-09 14:48:02 +00:00

108 lines
3.5 KiB
Java

/*
* Copyright (C) 2005-2009 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.copy;
import java.io.Serializable;
import java.util.Map;
import org.alfresco.service.namespace.QName;
/**
* The default behaviour that a type of aspect implements if there is no associated
* <{@link CopyBehaviourCallback behaviour}.
* <p>
* This implementation is {@link #getInstance() stateless} and therefore thread-safe.
* <p>
* The default behaviour is:
* <ul>
* <li><b>Must Copy:</b> YES</li>
* <li><b>Must Cascade:</b> YES, if cascade is on</li>
* <li><b>Properties to Copy:</b>ALL</li>
* </ul>
*
* @author Derek Hulley
* @since 3.2
*/
public class DefaultCopyBehaviourCallback extends AbstractCopyBehaviourCallback
{
private static CopyBehaviourCallback instance = new DefaultCopyBehaviourCallback();
/**
* @return Returns a stateless singleton
*/
public static CopyBehaviourCallback getInstance()
{
return instance;
}
/**
* Default behaviour: Always copy
*
* @return Returns <tt>true</tt> always
*/
public boolean getMustCopy(QName classQName, CopyDetails copyDetails)
{
return true;
}
/**
* Default behaviour: Cascade if we are copying children <b>AND</b> the association is primary
*
* @return Returns <tt>true</tt> if the association is primary and <code>copyChildren == true</code>
*/
public ChildAssocCopyAction getChildAssociationCopyAction(
QName classQName,
CopyDetails copyDetails,
CopyChildAssociationDetails childAssocCopyDetails)
{
if (!childAssocCopyDetails.isCopyChildren())
{
return ChildAssocCopyAction.IGNORE;
}
if (childAssocCopyDetails.getChildAssocRef().isPrimary())
{
return ChildAssocCopyAction.COPY_CHILD;
}
else
{
return ChildAssocCopyAction.COPY_ASSOC;
}
}
/**
* Default behaviour: Copy all associated properties
*
* @return Returns all the properties passes in
*/
public Map<QName, Serializable> getCopyProperties(
QName classQName,
CopyDetails copyDetails,
Map<QName, Serializable> properties)
{
return properties;
}
}