Package de.iip_ecosphere.platform.services.environment

Class AbstractYamlService

java.lang.Object
de.iip_ecosphere.platform.services.environment.AbstractYamlService
Direct Known Subclasses:
YamlService
public abstract class AbstractYamlService extends Object
Basic information about a service, abstract because template-based service objects do not work with SnakeYaml. By default, reference types are created based on the attribute definition in the class. As soon as mechanisms are available to handle this, these additional classes may collapse into a more simple hierarchy.
Author:
Holger Eichelberger, SSE

  • Field Details

    • id

      private String id

    • applicationId

      private String applicationId

    • name

      private String name

    • version

      private de.iip_ecosphere.platform.support.Version version

    • description

      private String description

    • kind

      private ServiceKind kind

    • deployable

      private boolean deployable

    • topLevel

      private boolean topLevel

    • netMgtKey

      private String netMgtKey

    • transportChannel

      private String transportChannel

  • Constructor Details

    • AbstractYamlService

      public AbstractYamlService()

  • Method Details

    • getId

      public String getId()
      Returns the unique id of the service.
      Returns:
      the id (may contain the application id and the application instance id if specified)

    • getApplicationId

      public String getApplicationId()
      Returns the application id this service is assigned to (without application instance id).
      Returns:
      the application id

    • getServiceId

      public String getServiceId()
      Returns the service id of the service, i.e. getId() without getApplicationId() and getApplicationInstanceId().
      Returns:
      the id

    • getApplicationInstanceId

      public String getApplicationInstanceId()
      Returns the application instance id this service is running within. Usually, the application id shall be a prefix of this id.
      Returns:
      the application instance id (may be empty for the default application instance)

    • getNetMgtKey

      public String getNetMgtKey()
      Returns the network management key of a service instance this service is relying on.
      Returns:
      the network management key, may be empty or null for none

    • getTransportChannel

      public String getTransportChannel()
      Returns the transport channel to utilize via getNetMgtKey().
      Returns:
      the transport channel, may be empty or null for none if the service uses an own mechanism (discouraged if getNetMgtKey() is given)

    • getName

      public String getName()
      Returns the name of the service.
      Returns:
      the name

    • getVersion

      public de.iip_ecosphere.platform.support.Version getVersion()
      Returns the version of the service.
      Returns:
      the version

    • getDescription

      public String getDescription()
      Returns the description of the service.
      Returns:
      the description

    • getKind

      public ServiceKind getKind()
      Sets the service kind.
      Returns:
      the service kind

    • isDeployable

      public boolean isDeployable()
      Returns whether this service is decentrally deployable.
      Returns:
      true for deployable, false for not deployable

    • isTopLevel

      public boolean isTopLevel()
      Returns whether this service is top-level.
      Returns:
      true for top-level, false for nested

    • setId

      public void setId(String id)
      Defines the id of the service. [required by SnakeYaml]
      Parameters:
      id - the id (may contain the application id if specified)

    • setName

      public void setName(String name)
      Defines the name of the service. [required by SnakeYaml]
      Parameters:
      name - the name

    • setApplicationId

      public void setApplicationId(String applicationId)
      Defines the application id this service is assigned to. [required by SnakeYaml]
      Parameters:
      applicationId - the application id

    • setNetMgtKey

      public void setNetMgtKey(String netMgtKey)
      Defines the network management key of a service instance this service is relying on.
      Parameters:
      netMgtKey - the network management key, may be empty or null for none

    • setTransportChannel

      public void setTransportChannel(String transportChannel)
      Defines the transport channel to utilize via getNetMgtKey().
      Parameters:
      transportChannel - the transport channel, may be empty or null for none if the service uses an own mechanism (discouraged if getNetMgtKey() is given)

    • setVersion

      public void setVersion(de.iip_ecosphere.platform.support.Version version)
      Defines the version of the service. [required by SnakeYaml]
      Parameters:
      version - the version

    • setDescription

      public void setDescription(String description)
      Defines the description of the service. [required by SnakeYaml]
      Parameters:
      description - the description (null is ignored, default is empty)

    • setDeployable

      public void setDeployable(boolean deployable)
      Sets whether this service is decentrally deployable.
      Parameters:
      deployable - true for deployable, false for not deployable

    • setTopLevel

      public void setTopLevel(boolean topLevel)
      Sets whether this service is a top-level service.
      Parameters:
      topLevel - true for topLevel, false for nested

    • setKind

      public void setKind(ServiceKind kind)
      Sets the service kind. [required by SnakeYaml]
      Parameters:
      kind - the service kind