Package com.illumon.iris.db.v2.tabledataservice

Interface TableDataService

All Superinterfaces:
NamedImplementation
All Known Implementing Classes:
AbstractTableDataService, CompositeTableDataService, DelegatingTableDataService, DynamicTableDataService, FilteredTableDataService, InvalidTableDataService, LocalTableDataService, RemoteTableDataService, TableDataService.Null
public interface TableDataService extends NamedImplementation
Service responsible for table location discovery.

  • Method Details

    • getTableLocationProvider

      @NotNull default TableLocationProvider getTableLocationProvider(@NotNull String namespace, @NotNull String tableName, @NotNull TableType tableType)
      Request a table location provider from this service.
      Parameters:
      namespace - The namespace
      tableName - The table name
      tableType - The table type
      Returns:
      A table location provider for the specified table key fields

    • getTableLocationProvider

      @NotNull TableLocationProvider getTableLocationProvider(@NotNull TableKey tableKey)
      Request a table location provider from this service.
      Parameters:
      tableKey - The table key
      Returns:
      A table location provider for the specified key

    • getKnownLocationProviders

      @NotNull Map<TableKey,TableLocationProvider> getKnownLocationProviders()
      Get the collection of table location providers that are currently instantiated. The returned map is unmodifiable and stable.
      Returns:
      map of TableKey to TableLocationProvider

    • reset

      void reset()
      Forget all state for future requests.

    • reset

      void reset(TableKey key)
      Forget all state for a single table.
      Parameters:
      key - forget state for this TableKey

    • getName

      @Nullable String getName()
      Allow TableDataService instances to have names.

    • getDescriptor

      @NotNull TableDataServiceDescriptor getDescriptor()
      Return the descriptor object for this TableDataService instance.
      Returns:
      the TableDataServiceDescriptor for this TableDataService

    • authenticate

      void authenticate()
      Authenticate the TableDataService using AuthenticationClientManager.getDefault()

    • describe

      default String describe()
      Like toString, but with more detail.
      Returns:
      a description string

    • shutdown

      default void shutdown()
      Stop any processes and release resources held by this TableDataService instance.