Package com.day.cq.polling.importer

Interface PollConfig

public interface PollConfig
The PollConfig interface represents polling configurations managed by the PollingImporter service.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getInterval()
    The active poll interval in seconds of this configuration.
    String
    getLogin()
    The login of this configuration.
    String
    getPassword()
    The password of this configuration.
    String
    getPath()
    Returns the identification path of this configuration.
    String
    getScheme()
    Returns the scheme.
    String
    getSource()
    Returns the data source URL.
    long
    getStoredInterval()
    The stored poll interval in seconds of this configuration.
    String
    getTarget()
    Returns the target path where the polled data is being stored.
    boolean
    isEnabled()
    The enable state for the configuration.

  • Method Details

    • getPath

      String getPath()
      Returns the identification path of this configuration.
      Returns:
      Identification path

    • getScheme

      String getScheme()
      Returns the scheme. This is used to select the appropriate Importer to handle polling the data source of this configuration.
      Returns:
      String representation of the scheme

    • getSource

      String getSource()
      Returns the data source URL. This is given to the Importer handling the getScheme() of this configuration to acquire the data.
      Returns:
      Data source URL

    • getTarget

      String getTarget()
      Returns the target path where the polled data is being stored. This is used to create the Resource provided to the Importer to import the data.
      Returns:
      Target path

    • getInterval

      long getInterval()
      The active poll interval in seconds of this configuration.
      Returns:
      Active poll interval in seconds

    • getStoredInterval

      long getStoredInterval()
      The stored poll interval in seconds of this configuration.
      Returns:
      Stored poll interval in seconds

    • isEnabled

      boolean isEnabled()
      The enable state for the configuration.
      Returns:
      Enabled state

    • getLogin

      String getLogin()
      The login of this configuration.
      Returns:
      Login name

    • getPassword

      String getPassword()
      The password of this configuration.
      Returns:
      Password