com.ibm.datapower.wamt.dataAPI
Interface StoredDeploymentPolicy

All Superinterfaces:
Persistable, StoredDeployablePolicy
All Known Implementing Classes:
StoredDeploymentPolicyImpl

public interface StoredDeploymentPolicy
extends StoredDeployablePolicy

The information that must be maintained and persisted for a DeploymentPolicy that is used in deploying a managed domain configuration. This includes the policy deployment source, and the policy type. 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.

It is a container for all the versions of this StoredDeploymentPolicy. Each successful domain deployment should persist a domain version element and a corresponding deployment policy version in the repository. The persisted domain version number should be the same as the deployment version number. The version number is used by the manager to correlate the domain version to the policy version.

See Also:
StoredDeploymentPolicy

Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 StoredDomain getDomain()
          Gets the name of the StoredDomain that contains this StoredDeploymentPolicy.
 long getLastModifiedOfDeployedSource()
          Gets the "last modified" timestamp of the policy source persisted on this deployment policy object.
 java.lang.String getPolicyDomainName()
          Gets the domain name on the StoredDeploymentPolicy.
 java.lang.String getPolicyName()
          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.
 DeploymentPolicyType getPolicyType()
          Gets the PolicyType on this DeploymentPolicy object.
 URLSource getPolicyURL()
          Returns the domain configuration source that was persisted on this DeploymentPolicy object.
 java.lang.String getPrimaryKey()
          Returns the Unique identifier for this StoredDeploymentPolicy.
 StoredDeploymentPolicyVersion getVersion(int versionNumber)
          Gets the DeploymentPolicyVersion object with the specified version number.
 void setLastModifiedOfDeployedSource(long synchDate)
          Persists the timestamp of the deployed policy source at the time of domain configuration deployment.
 void setPolicyDomainName(java.lang.String policyDomainName)
          Sets the Domain name that is to find the deployment domain within the configuration URLSource which will be deployed on the device
 
Methods inherited from interface com.ibm.datapower.wamt.dataAPI.StoredDeployablePolicy
delete, getHighestVersionNumber, getVersions
 

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

getDomain

StoredDomain getDomain()
Gets the name of the StoredDomain that contains this StoredDeploymentPolicy. There is only one DeploymentPolicy persisted for each Domain. This name should be human-consumable. This is exposed by DeploymentPolicy.getDomain()

Returns:
StoredDomain return the containing StoredDomain object.
See Also:
StoredDomain

getPrimaryKey

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

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

getPolicyDomainName

java.lang.String getPolicyDomainName()
Gets the domain name on the StoredDeploymentPolicy. It is used as an index into the configuration source. It is called by DeploymentPolicy.getPolicyDomainName().

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(URLSource, String, String)

setPolicyDomainName

void setPolicyDomainName(java.lang.String policyDomainName)
Sets the Domain name that is to find the deployment domain within the configuration URLSource which will be deployed on the device

Parameters:
policyDomainName - domain name that is used index into the configuration source and point to the domain within the configuration source.
See Also:
getPolicyDomainName()

getPolicyURL

URLSource getPolicyURL()
Returns the domain configuration source that was persisted on this DeploymentPolicy object. This can be set by invoking

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

Returns:
the configuration URLSource for this StoredDeploymentPolicy

getPolicyType

DeploymentPolicyType getPolicyType()
Gets the PolicyType on this DeploymentPolicy object. This data is for internal use and is not exposed via the clientAPI

Returns:
the Deployment Policy Type on this object
See Also:
DeploymentPolicyType.EXPORT, DeploymentPolicyType.XML, DeploymentPolicyType.NONE

getPolicyName

java.lang.String getPolicyName()
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.

Returns:
the policy name set on this StoredDeploymentPolicy to index into the persisted configuration source

setLastModifiedOfDeployedSource

void setLastModifiedOfDeployedSource(long synchDate)
Persists the timestamp of the deployed policy source at the time of domain configuration deployment. This persisted timestamp can be used later to compare with timestamp on the policy source to determine if the policy source has changed. If the policy source has a more recent timestamp than the persisted timestamp, the manager may synchronize the domain. This is used internally by the clientAPI.

Parameters:
synchDate - time stamp on the configuration source file
See Also:
getLastModifiedOfDeployedSource()

getLastModifiedOfDeployedSource

long getLastModifiedOfDeployedSource()
Gets the "last modified" timestamp of the policy source persisted on this deployment policy object. This retrieved timestamp can be used to determine if the policy source has a more recent timestamp than the persisted timestamp. If the policy source has a more recent timestamp than the persisted timestamp, the manager may synchronize the domain if other conditions are also met. This is for internal use only.

Returns:
timestamp on the StoredDeploymentPolicy
See Also:
setLastModifiedOfDeployedSource(long)

getVersion

StoredDeploymentPolicyVersion getVersion(int versionNumber)
Gets the DeploymentPolicyVersion object with the specified version number. This is invoked by DeploymentPolicy.getVersion(int)

Returns:
StoredDeploymentPolicyVersion if found, otherwise return


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