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 enum 
    Relation.Direction
    Declares the direction types of an relation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    LOCAL_CHANNEL
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChannel()
    Returns the name of the communication channel this relation is realized by.
    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.
    String
    getFunction()
    Returns the function at the containing service associated with this relation.
    String
    getId()
    The id of the relation.
    String
    getService()
    The id of the service this relation is connecting to.
    String
    getType()
    Returns the type of the data.
    String[]
    getTypes()
    Returns the types of data.

  • Field Details

  • Method Details

    • getId

      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

      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

      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

      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

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

    • getType

      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

      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()