org.norther.tammi.core.config
Interface StreamConfigurator

All Superinterfaces:

Configurator

All Known Subinterfaces:

PropertyConfigurator, XMLConfigurator

All Known Implementing Classes:

AbstractStreamConfigurator, DefaultPropertyConfigurator, DefaultXMLConfigurator

public interface StreamConfigurator
extends Configurator

Extends Configurator by supporting configuration from a stream source.

Author:

Ilkka Priha

Method Summary

void	configure(ObjectName target, File file) Configures a registered MBean from a configuration file by applying the ISO-8859-1 encoding.
void	configure(ObjectName target, File file, String encoding) Configures a registered MBean from an encoded configuration file.
void	configure(ObjectName target, InputStream input) Configures a registered MBean from a configuration stream by applying the ISO-8859-1 encoding.
void	configure(ObjectName target, InputStream input, String encoding) Configures a registered MBean from an encoded configuration stream.
void	configure(ObjectName target, String path) Configures a registered MBean from a configuration file path by applying the ISO-8859-1 encoding.
void	configure(ObjectName target, String path, String encoding) Configures a registered MBean from an encoded configuration file path.
void	configure(ObjectName target, URL url) Configures a registered MBean from a configuration URL by applying the ISO-8859-1 encoding.
void	configure(ObjectName target, URL url, String encoding) Configures a registered MBean from an encoded configuration URL.
String	getConfigKey() Gets the path finder key for resolving configuration paths.
void	setConfigKey(String key) Sets the path finder key for resolving configuration paths.

Methods inherited from interface org.norther.tammi.core.config.Configurator

configure, configure

Method Detail

getConfigKey

String getConfigKey()

Gets the path finder key for resolving configuration paths.

Returns:

the path finder key.

setConfigKey

void setConfigKey(String key)

Sets the path finder key for resolving configuration paths. The default key is PathFinderMBean.CONFIG.

Parameters:

key - the path finder key.

configure

void configure(ObjectName target,
               String path)
               throws ConfigurationException

Configures a registered MBean from a configuration file path by applying the ISO-8859-1 encoding.

Parameters:

target - the object name of the MBean.

path - the pathname of the configuration.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               String path,
               String encoding)
               throws ConfigurationException

Configures a registered MBean from an encoded configuration file path. If encoding is not given, the platform default is applied.

Parameters:

target - the object name of the MBean.

path - the pathname of the configuration.

encoding - the encoding of the configuration.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               File file)
               throws ConfigurationException

Configures a registered MBean from a configuration file by applying the ISO-8859-1 encoding.

Parameters:

target - the object name of the MBean.

file - the configuration file.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               File file,
               String encoding)
               throws ConfigurationException

Configures a registered MBean from an encoded configuration file. If encoding is not given, the platform default is applied.

Parameters:

target - the object name of the MBean.

file - the configuration file.

encoding - the encoding of the configuration.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               URL url)
               throws ConfigurationException

Configures a registered MBean from a configuration URL by applying the ISO-8859-1 encoding.

Parameters:

target - the object name of the MBean.

url - the configuration URL.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               URL url,
               String encoding)
               throws ConfigurationException

Configures a registered MBean from an encoded configuration URL. If encoding is not given, the platform default is applied.

Parameters:

target - the object name of the MBean.

url - the configuration URL.

encoding - the encoding of the configuration.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               InputStream input)
               throws ConfigurationException

Configures a registered MBean from a configuration stream by applying the ISO-8859-1 encoding.

Parameters:

target - the object name of the MBean.

input - the configuration stream.

Throws:

ConfigurationException - on configuration errors

configure

void configure(ObjectName target,
               InputStream input,
               String encoding)
               throws ConfigurationException

Configures a registered MBean from an encoded configuration stream. If encoding is not given, the platform default is applied.

Parameters:

target - the object name of the MBean.

input - the configuration stream.

encoding - the encoding of the configuration.

Throws:

ConfigurationException - on configuration errors