com.ibm.wsspi.zos.connect

Class ServiceStatus

  • java.lang.Object
    • com.ibm.wsspi.zos.connect.ServiceStatus


  • public class ServiceStatus
    extends java.lang.Object
    Represents a service endpoint's status. Artifacts defining a service status are permitted to define a custom status, but caution must be taken when doing so as the client that started the request may need to know and understand in a well defined manner the status it receives.

    A status description maybe entered. See toString() to learn how this object is represented as a String.

    The default status when this object is first created is UNKNOWN (no description).

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String STARTED
      Indicates that the service endpoint is started and ready to process work requests.
      static java.lang.String STOPPED
      Indicates that the service endpoint is stopped and cannot process work requests
      static java.lang.String UNKNOWN
      Indicates that the service endpoint's status is unknown.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ServiceStatus() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getDescription()
      Retrieves the service status description.
      java.lang.String getStatus()
      Retrieves the service status.
      void setDescription(java.lang.String description)
      Sets the service status description.
      void setStatus(java.lang.String status)
      Sets the service's current status.
      java.lang.String toString()
      Returns a short description of the service status.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • UNKNOWN

        public static final java.lang.String UNKNOWN
        Indicates that the service endpoint's status is unknown.
        See Also:
        Constant Field Values
      • STARTED

        public static final java.lang.String STARTED
        Indicates that the service endpoint is started and ready to process work requests.
        See Also:
        Constant Field Values
      • STOPPED

        public static final java.lang.String STOPPED
        Indicates that the service endpoint is stopped and cannot process work requests
        See Also:
        Constant Field Values
    • Constructor Detail

      • ServiceStatus

        public ServiceStatus()
    • Method Detail

      • setStatus

        public void setStatus(java.lang.String status)
        Sets the service's current status.
        Parameters:
        status - The service's current status.
      • getStatus

        public java.lang.String getStatus()
        Retrieves the service status.
        Returns:
        The service status.
      • setDescription

        public void setDescription(java.lang.String description)
        Sets the service status description.
        Parameters:
        description - The service status description.
      • getDescription

        public java.lang.String getDescription()
        Retrieves the service status description.
        Returns:
        The service status description.
      • toString

        public java.lang.String toString()
        Returns a short description of the service status. The result is the concatenation of the status and, if the description is present, a colon (:), a space, and the description.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the service status.