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

Class DataImportServiceConfig.Delegating

java.lang.Object

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

All Implemented Interfaces:

StringUtils.StringKeyedObject, DataImportServiceConfig, DataRoutingService.PropertyProvider, ServiceRegistryConfig, NamedImplementation

Enclosing interface:

DataImportServiceConfig

public static class DataImportServiceConfig.Delegating
extends Object
implements DataImportServiceConfig

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

DataImportServiceConfig.DeferredEndpoint, DataImportServiceConfig.Delegating, DataImportServiceConfig.Endpoint, DataImportServiceConfig.EndpointConfig

Constructor Summary

Constructors

Constructor	Description
Delegating(DataImportServiceConfig config)	Constructor: Delegate to the given DataImportServiceConfig.

Method Summary

Modifier and Type	Method	Description
TableDataServiceConfig	asTableDataServiceConfig()	Data Import Servers (with table data ports) can be used as a TableDataService.
ClaimSet	getClaims()	Get the claims explicitly made by this DIS.
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	getGroup()	The optional group for this DataImportService.
String	getName()	The name of this DataImportService.
Map<String,String>	getProperties()	Return all properties as a map.
String	getProperty(String propertyName)	Return the named property value, or null.
<T> T	getProperty(String propertyName, T defaultValue)	Return the named property value, with the type indicated by the default value.
String	getServiceRegistryType()	Returns the value populated for 'serviceregistry' tag under endpoints sub-config.
String	getStorageName()	Get the name of the storage configuration to use for this Data Import Server.
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.
String	toString()

Methods inherited from class java.lang.Object

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

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

getStringRepresentation, toStringHelper

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

getImplementationName

Constructor Details

Delegating

public Delegating(@NotNull
 DataImportServiceConfig config)

Constructor: Delegate to the given DataImportServiceConfig.

Parameters:

config - delegate to this DataImportServiceConfig

Method Details

getName

@NotNull
public String getName()

Description copied from interface: DataImportServiceConfig

The name of this DataImportService.

Specified by:

getName in interface DataImportServiceConfig

Returns:

the configured DIS name.

getGroup

@Nullable
public String getGroup()

Description copied from interface: DataImportServiceConfig

The optional group for this DataImportService. Matching DIS instances may be part of a named failover group.

Specified by:

getGroup in interface DataImportServiceConfig

Returns:

the group name, or null

getUserIntradayDirectoryName

@NotNull
public String getUserIntradayDirectoryName()

Description copied from interface: DataImportServiceConfig

Return the name of the subdirectory to use for writing and reader user data.

Specified by:

getUserIntradayDirectoryName in interface DataImportServiceConfig

Returns:

the user data directory for this data import server. Not all service instances will use this.

getFilter

@NotNull
public Filter getFilter()

Description copied from interface: DataImportServiceConfig

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)

Specified by:

getFilter in interface DataImportServiceConfig

Returns:

the filter for this DataImportServer

getClaims

@NotNull
public ClaimSet getClaims()

Description copied from interface: DataImportServiceConfig

Get the claims explicitly made by this DIS. The claims filter interacts with the data routing service and may differ from this list.

Specified by:

getClaims in interface DataImportServiceConfig

Returns:

the set of claims for this DIS

getStorageName

@NotNull
public String getStorageName()

Description copied from interface: DataImportServiceConfig

Get the name of the storage configuration to use for this Data Import Server. "private" is a special value that indicates that the DIS will bring its own storage configuration.

Specified by:

getStorageName in interface DataImportServiceConfig

Returns:

the configured storage name

getStorageRoot

@Nullable
public String getStorageRoot()

Description copied from interface: DataImportServiceConfig

Get the location where this Data Import Server will write data. May returns null if the DIS is expected to bring its own storage configuration or if this DataImportServiceConfig has not been realized by a DataRoutingService.

Specified by:

getStorageRoot in interface DataImportServiceConfig

Returns:

the root folder to which data will be written, or null

getWebServerParameters

@NotNull
public JettyServerHelper.Parameters getWebServerParameters()

Description copied from interface: DataImportServiceConfig

Return configuration for an optional diagnostic web service.

Specified by:

getWebServerParameters in interface DataImportServiceConfig

Returns:

configuration for the optional web service (which might be disabled).

getEndpointConfig

@NotNull
public DataImportServiceConfig.EndpointConfig getEndpointConfig()

Description copied from interface: DataImportServiceConfig

Get the configuration information a data import server needs to set up its services.

Specified by:

getEndpointConfig in interface DataImportServiceConfig

Returns:

DataImportServiceEndpointConfig that determines how services will be started.

getProperty

@Nullable
public String getProperty(@NotNull
 String propertyName)

Description copied from interface: DataRoutingService.PropertyProvider

Return the named property value, or null.

Specified by:

getProperty in interface DataRoutingService.PropertyProvider

Parameters:

propertyName - the name of the property to fetch

Returns:

the value of the property, or null if not set

getProperty

@NotNull
public <T> T getProperty(@NotNull
 String propertyName,
 @NotNull
 T defaultValue)

Description copied from interface: DataRoutingService.PropertyProvider

Return the named property value, with the type indicated by the default value. If the property isn't set, return the default value.

Specified by:

getProperty in interface DataRoutingService.PropertyProvider

Type Parameters:

T - The return value will be cast to this type, as defined by the default value

Parameters:

propertyName - the name of the property to fetch

defaultValue - the typed default value to return if the property is not set

Returns:

the value of the property, or null if not set

getProperties

@NotNull
public Map<String,String> getProperties()

Description copied from interface: DataRoutingService.PropertyProvider

Return all properties as a map. This is useful for interactions outside the DB project.

Specified by:

getProperties in interface DataRoutingService.PropertyProvider

Returns:

a map containing all keys and values for this provider

getServiceRegistryType

@NotNull
public String getServiceRegistryType()

Description copied from interface: ServiceRegistryConfig

Returns the value populated for 'serviceregistry' tag under endpoints sub-config.

Specified by:

getServiceRegistryType in interface DataImportServiceConfig

Specified by:

getServiceRegistryType in interface ServiceRegistryConfig

asTableDataServiceConfig

@NotNull
public TableDataServiceConfig asTableDataServiceConfig()

Description copied from interface: DataImportServiceConfig

Data Import Servers (with table data ports) can be used as a TableDataService. This returns a TableDataServiceConfig based on the DIS configuration.

Specified by:

asTableDataServiceConfig in interface DataImportServiceConfig

Returns:

a TableDataServiceConfig

toString

public String toString()

Overrides:

toString in class Object