Merged 5.2.N (5.2.1) to HEAD (5.2)

131282 mward: Merged r131242:131277 from BRANCHES/DEV/mward/5.2.n-restapi into BRANCHES/DEV/5.2.N


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@132232 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/rest/api/Sites.java

@@ -26,11 +26,7 @@
 package org.alfresco.rest.api;
 
 import org.alfresco.query.PagingResults;
-import org.alfresco.rest.api.model.FavouriteSite;
-import org.alfresco.rest.api.model.MemberOfSite;
-import org.alfresco.rest.api.model.Site;
-import org.alfresco.rest.api.model.SiteContainer;
-import org.alfresco.rest.api.model.SiteMember;
+import org.alfresco.rest.api.model.*;
 import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
 import org.alfresco.rest.framework.resource.parameters.Paging;
 import org.alfresco.rest.framework.resource.parameters.Parameters;
@@ -45,7 +41,7 @@ public interface Sites
     Site getSite(String siteId);
 	void deleteSite(String siteId, Parameters parameters);
     Site createSite(Site site, Parameters parameters);
-	Site updateSite(String siteId, Site site, Parameters parameters);
+	Site updateSite(String siteId, SiteUpdate site, Parameters parameters);
     
 	/**
 	 * people/<personId>/sites/<siteId>

source/java/org/alfresco/rest/api/impl/SitesImpl.java

@@ -62,11 +62,7 @@ import org.alfresco.rest.antlr.WhereClauseParser;
 import org.alfresco.rest.api.Nodes;
 import org.alfresco.rest.api.People;
 import org.alfresco.rest.api.Sites;
-import org.alfresco.rest.api.model.FavouriteSite;
-import org.alfresco.rest.api.model.MemberOfSite;
-import org.alfresco.rest.api.model.Site;
-import org.alfresco.rest.api.model.SiteContainer;
-import org.alfresco.rest.api.model.SiteMember;
+import org.alfresco.rest.api.model.*;
 import org.alfresco.rest.framework.core.exceptions.ConstraintViolatedException;
 import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
@@ -1141,13 +1137,14 @@ public class SitesImpl implements Sites
     }
 
     @Override
-    public Site updateSite(String siteId, Site update, Parameters parameters)
+    public Site updateSite(String siteId, SiteUpdate update, Parameters parameters)
     {
         if (logger.isDebugEnabled())
         {
             logger.debug("Updating site, ID: "+siteId+", site data: "+update+", parameters: "+parameters);
         }
 
+        // Get the site by ID (aka short name)
         SiteInfo siteInfo = validateSite(siteId);
         if (siteInfo == null)
         {
@@ -1155,16 +1152,19 @@ public class SitesImpl implements Sites
             throw new EntityNotFoundException(siteId);
         }
 
-        // Although this method will not update the site ID even if it is provided, we sanity
-        // check that no attempt is being made to alter it.
-        if (update.getId() != null && (!update.getId().equals(siteId)))
+        // Bind any provided values to the site info, allowing for "partial" updates.
+        if (update.getTitle() != null)
         {
-            throw new InvalidArgumentException("Site updates cannot change the site ID");
+            siteInfo.setTitle(update.getTitle());
+        }
+        if (update.getDescription() != null)
+        {
+            siteInfo.setDescription(update.getDescription());
+        }
+        if (update.getVisibility() != null)
+        {
+            siteInfo.setVisibility(update.getVisibility());
         }
-
-        siteInfo.setTitle(update.getTitle());
-        siteInfo.setDescription(update.getDescription());
-        siteInfo.setVisibility(update.getVisibility());
 
         // Validate the new details
         validateSite(new Site(siteInfo, null));

source/java/org/alfresco/rest/api/model/SiteUpdate.java

@@ -0,0 +1,115 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * 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/>.
+ * #L%
+ */
+package org.alfresco.rest.api.model;
+
+import org.alfresco.service.cmr.site.SiteVisibility;
+
+import java.io.Serializable;
+
+/**
+ * Class representing a site update API operation.
+ *
+ * @author Matt Ward
+ * @since 5.2
+ */
+public class SiteUpdate implements Serializable
+{
+    private static final long serialVersionUID = 1L;
+    private String title;
+    private String description;
+    private SiteVisibility visibility;
+
+
+    public SiteUpdate(String title, String description, SiteVisibility visibility)
+    {
+        this.title = title;
+        this.description = description;
+        this.visibility = visibility;
+    }
+
+    public String getTitle()
+    {
+        return title;
+    }
+
+    public void setTitle(String title)
+    {
+        this.title = title;
+    }
+
+    public String getDescription()
+    {
+        return description;
+    }
+
+    public void setDescription(String description)
+    {
+        this.description = description;
+    }
+
+    public SiteVisibility getVisibility()
+    {
+        return visibility;
+    }
+
+    public void setVisibility(SiteVisibility visibility)
+    {
+        this.visibility = visibility;
+    }
+
+    @Override
+    public boolean equals(Object o)
+    {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        SiteUpdate that = (SiteUpdate) o;
+
+        if (title != null ? !title.equals(that.title) : that.title != null) return false;
+        if (description != null ? !description.equals(that.description) : that.description != null) return false;
+        return visibility == that.visibility;
+
+    }
+
+    @Override
+    public int hashCode()
+    {
+        int result = title != null ? title.hashCode() : 0;
+        result = 31 * result + (description != null ? description.hashCode() : 0);
+        result = 31 * result + (visibility != null ? visibility.hashCode() : 0);
+        return result;
+    }
+
+    @Override
+    public String toString()
+    {
+        return "SiteUpdate{" +
+                "title='" + title + '\'' +
+                ", description='" + description + '\'' +
+                ", visibility=" + visibility +
+                '}';
+    }
+}

source/java/org/alfresco/rest/api/sites/SiteEntityResource.java

@@ -27,6 +27,7 @@ package org.alfresco.rest.api.sites;
 
 import org.alfresco.rest.api.Sites;
 import org.alfresco.rest.api.model.Site;
+import org.alfresco.rest.api.model.SiteUpdate;
 import org.alfresco.rest.framework.WebApiDescription;
 import org.alfresco.rest.framework.WebApiParam;
 import org.alfresco.rest.framework.core.ResourceParameter;
@@ -35,6 +36,7 @@ import org.alfresco.rest.framework.resource.EntityResource;
 import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
 import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
 import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.service.cmr.site.SiteVisibility;
 import org.alfresco.util.ParameterCheck;
 import org.springframework.beans.factory.InitializingBean;
 
@@ -131,6 +133,12 @@ public class SiteEntityResource implements EntityResourceAction.Read<Site>,
     @WebApiDescription(title="Update site", description="Update the Share site")
     public Site update(String siteId, Site site, Parameters parameters)
     {
-        return sites.updateSite(siteId, site, parameters);
+        final String title = site.getTitle();
+        final String description = site.getDescription();
+        final SiteVisibility visibility = site.getVisibility();
+
+        SiteUpdate update = new SiteUpdate(title, description, visibility);
+
+        return sites.updateSite(siteId, update, parameters);
     }
 }