org.alfresco.deployment

Interface DeploymentTarget

All Known Implementing Classes:

FileSystemDeploymentTarget

public interface DeploymentTarget

The deployment target is the interface that is provided by deployment targets.

Author:

mrogers

See Also:

FileSystemDeploymentTarget, org.alfresco.deployment.impl.asr.AVMDeploymentTarget

Method Summary

Methods

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

Method Detail

begin

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

Start a new deployment.

Parameters:

target - The name of the target which is being deployed to.

storeName - the name of the store being deployed. (authoring instance)

version - the version of the store being deployed. (authoring instance)

user - The user name for authentication.

password - The password for authentication.

Returns:

A deployment ticket which uniquely identifies the deployment.

Throws:

DeploymentException - - unable to start a new deployment

prepare

void prepare(String ticket)
             throws DeploymentException

Signals that the deployment should be prepared.

Parameters:

ticket - The deployment ticket.

Throws:

DeploymentException

commit

void commit(String ticket)

Signals that the deployment is finished and should commit.

Parameters:

ticket - The deployment ticket, returned by an earlier call to 'begin'.

abort

void abort(String ticket)

Signals that the deployment should be aborted and rolled back.

Parameters:

ticket - The deployment ticket, returned by an earlier call to 'begin'.

send

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

Send a file to a path.
The file may either be new or may be an update.
Implementations should also deal with the case where a directory becomes a file. If a file is created via this method then it should overwrite any existing directory on the same path.

Parameters:

ticket - The deployment ticket, returned by an earlier call to 'begin'

create - - true - create a new file, false update an existing file.

path - path of the new file

guid - unique identifier for this particular version of the file

encoding - the encoding of the file

mimeType - the mime type of the file

aspects - aspects to apply to the file

props - properties.

Returns:

an open output stream to receive content.

Throws:

DeploymentException - - unable to send, deployment should be aborted

createDirectory

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

Create a directory.
Implementations should also deal with the case where a file becomes a directory. If a directory is created via this method then it should overwrite any existing file on the same path.

Parameters:

ticket - the deployment ticket, returned by an earlier call to 'begin'

path - path of the new file

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

aspects - aspects to apply to the new directory

props - properties for the new directory

Throws:

DeploymentException - - unable to get the listing, deployment should be aborted

updateDirectory

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

Update a directory .

Parameters:

ticket - the deployment ticket, returned by an earlier call to 'begin'

path - path of the new file

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

aspects - aspects to apply to the new directory

props - properties for the new directory

Throws:

DeploymentException - - unable to set the GUID, deployment should be aborted

delete

void delete(String ticket,
          String path)
            throws DeploymentException

Delete a file or directory.

Parameters:

ticket - the deployment ticket, returned by an earlier call to 'begin'

path -

Throws:

DeploymentException - - unable to delete, deployment should be aborted

getListing

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

Get a listing of a directory.

Parameters:

ticket - the deployment ticket, returned by an earlier call to 'begin'

path -

Returns:

The listing in name sorted order.

Throws:

DeploymentException - - unable to get the listing, deployment should be aborted

getCurrentVersion

int getCurrentVersion(String target,
                    String storeName)

Get the current version for this target and source Store

Parameters:

target -

storeName - Returns the current version (authoring version), 0 means no version has been deployed, -1 means the version is unknown or not implemented by this target.