Package io.deephaven.dhservice.client.config

Interface ClientConnectionConfigProvider

All Known Implementing Classes:

ClientConnectionConfigPathParser, ClientConnectionConfigProviderDefault

public interface ClientConnectionConfigProvider

Provider for ClientConnectionConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClientConnectionConfigProvider.ProviderException

Method Summary

Modifier and Type	Method	Description
String	describe()	Describe this provider, for use in logging.
ClientConnectionConfig	get()	Loads the config.
static String	getConfigServiceFullServicePath()
static ClientConnectionConfigProvider	loadProvider()	Loads the provider.
Properties	toProperties()	Get the properties of the provider.

Method Details

get

ClientConnectionConfig get()
                    throws IOException,
ClientConnectionConfigProvider.ProviderException

Loads the config.

Returns:

the config

Throws:

IOException - if an IO exception occurs while loading the config

ClientConnectionConfigProvider.ProviderException - if a parsing exception occurs while processing the config

toProperties

Properties toProperties()
                 throws ClientConnectionConfigProvider.ProviderException

Get the properties of the provider. Useful for passing along the bootstrapped configuration information, for example, from dispatcher to worker.

Returns:

the properties of the provider

Throws:

ClientConnectionConfigProvider.ProviderException - if a parsing exception occurs while processing the config

loadProvider

static ClientConnectionConfigProvider loadProvider()

Loads the provider.

Returns:

the provider

getConfigServiceFullServicePath

static String getConfigServiceFullServicePath()

describe

String describe()

Describe this provider, for use in logging.

Returns:

String describing this provider