Package org.alfresco.rest.v0

Class LinksAPI

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.LinksAPI

@Component
public class LinksAPI
extends BaseAPI

Methods to make API requests using v0 API for Linking Records

Since:

3.2

Author:

Kavit Shah

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, LOGGER, NODE_PREFIX, NODE_REF_WORKSPACE_SPACES_STORE, RM_ACTIONS_API, RM_SITE_ID, SHARE_ACTION_API, UPDATE_METADATA_API

Constructor Summary

Constructors

Constructor	Description
LinksAPI()

Method Summary

Modifier and Type	Method	Description
org.apache.http.HttpResponse	linkRecord(String user, String password, int expectedStatusCode, String sourcePath, List<String> nodeRefs)	Creates the Link

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 Details

LinksAPI

public LinksAPI()

Method Details

linkRecord

public org.apache.http.HttpResponse linkRecord(String user,
 String password,
 int expectedStatusCode,
 String sourcePath,
 List<String> nodeRefs)
                                        throws UnsupportedEncodingException

Creates the Link

Parameters:

user - The username of the user to use.

password - The password of the user.

expectedStatusCode - The expected return status code.

sourcePath - The Source of link the record. 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 Node that needs to be linked.

Returns:

The HTTP Response.

Throws:

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

UnsupportedEncodingException