Package de.iip_ecosphere.platform.connectors.events

Interface EventHandlingConnector

All Known Subinterfaces:
Connector<O,I,CO,CI>
All Known Implementing Classes:
AbstractChannelConnector, AbstractConnector, AbstractThreadedConnector
public interface EventHandlingConnector
Basic connector interface providing access to event-relevant functionality.
Author:
Holger Eichelberger, SSE

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enablePolling(boolean enablePolling)
    Enable/disable polling (does not influence the polling timer).
    String
    getName()
    Returns a descriptive name of the connector/the connected protocol.
    Object
    getStorageValue(String key)
    Returns intermediate information that may be useful while transforming the results by configured transformation functions.
    void
    setDataTimeDifference(int difference)
    Adjusts the simulated data time difference.
    void
    setStorageValue(String key, Object value)
    Sets intermediate information that can be read out by while transforming results by configured transformation functions.
    void
    trigger()
    Trigger the ingestion of a next data item.
    void
    trigger(ConnectorTriggerQuery query)
    Trigger the ingestion of a next data item.

  • Method Details

    • getName

      String getName()
      Returns a descriptive name of the connector/the connected protocol.
      Returns:
      a descriptive name of the connected protocol

    • enablePolling

      void enablePolling(boolean enablePolling)
      Enable/disable polling (does not influence the polling timer).
      Parameters:
      enablePolling - whether polling shall enabled
      See Also:

    • trigger

      void trigger()
      Trigger the ingestion of a next data item.

    • trigger

      void trigger(ConnectorTriggerQuery query)
      Trigger the ingestion of a next data item.
      Parameters:
      query - specification what to ingest; capabilities depend on connector

    • setStorageValue

      void setStorageValue(String key, Object value)
      Sets intermediate information that can be read out by while transforming results by configured transformation functions.
      Parameters:
      key - the key of the value to set
      value - the actual value

    • getStorageValue

      Object getStorageValue(String key)
      Returns intermediate information that may be useful while transforming the results by configured transformation functions.
      Parameters:
      key - the key of the value to set
      Returns:
      the value, may be null

    • setDataTimeDifference

      void setDataTimeDifference(int difference)
      Adjusts the simulated data time difference.
      Parameters:
      difference - the difference, negative for configured fixed default, 0 for none (handle with care)