mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
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
157 lines
6.8 KiB
Java
157 lines
6.8 KiB
Java
/*
|
|
* 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;
|
|
|
|
}
|