Package org.odpi.openmetadata.serveroperations.rest

Class ServerStatusResponse

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
org.odpi.openmetadata.serveroperations.rest.ServerStatusResponse
All Implemented Interfaces:
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponse
public class ServerStatusResponse extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
ServerStatusResponse returns the status of a server running in a platform.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServerStatusResponse()
    Default constructor
    ServerStatusResponse(ServerStatusResponse template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    Date
    getServerEndTime()
    Return the time that the server last ended - it is null if the server is currently active.
    List<OMAGServerInstanceHistory>
    getServerHistory()
    Return the list of start and stop times for the previous restarts of the server.
    String
    getServerName()
    Return the name of the server where the services are running.
    Date
    getServerStartTime()
    Return the time that the server last started.
    String
    getServerType()
    Return the type of server that is hosting these services.
    int
    hashCode()
    Return hash code for this object
    boolean
    isActive()
    Is the server instance currently running?
    void
    setActive(boolean active)
    Set up whether the server is currently running.
    void
    setServerEndTime(Date serverEndTime)
    Set up the time that the server last ended - it is null if the server is currently active.
    void
    setServerHistory(List<OMAGServerInstanceHistory> serverHistory)
    Set up the list of start and stop times for the previous restarts of the server.
    void
    setServerName(String serverName)
    Set up the name of the server where the services are running.
    void
    setServerStartTime(Date serverStartTime)
    Set up the time that the server last started.
    void
    setServerType(String serverType)
    Set up the type of server that is hosting these services.
    String
    toString()
    JSON-like toString

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

    getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ServerStatusResponse

      public ServerStatusResponse()
      Default constructor

    • ServerStatusResponse

      public ServerStatusResponse(ServerStatusResponse template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getServerName

      public String getServerName()
      Return the name of the server where the services are running.
      Returns:
      name of server

    • setServerName

      public void setServerName(String serverName)
      Set up the name of the server where the services are running.
      Parameters:
      serverName - name of server

    • getServerType

      public String getServerType()
      Return the type of server that is hosting these services.
      Returns:
      string name

    • setServerType

      public void setServerType(String serverType)
      Set up the type of server that is hosting these services.
      Parameters:
      serverType - string name

    • isActive

      public boolean isActive()
      Is the server instance currently running?
      Returns:
      boolean

    • setActive

      public void setActive(boolean active)
      Set up whether the server is currently running.
      Parameters:
      active - boolean

    • getServerStartTime

      public Date getServerStartTime()
      Return the time that the server last started.
      Returns:
      date/time

    • setServerStartTime

      public void setServerStartTime(Date serverStartTime)
      Set up the time that the server last started.
      Parameters:
      serverStartTime - date/time

    • getServerEndTime

      public Date getServerEndTime()
      Return the time that the server last ended - it is null if the server is currently active.
      Returns:
      date/time or null

    • setServerEndTime

      public void setServerEndTime(Date serverEndTime)
      Set up the time that the server last ended - it is null if the server is currently active.
      Parameters:
      serverEndTime - date/time

    • getServerHistory

      public List<OMAGServerInstanceHistory> getServerHistory()
      Return the list of start and stop times for the previous restarts of the server.
      Returns:
      server history

    • setServerHistory

      public void setServerHistory(List<OMAGServerInstanceHistory> serverHistory)
      Set up the list of start and stop times for the previous restarts of the server.
      Parameters:
      serverHistory - server history

    • toString

      public String toString()
      JSON-like toString
      Overrides:
      toString in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Returns:
      string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Returns:
      int hash code