com.ibm.datapower.wamt.dataAPI
Interface StoredDeploymentPolicyVersion

All Superinterfaces:
Persistable, StoredVersion
All Known Implementing Classes:
StoredDeploymentPolicyVersionImpl

public interface StoredDeploymentPolicyVersion
extends StoredVersion

The related information that must be maintained and persisted for a DeploymentPolicyVersion. It is used during domain configuration deployment to a DataPower device. The policy name, the domain name, policy type, and configuration source image information are persisted in the repository.

Note: The deployment policy version element is contained by a deployment policy element in the WAMT.repository.xml file with the Local File System implementation.

The configuration source is a reference to a configuration blob from a device that should be deployed for this Domain. When using a configuration source, a domainName and a policy object name serve as an "index" into the source, pointing to the domain, and associated deployment policy within the configuration source blob.


Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 StoredDeploymentPolicy getDeploymentPolicy()
          Returns the persisted StoredDeploymentPolicy that contains this version.
 java.lang.String getPolicyDomainName()
          Gets the domain name on the StoredDeploymentPolicyVersion.
 java.lang.String getPolicyName()
          Gets the policy object name persisted on the StoredDeploymentPolicyVersion object.
 DeploymentPolicyType getPolicyType()
          Gets the DeploymentPolicyType on the StoredDeploymentPolicyVersion.
 java.lang.String getPrimaryKey()
          Returns Unique identifier for this StoredDeploymentPolicyVersion.
 void setPolicyDomainName(java.lang.String policyDomain)
          Sets the Policy Domain name on the StoredDeploymentPolicyVersion object which can be used along with the configuration source, domain name and policy object name during domain configuration deployment.
 void setPolicyName(java.lang.String policyName)
          Sets the policy object name on the StoredDeploymentPolicyVersion object which can be used along with the configuration source, domain name and policy object name during domain configuration deployment.
 
Methods inherited from interface com.ibm.datapower.wamt.dataAPI.StoredVersion
delete, getBlob, getTimestamp, getUserComment, getVersionedObject, getVersionNumber, setUserComment
 

Field Detail

COPYRIGHT_2009_2010

static final java.lang.String COPYRIGHT_2009_2010
See Also:
Constant Field Values

SCM_REVISION

static final java.lang.String SCM_REVISION
See Also:
Constant Field Values
Method Detail

getPrimaryKey

java.lang.String getPrimaryKey()
Returns Unique identifier for this StoredDeploymentPolicyVersion. This is invoked by DeploymentPolicyVersion.getPrimaryKey(). There is no setPrimaryKey exposed since it is managed by the dataAPI implementation.

Note: The Local File System implementation uses the unique identifier of the StoredDeploymentPolicy combined with the version number of this StoredDeploymentPolicyVersion.

Specified by:
getPrimaryKey in interface Persistable
Returns:
the unique identifier for this object
See Also:

, StoredDeploymentPolicy.getPrimaryKey()

getDeploymentPolicy

StoredDeploymentPolicy getDeploymentPolicy()
Returns the persisted StoredDeploymentPolicy that contains this version. This is invoked by DeploymentPolicyVersion.getDeploymentPolicy().

Note: For the Local File System implementation, the deploymentpolicy element contains version elements in the WAMT.repository.xml file.

Returns:
instance of StoredDeploymentPolicy which holds all the related versions

getPolicyDomainName

java.lang.String getPolicyDomainName()
Gets the domain name on the StoredDeploymentPolicyVersion. It is used as an index into the configuration source. A version is created with each domain deployment. It is called by DeploymentPolicyVersion.getPolicyDomainName().

Note: For the Local File System implementation, the policy domain name is stored as an attribute on the policydeployment version element.

Returns:
the policy domain name that serves as an "index" into the configuration source, and points to the domain within the domain configuration blob.
See Also:
DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String)

getPolicyType

DeploymentPolicyType getPolicyType()
Gets the DeploymentPolicyType on the StoredDeploymentPolicyVersion. It is used internally and cannot be set by users of the clientAPI.

Note: The policy type is an enumerated type which is stored as an attribute on the policydeployment version element in Local File System implementation,

Returns:
the persisted deployment policy type on the DeploymentPolicyVersion
See Also:
StoredVersion.getVersionedObject(), DeploymentPolicyType.XML, DeploymentPolicyType.EXPORT

getPolicyName

java.lang.String getPolicyName()
Gets the policy object name persisted on the StoredDeploymentPolicyVersion object. This is exposed by DeploymentPolicyVersion.getPolicyName().

Note: The policy name is stored as an attribute on the policydeployment version element by the Local File System implementation,

Returns:
the policy name that is used along with the domain name to index into the configuration source and point to the deployment policy and associated domain within the configuration source.
See Also:
StoredVersion.getVersionedObject(), DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String)

setPolicyName

void setPolicyName(java.lang.String policyName)
Sets the policy object name on the StoredDeploymentPolicyVersion object which can be used along with the configuration source, domain name and policy object name during domain configuration deployment. This is invoked internally by by clientAPI when a domain source configuration is deployed.

Note: The policy name is stored as an attribute on the policydeployment version element by the Local File System implementation,

Parameters:
policyName - the policy name that is used along with the domain name to index into the configuration source and points to the domain, and associated deployment policy within the configuration source.
See Also:
DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String), StoredVersion.getVersionedObject()

setPolicyDomainName

void setPolicyDomainName(java.lang.String policyDomain)
Sets the Policy Domain name on the StoredDeploymentPolicyVersion object which can be used along with the configuration source, domain name and policy object name during domain configuration deployment.

Note: The policy domain name is stored as an attribute on the policydeployment version element by the Local File System implementation.

Parameters:
policyDomain - the policy domain name that serves as an "index" into the configuration source, and points to the domain within the configuration source blob.
See Also:
StoredVersion.getVersionedObject()


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.