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

Interface DataImportServiceConfig

All Superinterfaces:

DataRoutingService.PropertyProvider, ServiceRegistryConfig

All Known Implementing Classes:

DataImportServiceConfig.Delegating

public interface DataImportServiceConfig
extends ServiceRegistryConfig, DataRoutingService.PropertyProvider

For use by DIS instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataImportServiceConfig.DeferredEndpoint
static class	DataImportServiceConfig.Delegating	Delegate method calls to an implementation object.
static interface	DataImportServiceConfig.Endpoint	For use by consumer of DIS as a data sink.
static interface	DataImportServiceConfig.EndpointConfig	Configuration for resolving a DataImportService endpoint

Method Summary

Modifier and Type	Method	Description
DataImportServiceConfig.EndpointConfig	getEndpointConfig()	Get the configuration information a data import server needs to set up its services.
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)
String	getName()	The name of this DataImportService.
String	getStorageRoot()	Get the location where this Data Import Server will write data.
String	getUserIntradayDirectoryName()	Return the name of the subdirectory to use for writing and reader user data.
JettyServerHelper.Parameters	getWebServerParameters()	Return configuration for an optional diagnostic web service.
boolean	isTableDataPortEnabled()	Return true if this DIS will serve data via the Table Data Protocol.
boolean	isTailerPortEnabled()	Return true if this DIS will accept data via the tailer interface.

Methods inherited from interface com.illumon.iris.db.v2.routing.DataRoutingService.PropertyProvider

getAllProperties, getProperty, getProperty

Methods inherited from interface com.illumon.iris.db.v2.routing.ServiceRegistryConfig

getServiceRegistryType

Method Details

getName

@NotNull String getName()

The name of this DataImportService.

Returns:

the configured DIS name.

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

isTableDataPortEnabled

boolean isTableDataPortEnabled()

Return true if this DIS will serve data via the Table Data Protocol.

Returns:

true if this DIS will serve data via table data protocol

isTailerPortEnabled

boolean isTailerPortEnabled()

Return true if this DIS will accept data via the tailer interface.

Returns:

true if this DIS will accept data

getStorageRoot

@NotNull String getStorageRoot()

Get the location where this Data Import Server will write data.

Returns:

the root folder to which data will be written

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.