Interface Agent

All Superinterfaces:
com.seeq.link.sdk.interfaces.AgentService
All Known Implementing Classes:
DefaultAgent

public interface Agent extends com.seeq.link.sdk.interfaces.AgentService
The agent interface facilitates initialization/destruction of agents, and allows for querying of the sum of all connections.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Destroys all connectors and stops sending heartbeats to the Seeq Server.
    List<com.seeq.link.sdk.interfaces.DatasourceConnection>
    Provides a collection of connections, which represents the union of all connections being managed by all connectors.
    void
    initialize(String name, SeeqWsConnection seeqWsConnection, SeeqHttpConnection seeqHttpConnection, ConnectorLoader connectorLoader, com.seeq.link.sdk.interfaces.ConfigService configService, Path dataFolder, Path globalFolder, boolean isRemoteAgent, RemoteAppender remoteAppender, com.seeq.link.sdk.interfaces.RemoteConfigChangeListener remoteConfigChangeListener, URL seeqExternalUrl)
    Agents have several dependencies, as detailed in the param documentation.

    Methods inherited from interface com.seeq.link.sdk.interfaces.AgentService

    createBatchSizeHelper, createBatchSizeHelper, getAgentIdentification, getApiProvider, getConfigService, getDataFolder, getDisplayName, getExportTaskScheduler, getGlobalFolder, getIndexingApiProvider, getSeeqServerURL, isRemoteAgent, isSeeqServerConnected, markConnectionsAsReinitialized, requestIndex, requestIndex, requestRestart, resolveSecret, sendAgentInfoToServer, sendMessage
  • Method Details

    • initialize

      void initialize(String name, SeeqWsConnection seeqWsConnection, SeeqHttpConnection seeqHttpConnection, ConnectorLoader connectorLoader, com.seeq.link.sdk.interfaces.ConfigService configService, Path dataFolder, Path globalFolder, boolean isRemoteAgent, RemoteAppender remoteAppender, com.seeq.link.sdk.interfaces.RemoteConfigChangeListener remoteConfigChangeListener, URL seeqExternalUrl)
      Agents have several dependencies, as detailed in the param documentation. The initialization call will load connectors and, if they are enabled in the Agent's connector configuration (which they are by default), will initialize them. Typically, a connector will detect established connection configurations and attempt to make connections automatically, but that is dependent on the connector implementation.
      Parameters:
      name - The name of the Agent, which is used in various communications and as the name of configuration file.
      seeqWsConnection - The Seeq Server bi-directional connection interface.
      seeqHttpConnection - The Seeq Server HTTP connection interface for communication using the API.
      connectorLoader - The interface used to find and load connectors.
      configService - The interface used to load configuration information.
      dataFolder - The path of the data folder for configuration, logs, and Seeq data
      globalFolder - The path of the data folder for configuration, logs, and Seeq data
      isRemoteAgent - True if this agent is a remote agent that should use compression
      remoteAppender - The remote appender to harvest log entries from. Only supply when isRemoteAgent is true.
      remoteConfigChangeListener - The listener to be informed when agent / connector configuration changed remotely
      seeqExternalUrl - The URL for Seeq users. (The agent connects on the private URL.)
    • destroy

      void destroy()
      Destroys all connectors and stops sending heartbeats to the Seeq Server.
    • getConnections

      List<com.seeq.link.sdk.interfaces.DatasourceConnection> getConnections()
      Provides a collection of connections, which represents the union of all connections being managed by all connectors.
      Returns:
      The union of all connections on all connectors.