org.alfresco.deployment.impl.server

Class Deployment

java.lang.Object

org.alfresco.deployment.impl.server.Deployment

All Implemented Interfaces:

Serializable, Iterable<DeployedFile>

public class Deployment
extends Object
implements Iterable<DeployedFile>, Serializable

This is a record of an ongoing deployment. A collection of Deployed Files

Author:

britt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Deployment(String ticket, String targetName, String storeName, int version) Create a new Deployment record

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Mark the Deployment as aborting.
void	add(DeployedFile file) Log that a file has been deployed.
void	commit() And commit is now in progress.
String	getAuthoringStoreName() Get the name of the store being deployed.
int	getAuthoringVersion() Get the version being deployed.
DeploymentState	getState() Get the state of the deployment.
boolean	isMetaError() Has there been an error detected with meta-data?
boolean	isStale(long timeout) Is the deployment stale.
Iterator<DeployedFile>	iterator() get the iterator for the files contained within this deployment.
void	prepare() Prepare this deployment.
void	setAuthoringStoreName(String storeName) Get the store name being deployed.
void	setAuthoringVersion(int version) Set the authoring version (of the deployment from the authoring server)
void	setDeploymentState(DeploymentState state) Set the state of a deployment
void	setMetaError(boolean metaError)

Methods inherited from class java.lang.Object

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

Constructor Detail

Deployment

public Deployment(String ticket,
          String targetName,
          String storeName,
          int version)
           throws IOException

Create a new Deployment record

Parameters:

ticket - the ticket for this deployment.

targetName - the name of the deployment target

storeName - the name of the source store on the authoring cluster.

version - the snapshot version (from the authoring cluster) being deployed.

Throws:

IOException

Method Detail

add

public void add(DeployedFile file)
         throws IOException

Log that a file has been deployed.

Parameters:

file -

Throws:

IOException

prepare

public void prepare()
             throws IOException,
                    DeploymentException

Prepare this deployment.

Throws:

IOException

DeploymentException

commit

public void commit()
            throws IOException

And commit is now in progress.

Throws:

IOException

abort

public void abort()
           throws IOException

Mark the Deployment as aborting.

Throws:

IOException

isStale

public boolean isStale(long timeout)

Is the deployment stale.

Parameters:

timeout -

Returns:

iterator

public Iterator<DeployedFile> iterator()

get the iterator for the files contained within this deployment.

Specified by:

iterator in interface Iterable<DeployedFile>

getState

public DeploymentState getState()

Get the state of the deployment.

Returns:

setDeploymentState

public void setDeploymentState(DeploymentState state)

Set the state of a deployment

Parameters:

state -

setMetaError

public void setMetaError(boolean metaError)

isMetaError

public boolean isMetaError()

Has there been an error detected with meta-data?

Returns:

setAuthoringVersion

public void setAuthoringVersion(int version)

Set the authoring version (of the deployment from the authoring server)

Parameters:

authoring - version

getAuthoringVersion

public int getAuthoringVersion()

Get the version being deployed. The version relates to the authoring cluster.

Returns:

setAuthoringStoreName

public void setAuthoringStoreName(String storeName)

Get the store name being deployed. The store name is from the authoring cluster.

Parameters:

storeName -

getAuthoringStoreName

public String getAuthoringStoreName()

Get the name of the store being deployed. The store name is from the authoring cluster.

Returns:

the name of the store on the authoring cluster