();
- String title = transferName + ", success";
+ String title = transferName;
String description = "Transfer success report : " + transferName + " targetName: " + target.getName();
String name = transferName;
@@ -290,7 +287,7 @@ public class TransferReporterImpl implements TransferReporter
File tempFile)
{
- String title = transferName + ", destination, success";
+ String title = transferName + " destination";
String description = "Transfer Destination Report, success, targetName : " + target.getName();
String name = transferName + " destination";
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEndEvent.java b/source/java/org/alfresco/service/cmr/transfer/TransferEndEvent.java
new file mode 100644
index 0000000000..1b9d3349be
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEndEvent.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.transfer;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * TransferEvents are produced by the Transfer service during an in flight
+ * transfer.
+ *
+ *
+ * The TransferCallback presents TransferEvents for processing.
+ *
+ * @see TransferCallback
+ *
+ * @author davidc
+ */
+public interface TransferEndEvent extends TransferEvent
+{
+ /**
+ * Gets the report generated by the transfer source repository
+ *
+ * @return source transfer report
+ */
+ public NodeRef getSourceReport();
+
+ /**
+ * Gets the report generated by the transfer destination repository
+ *
+ * @return destination transfer report
+ */
+ public NodeRef getDestinationReport();
+}
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java b/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java
index e7a0cc7eda..ab19d123c8 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEvent.java
@@ -35,7 +35,7 @@ public interface TransferEvent
/**
* The transfer events will Start with a START event and finish with either SUCCESS or ERROR
*/
- enum TransferState { START, SENDING_SNAPSHOT, SENDING_CONTENT, PREPARING, COMMITTING, SUCCESS, ERROR };
+ enum TransferState { START, SENDING_SNAPSHOT, SENDING_CONTENT, PREPARING, COMMITTING, SUCCESS, ERROR, CANCELLED };
/**
* Get the state of this transfer
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEventCancelled.java b/source/java/org/alfresco/service/cmr/transfer/TransferEventCancelled.java
new file mode 100644
index 0000000000..38a5f5815a
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEventCancelled.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.transfer;
+
+import org.alfresco.repo.transfer.TransferEndEventImpl;
+
+/**
+ * The cancelled event indicates a transfer was aborted
+ */
+public class TransferEventCancelled extends TransferEndEventImpl
+{
+ public String toString()
+ {
+ return "TransferEventCancelled";
+ }
+}
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEventError.java b/source/java/org/alfresco/service/cmr/transfer/TransferEventError.java
index 476027d121..b1cfcdb164 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferEventError.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEventError.java
@@ -18,12 +18,12 @@
*/
package org.alfresco.service.cmr.transfer;
-import org.alfresco.repo.transfer.TransferEventImpl;
+import org.alfresco.repo.transfer.TransferEndEventImpl;
/**
* Indicates the reason why a transfer failed
*/
-public class TransferEventError extends TransferEventImpl implements TransferEvent
+public class TransferEventError extends TransferEndEventImpl
{
private Exception exception;
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEventReport.java b/source/java/org/alfresco/service/cmr/transfer/TransferEventReport.java
index b074fea3e8..71c8bbac2c 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferEventReport.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEventReport.java
@@ -1,7 +1,5 @@
package org.alfresco.service.cmr.transfer;
-import java.util.Date;
-
import org.alfresco.repo.transfer.TransferEventImpl;
import org.alfresco.service.cmr.repository.NodeRef;
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferEventSuccess.java b/source/java/org/alfresco/service/cmr/transfer/TransferEventSuccess.java
index e8ea1079d7..2c62dd593b 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferEventSuccess.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferEventSuccess.java
@@ -18,12 +18,12 @@
*/
package org.alfresco.service.cmr.transfer;
-import org.alfresco.repo.transfer.TransferEventImpl;
+import org.alfresco.repo.transfer.TransferEndEventImpl;
/**
- * The success event indicates a successfull transfer
+ * The success event indicates a successful transfer
*/
-public class TransferEventSuccess extends TransferEventImpl implements TransferEvent
+public class TransferEventSuccess extends TransferEndEventImpl
{
public String toString()
{
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferException.java b/source/java/org/alfresco/service/cmr/transfer/TransferException.java
index 000b82eb01..9b9b1297f2 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferException.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferException.java
@@ -27,7 +27,7 @@ import org.alfresco.error.AlfrescoRuntimeException;
*/
public class TransferException extends AlfrescoRuntimeException
{
- /**
+ /**
* Serial version UID
*/
private static final long serialVersionUID = 3257571685241467958L;
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferFailureException.java b/source/java/org/alfresco/service/cmr/transfer/TransferFailureException.java
new file mode 100644
index 0000000000..26b071d835
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferFailureException.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+package org.alfresco.service.cmr.transfer;
+
+
+/**
+ * Transfer failure exception
+ *
+ * @author davidc
+ */
+public class TransferFailureException extends TransferException
+{
+ private static final long serialVersionUID = 9009938314128119981L;
+
+ private TransferEventError event;
+
+ public TransferFailureException(TransferEventError event)
+ {
+ super(event.getMessage(), event.getException());
+ this.event = event;
+ }
+
+ /**
+ * Gets the end event (representing the failure)
+ *
+ * @return end event
+ */
+ public TransferEventError getErrorEvent()
+ {
+ return event;
+ }
+}
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferService.java b/source/java/org/alfresco/service/cmr/transfer/TransferService.java
index d5f9f43aca..46e0e49fb4 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferService.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferService.java
@@ -28,12 +28,15 @@ import org.alfresco.service.Auditable;
import org.alfresco.service.NotAuditable;
/**
- * The transfer service is responsible for transfering nodes between one instance of Alfresco and another remote instance.
- * as well as the transfer method, this interface also provides methods for managing the
+ * The transfer service is responsible for transferring nodes between one instance of Alfresco and another remote instance.
+ * as well as the transfer method, this interface also provides methods for managing transfer targets.
+ *
+ * @see TransferService2
*
* @author Mark Rogers
*/
@PublicService
+@Deprecated
public interface TransferService
{
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferService2.java b/source/java/org/alfresco/service/cmr/transfer/TransferService2.java
new file mode 100644
index 0000000000..c1f5834aa7
--- /dev/null
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferService2.java
@@ -0,0 +1,235 @@
+/*
+ * Copyright (C) 2009-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ */
+
+package org.alfresco.service.cmr.transfer;
+
+import java.util.Collection;
+import java.util.Set;
+
+import org.alfresco.service.Auditable;
+import org.alfresco.service.NotAuditable;
+import org.alfresco.service.PublicService;
+
+/**
+ * The transfer service is responsible for transferring nodes between one instance of Alfresco and another remote instance.
+ * as well as the transfer method, this interface also provides methods for managing transfer targets.
+ *
+ * @author davidc
+ */
+@PublicService
+public interface TransferService2
+{
+
+ /**
+ * 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.
+ * The following properties must be set, nodes
+ * @param callback - a set of callback handlers that will be called as transfer proceeds. May be null.
+ * @throws TransferException
+ * @return transfer end event (in case of success or cancellation)
+ */
+ @Auditable(parameters={"targetName"})
+ public TransferEndEvent transfer(String targetName, TransferDefinition definition, Collection callback) throws TransferFailureException;
+
+ /**
+ * 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.
+ * The following properties must be set, nodes
+ * @param callbacks - a list of callback handlers that will be called as transfer proceeds. May be null.
+ * @throws TransferException
+ * @return transfer end event (in case of success or cancellation)
+ */
+ @Auditable(parameters={"targetName"})
+ public TransferEndEvent transfer(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferFailureException;
+
+ /**
+ * 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
+ */
+ @Auditable(parameters={"targetName"})
+ public void transferAsync(String targetName, TransferDefinition definition, Collection 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
+ */
+ @Auditable(parameters={"targetName"})
+ public void transferAsync(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferException;
+
+ /**
+ * Verify a target is available and that the configured credentials are valid.
+ * @throws TransferException
+ */
+ @NotAuditable
+ public void verify(TransferTarget target) throws TransferException;
+
+ /**
+ * Create and save a new transfer target. Creates and saves a new transfer target with a single, but long, method call.
+ *
+ * @param name, the name of this transfer target, which must be unique
+ * @param title, the display name of this transfer target
+ * @param description,
+ * @param endpointProtocol, either http or https
+ * @param endpointHost,
+ * @param endpointPort,
+ * @param endpointPath,
+ * @param username,
+ * @param password,
+ * @return the newly created transfer target.
+ */
+ @Auditable
+ public TransferTarget createAndSaveTransferTarget(String name, String title, String description, String endpointProtocol,
+ String endpointHost, int endpointPort, String endpointPath, String username, char[] password) throws TransferException;
+
+ /**
+ * Creates an in memory transfer target. Before it is used it must be populated with the following values and
+ * saved with the saveTransferTarget method. The name of the transfer target must be unique.
+ *
+ * - title
+ * - description
+ * - endpointProtocol
+ * - endpointHost
+ * - endpointPort
+ * - endpointPath
+ * - username
+ * - password
+ *
+ * @return an in memory transfer target
+ */
+ @Auditable(parameters={"name"})
+ public TransferTarget createTransferTarget(String name);
+
+ /**
+ * Get all the transfer targets
+ */
+ @NotAuditable
+ public SetgetTransferTargets() throws TransferException;
+
+ /**
+ * Get All the transfer targets for a particular transfer target group.
+ * @param groupName, the name of the transfer group
+ */
+ @NotAuditable
+ public SetgetTransferTargets(String groupName) throws TransferException;
+
+ /**
+ * Get a transfer target by its name
+ * @throws TransferException - target does not exist
+ */
+ @NotAuditable
+ 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
+ */
+ @NotAuditable
+ 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
+ * @param name, the name of this transfer target,
+ */
+ @Auditable(parameters={"name"})
+ public void deleteTransferTarget(String name) throws TransferException;
+
+ /**
+ * Save TransferTarget, will create a transfer target if it does not already exist or update an existing transfer target.
+ *
+ * The following properties may be updated:
+ * endpointHost,
+ * endpointPort,
+ * endpointProtocol,
+ * endpointPath,
+ * username,
+ * password,
+ * title,
+ * description
+ *
+ * The following properties may not be updated:
+ * name, must be specified.
+ * nodeRef, if specified will be ignored.
+ *
+ * @param update
+ */
+ @Auditable
+ public TransferTarget saveTransferTarget(TransferTarget update) throws TransferException;
+
+ /**
+ * Enables/Disables the named transfer target
+ * @param name the name of the transfer target
+ * @param enable (or false=disable)
+ */
+ @Auditable(parameters={"name", "enable"})
+ 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 identifier can be obtained from the TransferEventBegin event that is passed to registered callbacks when
+ * transfer starts.
+ *
+ * @param transferId the unique identifier of the transfer to cancel.
+ *
+ * @see TransferEventBegin;
+ */
+ @Auditable(parameters={"transferId"})
+ public void cancelAsync(String transferId);
+
+}