Module org.glassfish.main.jul

Package org.glassfish.main.jul.cfg

Class ConfigurationHelper

java.lang.Object

org.glassfish.main.jul.cfg.ConfigurationHelper

Direct Known Subclasses:

FormatterConfigurationHelper, HandlerConfigurationHelper

public class ConfigurationHelper
extends Object

This is a tool to help with parsing the logging.properties file to configure JUL business objects.

It respects JUL configuration standards, so ie. each formatter knows best how to configure itself, but still can use this helper to parse properties directly to objects instead of plain strings. Helper also supports custom error handlers.

Author:

David Matejcek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationHelper.LoggingPropertyErrorHandler	Allows custom error handling (ie.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationHelper.LoggingPropertyErrorHandler	ERROR_HANDLER_PRINT_TO_STDERR	Logs an error via the GlassFishLoggingTracer

Constructor Summary

Constructors

Constructor	Description
ConfigurationHelper(String prefix, ConfigurationHelper.LoggingPropertyErrorHandler errorHandler)

Method Summary

Modifier and Type	Method	Description
Boolean	getBoolean(LogProperty key, Boolean defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
Character	getCharacter(LogProperty key, Character defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
Charset	getCharset(LogProperty key, Charset defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
DateTimeFormatter	getDateTimeFormatter(LogProperty key, DateTimeFormatter defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
File	getFile(LogProperty key, File defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
Integer	getInteger(LogProperty key, Integer defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
Level	getLevel(LogProperty key, Level defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
List<String>	getList(LogProperty key, String defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
Integer	getNonNegativeInteger(LogProperty key, Integer defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
String	getString(LogProperty key, String defaultValue)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
protected void	handleError(Exception cause, String key, Object property)	Calls the ConfigurationHelper.LoggingPropertyErrorHandler set in constructor.
protected <T> T	parse(LogProperty key, T defaultValue, Function<String,T> converter)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.
protected <T> T	parseOrSupply(LogProperty key, Supplier<T> defaultValueSupplier, Function<String,T> converter)	Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value.

Methods inherited from class java.lang.Object

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

Field Details

ERROR_HANDLER_PRINT_TO_STDERR

public static final ConfigurationHelper.LoggingPropertyErrorHandler ERROR_HANDLER_PRINT_TO_STDERR

Logs an error via the GlassFishLoggingTracer

Constructor Details

ConfigurationHelper

public ConfigurationHelper(String prefix,
 ConfigurationHelper.LoggingPropertyErrorHandler errorHandler)

Parameters:

prefix - Usually a canonical class name without dot.

errorHandler -

Method Details

getString

public String getString(LogProperty key,
 String defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed String or defaultValue

getCharacter

public Character getCharacter(LogProperty key,
 Character defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Character or defaultValue

getInteger

public Integer getInteger(LogProperty key,
 Integer defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Integer or defaultValue

getNonNegativeInteger

public Integer getNonNegativeInteger(LogProperty key,
 Integer defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Integer or defaultValue

getBoolean

public Boolean getBoolean(LogProperty key,
 Boolean defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Boolean or defaultValue

getLevel

public Level getLevel(LogProperty key,
 Level defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Level or defaultValue

getFile

public File getFile(LogProperty key,
 File defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed File or defaultValue

getDateTimeFormatter

public DateTimeFormatter getDateTimeFormatter(LogProperty key,
 DateTimeFormatter defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed DateTimeFormatter or defaultValue

getCharset

public Charset getCharset(LogProperty key,
 Charset defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed Charset or defaultValue

getList

public List<String> getList(LogProperty key,
 String defaultValue)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

Returns:

parsed List of String instances or empty list

parse

protected <T> T parse(LogProperty key,
 T defaultValue,
 Function<String,T> converter)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Type Parameters:

T -

Parameters:

key - key relative to the prefix given in constructor

defaultValue -

converter - - function used to parse the value or the defaultValue

Returns:

parsed value or defaultValue

parseOrSupply

protected <T> T parseOrSupply(LogProperty key,
 Supplier<T> defaultValueSupplier,
 Function<String,T> converter)

Joins prefix.key, uses the result to call the LogManager.getProperty(String) and parses the retrieved value. Parsing exceptions are consumed by the ConfigurationHelper.LoggingPropertyErrorHandler given in constructor.

Type Parameters:

T -

Parameters:

key - key relative to the prefix given in constructor

defaultValueSupplier -

converter - - function used to parse the value or the defaultValue

Returns:

parsed value or defaultValue

handleError

protected void handleError(Exception cause,
 String key,
 Object property)

Calls the ConfigurationHelper.LoggingPropertyErrorHandler set in constructor.

Parameters:

cause -

key -

property -

Throws:

RuntimeException - - depends on the implementation of the error handler