org.rhq.core.util.updater

Class DeploymentData

java.lang.Object

org.rhq.core.util.updater.DeploymentData

public class DeploymentData
extends Object

Data that describes a particular deployment. In effect, this provides the data needed to fully deploy something.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
DeploymentData(DeploymentProperties deploymentProps, File sourceDir, File destinationDir, Map<File,File> rawFiles, Set<File> rawFilesToRealize, Map<File,File> zipFiles, Map<File,Pattern> zipEntriesToRealizeRegex, TemplateEngine templateEngine, Pattern ignoreRegex, Map<File,Boolean> zipsExploded) Constructor that prepares this object with the data that is necessary in order to deploy archive/file content a destination directory.
DeploymentData(DeploymentProperties deploymentProps, Set<File> zipFiles, Map<File,File> rawFiles, File sourceDir, File destinationDir, Map<File,Pattern> zipEntriesToRealizeRegex, Set<File> rawFilesToRealize, TemplateEngine templateEngine, Pattern ignoreRegex, boolean manageRootDir, Map<File,Boolean> zipsExploded) Deprecated. use {@link #DeploymentData(DeploymentProperties, File, File, Map, Set, Map, Map, TemplateEngine, Pattern, Map)
DeploymentData(DeploymentProperties deploymentProps, Set<File> zipFiles, Map<File,File> rawFiles, File sourceDir, File destinationDir, Map<File,Pattern> zipEntriesToRealizeRegex, Set<File> rawFilesToRealize, TemplateEngine templateEngine, Pattern ignoreRegex, Map<File,Boolean> zipsExploded) Deprecated. use {@link #DeploymentData(DeploymentProperties, File, File, Map, Set, Map, Map, TemplateEngine, Pattern, Map)

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentProperties	getDeploymentProps()
File	getDestinationDir()
Pattern	getIgnoreRegex()
Map<File,File>	getRawFiles()
Set<File>	getRawFilesToRealize()
File	getSourceDir()
TemplateEngine	getTemplateEngine()
Map<File,Pattern>	getZipEntriesToRealizeRegex()
Set<File>	getZipFiles() Deprecated. Use getZipFilesMap() to fully support the destinationDir attribute on archive deployment.
Map<File,File>	getZipFilesMap()
Map<File,Boolean>	getZipsExploded()
boolean	isManageRootDir() Deprecated. use getDeploymentProps().getDestinationCompliance().

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentData

@Deprecated
public DeploymentData(DeploymentProperties deploymentProps,
                         Set<File> zipFiles,
                         Map<File,File> rawFiles,
                         File sourceDir,
                         File destinationDir,
                         Map<File,Pattern> zipEntriesToRealizeRegex,
                         Set<File> rawFilesToRealize,
                         TemplateEngine templateEngine,
                         Pattern ignoreRegex,
                         boolean manageRootDir,
                         Map<File,Boolean> zipsExploded)

Deprecated. use {@link #DeploymentData(DeploymentProperties, File, File, Map, Set, Map, Map, TemplateEngine, Pattern, Map)

Equivalent to calling #DeploymentData(DeploymentProperties, Map, Map, File, File, Map, Set, TemplateEngine, Pattern, boolean, Map) with the zipFiles Map having as a keySet the Set of Files provided here, and null values for each Map entry. Also makes a call to to DeploymentProperties.setManageRootDir(boolean).

DeploymentData

@Deprecated
public DeploymentData(DeploymentProperties deploymentProps,
                         Set<File> zipFiles,
                         Map<File,File> rawFiles,
                         File sourceDir,
                         File destinationDir,
                         Map<File,Pattern> zipEntriesToRealizeRegex,
                         Set<File> rawFilesToRealize,
                         TemplateEngine templateEngine,
                         Pattern ignoreRegex,
                         Map<File,Boolean> zipsExploded)

Deprecated. use {@link #DeploymentData(DeploymentProperties, File, File, Map, Set, Map, Map, TemplateEngine, Pattern, Map)

Equivalent to calling #DeploymentData(DeploymentProperties, Map, Map, File, File, Map, Set, TemplateEngine, Pattern, Map) with the zipFiles map having as a keySet the Set of Files provided here, and null values for each Map entry.

Since:

4.9.0

DeploymentData

public DeploymentData(DeploymentProperties deploymentProps,
              File sourceDir,
              File destinationDir,
              Map<File,File> rawFiles,
              Set<File> rawFilesToRealize,
              Map<File,File> zipFiles,
              Map<File,Pattern> zipEntriesToRealizeRegex,
              TemplateEngine templateEngine,
              Pattern ignoreRegex,
              Map<File,Boolean> zipsExploded)

Constructor that prepares this object with the data that is necessary in order to deploy archive/file content a destination directory.

Parameters:

deploymentProps - metadata about this deployment

destinationDir - the root directory where the content is to be deployed

sourceDir - the root directory where the source files (zips and raw files) are located

rawFiles - files that are to be copied into the destination directory - the keys are the current locations of the files, the values are where the files should be copied (the values may be relative in which case they are relative to destDir and can have subdirectories and/or a different filename than what the file is named currently)

rawFilesToRealize - identifies the raw files that need to be realized; note that each item in this set must match a key to a rawFiles entry

zipFiles - the archives containing the content to be deployed - the keys are the current locations of the zip files and the values are the destinationDir entries. A null value in the Map entry indicates the zip is to be placed in destinationDir.

zipEntriesToRealizeRegex - the patterns of files (whose paths are relative to destDir) that must have replacement variables within them replaced with values obtained via the given template engine. The key is the name of the zip file that the regex must be applied to - in other words, the regex value is only applied to relative file names as found in their associated zip file.

templateEngine - if one or more filesToRealize are specified, this template engine is used to determine the values that should replace all replacement variables found in those files.

ignoreRegex - the files/directories to ignore when updating an existing deployment

zipsExploded - if not null, this is a map keyed on zip files whose values indicate if the zips should be exploded (true) or remain compressed after the deployment is finished (false). If a zip file is not found in this map, true is the default.

Since:

4.11

Method Detail

getDeploymentProps

public DeploymentProperties getDeploymentProps()

getZipFiles

@Deprecated
public Set<File> getZipFiles()

Deprecated. Use getZipFilesMap() to fully support the destinationDir attribute on archive deployment.

Returns:

The Set of zipFiles

getZipFilesMap

public Map<File,File> getZipFilesMap()

getRawFiles

public Map<File,File> getRawFiles()

getDestinationDir

public File getDestinationDir()

getSourceDir

public File getSourceDir()

getZipEntriesToRealizeRegex

public Map<File,Pattern> getZipEntriesToRealizeRegex()

getRawFilesToRealize

public Set<File> getRawFilesToRealize()

getTemplateEngine

public TemplateEngine getTemplateEngine()

getIgnoreRegex

public Pattern getIgnoreRegex()

isManageRootDir

@Deprecated
public boolean isManageRootDir()

Deprecated. use getDeploymentProps().getDestinationCompliance().

As of RHQ 4.9.0, this calls getDeploymentProps().getManageRootDir()

getZipsExploded

public Map<File,Boolean> getZipsExploded()