org.rhq.enterprise.server.rest.helper

Class ConfigurationHelper

java.lang.Object

org.rhq.enterprise.server.rest.helper.ConfigurationHelper

public class ConfigurationHelper
extends Object

Helper class to deal with configuration objects

Author:

Heiko W. Rupp

Constructor Summary

Constructors

Constructor and Description
ConfigurationHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	checkConfigurationWrtDefinition(org.rhq.core.domain.configuration.Configuration configuration, org.rhq.core.domain.configuration.definition.ConfigurationDefinition definition) Check that the passed configuration is valid wrt the passed definition
static Map<String,Object>	configurationToMap(org.rhq.core.domain.configuration.Configuration configuration, org.rhq.core.domain.configuration.definition.ConfigurationDefinition definition, boolean strict) convert passed configuration to generic map
static Object	convertSimplePropertyValue(org.rhq.core.domain.configuration.PropertySimple property, org.rhq.core.domain.configuration.definition.PropertyDefinitionSimple definition, boolean strict) Convert the passed simple property into an object of a matching type.
static org.rhq.core.domain.configuration.Configuration	mapToConfiguration(Map<String,Object> in) Convert the passed map into a RHQ configuration object

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationHelper

public ConfigurationHelper()

Method Detail

mapToConfiguration

public static org.rhq.core.domain.configuration.Configuration mapToConfiguration(Map<String,Object> in)

Convert the passed map into a RHQ configuration object

Parameters:

in - Map with items to convert. Map.Entry.Key is the name of the property and Map.Entry.Value the value

Returns:

a new Configuration object

configurationToMap

public static Map<String,Object> configurationToMap(org.rhq.core.domain.configuration.Configuration configuration,
                                    org.rhq.core.domain.configuration.definition.ConfigurationDefinition definition,
                                    boolean strict)

convert passed configuration to generic map

Parameters:

configuration - to be converted

definition - to convert to proper types, can be null, but strict has to be set to false. If null, all simple properties will be rendered as strings

strict - if enabled all configuration properties must have appropriate property definitions

Returns:

generic map

Throws:

IllegalArgumentException - if strict is true and configuration contains property without matching property definition

convertSimplePropertyValue

public static Object convertSimplePropertyValue(org.rhq.core.domain.configuration.PropertySimple property,
                                org.rhq.core.domain.configuration.definition.PropertyDefinitionSimple definition,
                                boolean strict)

Convert the passed simple property into an object of a matching type. The type is determined with the help of the passed definition

Parameters:

property - Property to convert

definition - Definition of the Property

Returns:

Object with the correct type

checkConfigurationWrtDefinition

public static List<String> checkConfigurationWrtDefinition(org.rhq.core.domain.configuration.Configuration configuration,
                                           org.rhq.core.domain.configuration.definition.ConfigurationDefinition definition)

Check that the passed configuration is valid wrt the passed definition

Parameters:

configuration - A Configuration to check

definition - A Definition to check the Configuration against

Returns:

List of validation failure messages. List is empty if no errors were found.