Package org.alfresco.rest.api.quicksharelinks

Class QuickShareLinkEntityResource

java.lang.Object

org.alfresco.rest.api.quicksharelinks.QuickShareLinkEntityResource

All Implemented Interfaces:

BinaryResourceAction.Read, EntityResourceAction.Create<QuickShareLink>, EntityResourceAction.Delete, EntityResourceAction.Read<QuickShareLink>, EntityResourceAction.ReadById<QuickShareLink>, ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="shared-links",
                title="Shared Links")
public class QuickShareLinkEntityResource
extends java.lang.Object
implements EntityResourceAction.ReadById<QuickShareLink>, BinaryResourceAction.Read, EntityResourceAction.Delete, EntityResourceAction.Create<QuickShareLink>, EntityResourceAction.Read<QuickShareLink>, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for Shared Links.

Author:

janv, Jamal Kaabi-Mofrad

Constructor Summary

Constructors

Constructor	Description
QuickShareLinkEntityResource()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
java.util.List<QuickShareLink>	create(java.util.List<QuickShareLink> nodeIds, Parameters parameters)	Create quick share.
void	delete(java.lang.String sharedId, Parameters parameters)	Delete the shared link.
void	email(java.lang.String sharedId, QuickShareLinkEmailRequest emailRequest, Parameters parameters, WithResponse response)
CollectionWithPagingInfo<QuickShareLink>	readAll(Parameters parameters)	Find shared links
QuickShareLink	readById(java.lang.String sharedId, Parameters parameters)	Returns limited metadata regarding the shared (content) link.
BinaryResource	readProperty(java.lang.String sharedId, Parameters parameters)	Download content via shared link.
void	setQuickShareLinks(QuickShareLinks quickShareLinks)

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickShareLinkEntityResource

public QuickShareLinkEntityResource()

Method Detail

setQuickShareLinks

public void setQuickShareLinks(QuickShareLinks quickShareLinks)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

readById

@WebApiNoAuth
public QuickShareLink readById(java.lang.String sharedId,
                               Parameters parameters)

Returns limited metadata regarding the shared (content) link. Note: does *not* require authenticated access for (public) shared link.

Specified by:

readById in interface EntityResourceAction.ReadById<QuickShareLink>

readProperty

@WebApiNoAuth
public BinaryResource readProperty(java.lang.String sharedId,
                                   Parameters parameters)
                            throws EntityNotFoundException

Download content via shared link. Note: does *not* require authenticated access for (public) shared link.

Specified by:

readProperty in interface BinaryResourceAction.Read

Parameters:

sharedId -

parameters - Parameters

Returns:

Throws:

EntityNotFoundException

delete

public void delete(java.lang.String sharedId,
                   Parameters parameters)

Delete the shared link. Once deleted, the shared link will no longer exist hence get/download will no longer work (ie. return 404). If the link is later re-created then a new unique shared id will be generated. Requires authenticated access.

Specified by:

delete in interface EntityResourceAction.Delete

Parameters:

sharedId - String id of the quick share

create

public java.util.List<QuickShareLink> create(java.util.List<QuickShareLink> nodeIds,
                                             Parameters parameters)

Create quick share. Requires authenticated access.

Specified by:

create in interface EntityResourceAction.Create<QuickShareLink>

Parameters:

nodeIds -

parameters -

Returns:

email

public void email(java.lang.String sharedId,
                  QuickShareLinkEmailRequest emailRequest,
                  Parameters parameters,
                  WithResponse response)

readAll

public CollectionWithPagingInfo<QuickShareLink> readAll(Parameters parameters)

Find shared links

Specified by:

readAll in interface EntityResourceAction.Read<QuickShareLink>

Parameters:

parameters - - will never be null and will have the PAGING default values