|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoredDomain
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 StoredDomainVersion
s
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 |
---|
static final java.lang.String COPYRIGHT_2009_2010
static final java.lang.String SCM_REVISION
Method Detail |
---|
java.lang.String getName()
StoredDomain
. This name should be human-consumable.
The name is immutable.
getPrimaryKey()
StoredDevice getDevice()
StoredDomain
resides. This is invoked by
Domain.getDevice()
java.lang.String getPrimaryKey()
Domain.getPrimaryKey()
There is no setPrimaryKey
exposed since it is managed by the
dataAPI implementation.
getPrimaryKey
in interface Persistable
StoredDeploymentPolicy getDeploymentPolicy()
Domain.getDeploymentPolicy()
Domain.setDeploymentPolicy(URLSource, String, String)
void setSourceURL(URLSource urlSource)
Domain.setSourceConfiguration(URLSource)
urlSource
- indicates the source for the configuration to be deployed to the DomainDomain.deployConfiguration()
,
Domain.setDeploymentPolicy(URLSource, String, String)
URLSource getSourceURL()
Domain.getSourceConfiguration()
and
Domain.setSourceConfiguration(URLSource)
void setSynchMode(DomainSynchronizationMode synchMode)
Domain.setSynchronizationMode(DomainSynchronizationMode)
synchMode
- a value of AUTO indicates the domain will be synchronized automaticallyDomainSynchronizationMode.AUTO
,
DomainSynchronizationMode.MANUAL
DomainSynchronizationMode getSynchMode()
Domain.getSynchronizationMode()
DomainSynchronizationMode.AUTO
,
DomainSynchronizationMode.MANUAL
void setLastModifiedOfDeployedSource(long synchDate)
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)
synchDate
- time in milliseconds when the domain configuration is deployed and
persisted in the repositorygetLastModifiedOfDeployedSource()
long getLastModifiedOfDeployedSource()
DomainSynchronizationMode
is set to DomainSynchronizationMode.AUTO
. See setLastModifiedOfDeployedSource(long)
for details of how the timestamp is used for domain synchronization.
setLastModifiedOfDeployedSource(long)
boolean getOutOfSynch()
Domain.setSourceConfiguration(URLSource)
,
Domain.setDeploymentPolicy(URLSource,String,String)
,
Domain.setSynchronizationMode(DomainSynchronizationMode)
void setOutOfSynch(boolean outOfSynch)
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
outOfSynch
- the value of true indicates the domain is not synchronized.Domain.setSourceConfiguration(URLSource)
,
Domain.setDeploymentPolicy(URLSource,String,String)
,
Domain.setSynchronizationMode(DomainSynchronizationMode)
void setQuiesceTimeout(int timeout)
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.
timeout
- value in secondsgetQuiesceTimeout()
int getQuiesceTimeout()
Domain.getQuiesceTimeout()
setQuiesceTimeout(int)
void add(StoredTag tag)
Domain.addTag(String, String)
to set the
tag on a StoredTag
and persist it in the repository.
tag
- StoreTagtag
- StoredTag[] getTags()
Domain.getTagNames()
,
Domain.getTagValues(String)
,
Domain.removeTag(String)
and
Domain.removeTag(String, String)
,
to retrieve the information from the repository.
void remove(StoredTag tag) throws DatastoreException
Domain.removeTag(String, String)
and
Domain.removeTag(String)
tag
- the StoredTagvoid removeTags()
Device.removeTags()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |