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

Interface DataImportServiceConfig

All Superinterfaces:
DataRoutingService.PropertyProvider, NamedImplementation, ServiceRegistryConfig, StringUtils.StringKeyedObject
All Known Implementing Classes:
DataImportServiceConfig.Delegating, DataImportServiceConfigImpl
public interface DataImportServiceConfig extends ServiceRegistryConfig, DataRoutingService.PropertyProvider, StringUtils.StringKeyedObject, NamedImplementation
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

      @NotNull 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

    • getServiceRegistryType

      @NotNull default String getServiceRegistryType()
      Description copied from interface: ServiceRegistryConfig
      Returns the value populated for 'serviceregistry' tag under endpoints sub-config.
      Specified by:
      getServiceRegistryType in interface ServiceRegistryConfig

    • getStorageName

      @NotNull String getStorageName()
      Get the name of the storage configuration to use for this Data Import Server. "private" is a special value that indicates that the DIS will bring its own storage configuration.
      Returns:
      the configured storage name

    • getStorageRoot

      @Nullable String getStorageRoot()
      Get the location where this Data Import Server will write data. May returns null if the DIS is expected to bring its own storage configuration or if this DataImportServiceConfig has not been realized by a DataRoutingService.
      Returns:
      the root folder to which data will be written, or null
      Throws:
      IllegalStateException - if the storage root lookup is needed but not available

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

    • asTableDataServiceConfig

      @NotNull TableDataServiceConfig asTableDataServiceConfig()
      Data Import Servers (with table data ports) can be used as a TableDataService. This returns a TableDataServiceConfig based on the DIS configuration.
      Returns:
      a TableDataServiceConfig
      Throws:
      IllegalStateException - if the DIS is not configured to serve table data

    • toStringHelper

      default String toStringHelper()
      Default implementation of toString() for DataImportServiceConfig. Can be called by toString() implementations.
      Returns:
      a string representation of this DataImportServiceConfig

    • equals

      static boolean equals(DataImportServiceConfig lhs, DataImportServiceConfig rhs)
      Compare two instances for interface equality.
      Parameters:
      lhs - the first object
      rhs - the second object
      Returns:
      true if the two instances are equal, according to the interface

    • getStringRepresentation

      default String getStringRepresentation()
      Allow all implementations to be stored in a KeyedObjectStore, keyed by name.
      Specified by:
      getStringRepresentation in interface StringUtils.StringKeyedObject
      Returns:
      the name of this DataImportServiceConfig