Merge DM-DM_deployment to HEAD

17716 : Copied alfresco/HEAD to alfresco/BRANCHES/DEV/BRIAN/DM-DM_deployment.
  17721 : Moved alfresco/BRANCHES/DEV/BRIAN/DM-DM_deployment to alfresco/BRANCHES/DEV/DM-DM_deployment.
  17809 : Bare Bones of TransferService.
  17813 : more bones
  17824 : bootstrap of the transfer spaces
  17826 : Added username, path, and a getter for the password.
  17832 : createTransferTarget, getTransferTargets() working.
  17836 : transfer target 
    - duplicate name detection
    - delete transfer target by name
    - get transfer target by name
    - TransferException added along with transfer-service.properties
  17840 : transfer target
   - enable / disable
   - update properties
  17851 : Added the notion of a transmitter for the transfer service, and an HttpClient implementation of it.
  17852 : Added the web script needed for the receiving end of a transfer, along with a command processor for clients to 
check availability of the service and credentials.
  17856 : Added a Mockito-based test for HttpClientTransmitterImpl
  17857 : Corrected javadoc for test class
  17858 : Added test for overriding SSL socket factory
  17859 : Wired up the transfer service to the transfer transmitter.
  17896 : Rework to spring for app:transferDefinitions it's now app:transfer_definitio
    - Add throws clauses to TransferService
    - Bare bones of interface for begin and sendManifest
  17944 : Work in progress on manifest file
  17947 : added parent and child associations to the snapshot.
  17956 : Now has the parent path implemented and introduces the TransferManifestNodeFactory.
  17965 : Added content, MLText and collections.
  17978 : addition of source and target peer associations.
  17982 : Fixing parentNode information.
  18008 : XML Manifest Reader checkpoint. (Still incomplete but lots working)
  18040 : ParentPath is transmitted, fixes for source and target assocs.
  18048 : SAIL-30: Initial commit of functionality for begin, sendManifest, and sendContent parts of the transfer process
  18049 : Fix for parse of Locale type.
  18054 : Added TransferManifestNodeHelper and more tests
  18066 : Work in progress check in
   - Implemented the content chunker
 - sketched out more interfaces on TransferTransmitter.
 - Please note that the chunker is not yet connected to the manifest file, that will come next.
r18069 : Wired up manifest reader to content chunker.
r18089 : Fiest cut of callback interface for review.
r18091 : added hashCode implementation which was missing from ContentData
r18095 : Start of the server-side commit. Note that this is an interim commit - not tested.
r18096 : Initial entry of a ContentData implementation of HttpClient's "Part"
r18155 : Work in progress check in.
    TransferEvent - incomplete
    HttpClientTransmitter - first cut complete (not tested)
    Server side - first cut complete (not tested)
  18156 : TransferMessage missing from last check in.
  18166 : check in command processors
  18167 : Work primarily on the transfer commit operation
  18170 : corrected spring errors.
  18176 : Further testing and fixing of transfer commit
  18206 : Work in progress.
  18236 : Work in progress - generally adding debug logging and sorting out exception handlers.
  18240 : Fix to call "end" correctly after exception is thrown with "commit"
  18242 : Aligning the manifest part names.
  18243 : PostSnapshot calls the correct method on the receiver service.
  18267 : First node has transferred.
  18274 : Fixing abort to call end, debug statements, formatting code brackest
  18275 : First code to handle updates. Also improved error messages passed back to client
  18289 : Checked in work in progress.  Content upload not working.
  18290 : Update to ensure file type.
  18300 : Added more log output and some of the error messages.
  18301 : Work in progress
  18302 : Added log output
  18307 : Added a noddy transfer action
  18315 : Sprint 2 complete - transfer and update one node.
  18354 : Now the manifest file has deleted nodes.
 - Adding copyright headers
  18384 : Plumbing for unit tests on one box.
  18416 : First end to end unit test working.   (one node create and update)
  18421 : Added path based update test and many send test.
  18458 : Added the functionality to transfer deleted and restored nodes.
  18481 : Implementation of transferAsync
  18491 : SAIL-32, SAIL-35
   - Added node crawler for DM-DM Transfer F6 and F9.
  18620 : Basic transfer report implementation

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18858 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Mark Rogers
2010-02-25 20:07:09 +00:00
parent e0f29a76e4
commit af1a735c98
93 changed files with 12954 additions and 20 deletions

View File

@@ -333,4 +333,17 @@ public class ContentData implements Serializable
{
return locale;
}
/**
* @return hashCode
*/
public int hashCode()
{
if(contentUrl!= null)
{
return contentUrl.hashCode();
}
return 0;
}
}

View File

@@ -41,7 +41,7 @@ import org.alfresco.util.ISO9075;
* /x/y/z
* </pre></b>
* In the above example, there will be <b>4</b> elements, the first being a reference
* to the root node, followed by qname elements for <b>x</b>, <b>x</b> and <b>z</b>.
* to the root node, followed by qname elements for <b>x</b>, <b>y</b> and <b>z</b>.
* <p>
* Methods and constructors are available to construct a <code>Path</code> instance
* from a path string or by building the path incrementally, including the ability to

View File

@@ -0,0 +1,50 @@
/*
* 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 org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* @author brian
*
*/
public interface NodeFilter
{
/**
* Examines the supplied node and indicates whether it has been accepted by the filter.
* @param thisNode
* @param serviceRegistry
* @return true if the supplied node matches the criteria specified on this filter, and false
* otherwise.
*/
boolean accept(NodeRef thisNode);
void init();
void setServiceRegistry(ServiceRegistry serviceRegistry);
}

View File

@@ -0,0 +1,50 @@
/*
* 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.Set;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* @author brian
*
*/
public interface NodeFinder
{
/**
* @param thisNode
* @param serviceRegistry
* @return
*/
Set<NodeRef> findFrom(NodeRef thisNode);
void init();
void setServiceRegistry(ServiceRegistry serviceRegistry);
}

View File

@@ -0,0 +1,49 @@
/*
* 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;
/**
* A Ranged Transfer event is a detail record for a State that has many smaller steps. For example when sending content the first
* event is 1 of the number of files to send. The second is 2 of the number of files to send.
*
* These events are intended to support "progress bar" types of interfaces.
*
* @author Mark Rogers
*/
public interface RangedTransferEvent extends TransferEvent
{
/**
* The position in the range
* @return
*/
long getPosition();
/**
* The maximum range
* @return
*/
long getRange();
}

View File

@@ -0,0 +1,44 @@
/*
* 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 java.io.Serializable;
/**
* The transfer callback is called during a transfer, it allows the real-time feedback of
* an in progress transfer. It can be used to populate a deployment report or to display
* a user interface.
*
* @author Mark Rogers
*/
public interface TransferCallback extends Serializable
{
/**
* processEvent
* @param event
*/
public void processEvent(TransferEvent event);
}

View File

@@ -0,0 +1,65 @@
/*
* 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 java.io.Serializable;
import java.util.Set;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Definition of a transfer.
*
* Specifies which node to transfer
*
*/
public class TransferDefinition implements Serializable
{
/**
*
*/
private static final long serialVersionUID = -8497919749300106861L;
// Which nodes to deploy
private Set<NodeRef> nodes;
/**
* Set which nodes to transfer
* @param nodes
*/
public void setNodes(Set<NodeRef> nodes)
{
this.nodes = nodes;
}
/**
* Get which nodes to transfer
* @return
*/
public Set<NodeRef> getNodes()
{
return nodes;
}
}

View File

@@ -0,0 +1,38 @@
package org.alfresco.service.cmr.transfer;
import java.util.Date;
/**
* @author Mark Rogers
*/
public interface TransferEvent
{
/**
* The transfer events will Start with a START event and finish with either SUCCESS or ERROR
*/
enum TransferState { START, SENDING_MANIFEST, SENDING_CONTENT, PREPARING, COMMITTING, SUCCESS, ERROR };
/**
* Get the state of this transfer
* @return the state of this transfer
*/
TransferState getTransferState();
/**
* The time this event occured.
* @return the date/time the event
*/
Date getTime();
/**
* Get a human readable message for this event
* @return
*/
String getMessage();
/**
* Is this the last event for this transfer ?
*/
boolean isLast();
}

View File

@@ -0,0 +1,41 @@
/*
* 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;
/**
* TransferEventCommittingStatus are produced when a transfer is being committed.
*
* The range can be used to produce a "progress bar"
*
*/
public class TransferEventCommittingStatus extends TransferEventImpl implements RangedTransferEvent
{
public String toString()
{
return "TransferEventCommittingStatus: " + super.getPosition() + " of " + super.getRange();
}
}

View File

@@ -0,0 +1,36 @@
/*
* 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;
public class TransferEventEndState extends TransferEventImpl implements TransferEvent
{
public String toString()
{
return ("TransferEventEndState: " + super.toString());
}
}

View File

@@ -0,0 +1,36 @@
/*
* 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;
public class TransferEventEnterState extends TransferEventImpl implements TransferEvent
{
public String toString()
{
return ("TransferEventEnterState: " + super.toString());
}
}

View File

@@ -0,0 +1,46 @@
/*
* 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;
/**
* Indicates the reason why a transfer failed
*/
public class TransferEventError extends TransferEventImpl implements TransferEvent
{
private Exception exception;
public void setException(Exception exception)
{
this.exception = exception;
}
public Exception getException()
{
return exception;
}
}

View File

@@ -0,0 +1,51 @@
/*
* 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;
/**
* Ranged Transfer event for sending content (e.g. sending content 1 of 64)
*/
public class TransferEventSendingContent extends TransferEventImpl implements RangedTransferEvent
{
private long size;
public String toString()
{
return "TransferEventSendingContent: " + super.getPosition() + " of " + super.getRange();
}
public void setSize(long size)
{
this.size = size;
}
public long getSize()
{
return size;
}
}

View File

@@ -0,0 +1,40 @@
/*
* 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;
/**
*
*
*/
public class TransferEventSendingManifest extends TransferEventImpl implements RangedTransferEvent
{
public String toString()
{
return "TransferEventSendingManifest: " + super.getPosition() + " of " + super.getRange();
}
}

View File

@@ -0,0 +1,32 @@
/*
* 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;
public class TransferEventSentContent extends TransferEventImpl implements TransferEvent
{
}

View File

@@ -0,0 +1,38 @@
/*
* 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;
/**
* The success event indicates a successfull transfer
*/
public class TransferEventSuccess extends TransferEventImpl implements TransferEvent
{
public String toString()
{
return "TransferEventSuccess";
}
}

View File

@@ -0,0 +1,60 @@
/*
* 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.error.AlfrescoRuntimeException;
/**
* Transfer service exception class
*
* @author Mark Rogers
*/
public class TransferException extends AlfrescoRuntimeException
{
/**
* Serial version UID
*/
private static final long serialVersionUID = 3257571685241467958L;
public TransferException(String msgId)
{
super(msgId);
}
public TransferException(String msgId, Object[] msgParams)
{
super(msgId, msgParams);
}
public TransferException(String msgId, Object[] msgParams, Throwable cause)
{
super(msgId, msgParams, cause);
}
public TransferException(String msgId, Throwable cause)
{
super(msgId, cause);
}
}

View File

@@ -0,0 +1,107 @@
/*
* 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.io.File;
import java.io.InputStream;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* @author brian
*
*/
public interface TransferReceiver
{
/**
*
* @param transferId
* @return
*/
File getStagingFolder(String transferId);
/**
*
* @param transferId
* @return
*/
NodeRef getTempFolder(String transferId);
/**
* Asks the receiver to setup a new transfer.
* @return The identifier of the new transfer
* @throws TransferException if an error occurred while setting up the transfer
*/
String start() throws TransferException;
/**
* Asks the receiver to end (and clean up) the specified transfer
* @param transferId The transfer to end
* @throws TransferException If the process of ending the transfer fails
*/
void end(String transferId) throws TransferException;
/**
* Nudge the transfer lock (to prevent it expiring) if the supplied transferId matches that referenced by the lock.
* @param transferId
* @throws TransferException if the lock doesn't exist or doesn't correspond to the supplied transferId.
*/
void nudgeLock(String transferId) throws TransferException;
/**
* Store the specified snapshot file into the transfer staging area.
* The specified transfer must currently be the holder of the transfer lock, otherwise an exception is thrown.
* This operation does not close the supplied stream, so the caller must do it as appropriate. The caller
* should assume that the supplied stream has been fully read when this operation returns.
* @param transferId The identifier of the transfer with which this snapshot is associated
* @param snapshotStream The open stream that holds the snapshot file.
* @throws TransferException If an error occurs while saving the snapshot file.
*/
void saveSnapshot(String transferId, InputStream snapshotStream) throws TransferException;
void saveContent(String transferId, String contentId, InputStream contentStream) throws TransferException;
/**
* Prepare
* @param transferId
* @throws TransferException
*/
void prepare(String transferId) throws TransferException;
/**
* Abort
* @param transferId
* @throws TransferException
*/
void abort(String transferId) throws TransferException;
/**
* Commit
* @param transferId
* @throws TransferException
*/
void commit(String transferId) throws TransferException;
}

View File

@@ -0,0 +1,156 @@
/*
* 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 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 java.util.Set;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* 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
*
* @author Mark Rogers
*/
public interface TransferService
{
/**
* Transfer nodes, sync. 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
* The following properties must be set, nodes
* @param definition, the definition of the transfer. Specifies which nodes to transfer.
* @throws TransferException
* @return the node reference of the transfer report
*/
public NodeRef transfer(String targetName, TransferDefinition definition) throws TransferException;
/**
* 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 the node reference of the transfer report
*/
public NodeRef transfer(String targetName, TransferDefinition definition, Set<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.
*
* @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
*/
public void transferAsync(String targetName, TransferDefinition definition, Set<TransferCallback> callback) throws TransferException;
/**
* Verify a target is available and that the configured credentials correctly identify an admin user.
* @throws TransferException
*/
public void verify(TransferTarget target) throws TransferException;
/**
* crate a new transfer target
* @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,
*/
public TransferTarget createTransferTarget(String name, String title, String description, String endpointProtocol, String endpointHost, int endpointPort, String endpointPath, String username, char[] password) throws TransferException;
/**
* Get all the transfer targets
*/
public Set<TransferTarget>getTransferTargets() throws TransferException;
/**
* Get All the transfer targets for a particular transfer target group.
* @param groupName, the name of the transfer group
*/
public Set<TransferTarget>getTransferTargets(String groupName) throws TransferException;
/**
* Get a transfer target by its name
* @throws TransferException - target does not exist
*/
public TransferTarget getTransferTarget(String name) throws TransferException;
/**
* 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,
*/
public void deleteTransferTarget(String name) throws TransferException;
/**
* Update TransferTarget
* 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
*/
public TransferTarget updateTransferTarget(TransferTarget update) throws TransferException;
/**
* Enables/Disables the named transfer target
* @param name the name of the transfer target
* @param enable (or false=disable)
*/
public void enableTransferTarget(String name, boolean enable) throws TransferException;
}

View File

@@ -0,0 +1,135 @@
package org.alfresco.service.cmr.transfer;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Transfer Target.
*
* @author Mark Rogers
*/
public interface TransferTarget
{
/**
* read only - get the node reference of the underlying transfer target node.
* @return
*/
public NodeRef getNodeRef();
/**
* Get the name of this transfer target
* @return
*/
public String getName();
/**
* Set the name of this transfer target. Please note that you can't update the name of a
* transfer target.
*
* @param name
*/
public void setName(String name);
/**
* Get the description for this transfer target
* @return
*/
public String getDescription();
/**
* Set the decription for this transfer target
* @param description
*/
public void setDescription(String description);
/**
* Get the title of this transfer target
* @return
*/
String getTitle();
/**
* Set the title for this transfer target
* @param title
*/
public void setTitle(String title);
/**
* Get the endpoint host
* @return
*/
public String getEndpointHost();
/**
* Set the endpoint host
* @param endpointHost
*/
public void setEndpointHost(String endpointHost);
/**
* Get the endpoint port
* @return
*/
int getEndpointPort();
/**
* Set the endpoint port
* @param endpointPort
*/
public void setEndpointPort(int endpointPort);
/**
* HTTP OR HTTPS
*/
public String getEndpointProtocol();
/**
* Set the endpoint protocol.
* @param endpointProtocol
*/
public void setEndpointProtocol(String endpointProtocol);
/**
* Set the password for this transfer target
* @param password clear text password.
*/
public void setPassword(char[] password);
/**
* The username used to authenticate with the transfer target
* @return
*/
String getUsername();
/**
* The username used to authenticate with the transfer target
* @param userName
*/
void setUsername(String userName);
/**
* Get the cleartext password
* @return
*/
char[] getPassword();
/**
* The location of the transfer service on the target endpoint host
* @return
*/
String getEndpointPath();
/**
* The location of the transfer service on the target endpoint host
*/
void setEndpointPath(String path);
/**
* is this transfer target enabled or disabled?
*/
boolean isEnabled();
/**
* enable this transfer target
*/
void setEnabled(boolean enabled);
}

View File

@@ -58,8 +58,10 @@ public final class QName implements QNamePattern, Serializable, Cloneable, Compa
/**
* Create a QName
*
* (With no prefix)
*
* @param namespaceURI the qualifying namespace (maybe null or empty string)
* @param localName the qualified name
* @param localName the local name
* @return the QName
*/
public static QName createQName(String namespaceURI, String localName)
@@ -109,7 +111,7 @@ public final class QName implements QNamePattern, Serializable, Cloneable, Compa
/**
* Create a QName
* Create a QName (from prefix format) <code>prefix:localName</code>
*
* @param qname qualified name of the following format <code>prefix:localName</code>
* @param prefixResolver lookup to resolve mappings between prefix and namespace