|
|||||||||||
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.StoredDeviceImpl
public class StoredDeviceImpl
It represents a DataPower device. All device related information that must be persisted for a physical DataPower device. This includes the device serialnumber, hostname, GUIPOrt, HLMPort, Hostname, Model, Symbolic Name, and quiesce time out.
It is the container for StoredDomains that represent domains on a DataPower device. Below is a sample of a device element
<devices xmi:id="DPDevice_0" deviceType="XI50" GUIPort="8080" HLMPort="5550" Hostname="9.42.112.77" password="password" serialNumber="130018M" userId="admin" name="dp10.rtp.raleigh.ibm.com" modelType="9003" currentAMPVersion="2.0" quiesceTimeout="60" featureLicenses="JAXP-API;WebSphere-JMS;"> ... </devices>
Field Summary |
---|
Fields inherited from interface com.ibm.datapower.wamt.dataAPI.StoredDevice |
---|
COPYRIGHT_2009_2010, 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()
Note: The Local File System implementation stores the AMP version as an attribute on the 'devices' element in the WAMT.repository.xml file. |
DeviceType |
getDeviceType()
Note: The Local File System implementation stores the deviceType as an attribute on the devices element in the WAMT.repository.xml file. |
StringCollection |
getFeatureLicenses()
Note: The Local File System implementation stores the getFeatureLicenses as an attribute on the device element in the WAMT.repository.xml file. |
int |
getGUIPort()
Note: The Local File System implementation stores the WebGUI port as an attribute on the device element in the WAMT.repository.xml file. |
int |
getHLMPort()
Gets the device's port number for HLM communication. |
java.lang.String |
getHostname()
Note: The Local File System implementation stores the hostname as an attribute on the devices element in the WAMT.repository.xml file. |
StoredDomain |
getManagedDomain(java.lang.String domainName)
Gets the domain from the repository that has the specified name. |
StoredDomain[] |
getManagedDomains()
Note: The Local File System implementation stores all managed domains elements inside a device element in the WAMT.repository.xml file. |
StoredManagedSet |
getManagedSet()
Note: The Local File System implementation stores managed device as attribute on the managedSets element in the WAMT.repository.xml file. |
ModelType |
getModelType()
Gets the ModelType for this device. |
java.lang.String |
getPassword()
Note: The Local File System implementation stores the password as an attribute on the device element in the WAMT.repository.xml file. |
java.lang.String |
getPrimaryKey()
Note: The Local File System implementation uses the serialNumber of the DataPower device that this object represents as the primary key. |
int |
getQuiesceTimeout()
Gets the persisted timeout value for quiescing the device. |
java.lang.String |
getSerialNumber()
Note: The Local File System implementation stores the serial number as an attribute on the 'devices' element in the WAMT.repository.xml file. |
java.lang.String |
getSymbolicName()
Note: The Local File System implementation stores the symbolic name as an attribute on the 'devices' element in the WAMT.repository.xml file. |
StoredTag[] |
getTags()
Gets the tags for this device. |
java.lang.String |
getUserId()
Note: The Local File System implementation stores the userId as an attribute on the device element in the WAMT.repository.xml file. |
void |
remove(StoredDomain domain)
Note: The Local File System implementation will remove the specified domain element from the WAMT.repository.xml file. |
void |
remove(StoredTag tag)
Remove the tags for this device. |
void |
removeTags()
Remove all tags for this device. |
void |
setBackupCertificateLocation(URLSource certificateLocation)
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 |
setDeviceType(DeviceType deviceType)
|
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)
Note: The Local File System implementation stores the HLM Posrt as an attribute on the device element in the WAMT.repository.xml file. |
void |
setHostname(java.lang.String hostname)
Sets the hostname or IP address of this device. |
void |
setManagedSet(StoredManagedSet managedSet)
Non-interface method to set the ManagedSet this device belongs to |
void |
setModelType(ModelType modelType)
|
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public StoredDomain[] getManagedDomains()
Note: The Local File System implementation stores all managed domains elements inside a device element in the WAMT.repository.xml file. Domains cannot exist outside of a containing device.
getManagedDomains
in interface StoredDevice
public StoredDomain getManagedDomain(java.lang.String domainName)
StoredDevice
Device.getManagedDomain(String)
getManagedDomain
in interface StoredDevice
public java.lang.String getPrimaryKey()
Note: The Local File System implementation uses the serialNumber of the DataPower device that this object represents as the primary key.
getPrimaryKey
in interface Persistable
getPrimaryKey
in interface StoredDevice
public java.lang.String getSymbolicName()
Note: The Local File System implementation stores the symbolic name as an attribute on the 'devices' element in the WAMT.repository.xml file.
getSymbolicName
in interface StoredDevice
StoredDevice.setSymbolicName(String)
public void setSymbolicName(java.lang.String name) throws AlreadyExistsInRepositoryException, DatastoreException
StoredDevice
Device.setSymbolicName(String)
to set this symbolic name.
setSymbolicName
in interface StoredDevice
name
- the device nameStoredDevice.getSymbolicName()
public java.lang.String getSerialNumber()
Note: The Local File System implementation stores the serial number as an attribute on the 'devices' element in the WAMT.repository.xml file.
getSerialNumber
in interface StoredDevice
public java.lang.String getHostname()
Note: The Local File System implementation stores the hostname as an attribute on the devices element in the WAMT.repository.xml file.
getHostname
in interface StoredDevice
StoredDevice.setHostname(String)
public void setHostname(java.lang.String hostname) throws DatastoreException
StoredDevice
Device.setHostname(String)
to set the hostname a StoredDevice
object.
setHostname
in interface StoredDevice
hostname
- the new hostname or IP address for this device *StoredDevice.getHostname()
public java.lang.String getUserId()
Note: The Local File System implementation stores the userId as an attribute on the device element in the WAMT.repository.xml file.
getUserId
in interface StoredDevice
StoredDevice.setUserId(String)
public void setUserId(java.lang.String userid) throws DatastoreException
StoredDevice
Device.getUserId()
.
setUserId
in interface StoredDevice
userid
- the new administrative userid *StoredDevice.setUserId(String)
public void setPassword(java.lang.String password) throws DatastoreException
StoredDevice
Device.setPassword(String)
.
setPassword
in interface StoredDevice
password
- the new administrative password *StoredDevice.getPassword()
public java.lang.String getPassword()
Note: The Local File System implementation stores the password as an attribute on the device element in the WAMT.repository.xml file.
getPassword
in interface StoredDevice
public java.lang.String getCurrentAMPVersion()
Note: The Local File System implementation stores the AMP version as an attribute on the 'devices' element in the WAMT.repository.xml file.
getCurrentAMPVersion
in interface StoredDevice
public void setCurrentAMPVersion(java.lang.String ampVersion) throws DatastoreException
StoredDevice
setCurrentAMPVersion
in interface StoredDevice
ampVersion
- the amp Version currently supported by the DataPower devicepublic int getHLMPort()
StoredDevice
Device.getHLMPort()
to retrieve the
information from the repository.
getHLMPort
in interface StoredDevice
StoredDevice.setHLMPort(int)
public void setHLMPort(int hlmPort) throws DatastoreException
Note: The Local File System implementation stores the HLM Posrt as an attribute on the device element in the WAMT.repository.xml file.
< inheritDoc/>
setHLMPort
in interface StoredDevice
hlmPort
- the device's port number for HLM communication.StoredDevice.getHLMPort()
public int getGUIPort()
Note: The Local File System implementation stores the WebGUI port as an attribute on the device element in the WAMT.repository.xml file.
getGUIPort
in interface StoredDevice
StoredDevice.setGUIPort(int)
public void setGUIPort(int guiPort) throws DatastoreException
StoredDevice
Device.setGUIPort(int)
to set the
port number for the WebGUI on a StoredDevice
and persist it in the repository.
setGUIPort
in interface StoredDevice
guiPort
- the device's port for the WebGUIStoredDevice.getGUIPort()
public StringCollection getFeatureLicenses()
Note: The Local File System implementation stores the getFeatureLicenses as an attribute on the device element in the WAMT.repository.xml file.
< inheritDoc/>
getFeatureLicenses
in interface StoredDevice
public void setFeatureLicenses(StringCollection featureLicenses) throws DatastoreException
StoredDevice
Device.createDevice(String, String, String, String, int)
to set the
feature entitlements for this device and persist it in the repository.
setFeatureLicenses
in interface StoredDevice
StoredDevice.getFeatureLicenses()
public ModelType getModelType()
StoredDevice
Device.getModelType()
to retrieve the
information from the repository.
getModelType
in interface StoredDevice
public void setModelType(ModelType modelType)
public StoredManagedSet getManagedSet()
Note: The Local File System implementation stores managed device as attribute on the managedSets element in the WAMT.repository.xml file.
< inheritDoc/>
getManagedSet
in interface StoredDevice
StoredManagedSet.add(StoredDevice)
public void remove(StoredDomain domain)
Note: The Local File System implementation will remove the specified domain element from the WAMT.repository.xml file. The clientAPI logic will delete all elements contained within a domain element.
remove
in interface StoredDevice
domain
- the domain to removeRepository.createDomain(StoredDevice, String)
public void setManagedSet(StoredManagedSet managedSet)
managedSet
- public DeviceType getDeviceType()
Note: The Local File System implementation stores the deviceType as an attribute on the devices element in the WAMT.repository.xml file.
< inheritDoc/>
getDeviceType
in interface StoredDevice
public void setDeviceType(DeviceType deviceType) throws DatastoreException
public void delete()
StoredDevice
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.
- Specified by:
delete
in interface StoredDevice
public URLSource getBackupCertificateLocation()
StoredDevice
getBackupCertificateLocation
in interface StoredDevice
public java.net.URI getBackupFileLocation()
StoredDevice
getBackupFileLocation
in interface StoredDevice
public void setBackupCertificateLocation(URLSource certificateLocation)
StoredDevice
Device.backup(String, URLSource, URI, boolean, boolean)
is invoked to backup up a managed or unmanaged device.
setBackupCertificateLocation
in interface StoredDevice
certificateLocation
- indicates location of back up certificates that can be later used
during the restore operation on the devicepublic void setBackupFileLocation(java.net.URI fileLocation)
StoredDevice
Device.backup(String, URLSource, URI, boolean, boolean)
is invoked to backup up a managed or unmanaged device.
setBackupFileLocation
in interface StoredDevice
fileLocation
- indicates location of back up files for a secure backup operationpublic void setQuiesceTimeout(int timeout)
StoredDevice
Device.setQuiesceTimeout(int)
setQuiesceTimeout
in interface StoredDevice
timeout
- value in secpublic int getQuiesceTimeout()
StoredDevice
Device.getQuiesceTimeout()
getQuiesceTimeout
in interface StoredDevice
public void add(StoredTag tag)
StoredDevice
Device.addTag(String, String)
to set the
tag on a StoredTag
and persist it in the repository.
add
in interface StoredDevice
tag
- StoreTagpublic StoredTag[] getTags()
StoredDevice
Device.getTagNames()
,
Device.getTagValues(String)
,
Device.removeTag(String)
and
Device.removeTag(String, String)
,
to retrieve the information from the repository.
getTags
in interface StoredDevice
public void remove(StoredTag tag)
StoredDevice
Device.removeTag(String, String)
and
Device.removeTag(String)
remove
in interface StoredDevice
tag
- the StoredTagpublic void removeTags()
StoredDevice
Device.removeTags()
removeTags
in interface StoredDevice
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |