com.ibm.datapower.wamt.dataAPI
Interface StoredDomain

All Superinterfaces:
Persistable, StoredDeployableConfiguration
All Known Implementing Classes:
StoredDomainImpl

public interface StoredDomain
extends StoredDeployableConfiguration

It represents a domain on a DataPower device and holds all information that must be maintained and persisted for a Domain. 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 deployed on this domain, as well as the StoredDeploymentPolicy and StoredDeploymentPolicyVersion used in the domain deployment


Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 void add(StoredTag tag)
          Add a tag to the domain.
 StoredDeploymentPolicy getDeploymentPolicy()
          Gets the Deployment Policy on this StoredDomain.
 StoredDevice getDevice()
          Returns the Device on which this StoredDomain resides.
 long getLastModifiedOfDeployedSource()
          Internal use only.
 java.lang.String getName()
          Gets the name of this StoredDomain.
 boolean getOutOfSynch()
          Internal Use Only

Gets the value of the OutOfSynch attribute on this StoreDomain.

 java.lang.String getPrimaryKey()
          Returns the Unique identifier for this StoredDomain.
 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.
 void remove(StoredTag tag)
          Remove the tags for this domain.
 void removeTags()
          Remove all tags for this domain.
 void setLastModifiedOfDeployedSource(long synchDate)
          Internal use only.
 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.
 
Methods inherited from interface com.ibm.datapower.wamt.dataAPI.StoredDeployableConfiguration
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

getName

java.lang.String getName()
Gets the name of this StoredDomain. This name should be human-consumable. The name is immutable.

Returns:
the name of this StoredDomain
See Also:
getPrimaryKey()

getDevice

StoredDevice getDevice()
Returns the Device on which this StoredDomain resides. This is invoked by Domain.getDevice()

Returns:
the StoredDevice object

getPrimaryKey

java.lang.String getPrimaryKey()
Returns the Unique identifier for this StoredDomain. This is invoked by Domain.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

getDeploymentPolicy

StoredDeploymentPolicy getDeploymentPolicy()
Gets the Deployment Policy on this StoredDomain. This is invoked by Domain.getDeploymentPolicy()

Returns:
the deployment policy for this domain
See Also:
Domain.setDeploymentPolicy(URLSource, String, String)

setSourceURL

void setSourceURL(URLSource urlSource)
Sets the Configuration source on this StoredDomain. This is invoked by Domain.setSourceConfiguration(URLSource)

Parameters:
urlSource - indicates the source for the configuration to be deployed to the Domain
See Also:
Domain.deployConfiguration(), Domain.setDeploymentPolicy(URLSource, String, String)

getSourceURL

URLSource getSourceURL()
Gets the configuration source location where the configuration is stored. This is invoked by Domain.getSourceConfiguration() and Domain.setSourceConfiguration(URLSource)

Returns:
the URLSource for this domain configuration source

setSynchMode

void setSynchMode(DomainSynchronizationMode synchMode)
Sets the Synchronization Mode on this StoredDomain to AUTO or MANUAL. This is invoked by Domain.setSynchronizationMode(DomainSynchronizationMode)

Parameters:
synchMode - a value of AUTO indicates the domain will be synchronized automatically
See Also:
DomainSynchronizationMode.AUTO, DomainSynchronizationMode.MANUAL

getSynchMode

DomainSynchronizationMode getSynchMode()
Gets the Synchronization Mode on this StoredDomain. This is invoked by Domain.getSynchronizationMode()

Returns:
synchronization mode persisted on the StoredDomain
See Also:
DomainSynchronizationMode.AUTO, DomainSynchronizationMode.MANUAL

setLastModifiedOfDeployedSource

void setLastModifiedOfDeployedSource(long synchDate)
Internal use only. Sets the time (in milliseconds) to record the timestamp of the domain configuration source when it is deployed. This timestamp is used to check if the timestamp of source has changed since the last deployment. If the DomainSynchronizationMode is set to DomainSynchronizationMode.AUTO, the manager periodically checks for a change in timestamp of the configuration source. If a change is detected, it automatically synchronizes the domain configuration by performing a redeploy. See Domain.setSynchronizationMode(DomainSynchronizationMode)

Parameters:
synchDate - time in milliseconds when the domain configuration is deployed and persisted in the repository
See Also:
getLastModifiedOfDeployedSource()

getLastModifiedOfDeployedSource

long getLastModifiedOfDeployedSource()
Internal use only. Gets the time stamp (in milliseconds) on the domain source Configuration when it was last deployed. This timestamp is used to perform automatic domain synchronization when the DomainSynchronizationMode is set to DomainSynchronizationMode.AUTO. See setLastModifiedOfDeployedSource(long) for details of how the timestamp is used for domain synchronization.

Returns:
time in milliseconds
See Also:
setLastModifiedOfDeployedSource(long)

getOutOfSynch

boolean getOutOfSynch()
Internal Use Only

Gets the value of the OutOfSynch attribute on this StoreDomain. A value of TRUE indicates that domain on the device is out of synch with the source configuration last deployed and persisted in the repository. The value is TRUE if users invoke any "set" method on Domain that causes the domain configuration to get out of synch.

Returns:
a value of true indicates the domain is not synchronized
See Also:
Domain.setSourceConfiguration(URLSource), Domain.setDeploymentPolicy(URLSource,String,String), Domain.setSynchronizationMode(DomainSynchronizationMode)

setOutOfSynch

void setOutOfSynch(boolean outOfSynch)
Internal use only Sets the value of the OutOfSynch attribute on the StoreDomain. The value is set to TRUE when set methods are called on the 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

Parameters:
outOfSynch - the value of true indicates the domain is not synchronized.
See Also:
Domain.setSourceConfiguration(URLSource), Domain.setDeploymentPolicy(URLSource,String,String), Domain.setSynchronizationMode(DomainSynchronizationMode)

setQuiesceTimeout

void setQuiesceTimeout(int timeout)
Sets the timeout value for quiescing a domain on the DataPower device before configuration deployment. This is invoked from 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.

Parameters:
timeout - value in seconds
See Also:
getQuiesceTimeout()

getQuiesceTimeout

int getQuiesceTimeout()
Gets the persisted timeout value for quiescing a domain on the DataPower device. This is invoked from Domain.getQuiesceTimeout()

Returns:
timeout value in seconds
See Also:
setQuiesceTimeout(int)

add

void add(StoredTag tag)
Add a tag to the domain. This is invoked by Domain.addTag(String, String) to set the tag on a StoredTag and persist it in the repository.

Parameters:
tag - StoreTag
tag -

getTags

StoredTag[] getTags()
Gets the tags for this domain. This is invoked from Domain.getTagNames(), Domain.getTagValues(String), Domain.removeTag(String) and Domain.removeTag(String, String), to retrieve the information from the repository.

Returns:
a array of StoredTags

remove

void remove(StoredTag tag)
            throws DatastoreException
Remove the tags for this domain. This is invoked from Domain.removeTag(String, String) and Domain.removeTag(String)

Parameters:
tag - the StoredTag

removeTags

void removeTags()
Remove all tags for this domain. This is invoked from Device.removeTags()



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