Package com.illumon.iris.db.v2.locations.local

Class LocalTableDataService

java.lang.Object

com.illumon.iris.db.v2.tabledataservice.AbstractTableDataService

com.illumon.iris.db.v2.locations.local.LocalTableDataService

All Implemented Interfaces:

TableDataService, NamedImplementation

public class LocalTableDataService
extends AbstractTableDataService

A table data service that finds locations via scanning a well-known directory hierarchy on a filesystem.

Note that multiple actual filesystems may be traversed depending on how links are assembled in the directory structure, and that remote filesystems (e.g. NFS) may be included.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.tabledataservice.TableDataService

TableDataService.Null

Field Summary

Fields

Modifier and Type	Field	Description
static EnumSet<TableType>	ALL_SUPPORTED_TABLE_TYPES
static final String	ALLOW_LIVE_USER_TABLES_PROP
static final boolean	DEFAULT_ALLOW_LIVE_USER_TABLES
static final int	DEFAULT_REFRESH_THREAD_POOL_SIZE
static final long	DEFAULT_TABLE_LOCATION_REFRESH_MILLIS
static final long	DEFAULT_TABLE_SIZE_REFRESH_MILLIS
static final String	GLOBAL_REFRESH_THREAD_POOL_SIZE_PROP
static final String	GLOBAL_TABLE_LOCATION_REFRESH_MILLIS_PROP
static final String	GLOBAL_TABLE_SIZE_REFRESH_MILLIS_PROP

Constructor Summary

Constructors

Constructor	Description
LocalTableDataService(LocalTablePathManager locationManager)	Simple read-only service for all supported table types.
LocalTableDataService(LocalTablePathManager locationManager, DataRoutingService.PropertyProvider properties)	Simple read-only service for all supported table types.
LocalTableDataService(LocalTablePathManager locationManager, EnumSet<TableType> tableTypes, boolean writable, DataRoutingService.PropertyProvider properties)	Creates a new LocalTableDataService with the specified parameters.
LocalTableDataService(File root)	Deprecated. the caller should have a LocalTablePathManager.
LocalTableDataService(String name, LocalTableDataServiceDescriptor descriptor)	The main constructor.
LocalTableDataService(String name, LocalTablePathManager locationManager, EnumSet<TableType> tableTypes, boolean writable, DataRoutingService.PropertyProvider properties)	Delegate to LocalTableDataService(String, LocalTablePathManager, EnumSet, boolean, DataRoutingService.PropertyProvider, boolean) with useMetadataIndexing set according to the default property and writable parameter.
LocalTableDataService(String name, LocalTablePathManager locationManager, EnumSet<TableType> tableTypes, boolean writable, DataRoutingService.PropertyProvider properties, boolean useMetadataIndexing)	The main constructor not using a TableDataServiceConfiguration object.

Method Summary

Modifier and Type	Method	Description
void	authenticate()	Authenticate the TableDataService using AuthenticationClientManager.getDefault()
LocalTableDataServiceDescriptor	getDescriptor()	Return the descriptor object for this TableDataService instance.
final LocalTablePathManager	getLocalTablePathManager()
protected TableLocationProvider	makeTableLocationProvider(TableKey tableKey)
void	shutdown()	Stop any processes and release resources held by this TableDataService instance.
String	toString()

Methods inherited from class com.illumon.iris.db.v2.tabledataservice.AbstractTableDataService

getKnownLocationProviders, getName, getTableLocationProvider, reset, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.illumon.util.type.NamedImplementation

getImplementationName

Methods inherited from interface com.illumon.iris.db.v2.tabledataservice.TableDataService

describe, getTableLocationProvider

Field Details

ALLOW_LIVE_USER_TABLES_PROP

public static final String ALLOW_LIVE_USER_TABLES_PROP

See Also:

• Constant Field Values

GLOBAL_TABLE_LOCATION_REFRESH_MILLIS_PROP

public static final String GLOBAL_TABLE_LOCATION_REFRESH_MILLIS_PROP

See Also:

• Constant Field Values

GLOBAL_TABLE_SIZE_REFRESH_MILLIS_PROP

public static final String GLOBAL_TABLE_SIZE_REFRESH_MILLIS_PROP

See Also:

• Constant Field Values

GLOBAL_REFRESH_THREAD_POOL_SIZE_PROP

public static final String GLOBAL_REFRESH_THREAD_POOL_SIZE_PROP

See Also:

• Constant Field Values

DEFAULT_TABLE_LOCATION_REFRESH_MILLIS

public static final long DEFAULT_TABLE_LOCATION_REFRESH_MILLIS

See Also:

• Constant Field Values

DEFAULT_TABLE_SIZE_REFRESH_MILLIS

public static final long DEFAULT_TABLE_SIZE_REFRESH_MILLIS

See Also:

• Constant Field Values

DEFAULT_REFRESH_THREAD_POOL_SIZE

public static final int DEFAULT_REFRESH_THREAD_POOL_SIZE

See Also:

• Constant Field Values

DEFAULT_ALLOW_LIVE_USER_TABLES

public static final boolean DEFAULT_ALLOW_LIVE_USER_TABLES

See Also:

• Constant Field Values

ALL_SUPPORTED_TABLE_TYPES

public static EnumSet<TableType> ALL_SUPPORTED_TABLE_TYPES

Constructor Details

LocalTableDataService

public LocalTableDataService(@NotNull
 LocalTablePathManager locationManager)

Simple read-only service for all supported table types.

Parameters:

locationManager - The database location manager

LocalTableDataService

public LocalTableDataService(@NotNull
 LocalTablePathManager locationManager,
 @NotNull
 DataRoutingService.PropertyProvider properties)

Simple read-only service for all supported table types.

Parameters:

locationManager - The database location manager

properties - Configuration properties for this table data service

LocalTableDataService

public LocalTableDataService(@NotNull
 LocalTablePathManager locationManager,
 @NotNull
 EnumSet<TableType> tableTypes,
 boolean writable,
 @NotNull
 DataRoutingService.PropertyProvider properties)

Creates a new LocalTableDataService with the specified parameters.

Parameters:

locationManager - The database location manager

tableTypes - The set of table types this service should support

writable - Whether this service should allow write operations

properties - Configuration properties for this table data service

LocalTableDataService

public LocalTableDataService(@Nullable
 String name,
 @NotNull
 LocalTablePathManager locationManager,
 @NotNull
 EnumSet<TableType> tableTypes,
 boolean writable,
 @NotNull
 DataRoutingService.PropertyProvider properties)

Delegate to LocalTableDataService(String, LocalTablePathManager, EnumSet, boolean, DataRoutingService.PropertyProvider, boolean) with useMetadataIndexing set according to the default property and writable parameter. useMetadataIndexing is always false if writable is true.

Parameters:

name - A name for this service

locationManager - The database location manager

tableTypes - The set of table types this service should support

writable - Whether this service should allow write operations

properties - Configuration properties for this table data service

LocalTableDataService

public LocalTableDataService(@Nullable
 String name,
 @NotNull
 LocalTablePathManager locationManager,
 @NotNull
 EnumSet<TableType> tableTypes,
 boolean writable,
 @NotNull
 DataRoutingService.PropertyProvider properties,
 boolean useMetadataIndexing)

The main constructor not using a TableDataServiceConfiguration object.

Parameters:

name - A name for this service

locationManager - The database location manager

tableTypes - the table types that should be supported

writable - true if the managed locations should be writable

properties - Configuration properties for this table data service

useMetadataIndexing - if true, use cached location metadata, not valid with writable locations

LocalTableDataService

public LocalTableDataService(@Nullable
 String name,
 @NotNull
 LocalTableDataServiceDescriptor descriptor)

The main constructor.

Parameters:

name - A name for this service

descriptor - the configuration for this LTDS

LocalTableDataService

@Deprecated
@TestUseOnly
public LocalTableDataService(@NotNull
 File root)

Deprecated.

the caller should have a LocalTablePathManager.

For testing only.

Parameters:

root - construct a LocalTablePathManager rooted here.

Method Details

getLocalTablePathManager

public final LocalTablePathManager getLocalTablePathManager()

makeTableLocationProvider

@NotNull
protected TableLocationProvider makeTableLocationProvider(@NotNull
 TableKey tableKey)

Specified by:

makeTableLocationProvider in class AbstractTableDataService

authenticate

public void authenticate()

Description copied from interface: TableDataService

Authenticate the TableDataService using AuthenticationClientManager.getDefault()

shutdown

public void shutdown()

Stop any processes and release resources held by this TableDataService instance.

toString

public String toString()

Overrides:

toString in class AbstractTableDataService

getDescriptor

@NotNull
public LocalTableDataServiceDescriptor getDescriptor()

Description copied from interface: TableDataService

Return the descriptor object for this TableDataService instance.

Specified by:

getDescriptor in interface TableDataService

Overrides:

getDescriptor in class AbstractTableDataService

Returns:

the TableDataServiceDescriptor for this TableDataService