org.alfresco.deployment.impl.fsr

Class FileSystemDeploymentTarget

java.lang.Object

org.alfresco.deployment.impl.fsr.FileSystemDeploymentTarget

All Implemented Interfaces:

Serializable, DeploymentTarget

public class FileSystemDeploymentTarget
extends Object
implements Serializable, DeploymentTarget

This represents a target for deployment to a filesystem A file system deployment can only process a single deployment

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileSystemDeploymentTarget()

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 targetName, 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> props) Create a directory.
void	delete(String ticket, String path) Delete a file or directory.
DeploymentReceiverAuthenticator	getAuthenticator()
int	getCurrentVersion(String target, String storeName) Get the current version for this target and source Store
FileSystemReceiverService	getFileSystemReceiverService()
List<FileDescriptor>	getListing(String ticket, String path) Get a listing of a directory.
String	getMetaDataDirectory() Get the directory in which metadata
String	getName() Get the target name.
List<FSDeploymentRunnable>	getPostCommit()
List<FSDeploymentRunnable>	getPrepare()
String	getRootDirectory() Get the root directory.
void	init() initialise this target
boolean	isAutoFix()
boolean	isBusy()
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	setAuthenticator(DeploymentReceiverAuthenticator authenticator)
void	setAutoFix(boolean autoFix) tell this target to autofix data during validation
void	setBusy(boolean isBusy)
void	setFileSystemReceiverService(FileSystemReceiverService fileSystemReceiverService)
void	setMetaDataDirectory(String dir)
void	setName(String name) Set the target name.
void	setPostCommit(List<FSDeploymentRunnable> postCommit)
void	setPrepare(List<FSDeploymentRunnable> prepare)
void	setRootDirectory(String root)
void	updateDirectory(String ticket, String path, String guid, Set<String> aspects, Map<String,Serializable> props) Update a directory .
void	validate() Validate this target

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemDeploymentTarget

public FileSystemDeploymentTarget()

Method Detail

setAuthenticator

public void setAuthenticator(DeploymentReceiverAuthenticator authenticator)

getAuthenticator

public DeploymentReceiverAuthenticator getAuthenticator()

init

public void init()

initialise this target

getName

public String getName()

Get the target name.

Returns:

setName

public void setName(String name)

Set the target name.

getRootDirectory

public String getRootDirectory()

Get the root directory.

Returns:

setRootDirectory

public void setRootDirectory(String root)

setAutoFix

public void setAutoFix(boolean autoFix)

tell this target to autofix data during validation

Parameters:

autoFix -

isAutoFix

public boolean isAutoFix()

setFileSystemReceiverService

public void setFileSystemReceiverService(FileSystemReceiverService fileSystemReceiverService)

getFileSystemReceiverService

public FileSystemReceiverService getFileSystemReceiverService()

begin

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

Description copied from interface: DeploymentTarget

Start a new deployment.

Specified by:

begin in interface DeploymentTarget

Parameters:

targetName - 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.

prepare

public void prepare(String ticket)

Description copied from interface: DeploymentTarget

Signals that the deployment should be prepared.

Specified by:

prepare in interface DeploymentTarget

Parameters:

ticket - The deployment ticket.

abort

public void abort(String ticket)

Description copied from interface: DeploymentTarget

Signals that the deployment should be aborted and rolled back.

Specified by:

abort in interface DeploymentTarget

Parameters:

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

commit

public void commit(String ticket)

Description copied from interface: DeploymentTarget

Signals that the deployment is finished and should commit.

Specified by:

commit in interface DeploymentTarget

Parameters:

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

delete

public void delete(String ticket,
          String path)

Description copied from interface: DeploymentTarget

Delete a file or directory.

Specified by:

delete in interface DeploymentTarget

Parameters:

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

getListing

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

Description copied from interface: DeploymentTarget

Get a listing of a directory.

Specified by:

getListing in interface DeploymentTarget

Parameters:

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

Returns:

The listing in name sorted order.

createDirectory

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

Description copied from interface: DeploymentTarget

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.

Specified by:

createDirectory in interface DeploymentTarget

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

send

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

Description copied from interface: DeploymentTarget

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.

Specified by:

send in interface DeploymentTarget

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.

updateDirectory

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

Description copied from interface: DeploymentTarget

Update a directory .

Specified by:

updateDirectory in interface DeploymentTarget

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

validate

public void validate()

Validate this target

setBusy

public void setBusy(boolean isBusy)

isBusy

public boolean isBusy()

setPostCommit

public void setPostCommit(List<FSDeploymentRunnable> postCommit)

getPostCommit

public List<FSDeploymentRunnable> getPostCommit()

setPrepare

public void setPrepare(List<FSDeploymentRunnable> prepare)

getPrepare

public List<FSDeploymentRunnable> getPrepare()

getCurrentVersion

public int getCurrentVersion(String target,
                    String storeName)

Description copied from interface: DeploymentTarget

Get the current version for this target and source Store

Specified by:

getCurrentVersion in interface DeploymentTarget

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.

setMetaDataDirectory

public void setMetaDataDirectory(String dir)

getMetaDataDirectory

public String getMetaDataDirectory()

Get the directory in which metadata

Returns: