org.alfresco.repo.avm

Interface AVMStore

All Known Implementing Classes:

AVMStoreImpl

public interface AVMStore

The store interface. Methods for filesystem like, versioning, and layering operations.

Author:

britt

Method Summary

Methods

Modifier and Type	Method and Description
void	addAspect(String path, org.alfresco.service.namespace.QName aspectName) Add an aspect to a node.
org.alfresco.service.cmr.repository.ContentWriter	createContentWriter(String path, boolean update) Get a ContentWriter to a file.
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 new 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 contents.
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 tag, String Description, Map<String,Integer> snapShotMap) Snapshots this store.
void	deleteNodeProperties(String path) Delete all properties from a node.
void	deleteNodeProperty(String path, org.alfresco.service.namespace.QName name) Delete a single property from a node.
void	deleteProperty(org.alfresco.service.namespace.QName name) Delete a property.
Acl	getACL(int version, String path) Get the ACL on a node.
Set<org.alfresco.service.namespace.QName>	getAspects(int version, String path) Get all aspects on a given node.
AVMRepository	getAVMRepository() Get the AVMRepository.
org.alfresco.service.cmr.repository.ContentData	getContentDataForRead(int version, String path) Get the ContentData on a file.
org.alfresco.service.cmr.repository.ContentData	getContentDataForWrite(String path) Get the ContentData for writing.
org.alfresco.service.cmr.repository.ContentReader	getContentReader(int version, String path) Get a ContentReader from a file.
List<String>	getDeleted(int version, String path) Get the names of the deleted nodes in a directory.
AVMStoreDescriptor	getDescriptor() Get the descriptor for this.
long	getId() Get the primary key.
String	getIndirectionPath(int version, String path) For a layered node, get its indirection.
InputStream	getInputStream(int version, String path) Get an InputStream from a file.
int	getLastVersionID() This gets the last extant version id.
SortedMap<String,AVMNodeDescriptor>	getListing(int version, String path, boolean includeDeleted) Get a listing of the designated directory.
SortedMap<String,AVMNodeDescriptor>	getListingDirect(int version, String path, boolean includeDeleted) Get the list of nodes directly contained in a directory.
String	getName() Get the name of this store.
int	getNextVersionID() This returns the next version in this store that will be snapshotted.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getNodeProperties(int version, String path) Get all the properties associated with a node.
PropertyValue	getNodeProperty(int version, String path, org.alfresco.service.namespace.QName name) Get a property by name.
OutputStream	getOutputStream(String path) Get an output stream to a file.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getProperties() Get all the properties associated with this node.
PropertyValue	getProperty(org.alfresco.service.namespace.QName name) Get a property by name.
DirectoryNode	getRoot() Get the root directory of this AVMStore.
AVMNodeDescriptor	getRoot(int version) Get the specified root as a descriptor.
Acl	getStoreAcl() Get the Acl associated with this store.
List<VersionDescriptor>	getVersions() Get all the version for this AVMStore.
List<VersionDescriptor>	getVersions(Date from, Date to) Get the versions from between the given dates.
List<VersionDescriptor>	getVersionsBetween(int startVersion, int endVersion) Get all versions from an including startVersion up to but NOT including endVersion
List<VersionDescriptor>	getVersionsFrom(int version) Get all the versions starting from the last until the version specified
List<VersionDescriptor>	getVersionsTo(int version) Get all the versions after and including the one specified
boolean	hasAspect(int version, String path, org.alfresco.service.namespace.QName aspectName) Does a given node have a given aspect.
void	link(String parentPath, String name, AVMNodeDescriptor toLink) Link a node into a directory, directly.
org.alfresco.repo.avm.Lookup	lookup(int version, String path, boolean write, boolean includeDeleted) Lookup a node.
org.alfresco.repo.avm.Lookup	lookupDirectory(int version, String path, boolean write) Lookup a directory.
void	makePrimary(String path) Make the indicated directory a primary indirection.
void	purgeVersion(int version) Purge all the nodes reachable only by the given version.
void	removeAspect(String path, org.alfresco.service.namespace.QName aspectName) Remove an aspect and all its properties from a node.
void	removeNode(String path, String name) Remove a node and all of its contents.
void	retargetLayeredDirectory(String path, String target) Change the target of a layered directory.
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	setContentData(String path, org.alfresco.service.cmr.repository.ContentData data) Set the ContentData for a file.
void	setEncoding(String path, String encoding) Set the encoding of a file.
void	setGuid(String path, String guid) Set the GUID on a node.
void	setMetaDataFrom(String path, AVMNode from) Set meta data, aspects, properties, acls, from another node.
void	setMimeType(String path, String mimeType) Set the mime type of a file.
void	setName(String name) Set the name of the store.
void	setNewRoot(DirectoryNode root) Set a new root for this store.
void	setNodeProperties(String path, Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Set a collection of properties on a node.
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	setProperties(Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Set a group of properties on this store.
void	setProperty(org.alfresco.service.namespace.QName name, PropertyValue value) Set a property on this store.
void	setStoreAcl(Acl acl) Set the acl on this store.
void	uncover(String dirPath, String name) Uncover a whited out node.
void	updateLink(String parentPath, String name, AVMNodeDescriptor toLink) Update a link to a node in a directory, directly.

Method Detail

getId

long getId()

Get the primary key.

getNextVersionID

int getNextVersionID()

This returns the next version in this store that will be snapshotted.

Returns:

The next version to be snapshotted.

getLastVersionID

int getLastVersionID()

This gets the last extant version id.

setNewRoot

void setNewRoot(DirectoryNode root)

Set a new root for this store.

Parameters:

root - The root to set.

getStoreAcl

Acl getStoreAcl()

Get the Acl associated with this store.

Returns:

setStoreAcl

void setStoreAcl(Acl acl)

Set the acl on this store.

Parameters:

acl -

createSnapshot

Map<String,Integer> createSnapshot(String tag,
                                 String Description,
                                 Map<String,Integer> snapShotMap)

Snapshots this store. This sets all nodes in the the store to the should be copied state, and creates a new version root.

Parameters:

tag - The short description.

description - The long description.

snapShotMap - Keeps track of snapshot ids for all stores that end up snapshotted, possibly recursively.

Returns:

The map of all implicitely and explicitely snapshotted stores.

createDirectory

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 parent directory.

name - The name to give the new directory.

createLayeredDirectory

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

Create a new layered directory.

Parameters:

srcPath - The path that the new layered directory will point at.

dstPath - The path to the directory to create the new layered directory in.

name - The name of the new layered directory.

createFile

OutputStream createFile(String path,
                      String name)

Create a new file. The designated file cannot already exist.

Parameters:

path - The path to the directory to contain the new file.

name - The name to give the new file.

Returns:

An OutputStream.

createFile

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 contents.

Parameters:

path - The path to the containing directory.

name - The name to give the file.

data - The contents of the file.

createLayeredFile

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

Create a new layered file.

Parameters:

srcPath - The target path for the new file.

dstPath - The path to the directory to make the new file in.

name - The name of the new file.

getInputStream

InputStream getInputStream(int version,
                         String path)

Get an InputStream from a file.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

An InputStream

getContentReader

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

Get a ContentReader from a file.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

A ContentReader

getListing

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

Get a listing of the designated directory.

Parameters:

version - The version to look under.

path - The path to the directory.

includeDeleted - Whether to see Deleted nodes.

Returns:

A listing.

getListingDirect

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.

includeDeleted - Whether to see Deleted nodes.

Returns:

A Map of names to descriptors.

getDeleted

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

Get the names of the deleted nodes in a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

Returns:

A List of names.

getOutputStream

OutputStream getOutputStream(String path)

Get an output stream to a file.

Parameters:

path - The path to the file.

Returns:

An OutputStream

createContentWriter

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

Get a ContentWriter to a file.

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.

removeNode

void removeNode(String path,
              String name)

Remove a node and all of its contents.

Parameters:

path - The path to the node's parent directory.

name - The name of the node to remove.

uncover

void uncover(String dirPath,
           String name)

Uncover a whited out node.

Parameters:

dirPath - The path to the directory.

name - The name to uncover.

getVersions

List<VersionDescriptor> getVersions()

Get all the version for this AVMStore.

Returns:

A Set of all versions.

getVersionsFrom

List<VersionDescriptor> getVersionsFrom(int version)

Get all the versions starting from the last until the version specified

Parameters:

version - - the version which which to end

Returns:

- the versions in descending order

getVersionsTo

List<VersionDescriptor> getVersionsTo(int version)

Get all the versions after and including the one specified

Parameters:

version - - the version to start from

Returns:

- the versions in ascending order

getVersionsBetween

List<VersionDescriptor> getVersionsBetween(int startVersion,
                                         int endVersion)

Get all versions from an including startVersion up to but NOT including endVersion

Parameters:

startVersion -

endVersion -

Returns:

- the versions in ascending order

getVersions

List<VersionDescriptor> getVersions(Date from,
                                  Date to)

Get the versions from between the given dates. From or to may be null but not both.

Parameters:

from - The earliest date.

to - The latest date.

Returns:

The Set of matching version IDs.

getAVMRepository

AVMRepository getAVMRepository()

Get the AVMRepository.

Returns:

The AVMRepository.

lookup

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

Lookup a node.

Parameters:

version - The version to look under.

path - The path to the node.

write - Whether this is in a write context.

includeDeleted - Whether to see Deleted nodes.

Returns:

A Lookup object.

lookupDirectory

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

Lookup a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

write - Whether this is in a write context.

Returns:

A Lookup object.

getIndirectionPath

String getIndirectionPath(int version,
                        String path)

For a layered node, get its indirection.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

The indirection.

makePrimary

void makePrimary(String path)

Make the indicated directory a primary indirection.

Parameters:

path - The AVMRepository relative path.

retargetLayeredDirectory

void retargetLayeredDirectory(String path,
                            String target)

Change the target of a layered directory.

Parameters:

path - The path to the layered directory.

target - The new target path.

getRoot

DirectoryNode getRoot()

Get the root directory of this AVMStore.

Returns:

The root directory.

getRoot

AVMNodeDescriptor getRoot(int version)

Get the specified root as a descriptor.

Parameters:

version - The version to get (-1 for head).

Returns:

The specified root or null.

getName

String getName()

Get the name of this store.

Returns:

The name.

setName

void setName(String name)

Set the name of the store.

Parameters:

name - To Set.

purgeVersion

void purgeVersion(int version)

Purge all the nodes reachable only by the given version.

Parameters:

version -

getDescriptor

AVMStoreDescriptor getDescriptor()

Get the descriptor for this.

Returns:

The descriptor.

setOpacity

void setOpacity(String path,
              boolean opacity)

Set the opacity of a layered directory. An opaque directory hides what is pointed at by its indirection.

Parameters:

path - The path to the layered directory.

opacity - True is opaque; false is not.

setNodeProperty

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 to set.

setNodeProperties

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

Set a collection of properties on a node.

Parameters:

path - The path to the node.

properties - The Map of QNames to PropertyValues.

getNodeProperty

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

Get a property by name.

Parameters:

version - The version to look under.

path - The path to the node.

name - The name of the property.

Returns:

A PropertyValue or null if not found.

deleteNodeProperty

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

void deleteNodeProperties(String path)

Delete all properties from a node.

Parameters:

path - The path to the node.

getNodeProperties

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

Get all the properties associated with a node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

A Map of QNames to PropertyValues.

setProperty

void setProperty(org.alfresco.service.namespace.QName name,
               PropertyValue value)

Set a property on this store. Replaces if property already exists.

Parameters:

name - The QName of the property.

value - The actual PropertyValue.

setProperties

void setProperties(Map<org.alfresco.service.namespace.QName,PropertyValue> properties)

Set a group of properties on this store. Replaces any property that exists.

Parameters:

properties - A Map of QNames to PropertyValues to set.

getProperty

PropertyValue getProperty(org.alfresco.service.namespace.QName name)

Get a property by name.

Parameters:

name - The QName of the property to fetch.

Returns:

The PropertyValue or null if non-existent.

getProperties

Map<org.alfresco.service.namespace.QName,PropertyValue> getProperties()

Get all the properties associated with this node.

Returns:

A Map of the properties.

deleteProperty

void deleteProperty(org.alfresco.service.namespace.QName name)

Delete a property.

Parameters:

name - The name of the property to delete.

getContentDataForRead

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

Get the ContentData on a file.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

The ContentData corresponding to the file.

getContentDataForWrite

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

Get the ContentData for writing.

Parameters:

path - The path to the file.

Returns:

The ContentData object.

setContentData

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

Set the ContentData for a file.

Parameters:

path - The path to the file.

data - The ContentData to set.

setMetaDataFrom

void setMetaDataFrom(String path,
                   AVMNode from)

Set meta data, aspects, properties, acls, from another node.

Parameters:

path - The path to the node to set metadata on.

from - The node to get the metadata from.

addAspect

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

Add an aspect to a node.

Parameters:

path - The path to the node.

aspectName - The name of the aspect.

getAspects

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

Get all aspects on a given node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

A List of the QNames of the aspects.

removeAspect

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

Remove an aspect and all its properties from a node.

Parameters:

path - The path to the node.

aspectName - The name of the aspect.

hasAspect

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

Does a given node have a given 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

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

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

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

Link a node into a directory, directly.

Parameters:

parentPath - The path to the directory.

name - The name to give the node.

toLink - The node to link.

updateLink

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

Update a link to a node in a directory, directly.

Parameters:

parentPath - The path to the directory.

name - The name to give the node.

toLink - The node to link.

revert

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 to revert.

toRevertTo - The descriptor of the version to revert to.

setGuid

void setGuid(String path,
           String guid)

Set the GUID on a node.

Parameters:

path -

guid -

setEncoding

void setEncoding(String path,
               String encoding)

Set the encoding of a file.

Parameters:

path -

encoding -

setMimeType

void setMimeType(String path,
               String mimeType)

Set the mime type of a file.

Parameters:

path -

mimeType -