ACE-4469: Merged BRANCHES/DEV/HEAD-SFS (cherry picked) to HEAD

113520: SFS-179: Added multipart upload support into Public API framework.
   114561: SFS-179: Added tests for upload API, as well as minor fixes.
   114732: SFS-179: Changed the assert import from 3.X to 4.X.
   114734: SFS-179: Added unit tests for Public API framework multiPart support.
   114735: SFS-179: Fixed unit test failure.
- Also removed mergeinfo added in r112639

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@114736 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Jamal Kaabi-Mofrad
2015-10-19 23:25:59 +00:00
parent a4c853d923
commit 8855ef66f8
19 changed files with 760 additions and 92 deletions

View File

@@ -61,6 +61,19 @@ public abstract class AbstractBaseApiTest extends EnterpriseTestApi
return response;
}
protected HttpResponse post(String url, String runAsUser, String body, String queryString, String contentType, int expectedStatus) throws Exception
{
publicApiClient.setRequestContext(new RequestContext(runAsUser));
if (queryString != null)
{
url += queryString;
}
HttpResponse response = publicApiClient.post(getScope(), url, null, null, null, body, contentType);
checkStatus(expectedStatus, response.getStatusCode());
return response;
}
protected HttpResponse getAll(String url, String runAsUser, PublicApiClient.Paging paging, int expectedStatus) throws Exception
{
publicApiClient.setRequestContext(new RequestContext(runAsUser));

View File

@@ -440,6 +440,17 @@ public class PublicApiClient
return response;
}
public HttpResponse post(String scope, String entityCollectionName, Object entityId, String relationCollectionName, Object relationshipEntityId,
String body, String contentType) throws IOException
{
HttpResponse response = client.post(getRequestContext(), scope, entityCollectionName, entityId, relationCollectionName,
relationshipEntityId != null ? relationshipEntityId.toString() : null, body, contentType);
logger.debug(response.toString());
return response;
}
public HttpResponse post(String urlSuffix, String body) throws IOException
{
HttpResponse response = client.post(getRequestContext(), urlSuffix, body);

View File

@@ -450,20 +450,33 @@ public class PublicApiHttpClient
PatchMethod req = new PatchMethod(url.toString());
return submitRequest(req, rq);
}
public HttpResponse post(final RequestContext rq, final String scope, final String entityCollectionName, final Object entityId, final String relationCollectionName, final Object relationshipEntityId, final String body) throws IOException
{
RestApiEndpoint endpoint = new RestApiEndpoint(rq.getNetworkId(), scope, entityCollectionName, entityId, relationCollectionName, relationshipEntityId, null);
String url = endpoint.getUrl();
PostMethod req = new PostMethod(url.toString());
if(body != null)
{
StringRequestEntity requestEntity = new StringRequestEntity(body, "application/json", "UTF-8");
req.setRequestEntity(requestEntity);
}
return submitRequest(req, rq);
}
public HttpResponse post(final RequestContext rq, final String scope, final String entityCollectionName, final Object entityId,
final String relationCollectionName, final Object relationshipEntityId, final String body) throws IOException
{
return post(rq, scope, entityCollectionName, entityId, relationCollectionName, relationshipEntityId, body, "application/json");
}
public HttpResponse post(final RequestContext rq, final String scope, final String entityCollectionName, final Object entityId,
final String relationCollectionName, final Object relationshipEntityId, final String body, String contentType) throws IOException
{
RestApiEndpoint endpoint = new RestApiEndpoint(rq.getNetworkId(), scope, entityCollectionName, entityId, relationCollectionName,
relationshipEntityId, null);
String url = endpoint.getUrl();
PostMethod req = new PostMethod(url.toString());
if (body != null)
{
if (contentType == null || contentType.isEmpty())
{
contentType = "application/json";
}
StringRequestEntity requestEntity = new StringRequestEntity(body, contentType, "UTF-8");
req.setRequestEntity(requestEntity);
}
return submitRequest(req, rq);
}
public HttpResponse delete(final Class<?> c, final RequestContext rq, final Object entityId, final Object relationshipEntityId) throws IOException
{

View File

@@ -0,0 +1,259 @@
/*
* Copyright (C) 2005-2015 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.rest.api.tests.util;
import static org.junit.Assert.assertNotNull;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.StringPart;
import org.apache.commons.httpclient.params.HttpMethodParams;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* <i><b>multipart/form-data</b></i> builder.
*
* @author Jamal Kaabi-Mofrad
*/
public class MultiPartBuilder
{
private FileData fileData;
private String siteId;
private String containerId;
private String destination;
private String uploadDirectory;
private String updateNodeRef;
private String description;
private String contentTypeQNameStr;
private List<String> aspects;
private boolean majorVersion;
private boolean overwrite = true; // If a fileName clashes for a versionable file
private MultiPartBuilder()
{
}
private MultiPartBuilder(MultiPartBuilder that)
{
this.fileData = that.fileData;
this.siteId = that.siteId;
this.containerId = that.containerId;
this.destination = that.destination;
this.uploadDirectory = that.uploadDirectory;
this.updateNodeRef = that.updateNodeRef;
this.description = that.description;
this.contentTypeQNameStr = that.contentTypeQNameStr;
this.aspects = that.aspects;
this.majorVersion = that.majorVersion;
this.overwrite = that.overwrite;
}
public static MultiPartBuilder create()
{
return new MultiPartBuilder();
}
public static MultiPartBuilder copy(MultiPartBuilder copy)
{
return new MultiPartBuilder(copy);
}
public MultiPartBuilder setFileData(FileData fileData)
{
this.fileData = fileData;
return this;
}
public MultiPartBuilder setSiteId(String siteId)
{
this.siteId = siteId;
return this;
}
public MultiPartBuilder setContainerId(String containerId)
{
this.containerId = containerId;
return this;
}
public MultiPartBuilder setDestination(String destination)
{
this.destination = destination;
return this;
}
public MultiPartBuilder setUploadDirectory(String uploadDirectory)
{
this.uploadDirectory = uploadDirectory;
return this;
}
public MultiPartBuilder setUpdateNoderef(String updateNodeRef)
{
this.updateNodeRef = updateNodeRef;
return this;
}
public MultiPartBuilder setDescription(String description)
{
this.description = description;
return this;
}
public MultiPartBuilder setContentTypeQNameStr(String contentTypeQNameStr)
{
this.contentTypeQNameStr = contentTypeQNameStr;
return this;
}
public MultiPartBuilder setAspects(List<String> aspects)
{
this.aspects = aspects;
return this;
}
public MultiPartBuilder setMajorVersion(boolean majorVersion)
{
this.majorVersion = majorVersion;
return this;
}
public MultiPartBuilder setOverwrite(boolean overwrite)
{
this.overwrite = overwrite;
return this;
}
private String getAspects(List<String> aspects)
{
if (aspects != null)
{
StringBuilder sb = new StringBuilder(aspects.size() * 2);
for (String str : aspects)
{
sb.append(str).append(',');
}
sb.deleteCharAt(sb.length() - 1); // remove leading separator
return sb.toString();
}
return null;
}
public static class FileData
{
private final String fileName;
private final File file;
private final String mimetype;
public FileData(String fileName, File file, String mimetype)
{
this.fileName = fileName;
this.file = file;
this.mimetype = mimetype;
}
public String getFileName()
{
return fileName;
}
public File getFile()
{
return file;
}
public String getMimetype()
{
return mimetype;
}
}
public static class MultiPartRequest
{
private final byte[] body;
private final String contentType;
private final long contentLength;
public MultiPartRequest(byte[] body, String contentType, long contentLength)
{
this.body = body;
this.contentType = contentType;
this.contentLength = contentLength;
}
public byte[] getBody()
{
return body;
}
public String getContentType()
{
return contentType;
}
public long getContentLength()
{
return contentLength;
}
}
public MultiPartRequest build() throws IOException
{
assertNotNull(fileData);
List<Part> parts = new ArrayList<>();
parts.add(new FilePart("filedata", fileData.getFileName(), fileData.getFile(), fileData.getMimetype(), null));
addPartIfNotNull(parts, "filename", fileData.getFileName());
addPartIfNotNull(parts, "siteid", siteId);
addPartIfNotNull(parts, "containerid", containerId);
addPartIfNotNull(parts, "destination", destination);
addPartIfNotNull(parts, "uploaddirectory", uploadDirectory);
addPartIfNotNull(parts, "updatenoderef", updateNodeRef);
addPartIfNotNull(parts, "description", description);
addPartIfNotNull(parts, "contenttype", contentTypeQNameStr);
addPartIfNotNull(parts, "aspects", getAspects(aspects));
addPartIfNotNull(parts, "majorversion", Boolean.toString(majorVersion));
addPartIfNotNull(parts, "overwrite", Boolean.toString(overwrite));
MultipartRequestEntity req = new MultipartRequestEntity(parts.toArray(new Part[parts.size()]), new HttpMethodParams());
ByteArrayOutputStream os = new ByteArrayOutputStream();
req.writeRequest(os);
return new MultiPartRequest(os.toByteArray(), req.getContentType(), req.getContentLength());
}
private void addPartIfNotNull(List<Part> list, String partName, String partValue)
{
if (partValue != null)
{
list.add(new StringPart(partName, partValue));
}
}
}