org.alfresco.service.cmr.remote

Interface AVMRemoteTransport

All Known Implementing Classes:

AVMRemoteTransportService

public interface AVMRemoteTransport

This is the actual remote interface that is wrapped by RMI.

Author:

britt

Method Summary

Methods

Modifier and Type	Method and Description
void	addAspect(String ticket, String path, org.alfresco.service.namespace.QName aspectName) Add an aspect to an AVM node.
void	closeInputHandle(String ticket, String handle) Close an input stream.
void	closeOutputHandle(String ticket, String handle) Close the server side output stream designated by the handle.
void	createBranch(String ticket, int version, String srcPath, String dstPath, String name) Create a new branch.
void	createDirectory(String ticket, String path, String name) Create a directory.
String	createFile(String ticket, String path, String name) Create a file and return a handle to an output stream.
void	createLayeredDirectory(String ticket, String targetPath, String parent, String name) Create a layered directory.
void	createLayeredFile(String ticket, String targetPath, String parent, String name) Create a new layered file.
Map<String,Integer>	createSnapshot(String ticket, String store, String label, String comment) Snapshot an AVMStore.
void	createStore(String ticket, String name) Create a new AVMStore.
void	deleteNodeProperties(String ticket, String path) Delete all properties from a node.
void	deleteNodeProperty(String ticket, String path, org.alfresco.service.namespace.QName name) Delete a property from a node.
void	deleteStoreProperty(String ticket, String store, org.alfresco.service.namespace.QName name) Delete a property from a store.
org.alfresco.util.Pair<Integer,String>	getAPath(String ticket, AVMNodeDescriptor desc) Get a version and path for a node.
Set<org.alfresco.service.namespace.QName>	getAspects(String ticket, int version, String path) Get all the aspects on an AVM node.
AVMNodeDescriptor	getCommonAncestor(String ticket, AVMNodeDescriptor left, AVMNodeDescriptor right) Get the most recent common ancestor of two nodes.
List<String>	getDeleted(String ticket, int version, String path) Get the names of nodes that have been deleted in a directory.
SortedMap<String,AVMNodeDescriptor>	getDirectoryListing(String ticket, AVMNodeDescriptor dir) Get a directory listing from a node descriptor.
SortedMap<String,AVMNodeDescriptor>	getDirectoryListing(String ticket, int version, String path) Get a listing of a directory.
SortedMap<String,AVMNodeDescriptor>	getDirectoryListingDirect(String ticket, int version, String path) Get a listing of a directories direct contents.
List<AVMNodeDescriptor>	getHistory(String ticket, AVMNodeDescriptor desc, int count) Get a list of ancestors of a node.
String	getIndirectionPath(String ticket, int version, String path) Get the indirection path for a node.
String	getInputHandle(String ticket, AVMNodeDescriptor desc) Get an input handle from a descriptor.
String	getInputHandle(String ticket, int version, String path) Get an input handle.
int	getLatestSnapshotID(String ticket, String storeName) Get the id of the latest extant snpashot.
LayeringDescriptor	getLayeringInfo(String ticket, int version, String path) Get layering information about a path.
int	getNextVersionID(String ticket, String storeName) Get the latest version id of the given AVMStore.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getNodeProperties(String ticket, int version, String path) Get all properties of a node.
PropertyValue	getNodeProperty(String ticket, int version, String path, org.alfresco.service.namespace.QName name) Get the value of a node property.
String	getOutputHandle(String ticket, String path) Get an opaque handle to a server side output stream.
AVMStoreDescriptor	getStore(String ticket, String name) Get the descriptor for a given AVMStore.
Map<org.alfresco.service.namespace.QName,PropertyValue>	getStoreProperties(String ticket, String store) Get all the properties on a store.
PropertyValue	getStoreProperty(String ticket, String store, org.alfresco.service.namespace.QName name) Get a property from a store.
AVMNodeDescriptor	getStoreRoot(String ticket, int version, String name) Get the specified root of the specified store.
List<AVMStoreDescriptor>	getStores(String ticket) Get a list of all AVM stores.
List<VersionDescriptor>	getStoreVersions(String ticket, String name) Get a List of all versions in a given store.
List<VersionDescriptor>	getStoreVersions(String ticket, String name, Date from, Date to) Get AVMStore versions between given dates.
boolean	hasAspect(String ticket, int version, String path, org.alfresco.service.namespace.QName aspectName) Does a node have a particular aspect.
AVMNodeDescriptor	lookup(String ticket, AVMNodeDescriptor dir, String name) Get a descriptor for the specified node.
AVMNodeDescriptor	lookup(String ticket, AVMNodeDescriptor dir, String name, boolean includeDeleted) Lookup a node identified by the directory that contains it, and its name; optionally, the lookup can retrive the descriptor of a node even if it has been deleted from its containing directory.
AVMNodeDescriptor	lookup(String ticket, int version, String path) Get a descriptor for the specified node.
AVMNodeDescriptor	lookup(String ticket, int version, String path, boolean includeDeleted) Lookup a node identified by version ID and path; optionally, if the node is deleted, its descriptor can still be retrieved.
void	makePrimary(String ticket, String path) Turn a directory into a primary indirection node.
void	purgeStore(String ticket, String name) Purge an AVMStore.
void	purgeVersion(String ticket, int version, String name) Purge a given version from a given store.
Map<org.alfresco.service.namespace.QName,PropertyValue>	queryStorePropertyKey(String ticket, String store, org.alfresco.service.namespace.QName keyPattern) Query a store for keys that match a pattern.
Map<String,Map<org.alfresco.service.namespace.QName,PropertyValue>>	queryStoresPropertyKey(String ticket, org.alfresco.service.namespace.QName keyPattern) Query all stores for keys that match a pattern.
byte[]	readInput(String Ticket, String handle, int count) Read a chunk of data from a handle.
void	removeAspect(String ticket, String path, org.alfresco.service.namespace.QName aspectName) Remove an aspect and its properties from a node.
void	removeNode(String ticket, String parent, String name) Remove a node.
void	rename(String ticket, String srcParent, String srcName, String dstParent, String dstName) Rename a node.
void	renameStore(String ticket, String sourceName, String destName) Rename a store.
void	retargetLayeredDirectory(String ticket, String path, String target) Set a layered directory node to point at a different target.
void	revert(String ticket, String path, AVMNodeDescriptor toRevertTo) Revert a head path to a given version.
void	setEncoding(String ticket, String path, String encoding) Set the encoding.
void	setGuid(String ticket, String path, String guid) Set the GUID on a node.
void	setMimeType(String ticket, String path, String mimeType) Set the mime type.
void	setNodeProperties(String ticket, String path, Map<org.alfresco.service.namespace.QName,PropertyValue> properties) Set a group of properties on a node.
void	setNodeProperty(String ticket, String path, org.alfresco.service.namespace.QName name, PropertyValue value) Set a property on a node.
void	setOpacity(String ticket, String path, boolean opacity) Turn on or off a directory's opacity.
void	setStoreProperties(String ticket, String store, Map<org.alfresco.service.namespace.QName,PropertyValue> props) Set a group of properties on a store.
void	setStoreProperty(String ticket, String store, org.alfresco.service.namespace.QName name, PropertyValue value) Set a property on a store.
void	uncover(String ticket, String dirPath, String name) Uncover a name in a layered directory.
void	writeOutput(String ticket, String handle, byte[] buff, int count) Write count bytes from buffer buff starting at offset offset in buff

Method Detail

getInputHandle

String getInputHandle(String ticket,
                    int version,
                    String path)

Get an input handle. A handle is an opaque reference to a server side input stream.

Parameters:

version - The version to look under.

path - The path to the file.

Returns:

A handle.

getInputHandle

String getInputHandle(String ticket,
                    AVMNodeDescriptor desc)

Get an input handle from a descriptor.

Parameters:

ticket - The authentication ticket.

desc - The descriptor.

Returns:

An input handle.

readInput

byte[] readInput(String Ticket,
               String handle,
               int count)

Read a chunk of data from a handle.

Parameters:

handle - The opaque input stream handle.

count - The number of bytes to try to read.

Returns:

An array of bytes. 0 length at eof.

closeInputHandle

void closeInputHandle(String ticket,
                    String handle)

Close an input stream. Server side input streams are timer limited, ie, they will be automatically closed after a given idle time. However, be nice, and close handles when you're done.

Parameters:

handle - The opaque handle to the server side stream.

getOutputHandle

String getOutputHandle(String ticket,
                     String path)

Get an opaque handle to a server side output stream.

Parameters:

path - The path to the existing file.

Returns:

An opaque handle.

writeOutput

void writeOutput(String ticket,
               String handle,
               byte[] buff,
               int count)

Write count bytes from buffer buff starting at offset offset in buff

Parameters:

handle - The opaque handle to the server side output stream.

buff - The data buffer.

count - The number of bytes to write.

closeOutputHandle

void closeOutputHandle(String ticket,
                     String handle)

Close the server side output stream designated by the handle.

Parameters:

handle - The handle to the server side output stream.

getDirectoryListingDirect

SortedMap<String,AVMNodeDescriptor> getDirectoryListingDirect(String ticket,
                                                            int version,
                                                            String path)

Get a listing of a directories direct contents.

Parameters:

version - The version to look under.

path - The path to the directory.

Returns:

A sorted listing.

getDirectoryListing

SortedMap<String,AVMNodeDescriptor> getDirectoryListing(String ticket,
                                                      int version,
                                                      String path)

Get a listing of a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

Returns:

A sorted listing.

getDirectoryListing

SortedMap<String,AVMNodeDescriptor> getDirectoryListing(String ticket,
                                                      AVMNodeDescriptor dir)

Get a directory listing from a node descriptor.

Parameters:

dir - The directory node descriptor.

Returns:

A sorted listing.

getDeleted

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

Get the names of nodes that have been deleted in a directory.

Parameters:

version - The version to look under.

path - The path to the directory.

Returns:

A list of deleted names.

createFile

String createFile(String ticket,
                String path,
                String name)

Create a file and return a handle to an output stream.

Parameters:

path - The path to the file.

name - The name of the file to create.

Returns:

An opaque handle to a server side output stream.

createDirectory

void createDirectory(String ticket,
                   String path,
                   String name)

Create a directory.

Parameters:

path - The path to the containing directory.

name - The name for the new directory.

createLayeredFile

void createLayeredFile(String ticket,
                     String targetPath,
                     String parent,
                     String name)

Create a new layered file.

Parameters:

targetPath - The path that is targeted.

parent - The path to the parent directory.

name - The name for the new file.

createLayeredDirectory

void createLayeredDirectory(String ticket,
                          String targetPath,
                          String parent,
                          String name)

Create a layered directory.

Parameters:

targetPath - The path that is targeted.

parent - The parent directory.

name - The name of the new directory.

retargetLayeredDirectory

void retargetLayeredDirectory(String ticket,
                            String path,
                            String target)

Set a layered directory node to point at a different target.

Parameters:

path - The path to the layered directory node.

target - The new target.

createStore

void createStore(String ticket,
               String name)

Create a new AVMStore.

Parameters:

name - The name to give the new store.

createBranch

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

Create a new branch.

Parameters:

version - The version to look under for the source node.

srcPath - The path to the source node.

dstPath - The path to the destination directory.

name - The name of the new branch.

removeNode

void removeNode(String ticket,
              String parent,
              String name)

Remove a node.

Parameters:

parent - The path to the parent directory.

name - The name of the node to remove.

rename

void rename(String ticket,
          String srcParent,
          String srcName,
          String dstParent,
          String dstName)

Rename a node.

Parameters:

srcParent - The source directory path.

srcName - The source node name.

dstParent - The destination directory path.

dstName - The destination name for the node.

uncover

void uncover(String ticket,
           String dirPath,
           String name)

Uncover a name in a layered directory.

Parameters:

dirPath - The path to the directory.

name - The name to uncover.

getNextVersionID

int getNextVersionID(String ticket,
                   String storeName)

Get the latest version id of the given AVMStore.

Parameters:

storeName - The name of the AVMStore.

Returns:

The latest version id.

getLatestSnapshotID

int getLatestSnapshotID(String ticket,
                      String storeName)

Get the id of the latest extant snpashot.

Parameters:

storeName - The name of the store.

Returns:

The id.

createSnapshot

Map<String,Integer> createSnapshot(String ticket,
                                 String store,
                                 String label,
                                 String comment)

Snapshot an AVMStore.

Parameters:

store - The name of the AVMStore to snapshot.

Returns:

The map of explicitly and implicitly snapshotted stores.

getStoreVersions

List<VersionDescriptor> getStoreVersions(String ticket,
                                       String name)

Get a List of all versions in a given store.

Parameters:

name - The name of the store.

Returns:

A List of VersionDescriptors.

getStoreVersions

List<VersionDescriptor> getStoreVersions(String ticket,
                                       String name,
                                       Date from,
                                       Date to)

Get AVMStore versions between given dates.

Parameters:

name - The name of the store.

from - The date from which (inclusive).

to - The date to which (inclusive).

Returns:

A List of VersionDescriptors.

getStores

List<AVMStoreDescriptor> getStores(String ticket)

Get a list of all AVM stores.

Returns:

A List of AVMStoreDescriptors.

getStore

AVMStoreDescriptor getStore(String ticket,
                          String name)

Get the descriptor for a given AVMStore.

Parameters:

name - The name of the store.

Returns:

An AVMStoreDescriptor.

getStoreRoot

AVMNodeDescriptor getStoreRoot(String ticket,
                             int version,
                             String name)

Get the specified root of the specified store.

Parameters:

version - The version number to fetch.

name - The name of the store.

Returns:

The AVMNodeDescriptor for the root.

lookup

AVMNodeDescriptor lookup(String ticket,
                       int version,
                       String path)

Get a descriptor for the specified node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

An AVMNodeDescriptor.

lookup

AVMNodeDescriptor lookup(String ticket,
                       int version,
                       String path,
                       boolean includeDeleted)

Lookup a node identified by version ID and path; optionally, if the node is deleted, its descriptor can still be retrieved.

Parameters:

version - The version ID to look under.

path - The simple absolute path to the parent directory.

includeDeleted - Whether to allow a deleted node to be retrieved

Returns:

An AVMNodeDescriptor, or null if the version does not exist.

lookup

AVMNodeDescriptor lookup(String ticket,
                       AVMNodeDescriptor dir,
                       String name)

Get a descriptor for the specified node.

Parameters:

dir - The descriptor for the directory node.

name - The name of the node to lookup.

Returns:

An AVMNodeDescriptor.

lookup

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

Lookup a node identified by the directory that contains it, and its name; optionally, the lookup can retrive the descriptor of a node even if it has been deleted from its containing directory.

Parameters:

dir - The descriptor for the directory node.

name - The name to lookup.

includeDeleted - Whether to allow a deleted node to be retrieved via the lookup

Returns:

The descriptor for the child, null if the child doesn't exist.

Throws:

AVMNotFoundException

AVMWrongTypeException

getIndirectionPath

String getIndirectionPath(String ticket,
                        int version,
                        String path)

Get the indirection path for a node.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

The indirection path/target.

purgeStore

void purgeStore(String ticket,
              String name)

Purge an AVMStore.

Parameters:

name - The name of the store to purge.

purgeVersion

void purgeVersion(String ticket,
                int version,
                String name)

Purge a given version from a given store.

Parameters:

version - The version id.

name - The name of the store.

makePrimary

void makePrimary(String ticket,
               String path)

Turn a directory into a primary indirection node.

Parameters:

path - The path to the directory.

getHistory

List<AVMNodeDescriptor> getHistory(String ticket,
                                 AVMNodeDescriptor desc,
                                 int count)

Get a list of ancestors of a node.

Parameters:

desc - The descriptor of the node whose history is to be fetched.

count - The maximum number of ancestors that will be returned.

Returns:

A List of descriptors for ancestors starting most recent first.

setOpacity

void setOpacity(String ticket,
              String path,
              boolean opacity)

Turn on or off a directory's opacity.

Parameters:

path - The path to the directory.

opacity - Whether the directory should be opaque or not.

getCommonAncestor

AVMNodeDescriptor getCommonAncestor(String ticket,
                                  AVMNodeDescriptor left,
                                  AVMNodeDescriptor right)

Get the most recent common ancestor of two nodes.

Parameters:

left - One node.

right - The other node.

Returns:

The common ancestor.

getLayeringInfo

LayeringDescriptor getLayeringInfo(String ticket,
                                 int version,
                                 String path)

Get layering information about a path.

Parameters:

version - The version to look under.

path - The path to the node.

Returns:

A LayeringDescriptor.

setNodeProperty

void setNodeProperty(String ticket,
                   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 give the property.

setNodeProperties

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

Set a group of properties on a node.

Parameters:

path - The path to the node.

properties - A Map of QNames to PropertyValues to set.

getNodeProperty

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

Get the value of a node property.

Parameters:

version - The version to look under.

path - The path to the node.

name - The name of the property.

Returns:

A PropertyValue.

getNodeProperties

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

Get all properties of a node.

Parameters:

version - The version.

path - The path to the node.

Returns:

A Map of QNames to PropertyValues.

deleteNodeProperty

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

Delete a property from a node.

Parameters:

path - The path to the node.

name - The name of the property.

deleteNodeProperties

void deleteNodeProperties(String ticket,
                        String path)

Delete all properties from a node.

Parameters:

path - The path to the node.

setStoreProperty

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

Set a property on a store.

Parameters:

store - The name of the store.

name - The name of the property to set.

value - The value of the property to set.

setStoreProperties

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

Set a group of properties on a store.

Parameters:

store - The name of the store.

props - A Map of QNames to PropertyValues to set.

getStoreProperty

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

Get a property from a store.

Parameters:

store - The name of the store.

name - The name of the property.

Returns:

A PropertyValue.

queryStorePropertyKey

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

Query a store for keys that match a pattern.

Parameters:

store - The store name.

keyPattern - The sql 'like' pattern.

Returns:

A Map of keys to values.

queryStoresPropertyKey

Map<String,Map<org.alfresco.service.namespace.QName,PropertyValue>> queryStoresPropertyKey(String ticket,
                                                                                         org.alfresco.service.namespace.QName keyPattern)

Query all stores for keys that match a pattern.

Parameters:

keyPattern - The sql 'like' pattern.

Returns:

A Map of store names to Maps of matching keys to values.

getStoreProperties

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

Get all the properties on a store.

Parameters:

store - The name of the store.

Returns:

A Map of QNames to PropertyValues.

deleteStoreProperty

void deleteStoreProperty(String ticket,
                       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.

renameStore

void renameStore(String ticket,
               String sourceName,
               String destName)

Rename a store.

Parameters:

ticket - The authentication ticket.

sourceName - The original name.

destName - The new name.

addAspect

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

Add an aspect to an AVM node.

Parameters:

path - The path to the node.

aspectName - The QName of the aspect.

Throws:

AVMNotFoundException

AVMExistsException

getAspects

Set<org.alfresco.service.namespace.QName> getAspects(String ticket,
                                                   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.

Throws:

AVMNotFoundException

removeAspect

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

Remove an aspect and its properties from a node.

Parameters:

path - The path to the node.

aspectName - The name of the aspect.

Throws:

AVMNotFoundException

hasAspect

boolean hasAspect(String ticket,
                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 aspect name to check.

Returns:

Whether the given node has the given aspect.

Throws:

AVMNotFoundException

revert

void revert(String ticket,
          String path,
          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 node to revert.

toRevertTo - The descriptor of the version to revert to.

Throws:

AVMNotFoundException

getAPath

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

Get a version and path for a node.

Parameters:

ticket - The authentication ticket.

desc - The node descriptor for the node we want to get a path to.

Returns:

version and path.

setGuid

void setGuid(String ticket,
           String path,
           String guid)

Set the GUID on a node.

Parameters:

ticket - The authentication ticket.

path - The path to the node.

guid - The GUID to set.

setMimeType

void setMimeType(String ticket,
               String path,
               String mimeType)

Set the mime type.

Parameters:

path - The path of the file.

mimeType - The mime type.

setEncoding

void setEncoding(String ticket,
               String path,
               String encoding)

Set the encoding.

Parameters:

path - The path of the file.

encoding - The encoding.