Package org.opencastproject.serviceregistry.api

Interface ServiceRegistration

All Known Implementing Classes:
JaxbServiceRegistration, ServiceRegistrationInMemoryImpl
public interface ServiceRegistration
Manages clustered services and the Jobs they may create to enable asynchronous job handling.

  • Method Details

    • getServiceType

      String getServiceType()
      Returns:
      the type of service

    • getHost

      String getHost()
      Returns:
      the host providing the service endpoint.

    • getPath

      String getPath()
      Returns:
      The relative path to the service endpoint.

    • isJobProducer

      boolean isJobProducer()
      Returns:
      Whether the service performs long running operations using Jobs.

    • isActive

      boolean isActive()
      Returns:
      Whether the service is active

    • isOnline

      boolean isOnline()
      Returns:
      Whether the service is online

    • isInMaintenanceMode

      boolean isInMaintenanceMode()
      Whether the service is in maintenance mode. If a server was in maintenance mode when shut down, it will remain in maintenance mode when it comes back online

    • getOnlineFrom

      Date getOnlineFrom()
      Gets the last time the service has been declared online
      Returns:
      the onlineFrom

    • getServiceState

      ServiceState getServiceState()
      Gets the current state of the service
      Returns:
      current state

    • getStateChanged

      Date getStateChanged()
      Gets the last date when state was changed
      Returns:
      last date when state was changed

    • getErrorStateTrigger

      int getErrorStateTrigger()
      Gets the job signature which changed last time the service state to error.
      Returns:
      the signature from error state trigger job

    • getWarningStateTrigger

      int getWarningStateTrigger()
      Gets the job signature which changed last time the service state to warning
      Returns:
      the signature from warning state trigger job