Package de.iip_ecosphere.platform.services.spring.descriptor

Interface Relation

  • All Known Implementing Classes:
    YamlRelation
    public interface Relation
    Represents a relation/connection between services, including the local communication broker/server endpoint (no other information given), an outgoing data port (channel, direction, type) or an opposite side incoming data port (channel, id, service, direction, type). [Name taken from usage view]
    Author:
    Holger Eichelberger, SSE

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Relation.Direction
      Declares the direction types of an relation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String LOCAL_CHANNEL  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getChannel()
      Returns the name of the communication channel this relation is realized by.
      java.lang.String getDescription()
      Returns the description of the relation.
      Relation.Direction getDirection()
      Returns the direction of the relation.
      Endpoint getEndpoint()
      Returns communication endpoint (port/host) the service shall communicate with.
      java.lang.String getFunction()
      Returns the function at the containing service associated with this relation.
      java.lang.String getId()
      The id of the relation.
      java.lang.String getService()
      The id of the service this relation is connecting to.
      java.lang.String getType()
      Returns the type of the data.
      java.lang.String[] getTypes()
      Returns the types of data.

    • Method Detail

      • getId

        java.lang.String getId()
        The id of the relation. All relation entries of all participating services must have the same id. Depending on the underlying implementation, id may be the same as getChannel() or differ, e.g, if getChannel() points to a technical channel name.
        Returns:
        the id of the channel, may be empty if is empty or in case of an outgoing data port, must be given for an opposite side data port.

      • getChannel

        java.lang.String getChannel()
        Returns the name of the communication channel this relation is realized by. Channel names may be used to query host and port via NetworkManager.
        Returns:
        the channel name, may be LOCAL_CHANNEL referring to all channels used for local communication

      • getService

        java.lang.String getService()
        The id of the service this relation is connecting to.
        Returns:
        the id of the service, may be empty if is empty or in case of an outgoing data port, must be given to denote the service holding an opposite side incoming data port.

      • getFunction

        java.lang.String getFunction()
        Returns the function at the containing service associated with this relation.
        Returns:
        the function name (may be null or empty for implicit functions that shall not be exibited)

      • getEndpoint

        Endpoint getEndpoint()
        Returns communication endpoint (port/host) the service shall communicate with.
        Returns:
        the communication endpoint (may be null for internal relations}

      • getDescription

        java.lang.String getDescription()
        Returns the description of the relation.
        Returns:
        the description, may be empty

      • getType

        java.lang.String getType()
        Returns the type of the data. May be multiple types, separated by commas.
        Returns:
        the type as qualified Java name (may be null for the relation with empty getChannel()

      • getTypes

        java.lang.String[] getTypes()
        Returns the types of data. getType() parsed into potentially many types}.
        Returns:
        the types, may contain just a single value

      • getDirection

        Relation.Direction getDirection()
        Returns the direction of the relation.
        Returns:
        the direction (may be null for the relation with empty getChannel()