org.alfresco.deployment

Interface DeploymentReceiverService

All Known Subinterfaces:

DeploymentReceiverTransport

All Known Implementing Classes:

DeploymentReceiverEngineImpl

public interface DeploymentReceiverService

Public Interface for File System Deployment Receiver (FSR)

Author:

britt

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(String ticket) Signals that the deployment should be aborted and rolled back.
DeploymentToken	begin(String target, String storeName, int version, String user, char[] password) Start a deployment.
void	commit(String ticket) Signals that the deployment should commit.
void	createDirectory(String ticket, String path, String guid, Set<String> aspects, Map<String,Serializable> properties) Create a new directory.
void	delete(String ticket, String path) Delete a file or directory.
List<FileDescriptor>	getListing(String ticket, String path) Get a listing of a directory.
void	prepare(String ticket) Signals that the deployment should prepare
OutputStream	send(String ticket, boolean create, String path, String guid, String encoding, String mimeType, Set<String> aspects, Map<String,Serializable> properties) Send a file to a path.
void	updateDirectory(String ticket, String path, String guid, Set<String> aspects, Map<String,Serializable> properties) Set the Guid (Version) on a directory.

Method Detail

begin

DeploymentToken begin(String target,
                    String storeName,
                    int version,
                    String user,
                    char[] password)

Start a deployment.

Parameters:

storeName - - the name of the store being deployed.

target - The target to deploy to. A target is simply a key to a receiver side deployment configuration.

version - - the version being deployed.

user - The user name for authentication.

password - The password for the user.

Returns:

information on the new deployment.

prepare

void prepare(String ticket)

Signals that the deployment should prepare

Parameters:

ticket - The transaction ticket.

commit

void commit(String ticket)

Signals that the deployment should commit.

Parameters:

ticket - The transaction ticket.

abort

void abort(String ticket)

Signals that the deployment should be aborted and rolled back.

Parameters:

ticket -

send

OutputStream send(String ticket,
                boolean create,
                String path,
                String guid,
                String encoding,
                String mimeType,
                Set<String> aspects,
                Map<String,Serializable> properties)

Send a file to a path.

Parameters:

ticket -

create - - true new file

path -

guid -

encoding -

mimeType -

aspects - - full qualified names of the aspects that this file is associated with.

props - - map of full qualified names and property values.

Returns:

an open output steam for writing content

createDirectory

void createDirectory(String ticket,
                   String path,
                   String guid,
                   Set<String> aspects,
                   Map<String,Serializable> properties)

Create a new directory.

Parameters:

ticket -

path -

guid - The GUID (Version) of the directory to be created.

updateDirectory

void updateDirectory(String ticket,
                   String path,
                   String guid,
                   Set<String> aspects,
                   Map<String,Serializable> properties)

Set the Guid (Version) on a directory.

Parameters:

ticket -

path -

guid -

delete

void delete(String ticket,
          String path)

Delete a file or directory.

Parameters:

ticket -

path -

getListing

List<FileDescriptor> getListing(String ticket,
                              String path)

Get a listing of a directory.

Parameters:

ticket -

path -

Returns:

The listing in name sorted order.