|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.clientAPI.FirmwareVersion
public class FirmwareVersion
A single instance of a firmware image.
A firmware image for a device is uniquely identified by 5 pieces of information
Firmware
object, because they
are controlled by device hardware and licensing constraints. The last element is represented
by this object (FirmwareVersion
).
Although FirmwareVersion has an opaque integer version
member
(i.e., 2) , it is deprecated in favor of the more meaningful member
level
(i.e., "3.6.0.1").
For more information read the javadoc for the classes Firmware
and Version
.
Firmware
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2013
The minimum firmware level that can be deployed to any ManagedSets or added to the Manager. |
Fields inherited from interface com.ibm.datapower.wamt.clientAPI.Version |
---|
COPYRIGHT_2009_2010, SCM_REVISION |
Method Summary | |
---|---|
java.lang.String |
getAbsoluteDisplayName()
Get a human-readable name that represents this object, within the context of the system. |
Blob |
getBlob()
Get the Blob for this FirmwareVersion. |
static FirmwareVersion |
getByPrimaryKey(java.lang.String targetKey)
Retrieve a reference to the FirmwareVersion that has the specified primary key. |
Firmware |
getFirmware()
The same as getVersionedObject() , but casts the return value to
a Firmare class. |
java.lang.String |
getLevel()
Get the version level of this firmware. |
java.util.Date |
getManufactureDate()
Get the manufacture date of this firmware. |
java.lang.String |
getPrimaryKey()
|
java.lang.String |
getRelativeDisplayName()
Get a human-readable name that represents this object, within the context of a specific Firmware. |
java.util.Date |
getTimestamp()
Get the timestamp that signifies when the Version was created in the Manager. |
java.lang.String |
getUserComment()
Get the user comment that corresponds to this Version. |
Versionable |
getVersionedObject()
Get a reference to the object that this Version is a version of. |
int |
getVersionNumber()
Deprecated. Although this method will return a valid version number (i.e., 2), you probably want to use the more meaningful method getLevel() . This method should work and is
supported, but probably isn't the value you are looking for.
It is anticipated that a user interface would reference a
FirmwareVersion via the level instead of versionNumber. |
static boolean |
meetsMinimumLevel(java.lang.String levelToTest)
Check if a specified firmware level meets the minimum supported level. |
static boolean |
meetsMinimumLevel(java.lang.String minimumLevel,
java.lang.String levelToTestIn)
Check if a specified firmware level meets the minimum supported level. |
void |
setUserComment(java.lang.String userComment)
This is the method to set the user comment that can be later retrieved via Version.getUserComment() . |
java.lang.String |
toString()
Get a String representation of this object for the purpose of debugging or tracing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2013
meetsMinimumLevel
.
meetsMinimumLevel(String)
,
Constant Field ValuesMethod Detail |
---|
public java.lang.String getLevel() throws DeletedException
Version.getVersionNumber()
. This value is embedded in
the firmware image header, so there is no
setVersionNumber(String)
method. It will be automatically
populated by the method Manager.addFirmware(Blob, String)
.
Version.getVersionNumber()
public java.lang.String getPrimaryKey() throws DeletedException
public static boolean meetsMinimumLevel(java.lang.String levelToTest)
This method can be used to verify that this FirmwareVersion has a fully working AMP implementation. Otherwise the manager could be locked out from managing the device. The manager should deny any request to deploy firmware to devices that does not meet the minimum supported level.
levelToTest
- the level to test against the minimum supported firmware
level.
public static boolean meetsMinimumLevel(java.lang.String minimumLevel, java.lang.String levelToTestIn)
minimumLevel
- the minimum level to test against for a supported firmware
level.levelToTest
- the level to test against minimumLevel. This is usually the current
level of the device, but can be specified arbitrarily.
Device.meetsMinimumFirmwareLevel(String)
public static FirmwareVersion getByPrimaryKey(java.lang.String targetKey)
targetKey
- the primary key to search for
null
if no Firmware with the specified primary key
was found.getPrimaryKey()
public java.util.Date getManufactureDate() throws DeletedException
setManufactureDate(Date)
method. It will be automatically
populated by the method Manager.addFirmware(Blob, String)
.
public Versionable getVersionedObject() throws DeletedException
Version
DomainVersion.getVersionedObject()
should
return a Domain
, which is the parent object. This should
be a reminder for the subclass to implement the method getDomain()
or getFirmware() that would return a typed object instead
of a generic one. It isn't expected that a caller would actually use this
method.
getVersionedObject
in interface Version
public Firmware getFirmware() throws DeletedException
getVersionedObject()
, but casts the return value to
a Firmare
class.
public int getVersionNumber() throws DeletedException
getLevel()
. This method should work and is
supported, but probably isn't the value you are looking for.
It is anticipated that a user interface would reference a
FirmwareVersion via the level instead of versionNumber.
Version
setVersionNumber(int)
method. The combination
of version number and Object reference forms the primary key for a
Version object in the Manager.
getVersionNumber
in interface Version
public java.util.Date getTimestamp() throws DeletedException
Version
setTimestamp(Date)
method.
getTimestamp
in interface Version
public java.lang.String getUserComment() throws DeletedException
Version
getUserComment
in interface Version
Version.setUserComment(String)
public void setUserComment(java.lang.String userComment) throws DeletedException, DatastoreException, DirtySaveException
Version
Version.getUserComment()
. Calling this method will cause the
comment to be written to the persisted datastore.
setUserComment
in interface Version
userComment
- the user-defined comment to attach to this Version. It may
have reference to a new function, bug fix, change management or
problem management ticket, etc. This is a freeform field of
unlimited length.Version.getUserComment()
public Blob getBlob() throws DeletedException
Beware that the content inside the Blob is base64 encoded. This is
different behavior than DomainVersion. The reason for
this is documented in
Commands.setFirmware(DeviceContext, InputStream)
.
getBlob
in interface Version
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRelativeDisplayName()
getAbsoluteDisplayName()
public java.lang.String getAbsoluteDisplayName()
getRelativeDisplayName()
,
Firmware.getDisplayName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |