org.commonjava.indy.conf

Interface IndyConfigInfo

All Known Implementing Classes:

DefaultIndyConfiguration, UIConfiguration

public interface IndyConfigInfo

Registration helper for the configuration subsystem, which tells the IndyConfigFactory which section of the configuration file belongs to the conifguration class associated with implemenetations of this helper. It also provides information for writing out default configuration files in case no config is available, in order to setup a config directory that can be managed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPEND_DEFAULTS_TO_MAIN_CONF
static String	CONF_INCLUDES_DIR

Method Summary

Modifier and Type	Method and Description
InputStream	getDefaultConfig() The actual content which should be added to the default configuration file in case no configuration is provided, to allow modification of defaults in future executions.
String	getDefaultConfigFileName() The name of the file to be written in case no configuration is provided, to allow modification of defaults in future executions.

Field Detail

APPEND_DEFAULTS_TO_MAIN_CONF

static final String APPEND_DEFAULTS_TO_MAIN_CONF

See Also:

Constant Field Values

CONF_INCLUDES_DIR

static final String CONF_INCLUDES_DIR

See Also:

Constant Field Values

Method Detail

getDefaultConfigFileName

String getDefaultConfigFileName()

The name of the file to be written in case no configuration is provided, to allow modification of defaults in future executions.

Returns:

a filename, of the form *.conf (unless it's 'main.conf', in which case it'll be appended to the main config file), which will be written to the etc/indy/conf.d directory.

getDefaultConfig

InputStream getDefaultConfig()

The actual content which should be added to the default configuration file in case no configuration is provided, to allow modification of defaults in future executions.

Returns:

The content, usually as a result of loading Thread.currentThread().getContextClassLoader().getResourceAsStream("foo")