org.alfresco.repo.avm

Class AVMRepository

java.lang.Object

org.alfresco.repo.avm.AVMRepository

public class AVMRepository
extends Object

This or AVMStore are the implementors of the operations specified by AVMService.

Author:

britt

Constructor Summary

Constructors

Constructor and Description
AVMRepository() Create a new one.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAspect(String path, org.alfresco.service.namespace.QName aspectName) Add an aspect to an AVM Node.
boolean	can(AVMStore store, AVMNode node, String permission, boolean isDirectlyContained) Evaluate permission on a node.
boolean	can(String storeName, int version, String path, String permission)
void	createAVMStore(String name) Create a new AVMStore.
void	createAVMStore(String name, Map<org.alfresco.service.namespace.QName,PropertyValue> props)
void	createBranch(int version, String srcPath, String dstPath, String name) Create a new branch.
org.alfresco.service.cmr.repository.ContentWriter	createContentWriter(String path, boolean update) Get a ContentWriter to a file node.
AVMNodeDescriptor	createDirectory(AVMNodeDescriptor parent, String name) Create a new directory.
void	createDirectory(String path, String name, List<org.alfresco.service.namespace.QName> aspects, Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Create a new directory.
OutputStream	createFile(String path, String name) Create a file.
void	createFile(String path, String name, File data, List<org.alfresco.service.namespace.QName> aspects, Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Create a file with the given File as content.
void	createLayeredDirectory(String srcPath, String dstPath, String name) Create a new layered directory.
void	createLayeredFile(String srcPath, String dstPath, String name) Create a new layered file.
Map<String,Integer>	createSnapshot(String storeName, String tag, String description) Create a snapshot of a single AVMStore.
void	deleteNodeProperties(String path) Delete all properties on a node.
void	deleteNodeProperty(String path, org.alfresco.service.namespace.QName name) Delete a single property from a node.
void	deleteStoreProperty(String store, org.alfresco.service.namespace.QName name) Delete a property from a store.
void	flatten(String path, String name) Remove name without leaving behind a deleted node.
AVMNodeDescriptor	forceCopy(String path) Force a copy on write.
Acl	getACL(int version, String path) Get the ACL on a node.
org.alfresco.util.Pair<Integer,String>	getAPath(AVMNodeDescriptor desc) Get a single valid path for a node.
Set<org.alfresco.service.namespace.QName>	getAspects(AVMNodeDescriptor desc)
Set<org.alfresco.service.namespace.QName>	getAspects(int version, String path) Get all the aspects on an AVM node.
AVMStoreDescriptor	getAVMStore(String name) Get a descriptor for an AVMStore.
AVMNodeDescriptor	getAVMStoreRoot(int version, String name) Get a descriptor for an AVMStore root.
List<AVMStoreDescriptor>	getAVMStores() Get descriptors of all AVMStores.
List<VersionDescriptor>	getAVMStoreVersions(String name) Get all version for a given AVMStore.
List<VersionDescriptor>	getAVMStoreVersions(String name, Date from, Date to) Get the set of versions between (inclusive) of the given dates.
List<VersionDescriptor>	getAVMStoreVersionsBetween(String name, int startVersion, int endVersion)
List<VersionDescriptor>	getAVMStoreVersionsFrom(String name, int version)
List<VersionDescriptor>	getAVMStoreVersionsTo(String name, int version)
AVMNodeDescriptor	getCommonAncestor(AVMNodeDescriptor left, AVMNodeDescriptor right) Get the common ancestor of two nodes if one exists.
org.alfresco.service.cmr.repository.ContentData	getContentDataForRead(AVMNodeDescriptor desc)
org.alfresco.service.cmr.repository.ContentData	getContentDataForRead(int version, String path) Get the ContentData for a file.
org.alfresco.service.cmr.repository.ContentData	getContentDataForWrite(String path) Get the ContentData for a file for writing.
org.alfresco.service.cmr.repository.ContentReader	getContentReader(int version, String path) Get a content reader from a file node.
List<String>	getDeleted(int version, String path) Get the names of deleted nodes in a directory.
List<org.alfresco.util.Pair<Integer,String>>	getHeadPaths(AVMNodeDescriptor desc) Get all paths for a node reachable by HEAD.
List<AVMNodeDescriptor>	getHistory(AVMNodeDescriptor desc, int count) Get the history chain for a node.
String	getIndirectionPath(int version, String path) Get the indirection path for a layered node.
InputStream	getInputStream(AVMNodeDescriptor desc)
InputStream	getInputStream(int version, String path) Get an input stream from a file.
static AVMRepository	GetInstance() Get the single instance of AVMRepository.
int	getLatestSnapshotID(String name) Get the latest extant snapshotted version id.
int	getLatestVersionID(String name) Get the next version id for the given AVMStore.
LayeringDescriptor	getLayeringInfo(int version, String path) Get information about layering of a path.
SortedMap<String,AVMNodeDescriptor>	getListing(AVMNodeDescriptor dir, boolean includeDeleted) Get a directory listing from a directory node descriptor.
SortedMap<String,AVMNodeDescriptor>	getListing(AVMNodeDescriptor dir, String childNamePattern, boolean includeDeleted) Get a directory listing from a directory node descriptor fo children that match the given pattern
SortedMap<String,AVMNodeDescriptor>	getListing(int version, String path, boolean includeDeleted) Get a listing of a directory.
SortedMap<String,AVMNodeDescriptor>	getListingDirect(AVMNodeDescriptor dir, boolean includeDeleted) Get the list of nodes directly contained in a directory.
SortedMap<String,AVMNodeDescriptor>	getListingDirect(int version, String path, boolean includeDeleted) Get the list of nodes directly contained in a directory.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getNodeProperties(AVMNodeDescriptor desc)
Map<org.alfresco.service.namespace.QName,PropertyValue>	getNodeProperties(int version, String path) Get a Map of all the properties of a node.
PropertyValue	getNodeProperty(int version, String path, org.alfresco.service.namespace.QName name) Get a property by name for a node.
OutputStream	getOutputStream(String path) Get an output stream to a file.
List<org.alfresco.util.Pair<Integer,String>>	getPaths(AVMNodeDescriptor desc) Get all the paths to a particular node.
List<org.alfresco.util.Pair<Integer,String>>	getPathsInStoreHead(AVMNodeDescriptor desc, String store) Get all paths in a particular store in the head version for a particular node.
List<String>	getPathsInStoreVersion(AVMNodeDescriptor desc, String store, int version)
Acl	getStoreAcl(String storeName) Get the ACL on a store.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getStoreProperties(String store) Get all the properties for a store.
PropertyValue	getStoreProperty(String store, org.alfresco.service.namespace.QName name) Get a property from a store.
List<String>	getVersionPaths(VersionRoot version, AVMNode node) Gets all the pass from to the given node starting from the give version root.
boolean	hasAspect(int version, String path, org.alfresco.service.namespace.QName aspectName) Does a node have a particular aspect.
void	link(AVMNodeDescriptor parent, String name, AVMNodeDescriptor child) This is the danger version of link.
void	link(String parentPath, String name, AVMNodeDescriptor toLink) Link a node into a directory, directly.
AVMNodeDescriptor	lookup(AVMNodeDescriptor dir, String name, boolean includeDeleted) Lookup a descriptor from a directory descriptor.
org.alfresco.repo.avm.Lookup	lookup(int version, String path, boolean includeDeleted) Lookup a node.
org.alfresco.repo.avm.Lookup	lookupDirectory(int version, String path) Lookup a directory specifically.
void	makePrimary(String path) Make a directory into a primary indirection.
void	purgeAVMStore(String name) Get rid of all content that lives only in the given AVMStore.
void	purgeVersion(String name, int version) Remove all content specific to a AVMRepository and version.
Map<org.alfresco.service.namespace.QName,PropertyValue>	queryStorePropertyKey(String store, org.alfresco.service.namespace.QName keyPattern) Queries a given store for properties with keys that match a given pattern.
Map<String,Map<org.alfresco.service.namespace.QName,PropertyValue>>	queryStoresPropertyKeys(org.alfresco.service.namespace.QName keyPattern) Queries all AVM stores for properties with keys that match a given pattern.
void	remove(String path, String name) Remove a node and everything underneath it.
void	removeAspect(String path, org.alfresco.service.namespace.QName aspectName) Remove an aspect and all associated properties from a node.
void	rename(String srcPath, String srcName, String dstPath, String dstName) Rename a node.
void	renameStore(String sourceName, String destName) Rename a store.
void	retargetLayeredDirectory(String path, String target) Change what a layered directory points at.
void	revert(String path, String name, AVMNodeDescriptor toRevertTo) Revert a head path to a given version.
void	setACL(String path, Acl acl) Set the ACL on a node.
void	setAvmNodeDAO(AVMNodeDAO dao)
void	setAvmStoreDAO(AVMStoreDAO dao)
void	setAvmStorePropertyDAO(AVMStorePropertyDAO dao)
void	setChildEntryDAO(ChildEntryDAO dao)
void	setContentData(String path, org.alfresco.service.cmr.repository.ContentData data) Set the ContentData on a file.
void	setContentStore(ContentStore store) Set the ContentService.
void	setCreateStoreTxnListener(CreateStoreTxnListener listener)
void	setCreateVersionTxnListener(CreateVersionTxnListener listener)
void	setEncoding(String path, String encoding) Set the encoding on a node.
void	setGuid(String path, String guid) Set the GUID on a node.
void	setLookupCache(LookupCache cache) Set the Lookup Cache instance.
void	setMetaDataFrom(String path, AVMNodeDescriptor from)
void	setMimeType(String path, String mimeType) Set the mime type on a node.
void	setNodeProperties(String path, Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Set a collection of properties at once.
void	setNodeProperty(String path, org.alfresco.service.namespace.QName name, PropertyValue value) Set a property on a node.
void	setOpacity(String path, boolean opacity) Set the opacity of a layered directory.
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService service)
void	setPurgeStoreTxnListener(PurgeStoreTxnListener listener)
void	setPurgeVersionTxnListener(PurgeVersionTxnListener listener)
void	setStoreAcl(String storeName, Acl acl) Set the acl on a store.
void	setStoreProperties(String store, Map<org.alfresco.service.namespace.QName,PropertyValue> props) Set a group of properties on a store.
void	setStoreProperty(String store, org.alfresco.service.namespace.QName name, PropertyValue value) Set a property on a store.
void	setVersionLayeredNodeEntryDAO(VersionLayeredNodeEntryDAO dao)
void	setVersionRootDAO(VersionRootDAO dao)
void	uncover(String dirPath, String name) Uncover a deleted name in a layered directory.
void	updateLink(String parentPath, String name, AVMNodeDescriptor toLink) Update a link, directly.

Methods inherited from class java.lang.Object

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

Constructor Detail

AVMRepository

public AVMRepository()

Create a new one.

Method Detail

setContentStore

public void setContentStore(ContentStore store)

Set the ContentService.

setLookupCache

public void setLookupCache(LookupCache cache)

Set the Lookup Cache instance.

Parameters:

cache - The instance to set.

setCreateStoreTxnListener

public void setCreateStoreTxnListener(CreateStoreTxnListener listener)

setPurgeStoreTxnListener

public void setPurgeStoreTxnListener(PurgeStoreTxnListener listener)

setCreateVersionTxnListener

public void setCreateVersionTxnListener(CreateVersionTxnListener listener)

setPurgeVersionTxnListener

public void setPurgeVersionTxnListener(PurgeVersionTxnListener listener)

setAvmStoreDAO

public void setAvmStoreDAO(AVMStoreDAO dao)

setAvmNodeDAO

public void setAvmNodeDAO(AVMNodeDAO dao)

setVersionRootDAO

public void setVersionRootDAO(VersionRootDAO dao)

setVersionLayeredNodeEntryDAO

public void setVersionLayeredNodeEntryDAO(VersionLayeredNodeEntryDAO dao)

setAvmStorePropertyDAO

public void setAvmStorePropertyDAO(AVMStorePropertyDAO dao)

setChildEntryDAO

public void setChildEntryDAO(ChildEntryDAO dao)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService service)

createFile

public OutputStream createFile(String path,
                      String name)

Create a file.

Parameters:

path - The path to the containing directory.

name - The name for the new file.

createFile

public void createFile(String path,
              String name,
              File data,
              List<org.alfresco.service.namespace.QName> aspects,
              Map<org.alfresco.service.namespace.QName,PropertyValue> properties)

Create a file with the given File as content.

Parameters:

path - The path to the containing directory.

name - The name to give the file.

data - The file contents.

createDirectory

public void createDirectory(String path,
                   String name,
                   List<org.alfresco.service.namespace.QName> aspects,
                   Map<org.alfresco.service.namespace.QName,PropertyValue> properties)

Create a new directory.

Parameters:

path - The path to the containing directory.

name - The name to give the directory.

createDirectory

public AVMNodeDescriptor createDirectory(AVMNodeDescriptor parent,
                                String name)

Create a new directory. This assumes that the parent is already copied and therefore should only be used with great care.

Parameters:

parent - The parent node.

name - The name of the new directory.

Returns:

A descriptor for the newly created directory.

createLayeredDirectory

public void createLayeredDirectory(String srcPath,
                          String dstPath,
                          String name)

Create a new layered directory.

Parameters:

srcPath - The target indirection for the new layered directory.

dstPath - The path to the containing directory.

name - The name for the new directory.

createLayeredFile

public void createLayeredFile(String srcPath,
                     String dstPath,
                     String name)

Create a new layered file.

Parameters:

srcPath - The target indirection for the new layered file.

dstPath - The path to the containing directory.

name - The name of the new layered file.

createAVMStore

public void createAVMStore(String name)

Create a new AVMStore.

Parameters:

name - The name to give the new AVMStore.

createAVMStore

public void createAVMStore(String name,
                  Map<org.alfresco.service.namespace.QName,PropertyValue> props)

createBranch

public void createBranch(int version,
                String srcPath,
                String dstPath,
                String name)

Create a new branch.

Parameters:

version - The version to branch off.

srcPath - The path to make a branch from.

dstPath - The containing directory.

name - The name of the new branch.

getOutputStream

public OutputStream getOutputStream(String path)

Get an output stream to a file.

Parameters:

path - The full path to the file.

Returns:

An OutputStream.

getContentReader

public org.alfresco.service.cmr.repository.ContentReader getContentReader(int version,
                                                                 String path)

Get a content reader from a file node.

Parameters:

version - The version of the file.

path - The path to the file.

Returns:

A ContentReader.

createContentWriter

public org.alfresco.service.cmr.repository.ContentWriter createContentWriter(String path,
                                                                    boolean update)

Get a ContentWriter to a file node.

Parameters:

path - The path to the file.

update - true if the property must be updated atomically when the content write stream is closed (attaches a listener to the stream); false if the client code will perform the updates itself.

Returns:

A ContentWriter.

rename

public void rename(String srcPath,
          String srcName,
          String dstPath,
          String dstName)

Rename a node.

Parameters:

srcPath - Source containing directory.

srcName - Source name.

dstPath - Destination containing directory.

dstName - Destination name.

uncover

public void uncover(String dirPath,
           String name)

Uncover a deleted name in a layered directory.

Parameters:

dirPath - The path to the layered directory.

name - The name to uncover.

createSnapshot

public Map<String,Integer> createSnapshot(String storeName,
                                 String tag,
                                 String description)

Create a snapshot of a single AVMStore.

Parameters:

store - The name of the repository.

tag - The short description.

description - The thick description.

Returns:

The version id of the newly snapshotted repository.

remove

public void remove(String path,
          String name)

Remove a node and everything underneath it.

Parameters:

path - The path to the containing directory.

name - The name of the node to remove.

purgeAVMStore

public void purgeAVMStore(String name)

Get rid of all content that lives only in the given AVMStore. Also removes the AVMStore.

Parameters:

name - The name of the AVMStore to purge.

purgeVersion

public void purgeVersion(String name,
                int version)

Remove all content specific to a AVMRepository and version.

Parameters:

name - The name of the AVMStore.

version - The version to purge.

getInputStream

public InputStream getInputStream(int version,
                         String path)

Get an input stream from a file.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

An InputStream.

getInputStream

public InputStream getInputStream(AVMNodeDescriptor desc)

getListing

public SortedMap<String,AVMNodeDescriptor> getListing(int version,
                                             String path,
                                             boolean includeDeleted)

Get a listing of a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

includeDeleted - Whether to see DeletedNodes.

Returns:

A List of FolderEntries.

getListingDirect

public SortedMap<String,AVMNodeDescriptor> getListingDirect(int version,
                                                   String path,
                                                   boolean includeDeleted)

Get the list of nodes directly contained in a directory.

Parameters:

version - The version to look under.

path - The path to the directory to list.

Returns:

A Map of names to descriptors.

getListingDirect

public SortedMap<String,AVMNodeDescriptor> getListingDirect(AVMNodeDescriptor dir,
                                                   boolean includeDeleted)

Get the list of nodes directly contained in a directory.

Parameters:

dir - The descriptor to the directory node.

includeDeleted - Whether to include deleted children.

Returns:

A Map of names to descriptors.

getListing

public SortedMap<String,AVMNodeDescriptor> getListing(AVMNodeDescriptor dir,
                                             boolean includeDeleted)

Get a directory listing from a directory node descriptor.

Parameters:

dir - The directory node descriptor.

Returns:

A SortedMap listing.

getListing

public SortedMap<String,AVMNodeDescriptor> getListing(AVMNodeDescriptor dir,
                                             String childNamePattern,
                                             boolean includeDeleted)

Get a directory listing from a directory node descriptor fo children that match the given pattern

Parameters:

dir - The directory node descriptor.

Returns:

A SortedMap listing.

getDeleted

public List<String> getDeleted(int version,
                      String path)

Get the names of deleted nodes in a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

Returns:

A List of names.

getAVMStores

public List<AVMStoreDescriptor> getAVMStores()

Get descriptors of all AVMStores.

Returns:

A list of all descriptors.

getAVMStore

public AVMStoreDescriptor getAVMStore(String name)

Get a descriptor for an AVMStore.

Parameters:

name - The name to get.

Returns:

The descriptor.

getAVMStoreVersions

public List<VersionDescriptor> getAVMStoreVersions(String name)

Get all version for a given AVMStore.

Parameters:

name - The name of the AVMStore.

Returns:

A Set will all the version ids.

getAVMStoreVersions

public List<VersionDescriptor> getAVMStoreVersions(String name,
                                          Date from,
                                          Date to)

Get the set of versions between (inclusive) of the given dates. From or to may be null but not both.

Parameters:

name - The name of the AVMRepository.

from - The earliest date.

to - The latest date.

Returns:

The Set of version IDs.

getIndirectionPath

public String getIndirectionPath(int version,
                        String path)

Get the indirection path for a layered node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

The indirection path.

getLatestVersionID

public int getLatestVersionID(String name)

Get the next version id for the given AVMStore.

Parameters:

name - The name of the AVMStore.

Returns:

The next version id.

getLatestSnapshotID

public int getLatestSnapshotID(String name)

Get the latest extant snapshotted version id.

Parameters:

name - The store name.

getAVMStoreRoot

public AVMNodeDescriptor getAVMStoreRoot(int version,
                                String name)

Get a descriptor for an AVMStore root.

Parameters:

version - The version to get.

name - The name of the AVMStore.

Returns:

The descriptor for the root.

lookup

public org.alfresco.repo.avm.Lookup lookup(int version,
                                  String path,
                                  boolean includeDeleted)

Lookup a node.

Parameters:

version - The version to look under.

path - The path to lookup.

includeDeleted - Whether to see DeletedNodes.

Returns:

A lookup object.

lookup

public AVMNodeDescriptor lookup(AVMNodeDescriptor dir,
                       String name,
                       boolean includeDeleted)

Lookup a descriptor from a directory descriptor.

Parameters:

dir - The directory descriptor.

name - The name of the child to lookup.

Returns:

The child's descriptor.

getPaths

public List<org.alfresco.util.Pair<Integer,String>> getPaths(AVMNodeDescriptor desc)

Get all the paths to a particular node.

Parameters:

desc - The node descriptor.

Returns:

The list of version, paths.

getAPath

public org.alfresco.util.Pair<Integer,String> getAPath(AVMNodeDescriptor desc)

Get a single valid path for a node.

Parameters:

desc - The node descriptor.

Returns:

A version, path

getHeadPaths

public List<org.alfresco.util.Pair<Integer,String>> getHeadPaths(AVMNodeDescriptor desc)

Get all paths for a node reachable by HEAD.

Parameters:

desc - The node descriptor.

Returns:

A List of all the version, path Pairs that match.

getVersionPaths

public List<String> getVersionPaths(VersionRoot version,
                           AVMNode node)

Gets all the pass from to the given node starting from the give version root.

Parameters:

version - The version root.

node - The node to get the paths of.

Returns:

A list of all paths in the given version to the node.

getPathsInStoreHead

public List<org.alfresco.util.Pair<Integer,String>> getPathsInStoreHead(AVMNodeDescriptor desc,
                                                               String store)

Get all paths in a particular store in the head version for a particular node.

Parameters:

desc - The node descriptor.

store - The name of the store.

Returns:

All matching paths.

getLayeringInfo

public LayeringDescriptor getLayeringInfo(int version,
                                 String path)

Get information about layering of a path.

Parameters:

version - The version to look under.

path - The full avm path.

Returns:

A LayeringDescriptor.

lookupDirectory

public org.alfresco.repo.avm.Lookup lookupDirectory(int version,
                                           String path)

Lookup a directory specifically.

Parameters:

version - The version to look under.

path - The path to lookup.

Returns:

A lookup object.

makePrimary

public void makePrimary(String path)

Make a directory into a primary indirection.

Parameters:

path - The full path.

retargetLayeredDirectory

public void retargetLayeredDirectory(String path,
                            String target)

Change what a layered directory points at.

Parameters:

path - The full path to the layered directory.

target - The new target path.

getHistory

public List<AVMNodeDescriptor> getHistory(AVMNodeDescriptor desc,
                                 int count)

Get the history chain for a node.

Parameters:

desc - The node to get history of.

count - The maximum number of ancestors to traverse. Negative means all.

Returns:

A List of ancestors.

setOpacity

public void setOpacity(String path,
              boolean opacity)

Set the opacity of a layered directory. An opaque directory hides the things it points to via indirection.

Parameters:

path - The path to the layered directory.

opacity - True is opaque; false is not.

setNodeProperty

public void setNodeProperty(String path,
                   org.alfresco.service.namespace.QName name,
                   PropertyValue value)

Set a property on a node.

Parameters:

path - The path to the node.

name - The name of the property.

value - The value of the property.

setNodeProperties

public void setNodeProperties(String path,
                     Map<org.alfresco.service.namespace.QName,PropertyValue> properties)

Set a collection of properties at once.

Parameters:

path - The path to the node.

properties - The Map of QNames to PropertyValues.

getNodeProperty

public PropertyValue getNodeProperty(int version,
                            String path,
                            org.alfresco.service.namespace.QName name)

Get a property by name for a node.

Parameters:

version - The version to look under.

path - The path to the node.

name - The name of the property.

Returns:

The PropertyValue or null if it does not exist.

getNodeProperties

public Map<org.alfresco.service.namespace.QName,PropertyValue> getNodeProperties(int version,
                                                                        String path)

Get a Map of all the properties of a node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

A Map of QNames to PropertyValues.

deleteNodeProperty

public void deleteNodeProperty(String path,
                      org.alfresco.service.namespace.QName name)

Delete a single property from a node.

Parameters:

path - The path to the node.

name - The name of the property.

deleteNodeProperties

public void deleteNodeProperties(String path)

Delete all properties on a node.

Parameters:

path - The path to the node.

setStoreProperty

public void setStoreProperty(String store,
                    org.alfresco.service.namespace.QName name,
                    PropertyValue value)

Set a property on a store. Overwrites if property exists.

Parameters:

store - The AVMStore.

name - The QName.

value - The PropertyValue to set.

setStoreProperties

public void setStoreProperties(String store,
                      Map<org.alfresco.service.namespace.QName,PropertyValue> props)

Set a group of properties on a store. Overwrites any properties that exist.

Parameters:

store - The AVMStore.

props - The properties to set.

getStoreProperty

public PropertyValue getStoreProperty(String store,
                             org.alfresco.service.namespace.QName name)

Get a property from a store.

Parameters:

store - The name of the store.

name - The property

Returns:

The property value or null if non-existent.

queryStorePropertyKey

public Map<org.alfresco.service.namespace.QName,PropertyValue> queryStorePropertyKey(String store,
                                                                            org.alfresco.service.namespace.QName keyPattern)

Queries a given store for properties with keys that match a given pattern.

Parameters:

store - The name of the store.

keyPattern - The sql 'like' pattern, inserted into a QName.

Returns:

A Map of the matching key value pairs.

queryStoresPropertyKeys

public Map<String,Map<org.alfresco.service.namespace.QName,PropertyValue>> queryStoresPropertyKeys(org.alfresco.service.namespace.QName keyPattern)

Queries all AVM stores for properties with keys that match a given pattern.

Parameters:

keyPattern - The sql 'like' pattern, inserted into a QName.

Returns:

A List of Pairs of Store name, Map.Entry.

getStoreProperties

public Map<org.alfresco.service.namespace.QName,PropertyValue> getStoreProperties(String store)

Get all the properties for a store.

Parameters:

store - The name of the Store.

Returns:

A Map of all the properties.

deleteStoreProperty

public void deleteStoreProperty(String store,
                       org.alfresco.service.namespace.QName name)

Delete a property from a store.

Parameters:

store - The name of the store.

name - The name of the property.

getCommonAncestor

public AVMNodeDescriptor getCommonAncestor(AVMNodeDescriptor left,
                                  AVMNodeDescriptor right)

Get the common ancestor of two nodes if one exists. Unfortunately this is a quadratic problem, taking time proportional to the product of the lengths of the left and right history chains.

Parameters:

left - The first node.

right - The second node.

Returns:

The common ancestor. There are four possible results. Null means that there is no common ancestor. Left returned means that left is strictly an ancestor of right. Right returned means that right is strictly an ancestor of left. Any other non null return is the common ancestor and indicates that left and right are in conflict.

getContentDataForRead

public org.alfresco.service.cmr.repository.ContentData getContentDataForRead(int version,
                                                                    String path)

Get the ContentData for a file.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

The ContentData for the file.

getContentDataForWrite

public org.alfresco.service.cmr.repository.ContentData getContentDataForWrite(String path)

Get the ContentData for a file for writing.

Parameters:

path - The path to the file.

Returns:

The ContentData object.

setContentData

public void setContentData(String path,
                  org.alfresco.service.cmr.repository.ContentData data)

Set the ContentData on a file.

Parameters:

path - The path to the file.

data - The content data to set.

GetInstance

public static AVMRepository GetInstance()

Get the single instance of AVMRepository.

Returns:

The single instance.

setMetaDataFrom

public void setMetaDataFrom(String path,
                   AVMNodeDescriptor from)

addAspect

public void addAspect(String path,
             org.alfresco.service.namespace.QName aspectName)

Add an aspect to an AVM Node.

Parameters:

path - The path to the node.

aspectName - The name of the aspect.

getAspects

public Set<org.alfresco.service.namespace.QName> getAspects(int version,
                                                   String path)

Get all the aspects on an AVM node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

A List of the QNames of the Aspects.

removeAspect

public void removeAspect(String path,
                org.alfresco.service.namespace.QName aspectName)

Remove an aspect and all associated properties from a node.

Parameters:

path - The path to the node.

aspectName - The name of the aspect.

hasAspect

public boolean hasAspect(int version,
                String path,
                org.alfresco.service.namespace.QName aspectName)

Does a node have a particular aspect.

Parameters:

version - The version to look under.

path - The path to the node.

aspectName - The name of the aspect.

Returns:

Whether the node has the aspect.

setACL

public void setACL(String path,
          Acl acl)

Set the ACL on a node.

Parameters:

path - The path to the node.

acl - The ACL to set.

getACL

public Acl getACL(int version,
         String path)

Get the ACL on a node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

The ACL.

link

public void link(String parentPath,
        String name,
        AVMNodeDescriptor toLink)

Link a node into a directory, directly.

Parameters:

parentPath - The path to the parent.

name - The name to give the node.

toLink - The node to link.

updateLink

public void updateLink(String parentPath,
              String name,
              AVMNodeDescriptor toLink)

Update a link, directly.

Parameters:

parentPath - The path to the parent.

name - The name to give the node.

toLink - The node to link.

link

public void link(AVMNodeDescriptor parent,
        String name,
        AVMNodeDescriptor child)

This is the danger version of link. It must be called on a copied and unsnapshotted directory. It blithely inserts a child without checking if a child exists with a conflicting name.

Parameters:

parent - The parent directory.

name - The name to give the child.

child - The child to link in.

flatten

public void flatten(String path,
           String name)

Remove name without leaving behind a deleted node. Dangerous if used unwisely.

Parameters:

path - The path to the layered directory.

name - The name of the child.

forceCopy

public AVMNodeDescriptor forceCopy(String path)

Force a copy on write.

Parameters:

path - The path to force.

renameStore

public void renameStore(String sourceName,
               String destName)

Rename a store.

Parameters:

sourceName - The original name.

destName - The new name.

Throws:

AVMNotFoundException

AVMExistsException

revert

public void revert(String path,
          String name,
          AVMNodeDescriptor toRevertTo)

Revert a head path to a given version. This works by cloning the version to revert to, and then linking that new version into head. The reverted version will have the previous head version as ancestor.

Parameters:

path - The path to the parent directory.

name - The name of the node.

toRevertTo - The descriptor of the version to revert to.

setGuid

public void setGuid(String path,
           String guid)

Set the GUID on a node.

Parameters:

path -

guid -

setEncoding

public void setEncoding(String path,
               String encoding)

Set the encoding on a node.

Parameters:

path -

encoding -

setMimeType

public void setMimeType(String path,
               String mimeType)

Set the mime type on a node.

Parameters:

path -

encoding -

getPathsInStoreVersion

public List<String> getPathsInStoreVersion(AVMNodeDescriptor desc,
                                  String store,
                                  int version)

getNodeProperties

public Map<org.alfresco.service.namespace.QName,PropertyValue> getNodeProperties(AVMNodeDescriptor desc)

getContentDataForRead

public org.alfresco.service.cmr.repository.ContentData getContentDataForRead(AVMNodeDescriptor desc)

getAspects

public Set<org.alfresco.service.namespace.QName> getAspects(AVMNodeDescriptor desc)

can

public boolean can(AVMStore store,
          AVMNode node,
          String permission,
          boolean isDirectlyContained)

Evaluate permission on a node. I've got a bad feeling about this...

Parameters:

store -

node -

permission -

Returns:

can

public boolean can(String storeName,
          int version,
          String path,
          String permission)

setStoreAcl

public void setStoreAcl(String storeName,
               Acl acl)

Set the acl on a store.

Parameters:

storeName -

acl -

getStoreAcl

public Acl getStoreAcl(String storeName)

Get the ACL on a store.

Parameters:

storeName -

Returns:

getAVMStoreVersionsTo

public List<VersionDescriptor> getAVMStoreVersionsTo(String name,
                                            int version)

Parameters:

name -

version -

Returns:

getAVMStoreVersionsFrom

public List<VersionDescriptor> getAVMStoreVersionsFrom(String name,
                                              int version)

Parameters:

name -

version -

Returns:

getAVMStoreVersionsBetween

public List<VersionDescriptor> getAVMStoreVersionsBetween(String name,
                                                 int startVersion,
                                                 int endVersion)

Parameters:

name -

startVersion -

endVersion -

Returns: