mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-02 17:35:18 +00:00
9c17cfa1e0
Added call to AVMService to get Versions by creation date. GetRepositoryVersions methods now return Lists of VersionDescriptors, value objects with the attributes of a version. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3131 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
252 lines
8.9 KiB
Java
252 lines
8.9 KiB
Java
/*
|
|
* Copyright (C) 2006 Alfresco, Inc.
|
|
*
|
|
* Licensed under the Mozilla Public License version 1.1
|
|
* with a permitted attribution clause. You may obtain a
|
|
* copy of the License at
|
|
*
|
|
* http://www.alfresco.org/legal/license.txt
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
* either express or implied. See the License for the specific
|
|
* language governing permissions and limitations under the
|
|
* License.
|
|
*/
|
|
|
|
package org.alfresco.repo.avm;
|
|
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.io.RandomAccessFile;
|
|
import java.util.Date;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* This is the service interface for the [Alfresco|Addled|Advanced|Apotheosed] Versioning
|
|
* Model. It specifies methods that are close in functionality to the underlying
|
|
* implementation, and is intended as both a first class Alfresco service and an
|
|
* aid in creating new implementations of existing services.
|
|
* Paths are of the form repositoryname:/foo/bar/baz
|
|
* @author britt
|
|
*/
|
|
public interface AVMService
|
|
{
|
|
/**
|
|
* Get an InputStream for a file node.
|
|
* @param version The version id to look in.
|
|
* @param path The simple absolute path to the file node.
|
|
* @return An InputStream for the designated file.
|
|
*/
|
|
public InputStream getFileInputStream(int version, String path);
|
|
|
|
/**
|
|
* Get an output stream to a file node. The file must already exist.
|
|
* @param path The simple absolute path to the file node.
|
|
*/
|
|
public OutputStream getFileOutputStream(String path);
|
|
|
|
/**
|
|
* Get a random access file to the given path.
|
|
* @param version The version to find.
|
|
* @param path The path to the file.
|
|
* @param access The access mode for RandomAccessFile.
|
|
* @return A RandomAccessFile
|
|
*/
|
|
public RandomAccessFile getRandomAccess(int version, String path, String access);
|
|
|
|
/**
|
|
* Get a listing of a Folder by name.
|
|
* @param version The version id to look in.
|
|
* @param path The simple absolute path to the file node.
|
|
* @return A List of FolderEntrys.
|
|
*/
|
|
public List<FolderEntry> getDirectoryListing(int version, String path);
|
|
|
|
/**
|
|
* Get a directory listing from a node descriptor.
|
|
* @param dir The directory node descriptor.
|
|
* @return A Map of names to node descriptors.
|
|
*/
|
|
public Map<String, AVMNodeDescriptor> getDirectoryListing(AVMNodeDescriptor dir);
|
|
|
|
/**
|
|
* Create a new File. Fails if the file already exists.
|
|
* @param path The simple absolute path to the parent.
|
|
* @param name The name to give the file.
|
|
* @param source A possibly null stream to draw initial contents from.
|
|
*/
|
|
public OutputStream createFile(String path, String name);
|
|
|
|
/**
|
|
* Create a new directory.
|
|
* @param parent The simple absolute path to the parent.
|
|
* @param name The name to give the folder.
|
|
*/
|
|
public void createDirectory(String path, String name);
|
|
|
|
/**
|
|
* Create a new layered file.
|
|
* @param srcPath The simple absolute path that the new file will point at.
|
|
* @param parent The simple absolute path to the parent.
|
|
* @param name The name to give the new file.
|
|
*/
|
|
public void createLayeredFile(String srcPath, String parent, String name);
|
|
|
|
/**
|
|
* Create a new layered directory.
|
|
* @param srcPath The simple absolute path that the new folder will point at.
|
|
* @param parent The simple absolute path to the parent.
|
|
* @param name The name to give the new folder.
|
|
*/
|
|
public void createLayeredDirectory(String srcPath, String parent, String name);
|
|
|
|
/**
|
|
* Retarget a layered directory.
|
|
* @param path Path to the layered directory.
|
|
* @param target The new target to aim at.
|
|
*/
|
|
public void retargetLayeredDirectory(String path, String target);
|
|
|
|
/**
|
|
* Create a new Repository. All Repositories are top level in a hierarchical
|
|
* sense.
|
|
* @param name The name to give the virtual repository.
|
|
*/
|
|
public void createRepository(String name);
|
|
|
|
/**
|
|
* Create a branch from a given version and path.
|
|
* @param version The version number from which to make the branch.
|
|
* @param srcPath The path to the node to branch from.
|
|
* @param dstPath The path to the directory to contain the
|
|
* new branch.
|
|
* @param name The name to give the new branch.
|
|
*/
|
|
public void createBranch(int version, String srcPath, String dstPath, String name);
|
|
|
|
/**
|
|
* Remove a child from its parent.
|
|
* @param parent The simple absolute path to the parent directory.
|
|
* @param name The name of the child to remove.
|
|
*/
|
|
public void removeNode(String parent, String name);
|
|
|
|
/**
|
|
* Rename a node.
|
|
* @param srcParent The simple absolute path to the parent folder.
|
|
* @param srcName The name of the node in the src Folder.
|
|
* @param dstParent The simple absolute path to the destination folder.
|
|
* @param dstName The name that the node will have in the destination folder.
|
|
*/
|
|
public void rename(String srcParent, String srcName, String dstParent, String dstName);
|
|
|
|
/**
|
|
* Uncover a name in a layered directory. That is, if the layered
|
|
* directory has a deleted entry of the given name remove that
|
|
* name from the deleted list.
|
|
* @param dirPath The path to the layered directory.
|
|
* @param name The name to uncover.
|
|
*/
|
|
public void uncover(String dirPath, String name);
|
|
|
|
/**
|
|
* Get the latest version id of the repository.
|
|
* @param repName The name of the repository.
|
|
* @return The latest version id of the repository.
|
|
*/
|
|
public int getLatestVersionID(String repName);
|
|
|
|
/**
|
|
* Snapshot the given repositories. When this is called everything that has been added,
|
|
* deleted, or modified since the last time this function was called, is marked
|
|
* as needing to be copied, so that further modifications will trigger copy on write
|
|
* semantics.
|
|
* @param repositories The names of the repositories to snapshot.
|
|
*/
|
|
public void createSnapshot(List<String> repositories);
|
|
|
|
/**
|
|
* Snapshot the given repository.
|
|
* @param repository The name of the repository to snapshot.
|
|
*/
|
|
public void createSnapshot(String repository);
|
|
|
|
/**
|
|
* Get the set of versions in a Repository
|
|
* @param name The name of the Repository.
|
|
* @return A Set of version IDs
|
|
*/
|
|
public List<VersionDescriptor> getRepositoryVersions(String name);
|
|
|
|
/**
|
|
* Get Repository version IDs by creation date. Either from or
|
|
* to can be null but not both.
|
|
* @param name The name of the repository.
|
|
* @param from Earliest date of version to include.
|
|
* @param to Latest date of version to include.
|
|
* @return The Set of version IDs that match.
|
|
*/
|
|
public List<VersionDescriptor> getRepositoryVersions(String name, Date from, Date to);
|
|
|
|
/**
|
|
* Get the names of all repositories.
|
|
* @return A List of all names.
|
|
*/
|
|
public List<String> getRepositoryNames();
|
|
|
|
/**
|
|
* Get the specified root of a repository.
|
|
* @param version The version to look up.
|
|
* @param name The name of the repository.
|
|
* @return A descriptor for the specified root.
|
|
*/
|
|
public AVMNodeDescriptor getRepositoryRoot(int version, String name);
|
|
|
|
/**
|
|
* Lookup a node by version ids and path.
|
|
* @param version The version id to look under.
|
|
* @param path The simple absolute path to the parent directory.
|
|
* @return An AVMNodeDescriptor.
|
|
*/
|
|
public AVMNodeDescriptor lookup(int version, String path);
|
|
|
|
/**
|
|
* Lookup a node from a directory node.
|
|
* @param dir The descriptor for the directory node.
|
|
* @param name The name to lookup.
|
|
* @return The descriptor for the child.
|
|
*/
|
|
public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name);
|
|
|
|
/**
|
|
* Get the indirection path for a layered file or directory.
|
|
* @param version The version number to get.
|
|
* @param path The path to the node of interest.
|
|
* @return The indirection path.
|
|
*/
|
|
public String getIndirectionPath(int version, String path);
|
|
|
|
/**
|
|
* Purge a repository. This is a complete wipe of a Repository.
|
|
* @param name The name of the Repository.
|
|
*/
|
|
public void purgeRepository(String name);
|
|
|
|
/**
|
|
* Purge a version from a repository. Deletes everything that lives in
|
|
* the given version only.
|
|
* @param version The version to purge.
|
|
* @param name The name of the Repository from which to purge it.
|
|
*/
|
|
public void purgeVersion(int version, String name);
|
|
|
|
/**
|
|
* Make a directory into a primary indirection node.
|
|
* @param path The full path.
|
|
*/
|
|
public void makePrimary(String path);
|
|
}
|