Merge DM-DM_deployment to HEAD

18665 : Switch over to using new surf <formdata multipart-processing="false" /> configuration option.
   - now the PostContentCommandProcessor and PostSnapshotCommandProcessor handle their own MimePart processing.
  18683 : SAIL-288 Implementation of TransferService client side cancelAsync.
  18716 : Adding TransferEventBegin missed from asyncCancel work.
  18734 : Transfer format : implementation of null properties and Serialized base64 Java objects for type d:any
  18749 : SAIL-290: Added features that provide asynchronous commit on the receiver end and the ability to query commit status, as well as code that writes a progress report on the server side (currently only plain text) and the functionality to allow a transfer to be cancelled
  18750 : New files that should have been checked in with previous commit but weren't...
  18770 : Various transfer service work.
   - correction to transfer report name.
   - use surf Base64 Encoder
   - implementation of async commit to the TransferServiceImpl
   - implementation of the statusCommand through the HttpClientTransmitter.
  18773 : transferId was null.
  18780 : Changed the server-side commit to occur asynchronously.
	Added two test actions to transfer a single node or a tree of nodes.
	Tweaked TransferDefinition to provide varargs version of setNodes.
  18793 : SAIL-290:    Added a couple of test actions.
    	Added varargs versions of transfer and transferAsync on TransferService.
  18794 : SAIL-290: Added "targetExists" operation to the TransferService interface.
  18804 : SAIL-36: Fixed an issue where transfer could fail if numerous nodes with the same cm:name value are transferred.
  18805 : SAIL-36: Added model file that should have been with last commit.
  18808 Continuing work on transfer report.
  18825 TransferServiceImplTest green line.
  18836 : Added a little more output to the server-side transfer report. 
  18848 : More work on transfer report.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18865 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/transfer/NodeCrawler.java

@@ -0,0 +1,18 @@
+package org.alfresco.service.cmr.transfer;
+
+import java.util.Set;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+
+public interface NodeCrawler
+{
+
+    public abstract Set<NodeRef> crawl(NodeRef... nodes);
+
+    public abstract Set<NodeRef> crawl(Set<NodeRef> startingNodes);
+
+    public abstract void setNodeFinders(NodeFinder... finders);
+
+    public abstract void setNodeFilters(NodeFilter... filters);
+
+}

source/java/org/alfresco/service/cmr/transfer/TransferDefinition.java

@@ -25,6 +25,9 @@
 package org.alfresco.service.cmr.transfer;
 
 import java.io.Serializable;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
 import java.util.Set;
 
 import org.alfresco.service.cmr.repository.NodeRef;
@@ -49,9 +52,14 @@ public class TransferDefinition implements Serializable
      * Set which nodes to transfer
      * @param nodes
      */
-    public void setNodes(Set<NodeRef> nodes)
+    public void setNodes(Collection<NodeRef> nodes)
     {
-        this.nodes = nodes;
+        this.nodes = new HashSet<NodeRef>(nodes);
+    }
+    
+    public void setNodes(NodeRef...nodes)
+    {
+        this.setNodes(new HashSet<NodeRef>(Arrays.asList(nodes)));
     }
 
     /**

source/java/org/alfresco/service/cmr/transfer/TransferEventBegin.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.service.cmr.transfer;
+
+import org.alfresco.repo.transfer.TransferEventImpl;
+
+/**
+ * TransferEventBegin is produced when a transfer has started.
+ */
+public class TransferEventBegin extends TransferEventImpl  
+{
+    private String transferId;
+    
+    public String toString()
+    {   
+        return "TransferEventBegin: " + transferId;
+    }
+
+    public void setTransferId(String transferId)
+    {
+        this.transferId = transferId;
+    }
+
+    public String getTransferId()
+    {
+        return transferId;
+    }
+}

source/java/org/alfresco/service/cmr/transfer/TransferProgress.java

@@ -0,0 +1,139 @@
+/*
+ * Copyright (C) 2009-2010 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have received a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+
+package org.alfresco.service.cmr.transfer;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * @author brian
+ * 
+ */
+public class TransferProgress
+{
+    public enum Status
+    {
+        PRE_COMMIT, COMMIT_REQUESTED, COMMITTING, COMPLETE, ERROR, CANCELLED
+    };
+
+    private static Set<Status> terminalStatuses = Collections.unmodifiableSet(new HashSet<Status>(Arrays.asList(
+            Status.COMPLETE, Status.ERROR, Status.CANCELLED)));
+    
+    private Status status;
+    private int currentPosition;
+    private int endPosition;
+    private Throwable error;
+
+    /**
+     * 
+     * @return The statuses that mark the end of the transfer. Once a transfer reaches one of these statuses
+     * it can never move into a different status.
+     */
+    public static Set<Status> getTerminalStatuses()
+    {
+        return terminalStatuses;
+    }
+    
+    /**
+     * 
+     * @return true if the current status is one of the terminal statuses.
+     */
+    public boolean isFinished()
+    {
+        return terminalStatuses.contains(status);
+    }
+    
+    /**
+     * @return the status
+     */
+    public Status getStatus()
+    {
+        return status;
+    }
+
+    /**
+     * @param status
+     *            the status to set
+     */
+    public void setStatus(Status status)
+    {
+        this.status = status;
+    }
+
+    /**
+     * @return the currentPosition
+     */
+    public int getCurrentPosition()
+    {
+        return currentPosition;
+    }
+
+    /**
+     * @param currentPosition
+     *            the currentPosition to set
+     */
+    public void setCurrentPosition(int currentPosition)
+    {
+        this.currentPosition = currentPosition;
+    }
+
+    /**
+     * @return the endPosition
+     */
+    public int getEndPosition()
+    {
+        return endPosition;
+    }
+
+    /**
+     * @param endPosition
+     *            the endPosition to set
+     */
+    public void setEndPosition(int endPosition)
+    {
+        this.endPosition = endPosition;
+    }
+
+    /**
+     * @return the error
+     */
+    public Throwable getError()
+    {
+        return error;
+    }
+
+    /**
+     * @param error
+     *            the error to set
+     */
+    public void setError(Throwable error)
+    {
+        this.error = error;
+    }
+
+}

source/java/org/alfresco/service/cmr/transfer/TransferReceiver.java

@@ -28,6 +28,7 @@ package org.alfresco.service.cmr.transfer;
 import java.io.File;
 import java.io.InputStream;
 
+import org.alfresco.repo.transfer.TransferProgressMonitor;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
@@ -96,12 +97,23 @@ public interface TransferReceiver
      * @param transferId
      * @throws TransferException
      */
-    void abort(String transferId) throws TransferException;
+    void cancel(String transferId) throws TransferException;
     
+    /**
+     * Commit asynchronously
+     * @param transferId
+     * @throws TransferException
+     */
+    void commitAsync(String transferId) throws TransferException;
+
     /**
      * Commit
      * @param transferId
      * @throws TransferException
      */
     void commit(String transferId) throws TransferException;
+    
+    TransferProgress getStatus(String transferId) throws TransferException;
+    
+    TransferProgressMonitor getProgressMonitor();
 }

source/java/org/alfresco/service/cmr/transfer/TransferService.java

@@ -25,6 +25,7 @@
 
 package org.alfresco.service.cmr.transfer;
 
+import java.util.Collection;
 import java.util.Set;
 
 import org.alfresco.service.cmr.repository.NodeRef;
@@ -63,24 +64,55 @@ public interface TransferService
      * @throws TransferException
      * @return the node reference of the transfer report
      */       
-   public NodeRef transfer(String targetName, TransferDefinition definition, Set<TransferCallback> callback) throws TransferException;
+   public NodeRef transfer(String targetName, TransferDefinition definition, Collection<TransferCallback> callback) throws TransferException;
    
    /**
-    * Transfer nodes async with callback.   The asynchronous version of the transfer method starts a transfer and returns as 
-    * soon as possible.
-    * The transfer callbacks will be called by a different thread to that used to call the transferAsync method so transaction 
-    * context will be different to the calling context. 
-    * 
-    * Please also be aware that the asychronous transfer does not have access to uncommitted 
-    * data in the calling transaction.
-    * 
+    * Transfer nodes sync, with callback.  This synchronous version of the transfer method waits for the transfer to complete 
+    * before returning to the caller.  Callbacks are called in the current thread context, so will be associated with the current 
+    * transaction and user.
+    *  
     * @param targetName the name of the target to transfer to
-    * @param definition - the definition of the transfer. Specifies which nodes to transfer.  
+    * @param definition - the definition of the transfer.   Specifies which nodes to transfer. 
     * The following properties must be set, nodes
-    * @param callback - a set of callback handlers that will be called as transfer proceeds.  May be null.
+    * @param callbacks - a list of callback handlers that will be called as transfer proceeds.  May be null.
     * @throws TransferException
+    * @return the node reference of the transfer report
     */       
-   public void transferAsync(String targetName, TransferDefinition definition, Set<TransferCallback> callback) throws TransferException;
+  public NodeRef transfer(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferException;
+  
+  /**
+   * Transfer nodes async with callback.   The asynchronous version of the transfer method starts a transfer and returns as 
+   * soon as possible.
+   * 
+   * The transfer callbacks will be called by a different thread to that used to call the transferAsync method so transaction 
+   * context will be different to the calling context. The asychronous transfer does not have access to uncommitted 
+   * data in the calling transaction.
+   * 
+   * @param targetName the name of the target to transfer to
+   * @param definition - the definition of the transfer. Specifies which nodes to transfer.  
+   * The following properties must be set, nodes
+   * @param callback - a collection of callback handlers that will be called as transfer proceeds.  May be null.
+   * 
+   * @throws TransferException
+   */       
+  public void transferAsync(String targetName, TransferDefinition definition, Collection<TransferCallback> callback) throws TransferException;
+
+  /**
+   * Transfer nodes async with callback.   The asynchronous version of the transfer method starts a transfer and returns as 
+   * soon as possible.
+   * 
+   * The transfer callbacks will be called by a different thread to that used to call the transferAsync method so transaction 
+   * context will be different to the calling context. The asychronous transfer does not have access to uncommitted 
+   * data in the calling transaction.
+   * 
+   * @param targetName the name of the target to transfer to
+   * @param definition - the definition of the transfer. Specifies which nodes to transfer.  
+   * The following properties must be set, nodes
+   * @param callbacks - a collection of callback handlers that will be called as transfer proceeds.  May be null.
+   * 
+   * @throws TransferException
+   */       
+  public void transferAsync(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferException;
 
     /**
       * Verify a target is available and that the configured credentials correctly identify an admin user.     
@@ -119,6 +151,13 @@ public interface TransferService
      */
     public TransferTarget getTransferTarget(String name) throws TransferException;
     
+    /**
+     * Test to see if the target with the specified name exists
+     * @param name
+     * @return true if the specified target exists, and false otherwise
+     */
+    public boolean targetExists(String name);
+    
     /**
      * Delete a transfer target.  After calling this method the transfer target will no longer exist.
      * @throws TransferException - target does not exist
@@ -153,4 +192,23 @@ public interface TransferService
      */
     public void enableTransferTarget(String name, boolean enable) throws TransferException;
     
+    /**
+     * Asynchronously cancel an in-progress transfer
+     * 
+     * This method tells an in-process transfer to give up, rollback and stop as soon as possible.
+     * 
+     * Depending upon the state of the in-progress transfer, the transfer may still complete, 
+     * despite calling this method, however in most cases the transfer will not complete.    
+     * 
+     * Calling this method for a transfer that does not exist, possibly because it has already finished, has no 
+     * effect and will not throw an exception.
+     * 
+     * The transfer handle is returned by a TransferEventBegin event callback.
+     * 
+     * @param transferId the unique identifier for the instance of the transfer to cancel.
+     * 
+     * @see TransferEventBegin;
+     */
+    public void cancelAsync(String transferId);
+    
 }