org.codehaus.cargo.container.spi.packager
Class AbstractDirectoryPackager

java.lang.Object
  org.codehaus.cargo.util.log.LoggedObject
      org.codehaus.cargo.container.spi.packager.AbstractDirectoryPackager

All Implemented Interfaces:

Packager, org.codehaus.cargo.util.log.Loggable

public abstract class AbstractDirectoryPackager
extends org.codehaus.cargo.util.log.LoggedObject
implements Packager

Package a container distribution and its local configuration in a directory.

Version:

$Id: Container.java 886 2006-02-28 12:40:47Z vmassol $

Constructor Summary

AbstractDirectoryPackager(java.lang.String targetDirectory)

Method Summary

protected abstract java.util.List	getConfigurationExclusions()
protected abstract java.util.List	getDistributionExclusions()
protected org.codehaus.cargo.util.FileHandler	getFileHandler()
java.lang.String	getTargetDirectory()
void	packageContainer(InstalledLocalContainer container) Package an installed container distribution and its local configuration in a single location.
protected void	setFileHandler(org.codehaus.cargo.util.FileHandler fileHandler)

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDirectoryPackager

public AbstractDirectoryPackager(java.lang.String targetDirectory)

Parameters:

targetDirectory - the directory where the container distribution and its local configuration will be packaged

Method Detail

getTargetDirectory

public java.lang.String getTargetDirectory()

Returns:

the directory where the container distribution and its local configuration will be packaged

getFileHandler

protected org.codehaus.cargo.util.FileHandler getFileHandler()

Returns:

the Cargo file utility class

setFileHandler

protected void setFileHandler(org.codehaus.cargo.util.FileHandler fileHandler)

Parameters:

fileHandler - the Cargo file utility class to use. This method is useful for unit testing with Mock objects as it can be passed a test file handler that doesn't perform any real file action.

packageContainer

public void packageContainer(InstalledLocalContainer container)

Package an installed container distribution and its local configuration in a single location.

Specified by:

packageContainer in interface Packager

Parameters:

container - the installed container to package

See Also:

Packager.packageContainer(org.codehaus.cargo.container.InstalledLocalContainer)

getDistributionExclusions

protected abstract java.util.List getDistributionExclusions()

Returns:

the list of distribution files (specified as Ant File patterns) which will not be present in the generated package. These files are files found in InstalledLocalContainer.getHome().

getConfigurationExclusions

protected abstract java.util.List getConfigurationExclusions()

Returns:

the list of configuration files (specified as Ant File patterns) which will not be present in the generated package. These files are files found in LocalConfiguration.getHome().