public interface TransferService2
Modifier and Type | Method and Description |
---|---|
void |
cancelAsync(String transferId)
Asynchronously cancel an in-progress transfer
This method tells an in-process transfer to give up, rollback and stop as soon as possible.
|
TransferTarget |
createAndSaveTransferTarget(String name,
String title,
String description,
String endpointProtocol,
String endpointHost,
int endpointPort,
String endpointPath,
String username,
char[] password)
Create and save a new transfer target.
|
TransferTarget |
createTransferTarget(String name)
Creates an in memory transfer target.
|
void |
deleteTransferTarget(String name)
Delete a transfer target.
|
void |
enableTransferTarget(String name,
boolean enable)
Enables/Disables the named transfer target
|
TransferTarget |
getTransferTarget(String name)
Get a transfer target by its name
|
Set<TransferTarget> |
getTransferTargets()
Get all the transfer targets
|
Set<TransferTarget> |
getTransferTargets(String groupName)
Get All the transfer targets for a particular transfer target group.
|
TransferTarget |
saveTransferTarget(TransferTarget update)
Save TransferTarget, will create a transfer target if it does not already exist or update an existing transfer target.
|
boolean |
targetExists(String name)
Test to see if the target with the specified name exists
|
TransferEndEvent |
transfer(String targetName,
TransferDefinition definition,
Collection<TransferCallback> callback)
Transfer nodes sync, with callback.
|
TransferEndEvent |
transfer(String targetName,
TransferDefinition definition,
TransferCallback... callbacks)
Transfer nodes sync, with callback.
|
void |
transferAsync(String targetName,
TransferDefinition definition,
Collection<TransferCallback> callback)
Transfer nodes async with callback.
|
void |
transferAsync(String targetName,
TransferDefinition definition,
TransferCallback... callbacks)
Transfer nodes async with callback.
|
void |
verify(TransferTarget target)
Verify a target is available and that the configured credentials are valid.
|
@Auditable(parameters="targetName") TransferEndEvent transfer(String targetName, TransferDefinition definition, Collection<TransferCallback> callback) throws TransferFailureException
targetName
- the name of the target to transfer todefinition
- - the definition of the transfer. Specifies which nodes to transfer.
The following properties must be set, nodescallback
- - a set of callback handlers that will be called as transfer proceeds. May be null.TransferException
TransferFailureException
@Auditable(parameters="targetName") TransferEndEvent transfer(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferFailureException
targetName
- the name of the target to transfer todefinition
- - the definition of the transfer. Specifies which nodes to transfer.
The following properties must be set, nodescallbacks
- - a list of callback handlers that will be called as transfer proceeds. May be null.TransferException
TransferFailureException
@Auditable(parameters="targetName") void transferAsync(String targetName, TransferDefinition definition, Collection<TransferCallback> callback) throws TransferException
targetName
- the name of the target to transfer todefinition
- - the definition of the transfer. Specifies which nodes to transfer.
The following properties must be set, nodescallback
- - a collection of callback handlers that will be called as transfer proceeds. May be null.TransferException
@Auditable(parameters="targetName") void transferAsync(String targetName, TransferDefinition definition, TransferCallback... callbacks) throws TransferException
targetName
- the name of the target to transfer todefinition
- - the definition of the transfer. Specifies which nodes to transfer.
The following properties must be set, nodescallbacks
- - a collection of callback handlers that will be called as transfer proceeds. May be null.TransferException
@NotAuditable void verify(TransferTarget target) throws TransferException
TransferException
@Auditable TransferTarget createAndSaveTransferTarget(String name, String title, String description, String endpointProtocol, String endpointHost, int endpointPort, String endpointPath, String username, char[] password) throws TransferException
name
- the name of this transfer target, which must be uniquetitle
- the display name of this transfer targetdescription
- StringendpointProtocol
- either http or httpsendpointHost
- StringendpointPort
- intendpointPath
- Stringusername
- Stringpassword
- char[]TransferException
@Auditable(parameters="name") TransferTarget createTransferTarget(String name)
@NotAuditable Set<TransferTarget> getTransferTargets() throws TransferException
TransferException
@NotAuditable Set<TransferTarget> getTransferTargets(String groupName) throws TransferException
groupName
- the name of the transfer groupTransferException
@NotAuditable TransferTarget getTransferTarget(String name) throws TransferException
TransferException
- - target does not exist@NotAuditable boolean targetExists(String name)
name
- String@Auditable(parameters="name") void deleteTransferTarget(String name) throws TransferException
name
- the name of this transfer target,TransferException
- - target does not exist@Auditable TransferTarget saveTransferTarget(TransferTarget update) throws TransferException
update
- TransferTargetTransferException
@Auditable(parameters={"name","enable"}) void enableTransferTarget(String name, boolean enable) throws TransferException
name
- the name of the transfer targetenable
- (or false=disable)TransferException
@Auditable(parameters="transferId") void cancelAsync(String transferId)
transferId
- the unique identifier of the transfer to cancel.TransferEventBegin
Copyright © 2005–2017 Alfresco Software. All rights reserved.