Package org.apache.logging.converter.config

Interface ConfigurationConverter

public interface ConfigurationConverter

Service class to convert between different logging configuration formats.

Method Summary

Modifier and Type	Method	Description
void	convert(InputStream inputStream, String inputFormat, OutputStream outputStream, String outputFormat)	Converts a logging configuration file from one format to another.
Map<String,String>	getFormatDescriptions()	Associates each supported format symbol with a description.
static ConfigurationConverter	getInstance()	A default implementation of ConfigurationConverter that uses ServiceLoader to load additional formats.
Set<String>	getSupportedInputFormats()	Returns the list of supported input formats.
Set<String>	getSupportedOutputFormats()	Returns the list of supported output formats.

Method Details

getInstance

static ConfigurationConverter getInstance()

A default implementation of ConfigurationConverter that uses ServiceLoader to load additional formats.

See Also:

• ConfigurationMapper

convert

void convert(InputStream inputStream,
 String inputFormat,
 OutputStream outputStream,
 String outputFormat)
      throws ConfigurationConverterException

Converts a logging configuration file from one format to another.

Parameters:

inputStream - The input configuration file, never null.

inputFormat - The input format. Must be one of the formats returned by getSupportedInputFormats().

outputStream - The output configuration file, never null.

outputFormat - The output format. Must be one of the formats returned by getSupportedOutputFormats().

Throws:

ConfigurationConverterException - If any kind of error occurs during the conversion process.

getSupportedInputFormats

Set<String> getSupportedInputFormats()

Returns the list of supported input formats.

getSupportedOutputFormats

Set<String> getSupportedOutputFormats()

Returns the list of supported output formats.

getFormatDescriptions

Map<String,String> getFormatDescriptions()

Associates each supported format symbol with a description.

For self-documentation purposes.