Package org.alfresco.rest.v0

Class CopyToAPI

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.CopyToAPI

@Component
public class CopyToAPI
extends BaseAPI

The v0 REST API for copy-to (which supports multi-item copy).

Since:

2.6

Author:

Tom Page

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.rest.core.v0.BaseAPI

BaseAPI.PermissionType, BaseAPI.RETENTION_SCHEDULE, BaseAPI.RM_ACTIONS, BaseAPI.RMProperty

Field Summary

Fields inherited from class org.alfresco.rest.core.v0.BaseAPI

ACTIONS_API, contentService, NODE_PREFIX, NODE_REF_WORKSPACE_SPACES_STORE, RM_ACTIONS_API, RM_SITE_ID, SHARE_ACTION_API, UPDATE_METADATA_API

Constructor Summary

Constructors

Constructor	Description
CopyToAPI()

Method Summary

Modifier and Type	Method	Description
org.apache.http.HttpResponse	copyTo(String user, String password, int expectedStatusCode, String targetContainerPath, List<String> nodeRefs)	Copy a list of nodes to the target container.
org.apache.http.HttpResponse	copyTo(String user, String password, String targetContainerPath, List<String> nodeRefs)	Copy a list of nodes to the target container.

Methods inherited from class org.alfresco.rest.core.v0.BaseAPI

addPropertyToRequest, deleteItem, doDeleteRequest, doGetRequest, doPostJsonRequest, doPostRequest, doPutJsonRequest, doPutRequest, doSlingshotPostJsonRequest, facetedRequest, getFilePlanPath, getItemNodeRef, getNodeRefSpacesStore, getObjectByPath, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValuesByUniquePropertyValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyToAPI

public CopyToAPI()

Method Detail

copyTo

public org.apache.http.HttpResponse copyTo(String user,
                                           String password,
                                           String targetContainerPath,
                                           List<String> nodeRefs)

Copy a list of nodes to the target container.

Parameters:

user - The username of the user to use.

password - The password of the user.

targetContainerPath - The destination to copy the nodes to. This should be in the format "{site}/{container}/{path}", "{site}/{container}", "{store_type}/{store_id}/{id}/{path}", "{store_type}/{store_id}/{id}" or "{store_type}/{store_id}".

nodeRefs - The list of nodes to copy.

Returns:

The HTTP Response.

Throws:

AssertionError - If the API call didn't return a 200 response.

copyTo

public org.apache.http.HttpResponse copyTo(String user,
                                           String password,
                                           int expectedStatusCode,
                                           String targetContainerPath,
                                           List<String> nodeRefs)

Copy a list of nodes to the target container.

Parameters:

user - The username of the user to use.

password - The password of the user.

expectedStatusCode - The expected return status code.

targetContainerPath - The destination to copy the nodes to. This should be in the format "{site}/{container}/{path}", "{site}/{container}", "{store_type}/{store_id}/{id}/{path}", "{store_type}/{store_id}/{id}" or "{store_type}/{store_id}".

nodeRefs - The list of nodes to copy.

Returns:

The HTTP Response.

Throws:

AssertionError - If the API didn't return the expected status code.