Package de.iip_ecosphere.platform.services

Interface TypedDataConnectorDescriptor

All Superinterfaces:
TypedDataDescriptor
All Known Implementing Classes:
AbstractServiceManager.TypedDataConnection
public interface TypedDataConnectorDescriptor extends TypedDataDescriptor
A typed data connector, i.e., points where data flows into and out from a service. We introduced this interface as channels may exhibit in the future also their connection details, e.g., for display in the service AAS.
Author:
Holger Eichelberger, SSE

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFunction()
    Returns the function at the containing service associated with this relation.
    String
    getId()
    Returns the id of the connector.
    String
    getService()
    Returns the id of the service this connector is pointing to/coming from.

    Methods inherited from interface de.iip_ecosphere.platform.services.TypedDataDescriptor

    getDescription, getName, getType

  • Method Details

    • getId

      String getId()
      Returns the id of the connector. Depending on the implementation, id may be the same as TypedDataDescriptor.getName() or differ, e.g, if TypedDataDescriptor.getName() points to a technical channel name.
      Returns:
      the id

    • getService

      String getService()
      Returns the id of the service this connector is pointing to/coming from.
      Returns:
      the service id, may be null or empty for none

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