mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
6afb44e712
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
122 lines
3.6 KiB
Java
122 lines
3.6 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* 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/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.service.cmr.remote;
|
|
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.util.Pair;
|
|
|
|
/**
|
|
* A highly simplified remote interface for the repo.
|
|
* @author britt
|
|
*/
|
|
public interface RepoRemote
|
|
{
|
|
/**
|
|
* Get the root node of the SpacesStore repo.
|
|
* @return The root node ref.
|
|
*/
|
|
public NodeRef getRoot();
|
|
|
|
/**
|
|
* Get a listing of a directory.
|
|
* @param dir The node ref of the directory.
|
|
* @return A Map of names to node refs.
|
|
*/
|
|
public Map<String, Pair<NodeRef, Boolean>> getListing(NodeRef dir);
|
|
|
|
/**
|
|
* Lookup a node by path relative to a node.
|
|
* @param base The base node ref.
|
|
* @param path The relative path.
|
|
* @return The node ref or null.
|
|
*/
|
|
public Pair<NodeRef, Boolean> lookup(NodeRef base, String path);
|
|
|
|
/**
|
|
* Create a file relative to a base node.
|
|
* @param base The base node ref.
|
|
* @param path The relative path.
|
|
* @return An OutputStream.
|
|
*/
|
|
public OutputStream createFile(NodeRef base, String path);
|
|
|
|
/**
|
|
* Write to an already existing file.
|
|
* @param base The base node ref.
|
|
* @param path The relative path.
|
|
* @return An OutputStream
|
|
*/
|
|
public OutputStream writeFile(NodeRef base, String path);
|
|
|
|
/**
|
|
* Create a new directory.
|
|
* @param base The base node ref.
|
|
* @param path The relative path.
|
|
* @return The node ref to the newly created directory.
|
|
*/
|
|
public NodeRef createDirectory(NodeRef base, String path);
|
|
|
|
/**
|
|
* Remove a node directly.
|
|
* @param toRemove The node ref to remove.
|
|
*/
|
|
public void removeNode(NodeRef toRemove);
|
|
|
|
/**
|
|
* Remove a node via a relative path.
|
|
* @param base The base node ref.
|
|
* @param path The relative path.
|
|
*/
|
|
public void removeNode(NodeRef base, String path);
|
|
|
|
/**
|
|
* Rename a node
|
|
* @param base The base node ref.
|
|
* @param src The relative source path.
|
|
* @param dst The relative target path.
|
|
*/
|
|
public void rename(NodeRef base, String src, String dst);
|
|
|
|
/**
|
|
* Read a file directly.
|
|
* @param fileRef The node ref of the file.
|
|
* @return An InputStream.
|
|
*/
|
|
public InputStream readFile(NodeRef fileRef);
|
|
|
|
/**
|
|
* Read a file from a relative path.
|
|
* @param base The base node ref.
|
|
* @param path The relative path to the file.
|
|
* @return An InputStream.
|
|
*/
|
|
public InputStream readFile(NodeRef base, String path);
|
|
}
|