Openhtmltopdf 1.0.10 · com.openhtmltopdf.util.Configuration

Stores runtime configuration information for application parameters that may vary on restarting. This implements the Singleton pattern, but through static methods. That is, the first time Configuration is used, the properties are loaded into the Singleton instance. Subsequent calls to valueFor() retrieve values from the Singleton. To look up a property, use Configuration#valueFor(String).

Properties may be overridden using a second properties file, or individually using System properties specified on the command line. To override using a second properties file, specify the System property xr-conf. This should be the location of the second file relative to the CLASSPATH, or else a file path, e.g.

java -Dxr-conf=resources/conf/myprops.conf

You can also place your override properties file in your user home directory, in

${user.home}/.flyingsaucer/local.xhtmlrenderer.conf

To override a property using the System properties, just re-define the property on the command line. e.g.

java -Dxr.property-name=new_value

The order in which these will be read is: default properties (bundled with the core, in the jar; override configuration properties; properties file in user.home; and system properties.

You can override as many properties as you like.

Note that overrides are driven by the property names in the default configuration file. Specifying a property name not in that file will have no effect--the property will not be loaded or available for lookup. Configuration is NOT used to control logging levels or output; see LogStartupConfig.

There are convenience converstion method for all the primitive types, in methods like valueAsInt(String, int). A default must always be provided for these methods. The default is returned if the value is not found, or if the conversion from String fails. If the value is not present, or the conversion fails, a warning message is written to the log.

Field Summary

Modifier and Type	Field and Description
private Logger	configLogger Logger we use internally related to configuration.
private Level	logLevel The log Level for Configuration messages; taken from show-config System property.
private Properties	properties Our backing data store of properties.
private static final String	SF_FILE_NAME The location of our default properties file; must be on the CLASSPATH.
private static Configuration	sInstance The Singleton instance of the class.
private List<LogRecord>	startupLogRecords List of LogRecords for messages from Configuration startup; used to hold these temporarily as we can't use XRLog while starting up, as it depends on Configuration.

Constructor Summary

Access	Constructor and Description
private	Configuration() Default constructor.

Method Summary

Modifier and Type	Method and Description
private void	fine(String message to log msg) Used internally to log a message about the class at level FINE
private void	finer(String message to log msg) Used internally to log a message about the class at level FINER
private String	getSystemPropertyOverrideFileName()
private String	getUserHomeOverrideFileName()
private void	handleUnexpectedExceptionOnInit(Exception e)
public static boolean	hasValue(String key)
private void	info(String message to log msg) Used internally to log a message about the class at level INFO
private static synchronized Configuration	Returns: The singleton instance of the class. instance()
public static boolean	Returns: Value assigned to the key, as a String. isFalse(String Name of the property. key, boolean PARAM defaultVal) Returns true if the value is not "true" (ignores case), or the default provided value if not found or if the value is not a valid boolean (true or false, ignores case).
public static boolean	Returns: Value assigned to the key, as a String. isTrue(String Name of the property. key, boolean PARAM defaultVal) Returns true if the value is "true" (ignores case), or the default provided value if not found or if the value is not a valid boolean (true or false, ignores case).
public static Iterator<String>	Returns: Returns Iterator, see description. keysByPrefix(String Prefix to filter on. No regex. prefix) Returns all configuration keys that start with prefix.
private void	loadDefaultProperties() Loads the default set of properties.
private void	loadOverrideProperties(String Path to the file, or classpath URL, where properties are defined. uri) Loads overriding property values from a second configuration file; this is optional.
private void	loadSystemProperties() Loads overriding property values from a System properties; this is optional.
private void	logAfterLoad() Writes a log of loaded properties to the plumbing.init Logger.
private Properties	newFallbackProperties() Returns a Properties instance filled with values of last resort--in case we can't read default properties file for some reason; this is to prevent Configuration init from throwing any exceptions, or ending up with a completely empty configuration instance.
private void	println(Level the logging level to record the message at level, String the message to log msg) Used internally for logging status/info about the class.
public static void	setConfigLogger(Logger Logger used for Configuration-related messages logger) Sets the logger which we use for Configuration-related logging.
public static int	Returns: Value assigned to the key, as a String. valueAsByte(String Name of the property. key, byte PARAM defaultVal) Returns the value for key in the Configuration as a byte, or the default provided value if not found or if the value is not a valid byte.
public static double	Returns: Value assigned to the key, as a String. valueAsDouble(String Name of the property. key, double PARAM defaultVal) Returns the value for key in the Configuration as a double, or the default provided value if not found or if the value is not a valid double.
public static float	Returns: Value assigned to the key, as a String. valueAsFloat(String Name of the property. key, float PARAM defaultVal) Returns the value for key in the Configuration as a float, or the default provided value if not found or if the value is not a valid float.
public static int	Returns: Value assigned to the key, as a String. valueAsInt(String Name of the property. key, int PARAM defaultVal) Returns the value for key in the Configuration as an integer, or a default value if not found or if the value is not a valid integer.
public static long	Returns: Value assigned to the key, as a String. valueAsLong(String Name of the property. key, long PARAM defaultVal) Returns the value for key in the Configurationas a long, or the default provided value if not found or if the value is not a valid long.
public static int	Returns: Value assigned to the key, as a String. valueAsShort(String Name of the property. key, short PARAM defaultVal) Returns the value for key in the Configuration as a short, or the default provided value if not found or if the value is not a valid short.
public static String	Returns: Value assigned to the key, as a String. valueFor(String Name of the property. key) Returns the value for key in the Configuration.
public static String	Returns: Value assigned to the key, as a String. valueFor(String Name of the property. key, String PARAM defaultVal) Returns the value for key in the Configuration, or the default provided value if not found.
public static Object	Returns: Value of the constant, or defaultValue in case of error. valueFromClassConstant(String Name of the property key, Object Returned in case of error. defaultValue) Given a property, resolves the value to a public constant field on some class, where the field is of type Object.
private void	warning(String message to log msg) Used internally to log a message about the class at level WARNING
private void	warning(String message to log msg, Throwable the exception to report th) Used internally to log a message about the class at level WARNING, in case an exception was thrown

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configLogger	back to summary
private Logger configLogger Logger we use internally related to configuration.

logLevel	back to summary
private Level logLevel The log Level for Configuration messages; taken from show-config System property.

properties	back to summary
private Properties properties Our backing data store of properties.

SF_FILE_NAME	back to summary
private static final String SF_FILE_NAME The location of our default properties file; must be on the CLASSPATH.

sInstance	back to summary
private static Configuration sInstance The Singleton instance of the class.

startupLogRecords	back to summary
private List<LogRecord> startupLogRecords List of LogRecords for messages from Configuration startup; used to hold these temporarily as we can't use XRLog while starting up, as it depends on Configuration.

Constructor Detail

Configuration	back to summary
private Configuration() Default constructor. Will parse default configuration file, system properties, override properties, etc. and result in a usable Configuration instance. Exceptions RuntimeException: if any stage of loading configuration results in an Exception. This could happen, for example, if the default configuration file was not readable.

Configuration

public Class Configuration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail