Package com.illumon.iris.db.v2.configuration

Class NonExistentDataRoutingService

java.lang.Object

com.illumon.iris.db.v2.configuration.NonExistentDataRoutingService

All Implemented Interfaces:

DataRoutingService, NamedImplementation, AutoCloseable

public class NonExistentDataRoutingService
extends Object
implements DataRoutingService

This implementation is a placeholder for a "does not exist" data routing file.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.configuration.DataRoutingService

DataRoutingService.DataImportServiceConfig, DataRoutingService.DataImportServiceEndpoint, DataRoutingService.Delegating, DataRoutingService.Endpoint, DataRoutingService.Filter, DataRoutingService.ListFilter, DataRoutingService.LocationFilter, DataRoutingService.LogAggregatorConfig, DataRoutingService.LogAggregatorEndpoint, DataRoutingService.NullFilter, DataRoutingService.NullPropertyProvider, DataRoutingService.PropertyProvider, DataRoutingService.TableDataServiceConfig, DataRoutingService.TableFilter

Field Summary

Fields

Modifier and Type	Field	Description
static NonExistentDataRoutingService	INSTANCE

Fields inherited from interface com.illumon.iris.db.v2.configuration.DataRoutingService

DEFAULT_LOCAL_TABLE_DATA_SERVICE, DEFAULT_QUERY_SERVER_TABLE_DATA_SERVICE, DEFAULT_SELECTION_TAG, MERGE_QUERY_TDS_TAG, NULL_FILTER, NULL_PROPERTY_PROVIDER, QUERY_QUERY_TDS_TAG, TABLE_DATA_SERVICE_CONFIG_PROP, TABLE_DATA_SERVICE_CONFIG_PROPS_WITH_LEGACY, VALIDATE_QUERY_TDS_TAG

Constructor Summary

Constructors

Constructor	Description
NonExistentDataRoutingService()

Method Summary

Modifier and Type	Method	Description
String	about()	Information about a SchemaService instance.
String	asYamlString()	Serialize the data routing as a YAML string.
void	close()
Collection<? extends DataRoutingService.DataImportServiceEndpoint>	getAllDataImportServiceDestinations()	Get all known DIS destinations.
Collection<? extends DataRoutingService.LogAggregatorConfig>	getAllLogAggregatorServiceConfigs()
DataRoutingService.DataImportServiceConfig	getDataImportServiceConfig(String name)	Get DIS parameters for this named DIS instance.
Collection<? extends DataRoutingService.DataImportServiceEndpoint>	getDataImportServiceDestinations(TableIdentifier tableIdentifier)	Get DIS destinations for a table key.
DataRoutingService.LogAggregatorConfig	getLogAggregatorConfig(String configName)
DataRoutingService.LogAggregatorEndpoint	getLogAggregatorDestination(TableIdentifier tableIdentifier)	Get the single LAS destination for the given table key.
TableDataService	getTableDataService(String tdsName, boolean allowIOMessageFlush)	Get the named TableDataService, specifying the message flush behavior for RemoteTableDataService connections.
DataRoutingService.TableDataServiceConfig	getTableDataServiceConfig(String name)	Information needed to configure a table data service server.
Collection<? extends DataRoutingService.TableDataServiceConfig>	getTableDataServiceConfigs()	Get all known table data service configurations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.v2.configuration.DataRoutingService

authenticate, authenticate, authenticate, getTableDataService

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

getImplementationName

Field Details

INSTANCE

public static final NonExistentDataRoutingService INSTANCE

Constructor Details

NonExistentDataRoutingService

public NonExistentDataRoutingService()

Method Details

about

public String about()

Description copied from interface: DataRoutingService

Information about a SchemaService instance. Useful for debugging.

Specified by:

about in interface DataRoutingService

Returns:

a string containing information about the instance

getDataImportServiceConfig

@Nullable public DataRoutingService.DataImportServiceConfig getDataImportServiceConfig(@NotNull String name)

Description copied from interface: DataRoutingService

Get DIS parameters for this named DIS instance. For consumption by a DIS instance or TableDataService consumer.

Specified by:

getDataImportServiceConfig in interface DataRoutingService

Parameters:

name - DIS configuration name

Returns:

the configuration for the named DIS, or null if it does not exist.

getDataImportServiceDestinations

@NotNull public Collection<? extends DataRoutingService.DataImportServiceEndpoint> getDataImportServiceDestinations(@NotNull TableIdentifier tableIdentifier)

Description copied from interface: DataRoutingService

Get DIS destinations for a table key. For consumption by a Tailer.

Specified by:

getDataImportServiceDestinations in interface DataRoutingService

Parameters:

tableIdentifier - the identifier of the data to be logged

Returns:

a possibly empty collection of DIS destinations that should receive data for the given table.

getAllDataImportServiceDestinations

@NotNull public Collection<? extends DataRoutingService.DataImportServiceEndpoint> getAllDataImportServiceDestinations()

Description copied from interface: DataRoutingService

Get all known DIS destinations. For consumption by a Tailer.

Specified by:

getAllDataImportServiceDestinations in interface DataRoutingService

Returns:

a possibly null collection of all known DIS destinations.

getLogAggregatorConfig

public DataRoutingService.LogAggregatorConfig getLogAggregatorConfig(@NotNull String configName)

Specified by:

getLogAggregatorConfig in interface DataRoutingService

getAllLogAggregatorServiceConfigs

public Collection<? extends DataRoutingService.LogAggregatorConfig> getAllLogAggregatorServiceConfigs()

Specified by:

getAllLogAggregatorServiceConfigs in interface DataRoutingService

getLogAggregatorDestination

@Nullable public DataRoutingService.LogAggregatorEndpoint getLogAggregatorDestination(@NotNull TableIdentifier tableIdentifier)

Description copied from interface: DataRoutingService

Get the single LAS destination for the given table key. Must support defaults (e.g. to localhost). TODO: it would be nice to make this a little more generic, so one config also toggles between LAS and direct-to-file options. e.g. a token to give to Logger Factory

Specified by:

getLogAggregatorDestination in interface DataRoutingService

Parameters:

tableIdentifier - the identifier of the data to be logged

Returns:

the configured LogAggregatorEndpoint for the given tableIdentifier, or null if none match the key.

getTableDataService

@Nullable public TableDataService getTableDataService(@NotNull String tdsName, boolean allowIOMessageFlush) throws IOException

Description copied from interface: DataRoutingService

Get the named TableDataService, specifying the message flush behavior for RemoteTableDataService connections. allowIOMessageFlush == true is unsuitable for interactive or other applications where threads might be interrupted.

Specified by:

getTableDataService in interface DataRoutingService

Parameters:

tdsName - the name of a configured TableDataService

allowIOMessageFlush - value to be passed into RemoteTableDataService's constructor

Returns:

the named TableDataService, or null if not found.

Throws:

IOException

getTableDataServiceConfig

@Nullable public DataRoutingService.TableDataServiceConfig getTableDataServiceConfig(@NotNull String name)

Description copied from interface: DataRoutingService

Information needed to configure a table data service server. For use by a TableDataService provider (LocalTableDataServer, TableDataCacheProxy).

Specified by:

getTableDataServiceConfig in interface DataRoutingService

Parameters:

name - configuration name

Returns:

the named TableDataServiceConfig, or null if not found.

getTableDataServiceConfigs

@NotNull public Collection<? extends DataRoutingService.TableDataServiceConfig> getTableDataServiceConfigs()

Description copied from interface: DataRoutingService

Get all known table data service configurations. The data includes name description and tags.

Specified by:

getTableDataServiceConfigs in interface DataRoutingService

Returns:

all known TableDataServiceConfigs

asYamlString

@NotNull public String asYamlString()

Description copied from interface: DataRoutingService

Serialize the data routing as a YAML string. Internal use only.

Specified by:

asYamlString in interface DataRoutingService

Returns:

YAML representation of the configuration

close

public void close() throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception