Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Class ConfigUtil

java.lang.Object

org.tquadrat.foundation.config.ConfigUtil

@UtilityClass
@ClassVersion(sourceVersion="$Id: ConfigUtil.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class ConfigUtil
extends Object

Utility methods that can be used to handle configuration beans.

The main API is defined by the two methods:

• getConfiguration(Class, TCEFunction)
• getConfiguration(Class, String, TCEBiFunction)

They are used to generate and return the configuration bean instance for the given configuration bean specification. For the same specification, it returns always the same instance (for an implementation of SessionBeanSpec, it will be the same instance when specification and session key are the same).

The factory argument for getConfiguration(Class, TCEFunction) can be a lambda like this:

c -> c.getConstructor().newInstance()

and for

getConfiguration(Class, String, TCEBiFunction),

it could be:

(c,s) -> c.getConstructor( String.class ).newInstance( s )

The factory is required because the code in the module org.tquadrat.foundation.ui cannot access classes in the ~.generated package of the module that uses the configuration, and that holds the generated configuration beans.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ConfigUtil.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ConfigUtil"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<Class<? extends ConfigBeanSpec>,ConfigBeanSpec>	m_ConfigurationBeanRegistry	The registry for global configuration beans.
private static final AutoLock	m_ConfigurationBeanRegistryLock	The lock for the m_ConfigurationBeanRegistry.
private static final Map<Class<? extends SessionBeanSpec>,Map<String,? extends SessionBeanSpec>>	m_SessionConfigBeanRegistry	The registry for session configuration beans.
private static final AutoLock	m_SessionConfigBeanRegistryLock	The lock for the m_SessionConfigBeanRegistry.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConfigUtil()	No instance allowed for this class.

Method Summary

Modifier and Type	Method	Description
static final <T extends SessionBeanSpec> void	dropConfiguration(Class<T> specification, String sessionKey)	Drops the configuration bean for the given specification and the given session key.
static final void	dumpParamFileTemplate(List<? extends CLIDefinition> cmdLineDefinition, OutputStream outputStream)	Dumps a parameter file template for the provided command line definition to the given OutputStream.
static final <T extends SessionBeanSpec> T	getConfiguration(Class<? extends T> specification, String sessionKey, TCEBiFunction<Class<T>,? super String,T> factory)	Retrieves the configuration bean for the given specification and the given session key.
static final <T extends ConfigBeanSpec> T	getConfiguration(Class<? extends T> specification, TCEFunction<Class<T>,T> factory)	Retrieves the configuration bean for the given specification.
private static final <T extends ConfigBeanSpec> T	loadConfigurationBean(Class<? extends ConfigBeanSpec> specification, TCEFunction<? super Class<T>,T> factory)	Retrieves the configuration bean class and loads it.
private static final <T extends ConfigBeanSpec> T	loadSessionBean(Class<? extends T> specification, String sessionKey, TCEBiFunction<? super Class<T>,? super String,T> factory)	Retrieves the configuration bean class for a session bean and loads it.
static final Map<String,Object>	parseCommandLine(InputStream cmdLineDefinition, boolean validate, String... args)	Parses the given command line arguments based on the given instance of InputStream that provides the XML CLI definition.
static final void	parseCommandLine(Collection<? extends CLIDefinition> cmdLineDefinition, String... args)	Parses the given command line arguments based on the provided list of CLIDefinition instances.
static final Map<String,Object>	parseCommandLine(ResourceBundle resourceBundle, InputStream cmdLineDefinition, boolean validate, String... args)	Parses the given command line arguments based on the given instance of InputStream that provides the XML CLI definition.
static final void	printUsage(OutputStream outputStream, Optional<ResourceBundle> resources, CharSequence command, Collection<? extends CLIDefinition> definitions)	Prints a usage message to the given OutputStream.
static final String	resolveMessage(Optional<ResourceBundle> bundle, CLIDefinition definition)	Returns the message from the given CLIDefinition.
private static final String	retrieveClassName(Class<? extends ConfigBeanSpec> specification)	Retrieves the class name for the configuration bean from the given specification.

Methods inherited from class java.lang.Object

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

Field Details

m_ConfigurationBeanRegistry

private static final Map<Class<? extends ConfigBeanSpec>,ConfigBeanSpec> m_ConfigurationBeanRegistry

The registry for global configuration beans.

The key is the configuration bean specification interface, the value is the initialised instance of the related configuration bean.

m_SessionConfigBeanRegistry

private static final Map<Class<? extends SessionBeanSpec>,Map<String,? extends SessionBeanSpec>> m_SessionConfigBeanRegistry

The registry for session configuration beans.

The key is the configuration bean specification interface, the value is a map holding the initialised instances of the related configuration beans, indexed by the session identifier.

m_ConfigurationBeanRegistryLock

private static final AutoLock m_ConfigurationBeanRegistryLock

The lock for the m_ConfigurationBeanRegistry.

m_SessionConfigBeanRegistryLock

private static final AutoLock m_SessionConfigBeanRegistryLock

The lock for the m_SessionConfigBeanRegistry.

Constructor Details

ConfigUtil

private ConfigUtil()

No instance allowed for this class.

Method Details

dropConfiguration

@API(status=STABLE,
     since="0.0.1")
public static final <T extends SessionBeanSpec>
void dropConfiguration(Class<T> specification,
 String sessionKey)

Drops the configuration bean for the given specification and the given session key.

The "session key" can be any arbitrary kind of a unique identifier: a user id, a session id, a URI, or a UUID.

Nothing happens if the there is not configuration bean for the given specification and/or session key.

Type Parameters:

T - The type of the configuration bean specification.

Parameters:

specification - The specification interface for the configuration bean.

sessionKey - The session key.

dumpParamFileTemplate

@API(status=STABLE,
     since="0.0.2")
public static final void dumpParamFileTemplate(List<? extends CLIDefinition> cmdLineDefinition,
 OutputStream outputStream)
                                        throws IOException

Dumps a parameter file template for the provided command line definition to the given OutputStream.

Parameters:

cmdLineDefinition - The command line definition.

outputStream - The target output stream.

Throws:

IOException - Something went wrong when writing to the output stream.

getConfiguration

@API(status=STABLE,
     since="0.0.1")
public static final <T extends ConfigBeanSpec> T getConfiguration(Class<? extends T> specification,
 TCEFunction<Class<T>,T> factory)

Retrieves the configuration bean for the given specification.

Type Parameters:

T - The type of the configuration bean specification.

Parameters:

specification - The specification interface for the configuration bean.

factory - The factory that instantiates the configuration bean.

Returns:

The configuration bean.

getConfiguration

@API(status=STABLE,
     since="0.0.1")
public static final <T extends SessionBeanSpec> T getConfiguration(Class<? extends T> specification,
 String sessionKey,
 TCEBiFunction<Class<T>,? super String,T> factory)

Retrieves the configuration bean for the given specification and the given session key.

The "session key" can be any arbitrary kind of a unique identifier: a user id, a session id, a URI, or a UUID.

Type Parameters:

T - The type of the configuration bean specification.

Parameters:

specification - The specification interface for the configuration bean.

sessionKey - The session key.

factory - The factory that instantiates the configuration bean.

Returns:

The configuration bean.

loadConfigurationBean

private static final <T extends ConfigBeanSpec> T loadConfigurationBean(Class<? extends ConfigBeanSpec> specification,
 TCEFunction<? super Class<T>,T> factory)

Retrieves the configuration bean class and loads it.

Type Parameters:

T - The type of the configuration bean specification.

Parameters:

specification - The specification interface for the configuration bean.

factory - The factory that instantiates the configuration bean.

Returns:

The configuration bean.

loadSessionBean

private static final <T extends ConfigBeanSpec> T loadSessionBean(Class<? extends T> specification,
 String sessionKey,
 TCEBiFunction<? super Class<T>,? super String,T> factory)

Retrieves the configuration bean class for a session bean and loads it.

Type Parameters:

T - The type of the configuration bean specification.

Parameters:

specification - The specification interface for the configuration bean.

sessionKey - The session key.

factory - The factory that instantiates the configuration bean.

Returns:

The configuration bean.

parseCommandLine

@API(status=STABLE,
     since="0.0.1")
public static final void parseCommandLine(Collection<? extends CLIDefinition> cmdLineDefinition,
 String... args)
                                   throws CmdLineException

Parses the given command line arguments based on the provided list of CLIDefinition instances.

Parameters:

cmdLineDefinition - The definition for the expected/allowed command line options and arguments.

args - The command line arguments.

Throws:

CmdLineException - The parsing failed for some reason.

parseCommandLine

@API(status=STABLE,
     since="0.0.1")
public static final Map<String,Object> parseCommandLine(InputStream cmdLineDefinition,
 boolean validate,
 String... args)
                                                 throws CmdLineException,
XMLStreamException,
IOException

Parses the given command line arguments based on the given instance of InputStream that provides the XML CLI definition. In case of an invalid entry on the command line, an error message will be printed to System.err.

Parameters:

cmdLineDefinition - The definition for the expected/allowed command line options and arguments.

validate - true if the given XML should be validated against the schema CLIDefinition.xsd previous to parsing it, false if the validation can be omitted.

args - The command line arguments.

Returns:

The command line values; the key for the result map is the value from the "propertyName" property.

Throws:

CmdLineException - The parsing of the command line failed for some reason.

XMLStreamException - The parsing for the XML CLI definition failed for some reason.

IOException - Reading the XML CLI definition failed.

parseCommandLine

@API(status=STABLE,
     since="0.0.2")
public static final Map<String,Object> parseCommandLine(ResourceBundle resourceBundle,
 InputStream cmdLineDefinition,
 boolean validate,
 String... args)
                                                 throws CmdLineException,
XMLStreamException,
IOException

Parses the given command line arguments based on the given instance of InputStream that provides the XML CLI definition. In case of an invalid entry on the command line, an error message will be printed to System.err.

Parameters:

resourceBundle - The ResourceBundle for the messages.

cmdLineDefinition - The definition for the expected/allowed command line options and arguments.

validate - true if the given XML should be validated against the schema CLIDefinition.xsd previous to parsing it, false if the validation can be omitted.

args - The command line arguments.

Returns:

The command line values; the key for the result map is the value from the "propertyName" property.

Throws:

CmdLineException - The parsing of the command line failed for some reason.

XMLStreamException - The parsing for the XML CLI definition failed for some reason.

IOException - Reading the XML CLI definition failed.

printUsage

@API(status=STABLE,
     since="0.0.1")
public static final void printUsage(OutputStream outputStream,
 Optional<ResourceBundle> resources,
 CharSequence command,
 Collection<? extends CLIDefinition> definitions)
                             throws IOException

Prints a usage message to the given OutputStream.

Parameters:

outputStream - The output stream.

resources - The resource bundle that is used for translation.

command - The command used to start the program.

definitions - The CLI definitions.

Throws:

IOException - A problem occurred on writing to the output stream.

resolveMessage

@API(status=STABLE,
     since="0.0.2")
public static final String resolveMessage(Optional<ResourceBundle> bundle,
 CLIDefinition definition)

Returns the message from the given CLIDefinition.

Parameters:

bundle - The resource bundle.

definition - The CLIDefinition.

Returns:

The resolved message.

retrieveClassName

private static final String retrieveClassName(Class<? extends ConfigBeanSpec> specification)

Retrieves the class name for the configuration bean from the given specification.

Parameters:

specification - The specification.

Returns:

The class name.