Package org.alfresco.rest.api

Interface DeletedNodes

All Known Implementing Classes:

DeletedNodesImpl

public interface DeletedNodes

Handles trashcan / deleted nodes

Author:

Gethin James

Method Summary

Modifier and Type	Method	Description
BinaryResource	getContent(String archivedId, String renditionId, Parameters parameters)	Download file content (or rendition content) via archived node.
Node	getDeletedNode(String originalId, Parameters parameters, boolean fullnode, Map<String,UserInfo> mapUserInfo)	Gets a single deleted node by id.
Rendition	getRendition(String archivedId, String renditionId, Parameters parameters)
CollectionWithPagingInfo<Rendition>	getRenditions(String archivedId, Parameters parameters)
CollectionWithPagingInfo<Node>	listDeleted(Parameters parameters)	Lists deleted nodes using a ArchivedNodesCannedQuery
void	purgeArchivedNode(String archivedId)	Permanently delete the node.
default DirectAccessUrl	requestContentDirectUrl(String archivedId, String renditionId, boolean attachment)	Gets a presigned URL to directly access content.
DirectAccessUrl	requestContentDirectUrl(String archivedId, String renditionId, boolean attachment, Long validFor)	Gets a presigned URL to directly access content.
Node	restoreArchivedNode(String archivedId, NodeTargetAssoc nodeTargetAssoc)	Restores a deleted node and returns it.

Method Detail

listDeleted

CollectionWithPagingInfo<Node> listDeleted(Parameters parameters)

Lists deleted nodes using a ArchivedNodesCannedQuery

Parameters:

parameters -

Returns:

Collection of deleted Nodes

getDeletedNode

Node getDeletedNode(String originalId,
                    Parameters parameters,
                    boolean fullnode,
                    Map<String,UserInfo> mapUserInfo)

Gets a single deleted node by id.

Parameters:

originalId -

parameters -

fullnode - Should we return the full representation of the minimal one?

mapUserInfo -

Returns:

a deleted node

restoreArchivedNode

Node restoreArchivedNode(String archivedId,
                         NodeTargetAssoc nodeTargetAssoc)

Restores a deleted node and returns it.

Parameters:

archivedId -

nodeTargetAssoc - - optional

Returns:

the new undeleted node.

purgeArchivedNode

void purgeArchivedNode(String archivedId)

Permanently delete the node.

Parameters:

archivedId -

getContent

BinaryResource getContent(String archivedId,
                          String renditionId,
                          Parameters parameters)

Download file content (or rendition content) via archived node.

Parameters:

archivedId -

renditionId - - optional

parameters - Parameters

Returns:

getRendition

Rendition getRendition(String archivedId,
                       String renditionId,
                       Parameters parameters)

Parameters:

archivedId -

renditionId -

Returns:

getRenditions

CollectionWithPagingInfo<Rendition> getRenditions(String archivedId,
                                                  Parameters parameters)

Parameters:

archivedId -

Returns:

requestContentDirectUrl

default DirectAccessUrl requestContentDirectUrl(String archivedId,
                                                String renditionId,
                                                boolean attachment)

Gets a presigned URL to directly access content.

Parameters:

archivedId - The node id for which to obtain the direct access URL

renditionId - The rendition id for which to obtain the direct access URL

attachment - true if an attachment URL is requested, false for an embedded URL, true by default.

Returns:

A direct access URL object for the content.

requestContentDirectUrl

DirectAccessUrl requestContentDirectUrl(String archivedId,
                                        String renditionId,
                                        boolean attachment,
                                        Long validFor)

Gets a presigned URL to directly access content.

Parameters:

archivedId - The node id for which to obtain the direct access URL

renditionId - The rendition id for which to obtain the direct access URL

attachment - true if an attachment URL is requested, false for an embedded URL, true by default.

validFor - The time at which the direct access URL will expire.

Returns:

A direct access URL object for the content.