com.ibm.datapower.wamt.dataAPI
Interface StoredFirmware

All Superinterfaces:
Persistable
All Known Implementing Classes:
StoredFirmwareImpl

public interface StoredFirmware
extends Persistable

The information related to Firmware that must be maintained and persisted for a firmware that can be deployed to a device. This includes the device type, model type, strict features list, and non-strict feature list. It acts as a container for different levels of firmware, i.e. FirmwareVersion objects for a specific device type.


Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 void delete()
          Deletes the persisted instance of this StoredFirmware.
 DeviceType getDeviceType()
          Gets the deviceType of this StoredFirmware.
 int getHighestVersionNumber()
          Gets the highest version number that has EVER been used for a version of this object.
 ModelType getModelType()
          Gets the modelType of this StoredFirmware.
 StringCollection getNonstrictFeatures()
          Gets the StringCollection that represents the nonstrict features supported by this firmware.
 java.lang.String getPrimaryKey()
          Returns the unique identifier for this StoredFirmware.
 StringCollection getStrictFeatures()
          Gets the StringCollection that represents the strict features supported by this firmware.
 StoredFirmwareVersion[] getVersions()
          Returns all the FirmwareVersions contained by this StoredFirmware object.
 void remove(StoredFirmwareVersion firmwareVersion)
          Removes the specifed StoredFirmwareVersion from this StoredFirmware.
 

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

getDeviceType

DeviceType getDeviceType()
Gets the deviceType of this StoredFirmware. StoredFirmware is specific to a combination of device type + model type + features. The deviceType is immutable, so there is no setDeviceType method. This is invoked by Firmware.getDeviceType()

Note: The Local File System implementation persists device type as an attribute on firmwares element in the WAMT.repository.xml file.

Returns:
the device type that this firmware must run on

getModelType

ModelType getModelType()
Gets the modelType of this StoredFirmware. StoredFirmware is specific to a combination of device type + model type + features. The deviceType is immutable, so there is no setModelType method. This is invoked by Firmware.getModelType()

Note: The Local File System implementation persists device model type as an attribute on firmwares element in the WAMT.repository.xml file.

Returns:
the device type that this firmware must run on

getStrictFeatures

StringCollection getStrictFeatures()
Gets the StringCollection that represents the strict features supported by this firmware. If a Firmware supports a strict feature, it can ONLY be installed on devices having a license for that feature.

StoredFirmware is specific to a combination of device type + model type + strictfeatures + nonstrictFeatures. The strictFeatures attribute is immutable, so there is no setStrictFeatures method. This is invoked by Firmware.getStrictFeatures()

Note: The Local File System implementation persists the collection of strict features as an attribute on firmwares element in the WAMT.repository.xml file.

Returns:
the StringCollection that represent the strict features supported by this firmware. i.e., "MQ", "TAM", etc.

getNonstrictFeatures

StringCollection getNonstrictFeatures()
Gets the StringCollection that represents the nonstrict features supported by this firmware. If a Firmware supports a nonstrict feature, it can be installed on a device irrespective of whether that device has a licence for that feature.

StoredFirmware is specific to a combination of device type + model type + strictfeatures + nonstrictFeatures. The nonstrictFeatures attribute is immutable, so there is no setNonstrictFeatures method. This is invoked by Firmware.getNonstrictFeatures()

Note: The Local File System implementation persists the collection of non-strict features as an attribute on firmwares element in the WAMT.repository.xml file.

Returns:
the StringCollection that represent the nonstrict features supported by this firmware. i.e., "DataGlue;JAXP-API;PKCS7-SMIME;HSM;XG4;Compact-Flash;iSCSI;RaidVolume;LocateLED;AppOpt;MQ;WebSphere-JMS;"

getVersions

StoredFirmwareVersion[] getVersions()
Returns all the FirmwareVersions contained by this StoredFirmware object. This is invoked by Firmware.getVersions()

Returns:
the FirmwareVersions contained by this StoredFirmware object

getHighestVersionNumber

int getHighestVersionNumber()
Gets the highest version number that has EVER been used for a version of this object. Used to create unique identifiers for the versions of this object. It is OK for this number to wrap as long as it doesn't create duplicated identifiers among the current set of versions. This is invoked by Firmware.getHighestVersionNumber()

Note: The Local File System implementation persists the highest version number as an attribute on firmwares element in the WAMT.repository.xml file.

Returns:
The highest version number that has EVER been for a version of this object

getPrimaryKey

java.lang.String getPrimaryKey()
Returns the unique identifier for this StoredFirmware. This is invoked by Firmware.getPrimaryKey(). There is no setPrimaryKey exposed since it is managed by the dataAPI implementation.

Note: The Local File System implementation combines the device type, model type, strict features and non-strict features as the unique identifier of this object.

Specified by:
getPrimaryKey in interface Persistable
Returns:
the unique identifier for this object

remove

void remove(StoredFirmwareVersion firmwareVersion)
            throws NotExistInRepositoryException
Removes the specifed StoredFirmwareVersion from this StoredFirmware. This is invoked by Firmware.remove(com.ibm.datapower.wamt.clientAPI.Version).

Parameters:
firmwareVersion - the StoredFirmwareVersion to remove
See Also:
Repository.createFirmwareVersion(StoredFirmware, Blob, String, Date, String, Date)

delete

void delete()
            throws NotEmptyInRepositoryException,
                   DatastoreException
Deletes the persisted instance of this StoredFirmware. This is invoked by Manager.remove(com.ibm.datapower.wamt.clientAPI.Firmware) which also contains the logic to removes any contained FirmwareVersions.



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