ALF-11318: Add policy to prevent copying of rateable aspect and associated aspects.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@37313 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2012-05-31 14:53:01 +00:00
parent ebb756825e
commit b3f62c505c
3 changed files with 178 additions and 1 deletions
--- a/source/java/org/alfresco/repo/rating/RateableAspect.java
+++ b/source/java/org/alfresco/repo/rating/RateableAspect.java
@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2005-2011 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.alfresco.repo.rating;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.copy.CopyBehaviourCallback;
+import org.alfresco.repo.copy.CopyDetails;
+import org.alfresco.repo.copy.CopyServicePolicies;
+import org.alfresco.repo.copy.DefaultCopyBehaviourCallback;
+import org.alfresco.repo.copy.DoNothingCopyBehaviourCallback;
+import org.alfresco.repo.policy.JavaBehaviour;
+import org.alfresco.repo.policy.PolicyComponent;
+import org.alfresco.service.cmr.rating.RatingScheme;
+import org.alfresco.service.namespace.NamespaceService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.Pair;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+/**
+ * Rateable aspect behaviour bean. When any node with the rateable aspect is
+ * copied, then ensure the ratings and roll ups are not copied.
+ * 
+ * @author Alex Miller
+ */
+public class RateableAspect implements CopyServicePolicies.OnCopyNodePolicy
+{
+    /** logger */
+    private static final Log logger = LogFactory.getLog(RateableAspect.class);
+
+    /** Services */
+    private PolicyComponent policyComponent;
+
+    private RatingNamingConventionsUtil ratingNamingConventions;
+
+    private RatingSchemeRegistry ratingSchemeRegistry;
+
+    /**
+     * Set the policy component
+     * 
+     * @param policyComponent policy component
+     */
+    public void setPolicyComponent(PolicyComponent policyComponent)
+    {
+        this.policyComponent = policyComponent;
+    }
+
+    /**
+     * Set the rating scheme registry
+     * 
+     * @param ratingSchemeRegistry The rating scheme registry
+     */
+    public void setRatingSchemeRegistry(RatingSchemeRegistry ratingSchemeRegistry)
+    {
+        this.ratingSchemeRegistry = ratingSchemeRegistry;
+    }
+
+    /**
+     * Set the rating naming conventions service.
+     * 
+     * @param
+     */
+    public void setRatingNamingConventions(RatingNamingConventionsUtil ratingNamingConventions)
+    {
+        this.ratingNamingConventions = ratingNamingConventions;
+    }
+
+    /**
+     * Initialise method
+     */
+    public void init()
+    {
+        // Prevent the ratebale aspect from being copied
+        bindNoCopyBehaviour(ContentModel.ASPECT_RATEABLE);
+
+        // Prevent the roll up aspects from being copied
+        for (RatingScheme ratingScheme : ratingSchemeRegistry.getRatingSchemes().values())
+        {
+            if (ratingScheme.getPropertyRollups() != null && ratingScheme.getPropertyRollups().size() > 0) 
+            {
+                QName rollupAspectName = ratingNamingConventions.getRollupAspectNameFor(ratingScheme);
+                bindNoCopyBehaviour(rollupAspectName);
+            }
+        }
+    }
+
+    private void bindNoCopyBehaviour(QName rollupAspectName)
+    {
+        this.policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "getCopyCallback"),
+                rollupAspectName, new JavaBehaviour(this, "getCopyCallback"));
+    }
+
+    /**
+     * @return Returns {@link RateableAspectCopyBehaviourCallback}
+     */
+    public CopyBehaviourCallback getCopyCallback(QName classRef, CopyDetails copyDetails)
+    {
+        return DoNothingCopyBehaviourCallback.getInstance();
+    }
+}