org.rhq.core.util.updater

Class DeploymentProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.rhq.core.util.updater.DeploymentProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class DeploymentProperties
extends Properties

Provides properties that define metadata about a deployment. Use the factory method loadFromFile(File) to load deployment properties files. Use saveToFile(File) to store deployment properties.

Author:

John Mazzitelli

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
DeploymentProperties() Creates an empty set of deployment properties.
DeploymentProperties(int deploymentId, String bundleName, String bundleVersion, String description) Deprecated. use DeploymentProperties(int, String, String, String, DestinationComplianceMode). This constructor sets the compliance mode to DestinationComplianceMode.full.
DeploymentProperties(int deploymentId, String bundleName, String bundleVersion, String description, DestinationComplianceMode destinationCompliance) Convenience constructor whose parameters are all the required values that this object needs.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBundleName()
String	getBundleVersion()
int	getDeploymentId() This returns a deployment ID that identifies a known deployment.
String	getDescription()
DestinationComplianceMode	getDestinationCompliance() Returns the compliance mode of the destination.
boolean	getManageRootDir() Deprecated. use getDestinationCompliance()
boolean	isValid() Returns true if this object has everything required to define a valid deployment.
static DeploymentProperties	loadFromFile(File file)
void	saveToFile(File file)
void	setBundleName(String name)
void	setBundleVersion(String version)
void	setDeploymentId(int id)
void	setDescription(String description)
void	setDestinationCompliance(DestinationComplianceMode compliance)
void	setManageRootDir(boolean willManageRootDir) Deprecated. use setDestinationCompliance(DestinationComplianceMode) instead

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeploymentProperties

public DeploymentProperties()

Creates an empty set of deployment properties. The caller must ensure valid deployment properties are set later.

DeploymentProperties

@Deprecated
public DeploymentProperties(int deploymentId,
                               String bundleName,
                               String bundleVersion,
                               String description)

Deprecated. use DeploymentProperties(int, String, String, String, DestinationComplianceMode). This constructor sets the compliance mode to DestinationComplianceMode.full.

Convenience constructor whose parameters are all the required values that this object needs.

Parameters:

deploymentId - see getDeploymentId()

bundleName - see getBundleName()

bundleVersion - see getBundleVersion()

description - see getDescription()

DeploymentProperties

public DeploymentProperties(int deploymentId,
                    String bundleName,
                    String bundleVersion,
                    String description,
                    DestinationComplianceMode destinationCompliance)

Convenience constructor whose parameters are all the required values that this object needs.

Parameters:

deploymentId - see getDeploymentId()

bundleName - see getBundleName()

bundleVersion - see getBundleVersion()

description - see getDescription()

destinationCompliance - see getDestinationCompliance()

Method Detail

loadFromFile

public static DeploymentProperties loadFromFile(File file)
                                         throws Exception

Throws:

Exception

isValid

public boolean isValid()

Returns true if this object has everything required to define a valid deployment.

Returns:

true if this is valid

saveToFile

public void saveToFile(File file)
                throws Exception

Throws:

Exception

getDeploymentId

public int getDeploymentId()

This returns a deployment ID that identifies a known deployment. If the deployment is not yet known (that is, its going to be a new deployment added to the system), this will typically return 0.

Returns:

an identifier that uniquely identifies this particular deployment.

setDeploymentId

public void setDeploymentId(int id)

getBundleName

public String getBundleName()

Returns:

the name of the bundle for this deployment

setBundleName

public void setBundleName(String name)

getBundleVersion

public String getBundleVersion()

Returns:

the version of the bundle for this deployment

setBundleVersion

public void setBundleVersion(String version)

getDescription

public String getDescription()

Returns:

the description of this deployment

setDescription

public void setDescription(String description)

getManageRootDir

@Deprecated
public boolean getManageRootDir()

Deprecated. use getDestinationCompliance()

Note that as of RHQ 4.9.0, this attribute is deprecated. There is an attempt made to handle reading the old version of the attribute:

1. if "bundle.destination.compliance" attribute is set, base the value on it. If the compliance is "full" this method returns true, otherwise it returns false.
2. if "manage.root.dir" attribute is set, base the return value on it (this handles the previous behavior).
3. if none of the above attributes is set, return the default value of the deprecated manageRootDir attribute, which is true.

Returns:

the flag to indicate if the entire root directory content is to be managed. If there is no property, this method returns a default of true

setManageRootDir

@Deprecated
public void setManageRootDir(boolean willManageRootDir)

Deprecated. use setDestinationCompliance(DestinationComplianceMode) instead

As of RHQ 4.9.0, this is equivalent to setDestinationCompliance(willManageRootDir ? DestinationComplianceMode.full : DestinationComplianceMode.filesAndDirectories).

Parameters:

willManageRootDir - whether to manage the root directory

getDestinationCompliance

public DestinationComplianceMode getDestinationCompliance()

Returns the compliance mode of the destination. This is a required attribute.

Since:

4.9.0

setDestinationCompliance

public void setDestinationCompliance(DestinationComplianceMode compliance)