diff --git a/config/alfresco/avm-services-context.xml b/config/alfresco/avm-services-context.xml
index c5db7dd4ea..51016b68b8 100644
--- a/config/alfresco/avm-services-context.xml
+++ b/config/alfresco/avm-services-context.xml
@@ -203,6 +203,36 @@
+
+
+
+
+ ${avm.remote.idlestream.timeout}
+
+
+
+
+
+
+
+
+
+
+
+
+
+ org.alfresco.repo.avm.AVMRemote
+
+
+ avm
+
+
+ ${avm.remote.port}
+
+
+
+
diff --git a/config/alfresco/repository.properties b/config/alfresco/repository.properties
index 78a6f896e8..6df1278fdd 100644
--- a/config/alfresco/repository.properties
+++ b/config/alfresco/repository.properties
@@ -111,4 +111,6 @@ user.name.caseSensitive=false
# AVM Specific properties.
avm.storage=build/test-results/storage
avm.initialize=true
+avm.remote.idlestream.timeout=30000
+avm.remote.port=1313
diff --git a/source/java/org/alfresco/repo/avm/AVMRemoteImpl.java b/source/java/org/alfresco/repo/avm/AVMRemoteImpl.java
new file mode 100644
index 0000000000..7de0a0243b
--- /dev/null
+++ b/source/java/org/alfresco/repo/avm/AVMRemoteImpl.java
@@ -0,0 +1,864 @@
+/*
+ * 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.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.SortedMap;
+
+import org.alfresco.repo.domain.PropertyValue;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.GUID;
+
+/**
+ * This is the server side implementation for the remote AVM interface.
+ * @author britt
+ */
+public class AVMRemoteImpl implements AVMRemote, Runnable
+{
+ /**
+ * The map of handles to open input streams.
+ */
+ private Map fInputStreams;
+
+ /**
+ * The map of handles to last accesses for input streams.
+ */
+ private Map fInputLastAccessTimes;
+
+ /**
+ * The map of handles to busy flags.
+ */
+ private Map fInputBusy;
+
+ /**
+ * The map of handles to open output streams.
+ */
+ private Map fOutputStreams;
+
+ /**
+ * The map of handles to last accesses for output streams.
+ */
+ private Map fOutputLastAccessTimes;
+
+ /**
+ * The map of handles to busy flags.
+ */
+ private Map fOutputBusy;
+
+ /**
+ * The stale handle time. This is the maximum time a handle
+ * can stay idle in milliseconds.
+ */
+ private long fIdleTimeout;
+
+ /**
+ * Reference to AVMService.
+ */
+ private AVMService fAVMService;
+
+ /**
+ * The thread for this Runnable.
+ */
+ private Thread fThread;
+
+ /**
+ * Flag for whether this Runnable is done.
+ */
+ private boolean fDone;
+
+ /**
+ * Default constructor.
+ */
+ public AVMRemoteImpl()
+ {
+ fIdleTimeout = 30000;
+ fInputStreams = new HashMap();
+ fInputLastAccessTimes = new HashMap();
+ fInputBusy = new HashMap();
+ fOutputStreams = new HashMap();
+ fOutputLastAccessTimes = new HashMap();
+ fOutputBusy = new HashMap();
+ }
+
+ // Setters for Spring.
+
+ /**
+ * Set the Idle Timeout value.
+ * @param timeout The value to set.
+ */
+ public void setIdleTimeout(long timeout)
+ {
+ fIdleTimeout = timeout;
+ }
+
+ /**
+ * Set the AVMService.
+ * @param service The service to set.
+ */
+ public void setAvmService(AVMService service)
+ {
+ fAVMService = service;
+ }
+
+ /**
+ * The init method. This fires up a thread to check
+ * for closable streams.
+ */
+ public void init()
+ {
+ fThread = new Thread(this);
+ fDone = false;
+ fThread.start();
+ }
+
+ /**
+ * The body of this Runnable.
+ */
+ public synchronized void run()
+ {
+ while (!fDone)
+ {
+ try
+ {
+ wait(fIdleTimeout);
+ }
+ catch (InterruptedException e)
+ {
+ // Do nothing.
+ }
+ long now = System.currentTimeMillis();
+ List toClose = new ArrayList();
+ for (String handle : fInputLastAccessTimes.keySet())
+ {
+ if (fInputBusy.get(handle))
+ {
+ continue;
+ }
+ if (now - fInputLastAccessTimes.get(handle) > fIdleTimeout)
+ {
+ toClose.add(handle);
+ }
+ }
+ for (String handle : toClose)
+ {
+ try
+ {
+ fInputStreams.get(handle).close();
+ }
+ catch (IOException e)
+ {
+ // Do nothing.
+ }
+ fInputStreams.remove(handle);
+ fInputLastAccessTimes.remove(handle);
+ fInputBusy.remove(handle);
+ }
+ toClose.clear();
+ for (String handle : fOutputLastAccessTimes.keySet())
+ {
+ if (fOutputBusy.get(handle))
+ {
+ continue;
+ }
+ if (now - fOutputLastAccessTimes.get(handle) > fIdleTimeout)
+ {
+ toClose.add(handle);
+ }
+ }
+ for (String handle : toClose)
+ {
+ try
+ {
+ fOutputStreams.get(handle).close();
+ }
+ catch (IOException e)
+ {
+ // Do nothing.
+ }
+ fOutputStreams.remove(handle);
+ fOutputLastAccessTimes.remove(handle);
+ fOutputBusy.remove(handle);
+ }
+ }
+ }
+
+ /**
+ * Shutdown the Runnable cleanly.
+ */
+ public void shutDown()
+ {
+ synchronized (this)
+ {
+ fDone = true;
+ notifyAll();
+ }
+ try
+ {
+ fThread.join();
+ }
+ catch (InterruptedException e)
+ {
+ // Do nothing.
+ }
+ }
+
+ /**
+ * Get an input handle. A handle is an opaque reference
+ * to a server side input stream.
+ * @param version The version to look under.
+ * @param path The path to the file.
+ * @return A handle.
+ */
+ public String getInputHandle(int version, String path)
+ {
+ InputStream in = fAVMService.getFileInputStream(version, path);
+ String handle = GUID.generate();
+ synchronized (this)
+ {
+ fInputStreams.put(handle, in);
+ fInputLastAccessTimes.put(handle, System.currentTimeMillis());
+ fInputBusy.put(handle, false);
+ }
+ return handle;
+ }
+
+ /**
+ * Read a chunk of data from a handle.
+ * @param handle The opaque input stream handle.
+ * @param count The number of bytes to try to read.
+ * @return An array of bytes. 0 length at eof.
+ */
+ public byte [] readInput(String handle, int count)
+ {
+ InputStream in = null;
+ synchronized (this)
+ {
+ in = fInputStreams.get(handle);
+ if (in == null)
+ {
+ throw new AVMException("Invalid Input Handle.");
+ }
+ fInputBusy.put(handle, true);
+ fInputLastAccessTimes.put(handle, System.currentTimeMillis());
+ }
+ byte [] buff = new byte[count];
+ int off = 0;
+ try
+ {
+ int read;
+ while ((read = in.read(buff, off, count - off)) != -1)
+ {
+ off += read;
+ }
+ if (off != count)
+ {
+ byte [] newBuff = new byte[off];
+ for (int i = 0; i < off; i++)
+ {
+ newBuff[i] = buff[i];
+ }
+ return newBuff;
+ }
+ return buff;
+ }
+ catch (IOException e)
+ {
+ throw new AVMException("I/O Error.");
+ }
+ finally
+ {
+ synchronized (this)
+ {
+ fInputBusy.put(handle, false);
+ }
+ }
+ }
+
+ /**
+ * 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.
+ * @param handle The opaque handle to the server side stream.
+ */
+ public synchronized void closeInputHandle(String handle)
+ {
+ InputStream in = fInputStreams.get(handle);
+ if (in != null)
+ {
+ try
+ {
+ in.close();
+ }
+ catch (IOException e)
+ {
+ // Do nothing.
+ }
+ fInputStreams.remove(handle);
+ fInputLastAccessTimes.remove(handle);
+ fInputBusy.remove(handle);
+ }
+ }
+
+ /**
+ * Get an opaque handle to a server side output stream.
+ * @param path The path to the existing file.
+ * @return An opaque handle.
+ */
+ public String getOutputHandle(String path)
+ {
+ OutputStream out = fAVMService.getFileOutputStream(path);
+ String handle = GUID.generate();
+ synchronized (this)
+ {
+ fOutputStreams.put(handle, out);
+ fOutputLastAccessTimes.put(handle, System.currentTimeMillis());
+ fOutputBusy.put(handle, false);
+ }
+ return handle;
+ }
+
+ /**
+ * Write count
bytes from buffer buff
+ * starting at offset offset
in buff
+ * @param handle The opaque handle to the server side output stream.
+ * @param buff The data buffer.
+ * @param offset The offset within the buffer.
+ * @param count The number of bytes to write.
+ */
+ public void writeOutput(String handle, byte [] buff, int count)
+ {
+ OutputStream out = null;
+ synchronized (this)
+ {
+ out = fOutputStreams.get(handle);
+ if (out == null)
+ {
+ throw new AVMException("Invalid Output Handle.");
+ }
+ fOutputBusy.put(handle, true);
+ fOutputLastAccessTimes.put(handle, System.currentTimeMillis());
+ }
+ try
+ {
+ out.write(buff, 0, count);
+ }
+ catch (IOException e)
+ {
+ throw new AVMException("I/O Errror.");
+ }
+ finally
+ {
+ synchronized (this)
+ {
+ fOutputBusy.put(handle, false);
+ }
+ }
+ }
+
+ /**
+ * Close the server side output stream designated by the handle.
+ * @param handle The handle to the server side output stream.
+ */
+ public synchronized void closeOutputHandle(String handle)
+ {
+ OutputStream out = fOutputStreams.get(handle);
+ if (out != null)
+ {
+ try
+ {
+ out.close();
+ }
+ catch (IOException e)
+ {
+ // Do nothing.
+ }
+ fOutputStreams.remove(handle);
+ fOutputLastAccessTimes.remove(handle);
+ fOutputBusy.remove(handle);
+ }
+ }
+
+ /**
+ * Get a listing of a directories direct contents.
+ * @param version The version to look under.
+ * @param path The path to the directory.
+ * @return A sorted listing.
+ */
+ public SortedMap
+ getDirectoryListingDirect(int version, String path)
+ {
+ return fAVMService.getDirectoryListingDirect(version, path);
+ }
+
+ /**
+ * Get a listing of a directory.
+ * @param version The version to look under.
+ * @param path The path to the directory.
+ * @return A sorted listing.
+ */
+ public SortedMap
+ getDirectoryListing(int version, String path)
+ {
+ return fAVMService.getDirectoryListing(version, path);
+ }
+
+ /**
+ * Get a directory listing from a node descriptor.
+ * @param dir The directory node descriptor.
+ * @return A sorted listing.
+ */
+ public SortedMap
+ getDirectoryListing(AVMNodeDescriptor dir)
+ {
+ return fAVMService.getDirectoryListing(dir);
+ }
+
+ /**
+ * Get the names of nodes that have been deleted in a directory.
+ * @param version The version to look under.
+ * @param path The path to the directory.
+ * @return A list of deleted names.
+ */
+ public List getDeleted(int version, String path)
+ {
+ return fAVMService.getDeleted(version, path);
+ }
+
+ /**
+ * Create a file and return a handle to an output stream.
+ * @param path The path to the file.
+ * @param name The name of the file to create.
+ * @return An opaque handle to a server side output stream.
+ */
+ public String createFile(String path, String name)
+ {
+ OutputStream out = fAVMService.createFile(path, name);
+ String handle = GUID.generate();
+ synchronized (this)
+ {
+ fOutputStreams.put(handle, out);
+ fOutputLastAccessTimes.put(handle, System.currentTimeMillis());
+ fOutputBusy.put(handle, false);
+ }
+ return handle;
+ }
+
+ /**
+ * Create a directory.
+ * @param path The path to the containing directory.
+ * @param name The name for the new directory.
+ */
+ public void createDirectory(String path, String name)
+ {
+ fAVMService.createDirectory(path, name);
+ }
+
+ /**
+ * Create a new layered file.
+ * @param targetPath The path that is targeted.
+ * @param parent The path to the parent directory.
+ * @param name The name for the new file.
+ */
+ public void createLayeredFile(String targetPath, String parent, String name)
+ {
+ fAVMService.createLayeredFile(targetPath, parent, name);
+ }
+
+ /**
+ * Create a layered directory.
+ * @param targetPath The path that is targeted.
+ * @param parent The parent directory.
+ * @param name The name of the new directory.
+ */
+ public void createLayeredDirectory(String targetPath, String parent, String name)
+ {
+ fAVMService.createLayeredDirectory(targetPath, parent, name);
+ }
+
+ /**
+ * Set a layered directory node to point at a different target.
+ * @param path The path to the layered directory node.
+ * @param target The new target.
+ */
+ public void retargetLayeredDirectory(String path, String target)
+ {
+ fAVMService.retargetLayeredDirectory(path, target);
+ }
+
+ /**
+ * Create a new AVMStore.
+ * @param name The name to give the new store.
+ */
+ public void createAVMStore(String name)
+ {
+ fAVMService.createAVMStore(name);
+ }
+
+ /**
+ * Create a new branch.
+ * @param version The version to look under for the source node.
+ * @param srcPath The path to the source node.
+ * @param dstPath The path to the destination directory.
+ * @param name The name of the new branch.
+ */
+ public void createBranch(int version, String srcPath, String dstPath, String name)
+ {
+ fAVMService.createBranch(version, srcPath, dstPath, name);
+ }
+
+ /**
+ * Remove a node.
+ * @param parent The path to the parent directory.
+ * @param name The name of the node to remove.
+ */
+ public void removeNode(String parent, String name)
+ {
+ fAVMService.removeNode(parent, name);
+ }
+
+ /**
+ * Rename a node.
+ * @param srcParent The source directory path.
+ * @param srcName The source node name.
+ * @param dstParent The destination directory path.
+ * @param dstName The destination name for the node.
+ */
+ public void rename(String srcParent, String srcName, String dstParent, String dstName)
+ {
+ fAVMService.rename(srcParent, srcName, dstParent, dstName);
+ }
+
+ /**
+ * Uncover a name in a layered directory.
+ * @param dirPath The path to the directory.
+ * @param name The name to uncover.
+ */
+ public void uncover(String dirPath, String name)
+ {
+ fAVMService.uncover(dirPath, name);
+ }
+
+ /**
+ * Get the latest version id of the given AVMStore.
+ * @param storeName The name of the AVMStore.
+ * @return The latest version id.
+ */
+ public int getLatestVersionID(String storeName)
+ {
+ return fAVMService.getLatestVersionID(storeName);
+ }
+
+ /**
+ * Snapshot the given AVMStores.
+ * @param stores A List of the names of the stores to snapshot.
+ * @return A List of the version ids of the newly created snapshots.
+ */
+ public List createSnapshot(List stores)
+ {
+ return fAVMService.createSnapshot(stores);
+ }
+
+ /**
+ * Snapshot an AVMStore.
+ * @param store The name of the AVMStore to snapshot.
+ * @return The version id of the new snapshot.
+ */
+ public int createSnapshot(String store)
+ {
+ return fAVMService.createSnapshot(store);
+ }
+
+ /**
+ * Get a List of all versions in a given store.
+ * @param name The name of the store.
+ * @return A List of VersionDescriptors.
+ */
+ public List getAVMStoreVersions(String name)
+ {
+ return fAVMService.getAVMStoreVersions(name);
+ }
+
+ /**
+ * Get AVMStore versions between given dates.
+ * @param name The name of the store.
+ * @param from The date from which (inclusive).
+ * @param to The date to which (inclusive).
+ * @return A List of VersionDescriptors.
+ */
+ public List getAVMStoreVersions(String name, Date from, Date to)
+ {
+ return fAVMService.getAVMStoreVersions(name, from, to);
+ }
+
+ /**
+ * Get a list of all AVM stores.
+ * @return A List of AVMStoreDescriptors.
+ */
+ public List getAVMStores()
+ {
+ return fAVMService.getAVMStores();
+ }
+
+ /**
+ * Get the descriptor for a given AVMStore.
+ * @param name The name of the store.
+ * @return An AVMStoreDescriptor.
+ */
+ public AVMStoreDescriptor getAVMStore(String name)
+ {
+ return fAVMService.getAVMStore(name);
+ }
+
+ /**
+ * Get the specified root of the specified store.
+ * @param version The version number to fetch.
+ * @param name The name of the store.
+ * @return The AVMNodeDescriptor for the root.
+ */
+ public AVMNodeDescriptor getAVMStoreRoot(int version, String name)
+ {
+ return fAVMService.getAVMStoreRoot(version, name);
+ }
+
+ /**
+ * Get a descriptor for the specified node.
+ * @param version The version to look under.
+ * @param path The path to the node.
+ * @return An AVMNodeDescriptor.
+ */
+ public AVMNodeDescriptor lookup(int version, String path)
+ {
+ return fAVMService.lookup(version, path);
+ }
+
+ /**
+ * Get a descriptor for the specified node.
+ * @param dir The descriptor for the directory node.
+ * @param name The name of the node to lookup.
+ * @return An AVMNodeDescriptor.
+ */
+ public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name)
+ {
+ return fAVMService.lookup(dir, name);
+ }
+
+ /**
+ * Get the indirection path for a node.
+ * @param version The version to look under.
+ * @param path The path to the node.
+ * @return The indirection path/target.
+ */
+ public String getIndirectionPath(int version, String path)
+ {
+ return fAVMService.getIndirectionPath(version, path);
+ }
+
+ /**
+ * Purge an AVMStore.
+ * @param name The name of the store to purge.
+ */
+ public void purgeAVMStore(String name)
+ {
+ fAVMService.purgeAVMStore(name);
+ }
+
+ /**
+ * Purge a given version from a given store.
+ * @param version The version id.
+ * @param name The name of the store.
+ */
+ public void purgeVersion(int version, String name)
+ {
+ fAVMService.purgeVersion(version, name);
+ }
+
+ /**
+ * Turn a directory into a primary indirection node.
+ * @param path The path to the directory.
+ */
+ public void makePrimary(String path)
+ {
+ fAVMService.makePrimary(path);
+ }
+
+ /**
+ * Get a list of ancestors of a node.
+ * @param desc The descriptor of the node whose history is to be fetched.
+ * @param count The maximum number of ancestors that will be returned.
+ * @return A List of descriptors for ancestors starting most recent first.
+ */
+ public List getHistory(AVMNodeDescriptor desc, int count)
+ {
+ return fAVMService.getHistory(desc, count);
+ }
+
+ /**
+ * Turn on or off a directory's opacity.
+ * @param path The path to the directory.
+ * @param opacity Whether the directory should be opaque or not.
+ */
+ public void setOpacity(String path, boolean opacity)
+ {
+ fAVMService.setOpacity(path, opacity);
+ }
+
+ /**
+ * Get the most recent common ancestor of two nodes.
+ * @param left One node.
+ * @param right The other node.
+ * @return The common ancestor.
+ */
+ public AVMNodeDescriptor getCommonAncestor(AVMNodeDescriptor left, AVMNodeDescriptor right)
+ {
+ return fAVMService.getCommonAncestor(left, right);
+ }
+
+ /**
+ * Get layering information about a path.
+ * @param version The version to look under.
+ * @param path The path to the node.
+ * @return A LayeringDescriptor.
+ */
+ public LayeringDescriptor getLayeringInfo(int version, String path)
+ {
+ return fAVMService.getLayeringInfo(version, path);
+ }
+
+ /**
+ * Set a property on a node.
+ * @param path The path to the node.
+ * @param name The name of the property.
+ * @param value The value to give the property.
+ */
+ public void setNodeProperty(String path, QName name, PropertyValue value)
+ {
+ fAVMService.setNodeProperty(path, name, value);
+ }
+
+ /**
+ * Set a group of properties on a node.
+ * @param path The path to the node.
+ * @param properties A Map of QNames to PropertyValues to set.
+ */
+ public void setNodeProperties(String path, Map properties)
+ {
+ fAVMService.setNodeProperties(path, properties);
+ }
+
+ /**
+ * Get the value of a node property.
+ * @param version The version to look under.
+ * @param path The path to the node.
+ * @param name The name of the property.
+ * @return A PropertyValue.
+ */
+ public PropertyValue getNodeProperty(int version, String path, QName name)
+ {
+ return fAVMService.getNodeProperty(version, path, name);
+ }
+
+ /**
+ * Get all properties of a node.
+ * @param version The version.
+ * @param path The path to the node.
+ * @return A Map of QNames to PropertyValues.
+ */
+ public Map getNodeProperties(int version, String path)
+ {
+ return fAVMService.getNodeProperties(version, path);
+ }
+
+ /**
+ * Delete a property from a node.
+ * @param path The path to the node.
+ * @param name The name of the property.
+ */
+ public void deleteNodeProperty(String path, QName name)
+ {
+ fAVMService.deleteNodeProperty(path, name);
+ }
+
+ /**
+ * Delete all properties from a node.
+ * @param path The path to the node.
+ */
+ public void deleteNodeProperties(String path)
+ {
+ fAVMService.deleteNodeProperties(path);
+ }
+
+ /**
+ * Set a property on a store.
+ * @param store The name of the store.
+ * @param name The name of the property to set.
+ * @param value The value of the property to set.
+ */
+ public void setStoreProperty(String store, QName name, PropertyValue value)
+ {
+ fAVMService.setStoreProperty(store, name, value);
+ }
+
+ /**
+ * Set a group of properties on a store.
+ * @param store The name of the store.
+ * @param props A Map of QNames to PropertyValues to set.
+ */
+ public void setStoreProperties(String store, Map props)
+ {
+ fAVMService.setStoreProperties(store, props);
+ }
+
+ /**
+ * Get a property from a store.
+ * @param store The name of the store.
+ * @param name The name of the property.
+ * @return A PropertyValue.
+ */
+ public PropertyValue getStoreProperty(String store, QName name)
+ {
+ return fAVMService.getStoreProperty(store, name);
+ }
+
+ /**
+ * Get all the properties on a store.
+ * @param store The name of the store.
+ * @return A Map of QNames to PropertyValues.
+ */
+ public Map getStoreProperties(String store)
+ {
+ return fAVMService.getStoreProperties(store);
+ }
+
+ /**
+ * Delete a property from a store.
+ * @param store The name of the store.
+ * @param name The name of the property.
+ */
+ public void deleteStoreProperty(String store, QName name)
+ {
+ fAVMService.deleteStoreProperty(store, name);
+ }
+}