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

Class DataRoutingService.Delegating

java.lang.Object

com.illumon.iris.db.v2.routing.DataRoutingService.Delegating

All Implemented Interfaces:

DataRoutingService, StorageLookup, EndpointResolver, ClaimsProvider, SafeCloseable, NamedImplementation, AutoCloseable

Direct Known Subclasses:

DataRoutingServiceCachingImpl, DataRoutingServiceK8sImpl, DataRoutingServiceKvImpl

Enclosing interface:

DataRoutingService

public abstract static class DataRoutingService.Delegating
extends Object
implements DataRoutingService

Delegate method calls to an implementation object. This is designed to be subclassed.

Nested Class Summary

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

DataRoutingService.DeferredEndpoint, DataRoutingService.Delegating, DataRoutingService.Endpoint, DataRoutingService.EndpointConfig, DataRoutingService.ImmutablePropertyProvider, DataRoutingService.MapPropertyProvider, DataRoutingService.NonListening, DataRoutingService.NotReadyException, DataRoutingService.NullPropertyProvider, DataRoutingService.PropertyProvider

Field Summary

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

DEFAULT_LOCAL_TABLE_DATA_SERVICE, DEFAULT_QUERY_SERVER_TABLE_DATA_SERVICE, DEFAULT_SELECTION_TAG, HOST_TAG, MERGE_QUERY_TDS_TAG, NULL_PROPERTY_PROVIDER, PORT_TAG, QUERY_QUERY_TDS_TAG, SERVICE_REGISTRY_NONE, SERVICE_REGISTRY_SERVICE, TABLE_DATA_PORT_TAG, TABLE_DATA_SERVICE_CONFIG_PROP, TABLE_DATA_SERVICE_CONFIG_PROPS_WITH_LEGACY, TAILER_PORT_TAG, VALIDATE_QUERY_TDS_TAG

Constructor Summary

Constructors

Constructor	Description
Delegating()

Method Summary

Modifier and Type	Method	Description
abstract String	about()	Information about a DataRoutingService instance.
@NotNull String	asYamlString()	Serialize the data routing as a YAML string.
void	close()
@NotNull Map<String,DataImportServiceConfig>	getAllDataImportServiceConfigs(boolean excludeCoreConfigs)	Get all DIS configs, optionally excluding core configs (those defined in the main routing yml file) For consumption by administrative tools.
@NotNull Collection<? extends DataImportServiceConfig.EndpointConfig>	getAllDataImportServiceDestinationConfigs()	Get all known DataImportServer destination configs.
@NotNull Collection<? extends LogAggregatorConfig>	getAllLogAggregatorServiceConfigs()	Return all log aggregator configurations.
@NotNull CollectedClaims	getCollectedClaims()	Get the current claims for this owner (DataRoutingService).
@Nullable DataImportServiceConfig	getDataImportServiceConfig(@NotNull String name)	Get DIS parameters for this named DIS instance.
@NotNull Collection<? extends DataImportServiceConfig.EndpointConfig>	getDataImportServiceDestinationConfigs(@NotNull TableIdentifier tableIdentifier)	Get DIS destination configs for a table key.
protected abstract @NotNull DataRoutingService	getDelegate()
LogAggregatorConfig	getLogAggregatorConfig(@NotNull String configName)	Get configuration for the named log aggregator service instance.
LogAggregatorConfig.EndpointConfig	getLogAggregatorDestinationConfig(@NotNull TableIdentifier tableIdentifier)	Get the single LAS destination configuration for the given table key.
@Nullable StorageConfig	getStorage(@Nullable String name)	Get the StorageConfig associated with the given name.
@Nullable TableDataServiceConfig	getTableDataServiceConfig(@NotNull String name)	Information needed to configure a table data service server.
@NotNull Collection<? extends TableDataServiceConfig>	getTableDataServiceConfigs()	Get all known table data service configurations.
long	listen(@NotNull DataRoutingConfigListener listener)	Add a listener for changes to the DataRoutingService configuration.
void	registerClaims(@NotNull DataImportServiceConfig disConfig)	Register all claims for the given DataImportServiceConfig.
boolean	removeListener(@NotNull DataRoutingConfigListener listener)	Remove the given listener from the list of listeners.
boolean	supportsChangeNotification()	Probe the implementation to find out if change notification is supported.

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.routing.DataRoutingService

authenticate, authenticate, authenticate, getAllDataImportServiceConfigs, getAllDataImportServiceDeferredDestinations, getAllDataImportServiceDestinations, getDataImportServiceConfigWithStorage, getDataImportServiceDeferredDestinations, getDataImportServiceDestinations, getLocalInstance, getLogAggregatorDeferredDestination, getLogAggregatorDestination

Methods inherited from interface com.illumon.iris.db.v2.routing.endpoint.EndpointResolver

resolveLogAggregatorEndpoint, resolveTableDataEndpoint, resolveTailerEndpoint

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

getImplementationName

Constructor Details

Delegating

public Delegating()

Method Details

getDelegate

@NotNull
protected abstract @NotNull DataRoutingService getDelegate()

about

public abstract String about()

Description copied from interface: DataRoutingService

Information about a DataRoutingService instance. Useful for debugging.

Specified by:

about in interface DataRoutingService

Returns:

a string containing information about the instance

getDataImportServiceConfig

@Nullable
public @Nullable DataImportServiceConfig getDataImportServiceConfig(@NotNull
 @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.

getDataImportServiceDestinationConfigs

@NotNull
public @NotNull Collection<? extends DataImportServiceConfig.EndpointConfig> getDataImportServiceDestinationConfigs(@NotNull
 @NotNull TableIdentifier tableIdentifier)

Description copied from interface: DataRoutingService

Get DIS destination configs for a table key. For consumption by a Tailer.

Specified by:

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

getAllDataImportServiceConfigs

@NotNull
public @NotNull Map<String,DataImportServiceConfig> getAllDataImportServiceConfigs(boolean excludeCoreConfigs)

Description copied from interface: DataRoutingService

Get all DIS configs, optionally excluding core configs (those defined in the main routing yml file) For consumption by administrative tools.

Specified by:

getAllDataImportServiceConfigs in interface DataRoutingService

Parameters:

excludeCoreConfigs - if true, exclude core configs

Returns:

a possibly empty collection of all/non-core DIS configs

getAllDataImportServiceDestinationConfigs

@NotNull
public @NotNull Collection<? extends DataImportServiceConfig.EndpointConfig> getAllDataImportServiceDestinationConfigs()

Description copied from interface: DataRoutingService

Get all known DataImportServer destination configs. This includes destination configs with disabled tailer ports. For consumption by a Tailer.

Specified by:

getAllDataImportServiceDestinationConfigs in interface DataRoutingService

Returns:

a possibly null collection of all known DIS destinations.

getLogAggregatorConfig

public LogAggregatorConfig getLogAggregatorConfig(@NotNull
 @NotNull String configName)

Description copied from interface: DataRoutingService

Get configuration for the named log aggregator service instance.

Specified by:

getLogAggregatorConfig in interface DataRoutingService

Parameters:

configName - the LAS configuration name

Returns:

the configuration for the named log aggregator, no null if it does not exist

getAllLogAggregatorServiceConfigs

@NotNull
public @NotNull Collection<? extends LogAggregatorConfig> getAllLogAggregatorServiceConfigs()

Description copied from interface: DataRoutingService

Return all log aggregator configurations.

Specified by:

getAllLogAggregatorServiceConfigs in interface DataRoutingService

Returns:

a collection of all configured log aggregators.

getLogAggregatorDestinationConfig

@Nullable
public LogAggregatorConfig.EndpointConfig getLogAggregatorDestinationConfig(@NotNull
 @NotNull TableIdentifier tableIdentifier)

Description copied from interface: DataRoutingService

Get the single LAS destination configuration for the given table key.

Specified by:

getLogAggregatorDestinationConfig in interface DataRoutingService

Parameters:

tableIdentifier - the identifier of the data to be logged

Returns:

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

getTableDataServiceConfig

@Nullable
public @Nullable TableDataServiceConfig getTableDataServiceConfig(@NotNull
 @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 @NotNull Collection<? extends 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 @NotNull 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

getStorage

@Nullable
public @Nullable StorageConfig getStorage(@Nullable
 @Nullable String name)

Description copied from interface: StorageLookup

Get the StorageConfig associated with the given name.

Specified by:

getStorage in interface StorageLookup

Parameters:

name - The name of the storage to look up. May be null, in which case null will always be returned.

Returns:

The storage config, or null if not found

getCollectedClaims

@NotNull
public @NotNull CollectedClaims getCollectedClaims()

Description copied from interface: ClaimsProvider

Get the current claims for this owner (DataRoutingService).

Specified by:

getCollectedClaims in interface ClaimsProvider

Returns:

the current CollectedClaims

registerClaims

public void registerClaims(@NotNull
 @NotNull DataImportServiceConfig disConfig)

Description copied from interface: ClaimsProvider

Register all claims for the given DataImportServiceConfig.

Specified by:

registerClaims in interface ClaimsProvider

Parameters:

disConfig - The DIS config to register

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

supportsChangeNotification

public boolean supportsChangeNotification()

Description copied from interface: DataRoutingService

Probe the implementation to find out if change notification is supported.

Specified by:

supportsChangeNotification in interface DataRoutingService

Returns:

true if change notifications are supported.

listen

public long listen(@NotNull
 @NotNull DataRoutingConfigListener listener)

Description copied from interface: DataRoutingService

Add a listener for changes to the DataRoutingService configuration.

Specified by:

listen in interface DataRoutingService

Parameters:

listener - configuration change notices will be published to this listener

Returns:

the current configuration version

removeListener

public boolean removeListener(@NotNull
 @NotNull DataRoutingConfigListener listener)

Description copied from interface: DataRoutingService

Remove the given listener from the list of listeners.

Specified by:

removeListener in interface DataRoutingService

Parameters:

listener - the listener to remove

Returns:

true if a listener was removed, false if it could not be found or could not be removed