Package com.illumon.iris.db.v2.routing

Interface DataImportServiceConfig

All Superinterfaces:
DataRoutingService.PropertyProvider, ServiceRegistryConfig
All Known Implementing Classes:
DataImportServiceConfig.Delegating
public interface DataImportServiceConfig extends ServiceRegistryConfig, DataRoutingService.PropertyProvider
For use by DIS instance.

  • Method Details

    • getName

      @NotNull String getName()
      The name of this DataImportService.
      Returns:
      the configured DIS name.

    • getGroup

      @Nullable String getGroup()
      The optional group for this DataImportService. Matching DIS instances may be part of a named failover group.
      Returns:
      the group name, or null

    • getUserIntradayDirectoryName

      @NotNull String getUserIntradayDirectoryName()
      Return the name of the subdirectory to use for writing and reader user data.
      Returns:
      the user data directory for this data import server. Not all service instances will use this.

    • getFilter

      @NotNull Filter getFilter()
      Get the filter to be used for
      • TableFilter determining what data this DIS should accept
      • TableFilter and TableLocation filter determining how data is routed in a composed TableDataService (note that this filter is not used when the DIS is used directly as a TableDataService)
      Returns:
      the filter for this DataImportServer

    • getClaims

      @Nullable ClaimSet getClaims()
      Get the claims explicitly made by this DIS. The claims filter interacts with the data routing service and may differ from this list.
      Returns:
      the set of claims for this DIS

    • isTableDataPortEnabled

      boolean isTableDataPortEnabled()
      Return true if this DIS will serve data via the Table Data Protocol.
      Returns:
      true if this DIS will serve data via table data protocol

    • isTailerPortEnabled

      boolean isTailerPortEnabled()
      Return true if this DIS will accept data via the tailer interface.
      Returns:
      true if this DIS will accept data

    • getStorageRoot

      @Nullable String getStorageRoot()
      Get the location where this Data Import Server will write data. Returns null if the DIS is expected to bring its own storage configuration.
      Returns:
      the root folder to which data will be written

    • getWebServerParameters

      @NotNull JettyServerHelper.Parameters getWebServerParameters()
      Return configuration for an optional diagnostic web service.
      Returns:
      configuration for the optional web service (which might be disabled).

    • getEndpointConfig

      @NotNull DataImportServiceConfig.EndpointConfig getEndpointConfig()
      Get the configuration information a data import server needs to set up its services.
      Returns:
      DataImportServiceEndpointConfig that determines how services will be started.