Package org.ametys.plugins.core.ui.util

Class ConfigurationHelper

java.lang.Object

org.ametys.plugins.core.ui.util.ConfigurationHelper

public final class ConfigurationHelper
extends Object

Helper class providing methods to deal with common Configuration tasks.

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	clonePluginParameters(Map<String,Object> parameters)	Clone existing parameters
static String	parseConfigParameter(Configuration configuration)	Parse a mandatory configuration parameter Configuration.
static String	parseConfigParameter(Configuration configuration, String defaultValue)	Parse an optional configuration parameter Configuration.
static Object	parseObject(Configuration configuration)	Parse a structured Configuration to an Object.
static Object	parseObject(Configuration configuration, Object defaultValue)	Parse a structured Configuration to an Object.
static Map<String,Object>	parsePluginParameters(Configuration configuration, String defaultPluginName, Logger logger)	Parse parameters recursively.
static String	parsePluginResource(Configuration configuration, String defaultPluginName, String defaultValue, Logger logger)	Parse an optional plugin resource configuration.
static String	parsePluginResource(Configuration configuration, String defaultPluginName, Logger logger)	Parse a mandatory plugin resource configuration.
static List<ClientSideElement.ScriptFile>	parsePluginResourceList(Configuration configuration, String defaultPluginName, Logger logger)	Parse a plugin resource list configuration.
static List<String>	parsePluginResourceUri(Configuration configuration, String defaultPluginName, Logger logger)	Parse a plugin files list configuration and return the list of URIs.

Methods inherited from class java.lang.Object

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

Method Details

parsePluginResourceList

public static List<ClientSideElement.ScriptFile> parsePluginResourceList(Configuration configuration,
 String defaultPluginName,
 Logger logger)
                                                                  throws ConfigurationException

Parse a plugin resource list configuration.

Parameters:

configuration - The plugin resource list configuration.

defaultPluginName - The default plugin name to use for the resources.

logger - The logger.

Returns:

The list of complete URLs of files to import.

Throws:

ConfigurationException - If an error occurs

parsePluginResource

public static String parsePluginResource(Configuration configuration,
 String defaultPluginName,
 Logger logger)
                                  throws ConfigurationException

Parse a mandatory plugin resource configuration.

Parameters:

configuration - The plugin resource configuration.

defaultPluginName - The default plugin name to use for the resources.

logger - The logger.

Returns:

The plugin resource full URL.

Throws:

ConfigurationException - If an error occurs

parsePluginResource

public static String parsePluginResource(Configuration configuration,
 String defaultPluginName,
 String defaultValue,
 Logger logger)

Parse an optional plugin resource configuration.

Parameters:

configuration - The plugin resource configuration.

defaultPluginName - The default plugin name to use for the resources.

defaultValue - The default value

logger - The logger.

Returns:

The plugin resource full URL.

parsePluginResourceUri

public static List<String> parsePluginResourceUri(Configuration configuration,
 String defaultPluginName,
 Logger logger)
                                           throws ConfigurationException

Parse a plugin files list configuration and return the list of URIs.

Parameters:

configuration - The plugin files list configuration.

defaultPluginName - The default plugin name to use for the files.

logger - The logger.

Returns:

The list of complete URIs of files to import.

Throws:

ConfigurationException - If an error occurs

parseConfigParameter

public static String parseConfigParameter(Configuration configuration)
                                   throws ConfigurationException

Parse a mandatory configuration parameter Configuration.

Parameters:

configuration - The Configuration to parse.

Returns:

the configuration parameter value.

Throws:

ConfigurationException - if an error occurs.

parseConfigParameter

public static String parseConfigParameter(Configuration configuration,
 String defaultValue)

Parse an optional configuration parameter Configuration.

Parameters:

configuration - The Configuration to parse.

defaultValue - The default value.

Returns:

the configuration parameter value.

parseObject

public static Object parseObject(Configuration configuration)

Parse a structured Configuration to an Object. The returned Object can be either a String or a Map<String, Object>. The map's values are either a String, a Map, or a List<String>.

Parameters:

configuration - The structured Configuration to parse.

Returns:

The parsed Object.

parseObject

public static Object parseObject(Configuration configuration,
 Object defaultValue)

Parse a structured Configuration to an Object. The returned Object can be either a String or a Map<String, Object>. The map's values are either a String, a Map, or a List<String>.

Parameters:

configuration - The structured Configuration to parse.

defaultValue - The value to use when an empty tag is found (at any level in the tree).

Returns:

The parsed Object.

parsePluginParameters

public static Map<String,Object> parsePluginParameters(Configuration configuration,
 String defaultPluginName,
 Logger logger)
                                                throws ConfigurationException

Parse parameters recursively.

Parameters:

configuration - the parameters configuration.

defaultPluginName - The default plugin name.

logger - The logger.

Returns:

parameters in a Map

Throws:

ConfigurationException - If the configuration is incorrect.

clonePluginParameters

public static Map<String,Object> clonePluginParameters(Map<String,Object> parameters)

Clone existing parameters

Parameters:

parameters - The existing parameters

Returns:

The cloned