|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.dataAPI.local.filesystem.StoredDeploymentPolicyVersionImpl
public class StoredDeploymentPolicyVersionImpl
Holds all information related to a deployment policy version that can be used during domain configuration deployment to a DataPower device. The policy name, the domain name, policy type, and deployment policy image information is persisted in the local file system. Below is a sample of a deployment policy versions element contained within a deploymentPolicy element.
<deploymentPolicy xmi:id="DPPolicy_0" highestVersion="1" policyName="lathas" SynchDate="1276806718906" SourceURL="file:///C:/DataPower2010/DatapowerTest/lathasdomain.zip" policyType="EXPORT" domainName="lathas"> <versions xmi:id="DPPolicyVersion_0" timeCreatedInManager="1276807490921" userComment="Version generated from Domain.deployConfiguration()" versionImageFileLocation="Blob9198776463933681699.bin" versionNumber="1" policyType="EXPORT" domainName="lathas" policyName="lathas"/> </deploymentPolicy>
Field Summary |
---|
Fields inherited from interface com.ibm.datapower.wamt.dataAPI.StoredDeploymentPolicyVersion |
---|
COPYRIGHT_2009_2010, SCM_REVISION |
Method Summary | |
---|---|
void |
delete()
Deletes the version from the repository. |
Blob |
getBlob()
Gets the binary image for this version. |
StoredDeploymentPolicy |
getDeploymentPolicy()
Returns the persisted StoredDeploymentPolicy that contains this version. |
StoredDomain |
getDomain()
|
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. |
java.util.Date |
getTimestamp()
Gets the timestamp that signifies when the StoredVersion was created in the repository. |
java.lang.String |
getUserComment()
Gets the user comment that corresponds to this version. |
java.lang.Object |
getVersionedObject()
Gets a reference to the object that this StoredVersion describes. |
int |
getVersionNumber()
Gets the version number that this StoredVersion object represents. |
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. |
void |
setPolicyType(DeploymentPolicyType policyType)
|
void |
setUserComment(java.lang.String comment)
This method is used to set the user comment that can be later retrieved via StoredVersion.getUserComment() . |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getPrimaryKey()
StoredDeploymentPolicyVersion
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
.
getPrimaryKey
in interface Persistable
getPrimaryKey
in interface StoredDeploymentPolicyVersion
,
StoredDeploymentPolicy.getPrimaryKey()
public int getVersionNumber()
StoredVersion
setVersionNumber(int)
method. The combination of version number and Object reference forms the
primary key for a StoredVersion object in the repository.
getVersionNumber
in interface StoredVersion
public java.lang.Object getVersionedObject()
StoredVersion
getVersionedObject
in interface StoredVersion
public java.util.Date getTimestamp()
StoredVersion
setTimestamp(Date)
method. The timestamp is accessed from
DomainVersion.getTimestamp()
,
FirmwareVersion.getTimestamp()
, and
DeploymentPolicyVersion.getTimestamp()
getTimestamp
in interface StoredVersion
public java.lang.String getUserComment()
StoredVersion
DomainVersion.getUserComment()
,
FirmwareVersion.getUserComment()
,
DeploymentPolicyVersion.getUserComment()
getUserComment
in interface StoredVersion
StoredVersion.setUserComment(String)
public void setUserComment(java.lang.String comment) throws DatastoreException
StoredVersion
StoredVersion.getUserComment()
. Calling this method will cause the
comment to be written to the repository. The comment is set by invoking
DomainVersion.setUserComment(String)
,
FirmwareVersion.setUserComment(String)
,
DeploymentPolicyVersion.setUserComment(String)
setUserComment
in interface StoredVersion
comment
- the user-defined comment to attach to this StoredVersion. It
may have reference to a new function, bug fix, change
management or problem management ticket, etc. This is a
freeform field of unlimited length.StoredVersion.getUserComment()
public Blob getBlob()
StoredVersion
DomainVersion.getBlob()
,
FirmwareVersion.getBlob()
,
DeploymentPolicyVersion.getBlob()
The image is set by the clientAPI and store by the repository, so
there is no setBlob
method.
getBlob
in interface StoredVersion
public void delete()
StoredVersion
delete
in interface StoredVersion
public void setPolicyDomainName(java.lang.String policyDomain)
StoredDeploymentPolicyVersion
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.
setPolicyDomainName
in interface StoredDeploymentPolicyVersion
policyDomain
- the policy domain name that serves as an "index" into the
configuration source, and points
to the domain within the configuration source blob.StoredVersion.getVersionedObject()
public StoredDeploymentPolicy getDeploymentPolicy()
StoredDeploymentPolicyVersion
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.
getDeploymentPolicy
in interface StoredDeploymentPolicyVersion
public StoredDomain getDomain()
public DeploymentPolicyType getPolicyType()
StoredDeploymentPolicyVersion
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,
getPolicyType
in interface StoredDeploymentPolicyVersion
StoredVersion.getVersionedObject()
,
DeploymentPolicyType.XML
,
DeploymentPolicyType.EXPORT
public void setPolicyName(java.lang.String policyName)
StoredDeploymentPolicyVersion
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,
setPolicyName
in interface StoredDeploymentPolicyVersion
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.DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String)
,
StoredVersion.getVersionedObject()
public java.lang.String getPolicyName()
StoredDeploymentPolicyVersion
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,
getPolicyName
in interface StoredDeploymentPolicyVersion
StoredVersion.getVersionedObject()
,
DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String)
public void setPolicyType(DeploymentPolicyType policyType)
public java.lang.String getPolicyDomainName()
StoredDeploymentPolicyVersion
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.
getPolicyDomainName
in interface StoredDeploymentPolicyVersion
DeploymentPolicy.setPolicyExport(com.ibm.datapower.wamt.clientAPI.URLSource, String, String)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |