|
|||||||||||
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.StoredDomainImpl
public class StoredDomainImpl
The information that must be persisted for a StoredDomain on a DataPower device. This includes the Domain name, the device the domain resides on, synchronization mode, configuration source and the associated deployment policy. It is a container for all the StoredDomainVersions that are persisted in the local file system. When a domain is created an empty deploymentpolicy object is also created and persisted. Below is a sample domain element
<domains xmi:id="DPDomain_0" highestVersion="1" name="lathas" SourceURL="device://9.42.112.79/latha" SynchDate="0" OutOfSynch="false" checkVersionSynch="false" quiesceTimeout="60" SyncMode="MANUAL"> ... </domains>
Field Summary |
---|
Fields inherited from interface com.ibm.datapower.wamt.dataAPI.StoredDomain |
---|
COPYRIGHT_2009_2010, SCM_REVISION |
Constructor Summary | |
---|---|
StoredDomainImpl(java.util.Hashtable allDomains,
StoredDevice device,
java.lang.String domainName)
|
Method Summary | |
---|---|
void |
add(StoredTag tag)
Add a tag to the domain. |
void |
addDomainPolicy(StoredDeploymentPolicyImpl domainPolicy)
|
void |
addVersion(StoredDomainVersion version)
Add a new StoredDomainVervion to this StoredDomain |
void |
delete()
Deletes this StoredDeployableConfiguration. |
StoredDeploymentPolicy |
getDeploymentPolicy()
Gets the Deployment Policy on this StoredDomain. |
StoredDevice |
getDevice()
Note: In the Local File System implementation the domain element is contained within the device element on which the domain resides. |
int |
getHighestVersionNumber()
Returns the highest version number that has EVER been used for a version of this object. |
long |
getLastModifiedOfDeployedSource()
Internal use only. |
java.lang.String |
getName()
Note: The Local File System implementation combines the domain name with the serial number of the containing StoredDevice
as the unique identifier of this object. |
boolean |
getOutOfSynch()
Internal Use Only Gets the value of the OutOfSynch attribute on this StoreDomain. |
java.lang.String |
getPrimaryKey()
Note: The Local File System uses The name of this StoredDomain
combined with the Device primaryKey as the the unique identifier for this object |
int |
getQuiesceTimeout()
Gets the persisted timeout value for quiescing a domain on the DataPower device. |
URLSource |
getSourceURL()
Gets the configuration source location where the configuration is stored. |
DomainSynchronizationMode |
getSynchMode()
Gets the Synchronization Mode on this StoredDomain. |
StoredTag[] |
getTags()
Gets the tags for this domain. |
StoredVersion[] |
getVersions()
Returns the versions of the specified StoredDeployableConfiguration from the repository. |
void |
remove(StoredTag tag)
Remove the tags for this domain. |
void |
removeTags()
Remove all tags for this domain. |
void |
setLastModifiedOfDeployedSource(long synchDate)
Note: The Local File System persists time as an attribute on domains element. |
void |
setOutOfSynch(boolean outOfSynch)
Internal use only Sets the value of the OutOfSynch attribute on the StoreDomain. |
void |
setQuiesceTimeout(int timeout)
Sets the timeout value for quiescing a domain on the DataPower device before configuration deployment. |
void |
setSourceURL(URLSource urlSource)
Sets the Configuration source on this StoredDomain. |
void |
setSynchMode(DomainSynchronizationMode synchMode)
Sets the Synchronization Mode on this StoredDomain to AUTO or MANUAL. |
void |
updateDevice()
Non-interface method to add this Domain to a DeviceImpls list of managed domains. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StoredDomainImpl(java.util.Hashtable allDomains, StoredDevice device, java.lang.String domainName) throws AlreadyExistsInRepositoryException
Method Detail |
---|
public void addDomainPolicy(StoredDeploymentPolicyImpl domainPolicy) throws DatastoreException
public void delete() throws DatastoreException, NotEmptyInRepositoryException
StoredDeployableConfiguration
Device.removeManagedDomain(String)
Note: The Local File System implementation
clears the StoredDomain object and removes the element from the WAMT.repository.xml file.
It does not remove any contained elements. The logic to remove the contained elements is
handled in the clientAPI
.
delete
in interface StoredDeployableConfiguration
public java.lang.String getName()
Note: The Local File System implementation combines the domain name with the serial number of the containing StoredDevice
as the unique identifier of this object.
getName
in interface StoredDomain
StoredDomain.getPrimaryKey()
public java.lang.String getPrimaryKey()
Note: The Local File System uses The name of this StoredDomain
combined with the Device
primaryKey as the the unique identifier for this object
getPrimaryKey
in interface Persistable
getPrimaryKey
in interface StoredDomain
public StoredDevice getDevice()
Note: In the Local File System implementation the domain element is contained within the device element on which the domain resides.
getDevice
in interface StoredDomain
public void updateDevice()
public void addVersion(StoredDomainVersion version) throws AlreadyExistsInRepositoryException
version
- public StoredVersion[] getVersions()
StoredDeployableConfiguration
Domain.getVersions()
getVersions
in interface StoredDeployableConfiguration
public int getHighestVersionNumber()
StoredDeployableConfiguration
setHighestVersion
.
This is
called by Domain.getHighestVersionNumber()
getHighestVersionNumber
in interface StoredDeployableConfiguration
public void setSourceURL(URLSource urlSource)
StoredDomain
Domain.setSourceConfiguration(URLSource)
setSourceURL
in interface StoredDomain
urlSource
- indicates the source for the configuration to be deployed to the DomainDomain.deployConfiguration()
,
Domain.setDeploymentPolicy(URLSource, String, String)
public URLSource getSourceURL()
StoredDomain
Domain.getSourceConfiguration()
and
Domain.setSourceConfiguration(URLSource)
getSourceURL
in interface StoredDomain
public StoredDeploymentPolicy getDeploymentPolicy()
StoredDomain
Domain.getDeploymentPolicy()
getDeploymentPolicy
in interface StoredDomain
Domain.setDeploymentPolicy(URLSource, String, String)
public DomainSynchronizationMode getSynchMode()
StoredDomain
Domain.getSynchronizationMode()
getSynchMode
in interface StoredDomain
DomainSynchronizationMode.AUTO
,
DomainSynchronizationMode.MANUAL
public void setSynchMode(DomainSynchronizationMode synchMode)
StoredDomain
Domain.setSynchronizationMode(DomainSynchronizationMode)
setSynchMode
in interface StoredDomain
synchMode
- a value of AUTO indicates the domain will be synchronized automaticallyDomainSynchronizationMode.AUTO
,
DomainSynchronizationMode.MANUAL
public void setLastModifiedOfDeployedSource(long synchDate)
Note: The Local File System persists time as an attribute on domains element.
setLastModifiedOfDeployedSource
in interface StoredDomain
synchDate
- time in milliseconds when the domain configuration is deployed and
persisted in the repositoryStoredDomain.getLastModifiedOfDeployedSource()
public long getLastModifiedOfDeployedSource()
StoredDomain
DomainSynchronizationMode
is set to DomainSynchronizationMode.AUTO
. See StoredDomain.setLastModifiedOfDeployedSource(long)
for details of how the timestamp is used for domain synchronization.
getLastModifiedOfDeployedSource
in interface StoredDomain
StoredDomain.setLastModifiedOfDeployedSource(long)
public boolean getOutOfSynch()
StoredDomain
getOutOfSynch
in interface StoredDomain
Domain.setSourceConfiguration(URLSource)
,
Domain.setDeploymentPolicy(URLSource,String,String)
,
Domain.setSynchronizationMode(DomainSynchronizationMode)
public void setOutOfSynch(boolean outOfSynch)
StoredDomain
Domain
and the
domain on the device becomes out of synch with the configuration last deployed and
persisted in the repository. This is set to FALSE when the domain is re-synched making
the device domain configuration the same as the deployed domain configuration
setOutOfSynch
in interface StoredDomain
outOfSynch
- the value of true indicates the domain is not synchronized.Domain.setSourceConfiguration(URLSource)
,
Domain.setDeploymentPolicy(URLSource,String,String)
,
Domain.setSynchronizationMode(DomainSynchronizationMode)
public void setQuiesceTimeout(int timeout)
StoredDomain
Domain.setQuiesceTimeout(int)
. The time is used to
This timeout value (in seconds) is used for checking the status of a domain
quiesce or unquiesce operation. The quiesce operation is used on firmware versions 3.8.1 or higher to stop a
domain before deploying source configuration or updating it.
setQuiesceTimeout
in interface StoredDomain
timeout
- value in secondsStoredDomain.getQuiesceTimeout()
public int getQuiesceTimeout()
StoredDomain
Domain.getQuiesceTimeout()
getQuiesceTimeout
in interface StoredDomain
StoredDomain.setQuiesceTimeout(int)
public void add(StoredTag tag)
StoredDomain
Domain.addTag(String, String)
to set the
tag on a StoredTag
and persist it in the repository.
add
in interface StoredDomain
tag
- StoreTagpublic StoredTag[] getTags()
StoredDomain
Domain.getTagNames()
,
Domain.getTagValues(String)
,
Domain.removeTag(String)
and
Domain.removeTag(String, String)
,
to retrieve the information from the repository.
getTags
in interface StoredDomain
public void remove(StoredTag tag)
StoredDomain
Domain.removeTag(String, String)
and
Domain.removeTag(String)
remove
in interface StoredDomain
tag
- the StoredTagpublic void removeTags()
StoredDomain
Device.removeTags()
removeTags
in interface StoredDomain
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |