Package com.tccc.kos.core.primary.service.update

Class UpdateInfo

java.lang.Object
com.tccc.kos.core.primary.service.update.UpdateInfo
public class UpdateInfo extends Object
Information about a software update available on a storage device. UpdateService will examine all the KABs on the storage device, identify all the manifest chains and filter out any chains that are not compatible with the device. Each remaining chain is a potential software update that can installed.

The notes are intended to be displayed to the user performing the install to give them a sense of what is being installed. Given that an update can be defined by a chain of manifests, it can be difficult to give an update a single release number or description. UpdateService extracts the kos.install.summary and kos.install.detail properties from the various manifests, to build a description of the update via the notes list. See ChainedManifestBuilder to see how to add notes to a release. DeviceManifest notes are provided via kOS Studio.

Version:
2024-05-03

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    UpdateInfo.Note
    Notes from a single manifest in the chain.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCreateTime()
    Return the create time of the first manifest in the chain.
    String
    getDeviceId()
    The id of the storage device that contains the update.
    String
    getManifestId()
    The id of the first manifest in the chain.
    List<UpdateInfo.Note>
    getNotes()
    Return the notes extracted from the manifest chain.
    boolean
    isActive()
    If true, this update is currently running on this device so there is no need to install it again.
    boolean
    isBlocked()
    If true, a manifest in this update has been blocked on this device.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • getManifestId

      public String getManifestId()
      The id of the first manifest in the chain. This is used to install the chain.

    • getCreateTime

      public long getCreateTime()
      Return the create time of the first manifest in the chain.

    • isActive

      public boolean isActive()
      If true, this update is currently running on this device so there is no need to install it again.

    • isBlocked

      public boolean isBlocked()
      If true, a manifest in this update has been blocked on this device. This is typically because the device failed to boot correctly using using this manifest at some point in the past.

    • getDeviceId

      public String getDeviceId()
      The id of the storage device that contains the update.

    • getNotes

      public List<UpdateInfo.Note> getNotes()
      Return the notes extracted from the manifest chain. This gathers the kos.install.summary property and kos.install.details.* properties from each manifest in the chain. By convention this is used to provide a brief description of what is in each manifest in the chain.