Package de.iip_ecosphere.platform.services.environment

Enum Class ServiceKind

java.lang.Object
java.lang.Enum<ServiceKind>
de.iip_ecosphere.platform.services.environment.ServiceKind
All Implemented Interfaces:
Serializable, Comparable<ServiceKind>, Constable
public enum ServiceKind extends Enum<ServiceKind>
Defines the service kind.
Author:
Holger Eichelberger, SSE

  • Enum Constant Details

    • SOURCE_SERVICE

      public static final ServiceKind SOURCE_SERVICE
      A source service providing some form of input data, e.g., a connector.

    • TRANSFORMATION_SERVICE

      public static final ServiceKind TRANSFORMATION_SERVICE
      A transformation service in the widest sense, may be an AI service.

    • SINK_SERVICE

      public static final ServiceKind SINK_SERVICE
      A sink service consuming data and not re-emitting data.

    • PROBE_SERVICE

      public static final ServiceKind PROBE_SERVICE
      A probe service receiving data and turning it into alarms or monitoring information.

    • SERVER

      public static final ServiceKind SERVER
      A server process being executed in the environment of a service to utilize the communication capabilities of the service/transport/parameters. Internal service kind.

  • Field Details

    • START_COMPARATOR

      public static final Comparator<ServiceKind> START_COMPARATOR
      Comparator for default start sequence, lowest priority first.

    • startPriority

      private int startPriority

  • Constructor Details

    • ServiceKind

      private ServiceKind(int startPriority)
      Creates a service kind.
      Parameters:
      startPriority - the default start priority of the service kind, non-negative integer, the lower the earlier

  • Method Details

    • values

      public static ServiceKind[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ServiceKind valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getStartPriority

      public int getStartPriority()
      Returns the start priority.
      Returns:
      the default start priority of the service kind, non-negative integer, the lower the earlier

    • before

      public boolean before(ServiceKind kind, boolean includeEquals)
      Returns whether this kind shall be started before kind.
      Parameters:
      kind - the kind to compare
      includeEquals - whether equal start priorities shall be counted as before
      Returns:
      true if this kind shall be started before kind, false else

    • after

      public boolean after(ServiceKind kind, boolean includeEquals)
      Returns whether this kind shall be started after kind.
      Parameters:
      kind - the kind to compare
      includeEquals - whether equal start priorities shall be counted as after
      Returns:
      true if this kind shall be started after kind, false else