Package com.highdeal.admin.hci

Class StatusModel

java.lang.Object
com.highdeal.admin.hci.StatusModel
All Implemented Interfaces:
XMLMarshallable
public class StatusModel extends Object implements XMLMarshallable
This Java class represents the status of an instance in the SAP CC system.
  • Running status
  • Start date of the instance of the SAP CC system
  • Current local date of the system instance
  • Current free memory of the JVM
  • Total memory of the JVM
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="status">
  <xs:complexType>
    <xs:attribute name="isRunning" type="xs:boolean" use="required"/>
    <xs:attribute name="startDate" type="xs:dateTime"/>
    <xs:attribute name="currentDate" type="xs:dateTime"/>
    <xs:attribute name="freeMemory" type="xs:decimal" use="required"/>
    <xs:attribute name="totalMemory" type="xs:decimal" use="required"/>
    <xs:attribute name="licenseHardwareKey" type="xs:string"/>
    <xs:attribute name="licenseExpirationDate" type="xs:dateTime" />
    <xs:attribute name="serverStatus" type="ServerStatusType"/>
  </xs:complexType>
</xs:element>

  • Field Details

    • STATUS_MODEL

      public static final String STATUS_MODEL
      XML Mapping for the status model: "status"
      See Also:

    • ISRUNNING

      public static final String ISRUNNING
      XML Mapping for the running flag: "isRunning"
      See Also:

    • STARTDATE

      public static final String STARTDATE
      XML Mapping for the start date: "startDate"
      See Also:

    • CURRENTDATE

      public static final String CURRENTDATE
      XML Mapping for the start date: "startDate"
      See Also:

    • TOTAL_MEMORY

      public static final String TOTAL_MEMORY
      XML Mapping for the total memory: "totalMemory"
      See Also:

    • FREE_MEMORY

      public static final String FREE_MEMORY
      XML Mapping for the free memory: "freeMemory"
      See Also:

    • SERVER_STATUS

      public static final String SERVER_STATUS
      XML Mapping for the server status: "serverStatus"
      See Also:

    • LICENSE_HARDWARE_KEY

      public static final String LICENSE_HARDWARE_KEY
      XML Mapping for the license hardware key: "licenseHardwareKey"
      See Also:

    • LICENSE_EXPIRATION_DATE

      public static final String LICENSE_EXPIRATION_DATE
      XML Mapping for the license expiration date: "licenseExpirationDate"
      See Also:

  • Constructor Details

    • StatusModel

      public StatusModel()

    • StatusModel

      public StatusModel(ServerStatus serverStatus, Date startDate, Date currentDate, long totalMemory, long freeMemory, String licenseHardwareKey, Date licenseExpirationDate)
      Initializes a new StatusModel instance with the running status and the start date of the instance of the SAP CC system

      • totalMemory is the total memory of the JVM on StatusModel creation
      • freeMemory is the free memory of the JVM on StatusModel creation

      Parameters:
      serverStatus -
      startDate - The date when the server was started
      currentDate - The current date of the server
      totalMemory - The total available memory in the JVM
      freeMemory - The free available memory in the JVM
      licenseHardwareKey - The hardware key of the license
      licenseExpirationDate - The expiration date of the license
      See Also:

  • Method Details

    • getStartDate

      public Date getStartDate()
      Gets the date at which the instance of the SAP CC system has been started.
      Returns:
      The instance start date if the instance is started; null otherwise

    • setStartDate

      public void setStartDate(Date startDate)
      Sets the date at which the instance of the SAP CC system has been started
      Parameters:
      startDate - The start date

    • getCurrentDate

      public Date getCurrentDate()
      Gets the current date of this instance of the SAP CC system.
      Returns:
      The current instance date

    • setCurrentDate

      public void setCurrentDate(Date currentDate)
      Sets the current date of this instance of the SAP CC system.
      Parameters:
      currentDate - The current instance date

    • isRunning

      public boolean isRunning()
      Returns true if the instance of SAP CC system is running.
      Returns:
      true if the system instance is running, false otherwize.

    • setIsRunning

      @Deprecated public void setIsRunning(boolean isRunning)
      Deprecated.
      Use setServerStatus(ServerStatus).
      • setIsRunning(true) is equivalent to setServerStatus(ServerStatus.on)
      • setIsRunning(false) is equivalent to setServerStatus(ServerStatus.off)
      Sets the running status of the system instance.
      Parameters:
      isRunning - The running status

    • getFreeMemory

      public long getFreeMemory()
      Gets an estimation of the JVM free memory of the instance of the SAP CC system.
      Returns:
      The free memory of the JVM

    • setFreeMemory

      public void setFreeMemory(long freeMemory)
      Sets an estimation of the JVM free memory of the instance of the SAP CC system.
      Parameters:
      freeMemory - The free memory of the JVM

    • getTotalMemory

      public long getTotalMemory()
      Gets the total memory used by the JVM of the instance of the SAP CC system.
      Returns:
      The total memory of the JVM

    • setTotalMemory

      public void setTotalMemory(long totalMemory)
      Sets the total memory of the instance of the SAP CC system.
      Parameters:
      totalMemory - The total memory of the JVM

    • getServerStatus

      public ServerStatus getServerStatus()
      Returns the server status of the SAP CC instance status.
      Returns:
      the server status of the SAP CC instance status..

    • setServerStatus

      public void setServerStatus(ServerStatus serverStatus)
      Sets the server status of the SAP CC instance status.
      Parameters:
      serverStatus - The server status of the SAP CC instance status.

    • getLicenseHardwareKey

      public String getLicenseHardwareKey()
      Returns the hardware key of the SAP CC instance used by the license.
      Returns:
      the hardware key of the SAP CC instance used by the license

    • setLicenseHardwareKey

      public void setLicenseHardwareKey(String licenseHardwareKey)
      Sets the hardware key of the SAP CC instance used by the license.
      Parameters:
      licenseHardwareKey - the hardware key of the SAP CC instance used by the license

    • getLicenseExpirationDate

      public Date getLicenseExpirationDate()
      Returns the expiration date of the license.
      Returns:
      the expiration date of the license

    • setLicenseExpirationDate

      public void setLicenseExpirationDate(Date licenseExpirationDate)
      Sets the expiration date of the license.
      Parameters:
      licenseExpirationDate - the expiration date of the license

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the operation attributes from the XMLAttributes.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XMLAttributes containing the data

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child tag to this model.

      This tag is ignored for this model.

      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of the tag
      child - The XMLMarshallable child to add

    • addCharacterData

      public void addCharacterData(String cData)
      Adds string data to this model.

      This data is ignored for this model.

      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to add to the operation

    • marshal

      public void marshal(XMLOutputter output)
      Writes the operation XML data to the given output.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XMLOutputter to write into