Package org.alfresco.repo.transfer

Class TransferServiceImpl2

java.lang.Object

org.alfresco.repo.transfer.TransferServiceImpl2

All Implemented Interfaces:

TransferService2

public class TransferServiceImpl2
extends java.lang.Object
implements TransferService2

Implementation of the Transfer Service.

Author:

Mark Rogers

Constructor Summary

Constructors

Constructor	Description
TransferServiceImpl2()

Method Summary

Modifier and Type	Method	Description
void	cancelAsync(java.lang.String transferHandle)	CancelAsync
TransferTarget	createAndSaveTransferTarget(java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String endpointProtocol, java.lang.String endpointHost, int endpointPort, java.lang.String endpointPath, java.lang.String username, char[] password)	create transfer target
TransferTarget	createTransferTarget(java.lang.String name)	Create a new in memory transfer target
void	deleteTransferTarget(java.lang.String name)	Delete a transfer target.
void	enableTransferTarget(java.lang.String name, boolean enable)	Enables/Disables the named transfer target
protected org.alfresco.service.cmr.repository.NodeRef	getDefaultGroup()
protected org.alfresco.service.cmr.repository.NodeRef	getTransferHome()
TransferTarget	getTransferTarget(java.lang.String name)	Get a transfer target by its name
java.util.Set<TransferTarget>	getTransferTargets()	Get all transfer targets
java.util.Set<TransferTarget>	getTransferTargets(java.lang.String groupName)	Get all transfer targets in the specified group
TransferTransmitter	getTransmitter()
void	init()
TransferTarget	saveTransferTarget(TransferTarget update)	create or update a transfer target.
void	setActionService(ActionService actionService)
void	setCommitPollDelay(long commitPollDelay)
void	setDefaultTransferGroup(java.lang.String defaultGroup)
void	setDescriptorService(DescriptorService descriptorService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
void	setSingletonCache(org.alfresco.repo.cache.SimpleCache<java.lang.String,org.alfresco.service.cmr.repository.NodeRef> singletonCache)
void	setTransactionService(TransactionService transactionService)
void	setTransferManifestNodeFactory(TransferManifestNodeFactory transferManifestNodeFactory)
void	setTransferReporter(TransferReporter transferReporter)
void	setTransferSpaceQuery(java.lang.String transferSpaceQuery)
void	setTransferVersionChecker(TransferVersionChecker transferVersionChecker)
void	setTransmitter(TransferTransmitter transmitter)
boolean	targetExists(java.lang.String name)	Test to see if the target with the specified name exists
TransferEndEvent	transfer(java.lang.String targetName, TransferDefinition definition, java.util.Collection<TransferCallback> callbacks)	Transfer Synchronous
TransferEndEvent	transfer(java.lang.String targetName, TransferDefinition definition, TransferCallback... callbacks)	Transfer Synchronous
void	transferAsync(java.lang.String targetName, TransferDefinition definition, java.util.Collection<TransferCallback> callbacks)	Transfer async.
void	transferAsync(java.lang.String targetName, TransferDefinition definition, TransferCallback... callbacks)	Transfer async.
void	verify(TransferTarget target)	Verify a target is available and that the configured credentials are valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferServiceImpl2

public TransferServiceImpl2()

Method Detail

init

public void init()

createTransferTarget

public TransferTarget createTransferTarget(java.lang.String name)

Create a new in memory transfer target

Specified by:

createTransferTarget in interface TransferService2

Returns:

an in memory transfer target

createAndSaveTransferTarget

public TransferTarget createAndSaveTransferTarget(java.lang.String name,
                                                  java.lang.String title,
                                                  java.lang.String description,
                                                  java.lang.String endpointProtocol,
                                                  java.lang.String endpointHost,
                                                  int endpointPort,
                                                  java.lang.String endpointPath,
                                                  java.lang.String username,
                                                  char[] password)

create transfer target

Specified by:

createAndSaveTransferTarget in interface TransferService2

Parameters:

name - the name of this transfer target, which must be unique

title - the display name of this transfer target

description - String

endpointProtocol - either http or https

endpointHost - String

endpointPort - int

endpointPath - String

username - String

password - char[]

Returns:

the newly created transfer target.

getDefaultGroup

protected org.alfresco.service.cmr.repository.NodeRef getDefaultGroup()

getTransferTargets

public java.util.Set<TransferTarget> getTransferTargets()

Get all transfer targets

Specified by:

getTransferTargets in interface TransferService2

getTransferTargets

public java.util.Set<TransferTarget> getTransferTargets(java.lang.String groupName)

Get all transfer targets in the specified group

Specified by:

getTransferTargets in interface TransferService2

Parameters:

groupName - the name of the transfer group

deleteTransferTarget

public void deleteTransferTarget(java.lang.String name)

Description copied from interface: TransferService2

Delete a transfer target. After calling this method the transfer target will no longer exist.

Specified by:

deleteTransferTarget in interface TransferService2

Parameters:

name - the name of this transfer target,

enableTransferTarget

public void enableTransferTarget(java.lang.String name,
                                 boolean enable)

Enables/Disables the named transfer target

Specified by:

enableTransferTarget in interface TransferService2

Parameters:

name - the name of the transfer target

enable - (or false=disable)

targetExists

public boolean targetExists(java.lang.String name)

Description copied from interface: TransferService2

Test to see if the target with the specified name exists

Specified by:

targetExists in interface TransferService2

Parameters:

name - String

Returns:

true if the specified target exists, and false otherwise

getTransferTarget

public TransferTarget getTransferTarget(java.lang.String name)

Description copied from interface: TransferService2

Get a transfer target by its name

Specified by:

getTransferTarget in interface TransferService2

saveTransferTarget

public TransferTarget saveTransferTarget(TransferTarget update)

create or update a transfer target.

Specified by:

saveTransferTarget in interface TransferService2

Parameters:

update - TransferTarget

transferAsync

public void transferAsync(java.lang.String targetName,
                          TransferDefinition definition,
                          TransferCallback... callbacks)

Transfer async.

Specified by:

transferAsync in interface TransferService2

Parameters:

targetName - String

definition - TransferDefinition

callbacks - TransferCallback...

transferAsync

public void transferAsync(java.lang.String targetName,
                          TransferDefinition definition,
                          java.util.Collection<TransferCallback> callbacks)

Transfer async.

Specified by:

transferAsync in interface TransferService2

Parameters:

targetName - String

definition - TransferDefinition

callbacks - - a collection of callback handlers that will be called as transfer proceeds. May be null.

transfer

public TransferEndEvent transfer(java.lang.String targetName,
                                 TransferDefinition definition,
                                 TransferCallback... callbacks)
                          throws TransferFailureException

Transfer Synchronous

Specified by:

transfer in interface TransferService2

Parameters:

targetName - String

definition - TransferDefinition

callbacks - TransferCallback...

Returns:

transfer end event (in case of success or cancellation)

Throws:

TransferFailureException

transfer

public TransferEndEvent transfer(java.lang.String targetName,
                                 TransferDefinition definition,
                                 java.util.Collection<TransferCallback> callbacks)
                          throws TransferFailureException

Transfer Synchronous

Specified by:

transfer in interface TransferService2

Parameters:

targetName - String

definition - TransferDefinition

callbacks - - a set of callback handlers that will be called as transfer proceeds. May be null.

Returns:

transfer end event (in case of success or cancellation)

Throws:

TransferFailureException

cancelAsync

public void cancelAsync(java.lang.String transferHandle)

CancelAsync

Specified by:

cancelAsync in interface TransferService2

Parameters:

transferHandle - the unique identifier of the transfer to cancel.

See Also:

TransferEventBegin

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

setSingletonCache

public void setSingletonCache(org.alfresco.repo.cache.SimpleCache<java.lang.String,org.alfresco.service.cmr.repository.NodeRef> singletonCache)

setTransferSpaceQuery

public void setTransferSpaceQuery(java.lang.String transferSpaceQuery)

setDefaultTransferGroup

public void setDefaultTransferGroup(java.lang.String defaultGroup)

getTransmitter

public TransferTransmitter getTransmitter()

setTransmitter

public void setTransmitter(TransferTransmitter transmitter)

getTransferHome

protected org.alfresco.service.cmr.repository.NodeRef getTransferHome()

verify

public void verify(TransferTarget target)
            throws TransferException

Description copied from interface: TransferService2

Verify a target is available and that the configured credentials are valid.

Specified by:

verify in interface TransferService2

Throws:

TransferException

setTransferManifestNodeFactory

public void setTransferManifestNodeFactory(TransferManifestNodeFactory transferManifestNodeFactory)

setActionService

public void setActionService(ActionService actionService)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setTransferReporter

public void setTransferReporter(TransferReporter transferReporter)

setCommitPollDelay

public void setCommitPollDelay(long commitPollDelay)

setDescriptorService

public void setDescriptorService(DescriptorService descriptorService)

setTransferVersionChecker

public void setTransferVersionChecker(TransferVersionChecker transferVersionChecker)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)