org.alfresco.rest.api

Interface Nodes

All Known Implementing Classes:

NodesImpl

public interface Nodes

File Folder (Nodes) API

Author:

janv, Jamal Kaabi-Mofrad, Gethin James, steveglover

Field Summary

Fields

Modifier and Type	Field and Description
static String	OP_CREATE
static String	OP_DELETE
static String	OP_UPDATE
static String	OP_UPDATE_PERMISSIONS
static String	PARAM_ASSOC_TYPE
static String	PARAM_AUTO_RENAME
static String	PARAM_CREATEBYUSER
static String	PARAM_CREATEDAT
static String	PARAM_INCLUDE_ALLOWABLEOPERATIONS
static String	PARAM_INCLUDE_ASPECTNAMES
static String	PARAM_INCLUDE_ASSOCIATION
static String	PARAM_INCLUDE_ISLINK
static String	PARAM_INCLUDE_ISLOCKED
static String	PARAM_INCLUDE_PATH
static String	PARAM_INCLUDE_PERMISSIONS
static String	PARAM_INCLUDE_PROPERTIES
static String	PARAM_INCLUDE_SUBTYPES
static String	PARAM_ISFILE
static String	PARAM_ISFOLDER
static String	PARAM_ISPRIMARY
static String	PARAM_MIMETYPE
static String	PARAM_MODIFIEDAT
static String	PARAM_MODIFIEDBYUSER
static String	PARAM_NAME
static String	PARAM_NODETYPE
static String	PARAM_OVERWRITE
static String	PARAM_PERMANENT
static String	PARAM_RELATIVE_PATH
static String	PARAM_SIZEINBYTES
static String	PARAM_VERSION_COMMENT
static String	PARAM_VERSION_MAJOR
static String	PATH_MY
static String	PATH_ROOT API Constants - query parameters, etc
static String	PATH_SHARED

Method Summary

Modifier and Type	Method and Description
List<AssocChild>	addChildren(String parentNodeId, List<AssocChild> entities)
void	addCustomAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> aspectNames, List<org.alfresco.service.namespace.QName> exclusions) Add aspects to the specified NodeRef.
List<AssocTarget>	addTargets(String sourceNodeId, List<AssocTarget> entities)
Node	createNode(String parentFolderNodeId, Node nodeInfo, Parameters parameters) Create node - folder or (empty) file.
org.alfresco.service.namespace.QName	createQName(String qnameStr) Helper to create a QName from either a fully qualified or short-name QName string
void	deleteNode(String nodeId, Parameters parameters) Delete the given node.
org.alfresco.service.namespace.QName	getAssocType(String assocTypeQNameStr)
org.alfresco.service.namespace.QName	getAssocType(String assocTypeQNameStr, boolean mandatory)
BinaryResource	getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef, Parameters parameters, boolean recordActivity) Download file content.
BinaryResource	getContent(String fileNodeId, Parameters parameters, boolean recordActivity) Download file content.
Document	getDocument(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the document representation for the given node.
Folder	getFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the folder representation for the given node.
Node	getFolderOrDocument(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName nodeTypeQName, List<String> includeParam, Map<String,UserInfo> mapUserInfo) Get the folder or document representation (as appropriate) for the given node.
Node	getFolderOrDocument(String nodeId, Parameters parameters) Get the folder or document representation (as appropriate) for the given node.
Node	getFolderOrDocumentFullInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName nodeTypeQName, Parameters parameters, Map<String,UserInfo> mapUserInfo)
Node	getNode(String nodeId) Get the node representation for the given node.
boolean	isSubClass(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName ofClassQName, boolean validateNodeRef) Determines whether the type of the given nodeRef is a sub-class of another class or not.
CollectionWithPagingInfo<Node>	listChildren(String parentFolderNodeId, Parameters parameters) Get list of children of a parent folder.
Node	lock(String nodeId, LockInfo lockInfo, Parameters parameters) Lock a node
PathInfo	lookupPathInfo(org.alfresco.service.cmr.repository.NodeRef nodeRefIn, org.alfresco.service.cmr.repository.ChildAssociationRef archivedParentAssoc) Returns the path to the given nodeRef nodeRefIn or the archived nodeRef archivedParentAssoc.
List<String>	mapFromNodeAspects(Set<org.alfresco.service.namespace.QName> nodeAspects, List<String> excludedNS, List<org.alfresco.service.namespace.QName> excludedAspects) Map from aspects (Set of QName) retrieved from the repository to a map List of String required that can be formatted/expressed as required by the API JSON response for get nodes, get person etc.
Map<String,Object>	mapFromNodeProperties(Map<org.alfresco.service.namespace.QName,Serializable> nodeProps, List<String> selectParam, Map<String,UserInfo> mapUserInfo, List<String> excludedNS, List<org.alfresco.service.namespace.QName> excludedProps) Convert from node properties (map of QName to Serializable) retrieved from the respository to a map of String to Object that can be formatted/expressed as required by the API JSON response for get nodes, get person etc.
Set<org.alfresco.service.namespace.QName>	mapToNodeAspects(List<String> aspectNames) Map from a String representation of aspect names to a set of QName objects, as used by the repository.
Map<org.alfresco.service.namespace.QName,Serializable>	mapToNodeProperties(Map<String,Object> props) Map from the JSON API format of properties (String to Object) to the typical node properties map used by the repository (QName to Serializable).
Node	moveOrCopyNode(String sourceNodeId, String parentFolderNodeId, String name, Parameters parameters, boolean isCopy) Move or Copy node
boolean	nodeMatches(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<org.alfresco.service.namespace.QName> expectedTypes, Set<org.alfresco.service.namespace.QName> excludedTypes)
Node	unlock(String nodeId, Parameters parameters) Unlock a node
Node	updateContent(String fileNodeId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters) Uploads file content (updates existing node with new content).
void	updateCustomAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> aspectNames, List<org.alfresco.service.namespace.QName> exclusions) Update aspects for the specified NodeRef.
Node	updateNode(String nodeId, Node entity, Parameters parameters) Update node meta-data.
Node	upload(String parentFolderNodeId, org.springframework.extensions.webscripts.servlet.FormData formData, Parameters parameters) Uploads file content and meta-data into the repository.
org.alfresco.service.cmr.repository.NodeRef	validateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
org.alfresco.service.cmr.repository.NodeRef	validateNode(org.alfresco.service.cmr.repository.StoreRef storeRef, String nodeId)
org.alfresco.service.cmr.repository.NodeRef	validateNode(String nodeId)
org.alfresco.service.cmr.repository.NodeRef	validateOrLookupNode(String nodeId, String path)

Field Detail

PATH_ROOT

static final String PATH_ROOT

API Constants - query parameters, etc

See Also:

Constant Field Values

PATH_MY

static final String PATH_MY

See Also:

Constant Field Values

PATH_SHARED

static final String PATH_SHARED

See Also:

Constant Field Values

OP_CREATE

static final String OP_CREATE

See Also:

Constant Field Values

OP_DELETE

static final String OP_DELETE

See Also:

Constant Field Values

OP_UPDATE

static final String OP_UPDATE

See Also:

Constant Field Values

OP_UPDATE_PERMISSIONS

static final String OP_UPDATE_PERMISSIONS

See Also:

Constant Field Values

PARAM_RELATIVE_PATH

static final String PARAM_RELATIVE_PATH

See Also:

Constant Field Values

PARAM_PERMANENT

static final String PARAM_PERMANENT

See Also:

Constant Field Values

PARAM_INCLUDE_PROPERTIES

static final String PARAM_INCLUDE_PROPERTIES

See Also:

Constant Field Values

PARAM_INCLUDE_PATH

static final String PARAM_INCLUDE_PATH

See Also:

Constant Field Values

PARAM_INCLUDE_ASPECTNAMES

static final String PARAM_INCLUDE_ASPECTNAMES

See Also:

Constant Field Values

PARAM_INCLUDE_ISLINK

static final String PARAM_INCLUDE_ISLINK

See Also:

Constant Field Values

PARAM_INCLUDE_ISLOCKED

static final String PARAM_INCLUDE_ISLOCKED

See Also:

Constant Field Values

PARAM_INCLUDE_ALLOWABLEOPERATIONS

static final String PARAM_INCLUDE_ALLOWABLEOPERATIONS

See Also:

Constant Field Values

PARAM_INCLUDE_PERMISSIONS

static final String PARAM_INCLUDE_PERMISSIONS

See Also:

Constant Field Values

PARAM_INCLUDE_ASSOCIATION

static final String PARAM_INCLUDE_ASSOCIATION

See Also:

Constant Field Values

PARAM_ISFOLDER

static final String PARAM_ISFOLDER

See Also:

Constant Field Values

PARAM_ISFILE

static final String PARAM_ISFILE

See Also:

Constant Field Values

PARAM_INCLUDE_SUBTYPES

static final String PARAM_INCLUDE_SUBTYPES

See Also:

Constant Field Values

PARAM_NAME

static final String PARAM_NAME

See Also:

Constant Field Values

PARAM_CREATEDAT

static final String PARAM_CREATEDAT

See Also:

Constant Field Values

PARAM_MODIFIEDAT

static final String PARAM_MODIFIEDAT

See Also:

Constant Field Values

PARAM_CREATEBYUSER

static final String PARAM_CREATEBYUSER

See Also:

Constant Field Values

PARAM_MODIFIEDBYUSER

static final String PARAM_MODIFIEDBYUSER

See Also:

Constant Field Values

PARAM_MIMETYPE

static final String PARAM_MIMETYPE

See Also:

Constant Field Values

PARAM_SIZEINBYTES

static final String PARAM_SIZEINBYTES

See Also:

Constant Field Values

PARAM_NODETYPE

static final String PARAM_NODETYPE

See Also:

Constant Field Values

PARAM_VERSION_MAJOR

static final String PARAM_VERSION_MAJOR

See Also:

Constant Field Values

PARAM_VERSION_COMMENT

static final String PARAM_VERSION_COMMENT

See Also:

Constant Field Values

PARAM_OVERWRITE

static final String PARAM_OVERWRITE

See Also:

Constant Field Values

PARAM_AUTO_RENAME

static final String PARAM_AUTO_RENAME

See Also:

Constant Field Values

PARAM_ISPRIMARY

static final String PARAM_ISPRIMARY

See Also:

Constant Field Values

PARAM_ASSOC_TYPE

static final String PARAM_ASSOC_TYPE

See Also:

Constant Field Values

Method Detail

getNode

Node getNode(String nodeId)

Get the node representation for the given node.

Parameters:

nodeId - String

Returns:

Node

getDocument

Document getDocument(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the document representation for the given node.

Parameters:

nodeRef - NodeRef

Returns:

Document

getFolder

Folder getFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the folder representation for the given node.

Parameters:

nodeRef - NodeRef

Returns:

Folder

getFolderOrDocument

Node getFolderOrDocument(String nodeId,
                         Parameters parameters)

Get the folder or document representation (as appropriate) for the given node.

Parameters:

nodeId - String nodeId or well-known alias, eg. "-root-" or "-my-"

parameters - the Parameters object to get the parameters passed into the request including: - incPrimaryParent

Returns:

getFolderOrDocumentFullInfo

Node getFolderOrDocumentFullInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                 org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                                 org.alfresco.service.namespace.QName nodeTypeQName,
                                 Parameters parameters,
                                 Map<String,UserInfo> mapUserInfo)

getFolderOrDocument

Node getFolderOrDocument(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                         org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                         org.alfresco.service.namespace.QName nodeTypeQName,
                         List<String> includeParam,
                         Map<String,UserInfo> mapUserInfo)

Get the folder or document representation (as appropriate) for the given node.

Parameters:

nodeRef - A real Node

parentNodeRef -

nodeTypeQName -

includeParam -

mapUserInfo -

Returns:

listChildren

CollectionWithPagingInfo<Node> listChildren(String parentFolderNodeId,
                                            Parameters parameters)

Get list of children of a parent folder.

Parameters:

parentFolderNodeId - String id of parent folder node or well-known alias, eg. "-root-" or "-my-"

parameters - the Parameters object to get the parameters passed into the request including: - filter, sort & paging params (where, orderBy, skipCount, maxItems) - incFiles, incFolders (both true by default)

Returns:

a paged list of org.alfresco.rest.api.model.Node objects

deleteNode

void deleteNode(String nodeId,
                Parameters parameters)

Delete the given node. Note: will cascade delete for a folder.

Parameters:

nodeId - String id of node (folder or document)

parameters - the Parameters object to get the parameters passed into the request - permanent (default false)

createNode

Node createNode(String parentFolderNodeId,
                Node nodeInfo,
                Parameters parameters)

Create node - folder or (empty) file.

Parameters:

parentFolderNodeId -

nodeInfo -

parameters -

Returns:

moveOrCopyNode

Node moveOrCopyNode(String sourceNodeId,
                    String parentFolderNodeId,
                    String name,
                    Parameters parameters,
                    boolean isCopy)

Move or Copy node

Parameters:

sourceNodeId -

parentFolderNodeId -

name -

parameters -

Returns:

updateNode

Node updateNode(String nodeId,
                Node entity,
                Parameters parameters)

Update node meta-data.

Parameters:

nodeId -

entity -

parameters -

Returns:

getContent

BinaryResource getContent(String fileNodeId,
                          Parameters parameters,
                          boolean recordActivity)

Download file content.

Parameters:

fileNodeId -

parameters -

recordActivity - true, if an activity post is required.

Returns:

getContent

BinaryResource getContent(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          Parameters parameters,
                          boolean recordActivity)

Download file content.

Parameters:

nodeRef - the content nodeRef

parameters -

recordActivity - true, if an activity post is required.

Returns:

updateContent

Node updateContent(String fileNodeId,
                   BasicContentInfo contentInfo,
                   InputStream stream,
                   Parameters parameters)

Uploads file content (updates existing node with new content). Note: may create a new version, depending on versioning behaviour.

Parameters:

fileNodeId -

contentInfo -

stream -

parameters -

Returns:

upload

Node upload(String parentFolderNodeId,
            org.springframework.extensions.webscripts.servlet.FormData formData,
            Parameters parameters)

Uploads file content and meta-data into the repository.

Parameters:

parentFolderNodeId - String id of parent folder node or well-known alias, eg. "-root-" or "-my-"

formData - the FormData

parameters - the Parameters object to get the parameters passed into the request

Returns:

Node if successful

validateNode

org.alfresco.service.cmr.repository.NodeRef validateNode(org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                         String nodeId)

validateNode

org.alfresco.service.cmr.repository.NodeRef validateNode(String nodeId)

validateNode

org.alfresco.service.cmr.repository.NodeRef validateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)

validateOrLookupNode

org.alfresco.service.cmr.repository.NodeRef validateOrLookupNode(String nodeId,
                                                                 String path)

nodeMatches

boolean nodeMatches(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    Set<org.alfresco.service.namespace.QName> expectedTypes,
                    Set<org.alfresco.service.namespace.QName> excludedTypes)

isSubClass

boolean isSubClass(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                   org.alfresco.service.namespace.QName ofClassQName,
                   boolean validateNodeRef)

Determines whether the type of the given nodeRef is a sub-class of another class or not.

Parameters:

nodeRef - source nodeRef

ofClassQName - the class to test against

validateNodeRef - whether to validate the given source node or not

Returns:

true if the type of the given nodeRef is a sub-class of another class, otherwise false

createQName

org.alfresco.service.namespace.QName createQName(String qnameStr)

Helper to create a QName from either a fully qualified or short-name QName string

Parameters:

qnameStr - Fully qualified or short-name QName string

Returns:

QName

getAssocType

org.alfresco.service.namespace.QName getAssocType(String assocTypeQNameStr)

getAssocType

org.alfresco.service.namespace.QName getAssocType(String assocTypeQNameStr,
                                                  boolean mandatory)

addChildren

List<AssocChild> addChildren(String parentNodeId,
                             List<AssocChild> entities)

Parameters:

parentNodeId -

entities -

Returns:

addTargets

List<AssocTarget> addTargets(String sourceNodeId,
                             List<AssocTarget> entities)

Parameters:

sourceNodeId -

entities -

Returns:

lock

Node lock(String nodeId,
          LockInfo lockInfo,
          Parameters parameters)

Lock a node

Parameters:

nodeId -

lockInfo -

parameters -

Returns:

unlock

Node unlock(String nodeId,
            Parameters parameters)

Unlock a node

Parameters:

nodeId -

parameters -

Returns:

mapFromNodeProperties

Map<String,Object> mapFromNodeProperties(Map<org.alfresco.service.namespace.QName,Serializable> nodeProps,
                                         List<String> selectParam,
                                         Map<String,UserInfo> mapUserInfo,
                                         List<String> excludedNS,
                                         List<org.alfresco.service.namespace.QName> excludedProps)

Convert from node properties (map of QName to Serializable) retrieved from the respository to a map of String to Object that can be formatted/expressed as required by the API JSON response for get nodes, get person etc.

Returns null if there are no properties to return, rather than an empty map.

Parameters:

nodeProps -

selectParam -

mapUserInfo -

excludedNS -

excludedProps -

Returns:

The map of properties, or null if none to return.

mapToNodeProperties

Map<org.alfresco.service.namespace.QName,Serializable> mapToNodeProperties(Map<String,Object> props)

Map from the JSON API format of properties (String to Object) to the typical node properties map used by the repository (QName to Serializable).

Parameters:

props -

Returns:

lookupPathInfo

PathInfo lookupPathInfo(org.alfresco.service.cmr.repository.NodeRef nodeRefIn,
                        org.alfresco.service.cmr.repository.ChildAssociationRef archivedParentAssoc)

Returns the path to the given nodeRef nodeRefIn or the archived nodeRef archivedParentAssoc.

Parameters:

nodeRefIn - the NodeRef

archivedParentAssoc - the ChildAssociationRef of the archived NodeRef

Returns:

the path to the given node

mapToNodeAspects

Set<org.alfresco.service.namespace.QName> mapToNodeAspects(List<String> aspectNames)

Map from a String representation of aspect names to a set of QName objects, as used by the repository.

Parameters:

aspectNames -

Returns:

mapFromNodeAspects

List<String> mapFromNodeAspects(Set<org.alfresco.service.namespace.QName> nodeAspects,
                                List<String> excludedNS,
                                List<org.alfresco.service.namespace.QName> excludedAspects)

Map from aspects (Set of QName) retrieved from the repository to a map List of String required that can be formatted/expressed as required by the API JSON response for get nodes, get person etc.

Returns null if there are no aspect names to return, rather than an empty list.

Parameters:

nodeAspects -

excludedNS -

excludedAspects -

Returns:

The list of aspect names, or null if none to return.

addCustomAspects

void addCustomAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                      List<String> aspectNames,
                      List<org.alfresco.service.namespace.QName> exclusions)

Add aspects to the specified NodeRef. Aspects that appear in the exclusions list will be ignored.

Parameters:

nodeRef -

aspectNames -

exclusions -

updateCustomAspects

void updateCustomAspects(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                         List<String> aspectNames,
                         List<org.alfresco.service.namespace.QName> exclusions)

Update aspects for the specified NodeRef. An empty list will result in aspects being removed.

Parameters:

nodeRef -

aspectNames -

exclusions -