com.exalead.config.bean

Class ConfigBeanFiller

java.lang.Object

com.exalead.config.bean.ConfigBeanFiller

Direct Known Subclasses:

CVComponentConfigHelper.ComponentConfigBeanFiller

public class ConfigBeanFiller
extends java.lang.Object

Class which fills a ConstructorBean from a ConfigPapi API this classe manage simple ConnectorConstructorBean and DynamicConnectorConstructorBean Supported types are classes with embedded setXXX(TYPE value) functions. TYPE can be a base type (String, int..), a class, or an array of these two families.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigBeanFiller.DecryptInterface Interface to provide a way of decrypt "encrypted" keys.
static class	ConfigBeanFiller.DefaultConfig Default configuration class.
protected static class	ConfigBeanFiller.FillResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY_REPRESENTATION
protected static ConfigBeanFiller.DecryptInterface	decryptProvider

Constructor Summary

Constructors

Constructor and Description
ConfigBeanFiller(com.exalead.config.ConfigApi cpapi)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	decryptValue(java.lang.String value) Called to resolve "encrypted" values.
protected void	dynamicFill(DynamicBeanConfig config)
protected static void	ensureAnnotationIsNotPresent(java.lang.reflect.Method met, java.lang.Class<?> cls) Ensure annotation classes are sane (class loader hell)
protected static java.lang.String	fancyClass(java.lang.Object obj)
protected BeanConfig	fill(java.lang.Class<?> connectorConfigClass) Fill the bean object and return a BeanConfig
BeanConfig	fill(java.lang.Class<?> connectorConfigClass, java.lang.ClassLoader loader) Fill the bean object and return a BeanConfig
BeanConfig	fill(java.lang.String configClassName, java.lang.ClassLoader loader) Fill the bean object and return a BeanConfig
protected java.lang.Object[]	fillArrayBean(java.lang.String baseName, java.lang.Class<?> cls) Fill the bean array object and return a FillResult
protected java.lang.Object	fillBean(java.lang.Class<?> classBean)
protected ConfigBeanFiller.FillResult	fillBean(java.lang.String baseName, java.lang.Class<?> classBean) Fill the bean object and return a FillResult
protected java.lang.Object	fillBean(java.lang.String className, java.lang.ClassLoader loader)
java.lang.Object	fillObject(java.lang.ClassLoader loader, java.lang.Class<?> connectorConfigClass) Fill the bean object and return a BeanConfig
java.lang.ClassLoader	getClassLoader() Return the class loader.
ConfigPropertyDefinition[]	getDynamicParameters(java.lang.String className, java.lang.ClassLoader loader) Deprecated.
static ConfigPropertyDefinition[]	getStaticParameters(java.lang.String className, java.lang.ClassLoader loader) Deprecated.
protected boolean	hasNonEmptySubkeys(java.lang.String key) Has sub-keys (".foo" keys) with non-empty value(s).
static java.lang.Class<?>	loadClass(java.lang.String name, java.lang.ClassLoader loader)
protected java.lang.Class<?>	resolveGenericTypeClass(com.exalead.config.ConfigApi cpapi, java.lang.String baseKey, java.lang.Class<?> classGeneric) Resolve a generic type.
static void	setGlobalDecryptProvider(ConfigBeanFiller.DecryptInterface provider) Set the global decrypt provider.

Methods inherited from class java.lang.Object

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

Field Detail

ARRAY_REPRESENTATION

public static final java.lang.String ARRAY_REPRESENTATION

See Also:

Constant Field Values

decryptProvider

protected static ConfigBeanFiller.DecryptInterface decryptProvider

Constructor Detail

ConfigBeanFiller

public ConfigBeanFiller(com.exalead.config.ConfigApi cpapi)

Method Detail

ensureAnnotationIsNotPresent

protected static void ensureAnnotationIsNotPresent(java.lang.reflect.Method met,
                                                   java.lang.Class<?> cls)
                                            throws java.lang.ClassCastException

Ensure annotation classes are sane (class loader hell)

Throws:

java.lang.ClassCastException

fancyClass

protected static java.lang.String fancyClass(java.lang.Object obj)

getClassLoader

public java.lang.ClassLoader getClassLoader()

Return the class loader.

Returns:

the class loader

getStaticParameters

@Deprecated
public static ConfigPropertyDefinition[] getStaticParameters(java.lang.String className,
                                                                         java.lang.ClassLoader loader)
                                                                  throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getDynamicParameters

@Deprecated
public ConfigPropertyDefinition[] getDynamicParameters(java.lang.String className,
                                                                   java.lang.ClassLoader loader)
                                                            throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

fillBean

protected java.lang.Object fillBean(java.lang.String className,
                                    java.lang.ClassLoader loader)
                             throws java.lang.Exception

Throws:

java.lang.Exception

fillBean

protected java.lang.Object fillBean(java.lang.Class<?> classBean)
                             throws java.lang.Exception

Throws:

java.lang.Exception

setGlobalDecryptProvider

public static void setGlobalDecryptProvider(ConfigBeanFiller.DecryptInterface provider)

Set the global decrypt provider.

Parameters:

provider -

decryptValue

protected java.lang.String decryptValue(java.lang.String value)

Called to resolve "encrypted" values.

Parameters:

value - the encrypted value

Returns:

the clear-text value

fillBean

protected ConfigBeanFiller.FillResult fillBean(java.lang.String baseName,
                                               java.lang.Class<?> classBean)
                                        throws java.lang.Exception

Fill the bean object and return a FillResult

Parameters:

baseName - the config key prefix (flattened)

classBean - the class

Throws:

java.lang.Exception

hasNonEmptySubkeys

protected boolean hasNonEmptySubkeys(java.lang.String key)
                              throws java.lang.Exception

Has sub-keys (".foo" keys) with non-empty value(s). The "key" name should be an array prefix with its identifier, NOT terminated by "." (such as "Foo.Key.0")

Throws:

java.lang.Exception

loadClass

public static java.lang.Class<?> loadClass(java.lang.String name,
                                           java.lang.ClassLoader loader)
                                    throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

resolveGenericTypeClass

protected java.lang.Class<?> resolveGenericTypeClass(com.exalead.config.ConfigApi cpapi,
                                                     java.lang.String baseKey,
                                                     java.lang.Class<?> classGeneric)
                                              throws java.lang.ClassNotFoundException,
                                                     java.lang.Exception

Resolve a generic type. This function can be overloaded to allow more advanced generic type handling.

Parameters:

cpapi - the config

baseKey - the base key configuration

classGeneric - the base class expected in return

Returns:

the resolved class

Throws:

java.lang.ClassNotFoundException

java.lang.Exception

fillArrayBean

protected java.lang.Object[] fillArrayBean(java.lang.String baseName,
                                           java.lang.Class<?> cls)
                                    throws java.lang.Exception

Fill the bean array object and return a FillResult

Parameters:

baseName - the config key prefix

cls - the config class

Returns:

null if no array item is defined

Throws:

java.lang.Exception - upon filling error

dynamicFill

protected void dynamicFill(DynamicBeanConfig config)
                    throws java.lang.Exception

Throws:

java.lang.Exception

fillObject

public java.lang.Object fillObject(java.lang.ClassLoader loader,
                                   java.lang.Class<?> connectorConfigClass)
                            throws MandatoryKeyMissingException,
                                   IllegalValueException,
                                   java.lang.Exception

Fill the bean object and return a BeanConfig

Parameters:

connectorConfigClass - the connector config class

Throws:

ConfigurationException - upon configuration error

MandatoryKeyMissingException

IllegalValueException

java.lang.Exception

fill

public BeanConfig fill(java.lang.String configClassName,
                       java.lang.ClassLoader loader)
                throws MandatoryKeyMissingException,
                       IllegalValueException,
                       java.lang.Exception

Fill the bean object and return a BeanConfig

Parameters:

connectorConfigClassName - the connector config class name

loader - the class loader

Throws:

ConfigurationException - upon configuration error

MandatoryKeyMissingException

IllegalValueException

java.lang.Exception

fill

public BeanConfig fill(java.lang.Class<?> connectorConfigClass,
                       java.lang.ClassLoader loader)
                throws MandatoryKeyMissingException,
                       IllegalValueException,
                       java.lang.Exception

Fill the bean object and return a BeanConfig

Parameters:

connectorConfigClass - the connector config class

loader - the class loader (this parameter is ignored)

Throws:

ConfigurationException - upon configuration error

MandatoryKeyMissingException

IllegalValueException

java.lang.Exception

fill

protected BeanConfig fill(java.lang.Class<?> connectorConfigClass)
                   throws MandatoryKeyMissingException,
                          IllegalValueException,
                          java.lang.Exception

Fill the bean object and return a BeanConfig

Parameters:

connectorConfigClass - the connector config class

Throws:

ConfigurationException - upon configuration error

MandatoryKeyMissingException

IllegalValueException

java.lang.Exception