|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoredDevice
All device related information that must be maintained and persisted for a physical
DataPower device, i.e Device
.
This includes the device serialnumber, hostname, GUIPOrt, HLMPort, Hostname, Model,
Symbolic Name, and Quiesce time out.
It is the container for StoredDomains persisted in the repository.
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 device. |
void |
delete()
Deletes the persisted instance of this StoredDevice. |
URLSource |
getBackupCertificateLocation()
Gets the location of the certificate file to be used in a secure backup operation on a device |
java.net.URI |
getBackupFileLocation()
Gets the location where the backup files are to be saved for a secure backup operation. |
java.lang.String |
getCurrentAMPVersion()
Gets the current AMP version supported by this device. |
DeviceType |
getDeviceType()
Gets the DeviceType for this device. |
StringCollection |
getFeatureLicenses()
Gets the list of Strings that represent the feature licenses for this device. |
int |
getGUIPort()
Gets the device's port for the WebGUI. |
int |
getHLMPort()
Gets the device's port number for HLM communication. |
java.lang.String |
getHostname()
Gets the hostname or IP address of this device. |
StoredDomain |
getManagedDomain(java.lang.String domainName)
Gets the domain from the repository that has the specified name. |
StoredDomain[] |
getManagedDomains()
Gets an array of the managed domains in this managed set. |
StoredManagedSet |
getManagedSet()
If this is a managed device, return the StoredManagedSet that owns this device member. |
ModelType |
getModelType()
Gets the ModelType for this device. |
java.lang.String |
getPassword()
Gets the administrative password for this device. |
java.lang.String |
getPrimaryKey()
A unique identifier for this StoredDevice in the repository which can be used as a primary key to retrieve and store the data. |
int |
getQuiesceTimeout()
Gets the persisted timeout value for quiescing the device. |
java.lang.String |
getSerialNumber()
Gets the serial number of this device. |
java.lang.String |
getSymbolicName()
Gets the symbolic name of this StoredDevice. |
StoredTag[] |
getTags()
Gets the tags for this device. |
java.lang.String |
getUserId()
Gets the administrative userid persisted on this StoredDevice . |
void |
remove(StoredDomain domain)
Removes the specified domain from this containing StoredDevice. |
void |
remove(StoredTag tag)
Remove the tags for this device. |
void |
removeTags()
Remove all tags for this device. |
void |
setBackupCertificateLocation(URLSource certificatesLocation)
Stores the location of the certificate file to be used in the secure backup operation. |
void |
setBackupFileLocation(java.net.URI fileLocation)
Stores the location for the backup file from a Device. |
void |
setCurrentAMPVersion(java.lang.String ampVersion)
Sets the current AMP version supported by this device. |
void |
setFeatureLicenses(StringCollection featureLicenses)
Sets the list of Strings that represent the feature licenses for this device. |
void |
setGUIPort(int guiPort)
Sets the device's port for the WebGUI. |
void |
setHLMPort(int hlmPort)
Sets the device's port number for HLM communication. |
void |
setHostname(java.lang.String hostname)
Sets the hostname or IP address of this device. |
void |
setPassword(java.lang.String password)
Sets the administrative password for this device. |
void |
setQuiesceTimeout(int timeout)
Sets the timeout value for quiescing a Device before performing a firmware update on the device. |
void |
setSymbolicName(java.lang.String name)
Sets the symbolic name of this StoredDevice. |
void |
setUserId(java.lang.String userid)
Sets the administrative userid for this device. |
Field Detail |
---|
static final java.lang.String COPYRIGHT_2009_2010
static final java.lang.String SCM_REVISION
Method Detail |
---|
java.lang.String getPrimaryKey()
getPrimaryKey
in interface Persistable
java.lang.String getSymbolicName()
Device.getSymbolicName()
to retrieve the symbolic name.
setSymbolicName(String)
void setSymbolicName(java.lang.String name) throws AlreadyExistsInRepositoryException, DatastoreException
Device.setSymbolicName(String)
to set this symbolic name.
name
- the device namegetSymbolicName()
java.lang.String getSerialNumber()
Device.getSerialNumber()
to retrieve the serial number of a persisted Device
object.
java.lang.String getHostname()
Device.getHostname()
to retrieve the hostname of a persisted Device
object.
setHostname(String)
void setHostname(java.lang.String hostname) throws DatastoreException
Device.setHostname(String)
to set the hostname a StoredDevice
object.
hostname
- the new hostname or IP address for this device *getHostname()
java.lang.String getCurrentAMPVersion()
Device.getCurrentAMPVersion()
to retrieve the supported AMP version from a StoredDevice
object.
void setCurrentAMPVersion(java.lang.String ampVersion) throws DatastoreException
ampVersion
- the amp Version currently supported by the DataPower deviceStoredDomain[] getManagedDomains()
Device.getManagedDomains()
.
If the device is not managed or has does not have any domains then no domains will be returned.
Domains cannot exist outside of a containing device object.
StoredDomain getManagedDomain(java.lang.String domainName)
Device.getManagedDomain(String)
domainName
-
void remove(StoredDomain domain) throws DatastoreException
Device.removeManagedDomain(String)
. It is followed
by logic to delete any child objects contained by the specified StoredDomain
object. It will delete
any StoredDomainVersion
, StoredDeploymentPolicy
and StoredDeploymentPolicyVersion
objects contained by the StoredDomain
in the repository.
domain
- the domain to removeRepository.createDomain(StoredDevice, String)
java.lang.String getUserId()
StoredDevice
. It is
use internally by the manager and also exposed through Device.getUserId()
.
setUserId(String)
void setUserId(java.lang.String userid) throws DatastoreException
Device.getUserId()
.
userid
- the new administrative userid *setUserId(String)
void setPassword(java.lang.String password) throws DatastoreException
Device.setPassword(String)
.
password
- the new administrative password *getPassword()
java.lang.String getPassword()
Device.getDeviceContext()
. The password
must be set on the DeviceContext for AMP calls.
int getHLMPort()
Device.getHLMPort()
to retrieve the
information from the repository.
setHLMPort(int)
void setHLMPort(int hlmPort) throws DatastoreException
Device.getHLMPort()
to set the
port number for HLM communication on a StoredDevice
and persist it in the repository.
hlmPort
- the device's port number for HLM communication.getHLMPort()
int getGUIPort()
Device.getGUIPort()
to retrieve the
information from the repository.
setGUIPort(int)
void setGUIPort(int guiPort) throws DatastoreException
Device.setGUIPort(int)
to set the
port number for the WebGUI on a StoredDevice
and persist it in the repository.
guiPort
- the device's port for the WebGUIgetGUIPort()
StringCollection getFeatureLicenses()
Device.getFeatureLicenses()
to retrieve the
information from the repository.
void setFeatureLicenses(StringCollection featureLicenses) throws DatastoreException
Device.createDevice(String, String, String, String, int)
to set the
feature entitlements for this device and persist it in the repository.
featureLicenses
- getFeatureLicenses()
StoredManagedSet getManagedSet()
Device.getManagedSet()
to retrieve the
information from the repository.
StoredManagedSet.add(StoredDevice)
DeviceType getDeviceType()
Device.getDeviceType()
to retrieve the
information from the repository. The DeviceType is immutable, so there is no
setDeviceType()
ModelType getModelType()
Device.getModelType()
to retrieve the
information from the repository.
void delete() throws DatastoreException
Manager.remove(com.ibm.datapower.wamt.clientAPI.Device)
If this StoredDevice
is managed by a StoredManagedSet
,i.e it is a device member of a StoredManagedSet
,
it will be removed from that StoredManagedSet before it is deleted. Also all stored objects contained within
the StoredManagedSet
such as StoredDomain
, DomainVersion
,
StoredDeploymentPolicy
, StoredDeploymentPolicyVersion
, and StoredTag
are also deleted because they do not exist without the containing StoredDevice
object.
void setBackupFileLocation(java.net.URI fileLocation)
Device.backup(String, URLSource, URI, boolean, boolean)
is invoked to backup up a managed or unmanaged device.
fileLocation
- indicates location of back up files for a secure backup operationjava.net.URI getBackupFileLocation()
void setBackupCertificateLocation(URLSource certificatesLocation)
Device.backup(String, URLSource, URI, boolean, boolean)
is invoked to backup up a managed or unmanaged device.
certificatesLocation
- indicates location of back up certificates that can be later used
during the restore operation on the deviceURLSource getBackupCertificateLocation()
void setQuiesceTimeout(int timeout)
Device.setQuiesceTimeout(int)
timeout
- value in secint getQuiesceTimeout()
Device.getQuiesceTimeout()
void add(StoredTag tag)
Device.addTag(String, String)
to set the
tag on a StoredTag
and persist it in the repository.
tag
- StoreTagStoredTag[] getTags()
Device.getTagNames()
,
Device.getTagValues(String)
,
Device.removeTag(String)
and
Device.removeTag(String, String)
,
to retrieve the information from the repository.
void remove(StoredTag tag) throws DatastoreException
Device.removeTag(String, String)
and
Device.removeTag(String)
tag
- the StoredTagvoid removeTags()
Device.removeTags()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |