mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
c03accdbea
121851 jvonka: (Quick) Shared Links API - update resource name to "/shared-links" - also add REST impl layer - TODO review impl (+ add tests) RA-775, RA-773, RA-750, RA-708, RA-776 git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@126428 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
77 lines
2.5 KiB
Java
77 lines
2.5 KiB
Java
/*
|
|
* Copyright (C) 2005-2016 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.rest.api;
|
|
|
|
import org.alfresco.rest.api.model.QuickShareLink;
|
|
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
|
import org.alfresco.rest.framework.resource.content.BinaryResource;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Centralises access to quick share services and maps between representations.
|
|
*
|
|
* @author janv
|
|
*
|
|
* @since publicapi1.0
|
|
*/
|
|
public interface QuickShareLinks
|
|
{
|
|
/**
|
|
* Returns limited metadata regarding the shared (content) link.
|
|
*
|
|
* Note: does *not* require authenticated access for (public) shared link.
|
|
*/
|
|
QuickShareLink readById(String sharedId, Parameters parameters);
|
|
|
|
/**
|
|
* Download content via shared link.
|
|
*
|
|
* Note: does *not* require authenticated access for (public) shared link.
|
|
*
|
|
* @param sharedId
|
|
* @param parameters {@link Parameters}
|
|
* @return
|
|
* @throws EntityNotFoundException
|
|
*/
|
|
BinaryResource readProperty(String sharedId, final Parameters parameters) throws EntityNotFoundException;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param sharedId String id of the quick share
|
|
*/
|
|
void delete(String sharedId, Parameters parameters);
|
|
|
|
/**
|
|
* Create quick share.
|
|
*
|
|
* Requires authenticated access.
|
|
*
|
|
* @param nodeIds
|
|
* @param parameters
|
|
* @return
|
|
*/
|
|
List<QuickShareLink> create(List<QuickShareLink> nodeIds, Parameters parameters);
|
|
} |