com.exalead.mercury.component.config

Class CVComponentConfigHelper

java.lang.Object

com.exalead.mercury.component.config.CVComponentConfigHelper

public class CVComponentConfigHelper
extends java.lang.Object

Configuration helper class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CVComponentConfigHelper.ComponentConfigBeanFiller The overridden ConfigBeanFiller with CVComponent-specific config serialization.
protected static class	CVComponentConfigHelper.ComponentConfigTypeGenerator The overridden ConfigTypeGenerator with CVComponent-specific config serialization.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<?>	clazz
static java.lang.String	COMPONENT_CONFIG_CLASS_NAME_KEY Name of the key which stores generic config object types.
protected java.lang.ClassLoader	loader

Constructor Summary

Constructors

Constructor and Description
CVComponentConfigHelper(java.lang.ClassLoader loader, java.lang.String pluginClass) Build a new config helper

Method Summary

Modifier and Type	Method and Description
static CVComponentConfig	buildConfig(java.lang.ClassLoader loader, java.lang.Class<? extends CVComponentConfig> configClass, com.exalead.config.ConfigApi conf) Static helper to build a CVComponentConfig corresponding to a given config class, using the provided ConfigApi object.
static CVComponentConfig	buildConfig(java.lang.ClassLoader loader, java.lang.Class<? extends CVComponentConfig> configClass, exa.bee.KeyValue kv) Static helper to build a CVComponentConfig corresponding to a given config class, using the provided root KeyValue object.
CVComponentConfig	buildConfig(com.exalead.config.ConfigApi conf) Build a new CVComponentConfig corresponding to the current class, using the provided ConfigApi object.
CVComponentConfig	buildConfig(exa.bee.KeyValue root) Build a new CVComponentConfig corresponding to the current class, using the provided configuration root key.
CVComponentConfig	buildConfig(java.util.List<exa.bee.KeyValue> kv) Build a new CVComponentConfig corresponding to the current class, using the provided configuration keys.
CVComponentConfig	buildConfig(java.lang.String[] kv) Build a new CVComponentConfig corresponding to the current class, using the provided configuration keys.
CVComponentConfigCheck<CVComponentConfig>	buildConfigChecker() Build a new CVComponentConfigCheck corresponding to the current class, using the provided configuration keys.
void	checkConfig(CVComponentConfig config, boolean useNow) Check a configuration using plugin's configuration checker.
protected static void	ensureAnnotationIsNotPresent(java.lang.Class<?> parent, java.lang.Class<?> cls) Ensure annotation classes are sane (class loader hell)
java.lang.Class<?>	getComponentClass() Return the component class.
CVComponentConfigClass	getComponentConfigClass() Get the CVComponentConfigClass associated with the component class.
protected com.exalead.config.ConfigApi	getConfigApi(exa.bee.KeyValue root)
protected com.exalead.config.ConfigApi	getConfigApi(java.util.List<exa.bee.KeyValue> kv)
protected com.exalead.config.ConfigApi	getConfigApi(java.lang.String[] kv)
java.lang.Class<? extends CVComponentConfigCheck<? extends CVComponentConfig>>	getConfigCheckClass() Get the configuration checker class.
java.lang.Class<? extends CVComponentConfig>	getConfigClass() Get the configuration class.
protected java.lang.Class<? extends CVComponentConfig>	getConfigClassInternal() Get the configuration class.
static exa.bee.KeyValue	getConfigKV(CVComponentConfig config) Get the component configuration as KeyValue.
static exa.bee.KeyValue	getConfigKV(CVComponentConfig config, boolean addDefaultValue) Get the component configuration as KeyValue.
ConfigBeanFiller.DefaultConfig	getDefaultBeanConfig() Return the default configuration as a DefaultConfig object.
ConfigBeanFiller.DefaultConfig	getDefaultBeanConfig(boolean addDefaultValue) Return the default configuration as a DefaultConfig object.
CVComponentConfig	getDefaultConfig() Get the default component configuration.
exa.bee.KeyValue	getDefaultConfigKV() Get the default component configuration as KeyValue.
exa.bee.KeyValue	getDefaultConfigKV(boolean addDefaultValue) Get the default component configuration as KeyValue.
Descriptor	getDescriptor() Get the default component configuration as KeyValue.
static Descriptor	getDescriptorOf(CVComponentConfig config) Get the component Descriptor.
boolean	isCVComponent() Is the current class a component class ?
static void	main(java.lang.String[] args) Static main sample (debugging purpose).

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_CONFIG_CLASS_NAME_KEY

public static final java.lang.String COMPONENT_CONFIG_CLASS_NAME_KEY

Name of the key which stores generic config object types.

See Also:

Constant Field Values

clazz

protected final java.lang.Class<?> clazz

loader

protected final java.lang.ClassLoader loader

Constructor Detail

CVComponentConfigHelper

public CVComponentConfigHelper(java.lang.ClassLoader loader,
                               java.lang.String pluginClass)
                        throws java.lang.ClassNotFoundException

Build a new config helper

Parameters:

pluginClass - The plugin class name

loader - class loader used to load the plugin and its components

Throws:

java.lang.ClassNotFoundException

Method Detail

getConfigApi

protected com.exalead.config.ConfigApi getConfigApi(java.lang.String[] kv)

getConfigApi

protected com.exalead.config.ConfigApi getConfigApi(java.util.List<exa.bee.KeyValue> kv)

getConfigApi

protected com.exalead.config.ConfigApi getConfigApi(exa.bee.KeyValue root)

ensureAnnotationIsNotPresent

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

Ensure annotation classes are sane (class loader hell)

Throws:

java.lang.ClassCastException

getComponentClass

public java.lang.Class<?> getComponentClass()

Return the component class.

getComponentConfigClass

public CVComponentConfigClass getComponentConfigClass()

Get the CVComponentConfigClass associated with the component class.

Returns:

null if no CVComponentConfigClass was declared

isCVComponent

public boolean isCVComponent()
                      throws java.lang.NoSuchMethodException

Is the current class a component class ?

Throws:

java.lang.NoSuchMethodException

getConfigClassInternal

protected java.lang.Class<? extends CVComponentConfig> getConfigClassInternal()

Get the configuration class.

Returns:

null if no such class was found.

getConfigClass

public java.lang.Class<? extends CVComponentConfig> getConfigClass()
                                                            throws java.lang.NoSuchMethodException

Get the configuration class.

Throws:

java.lang.NoSuchMethodException

getConfigCheckClass

public java.lang.Class<? extends CVComponentConfigCheck<? extends CVComponentConfig>> getConfigCheckClass()
                                                                                                   throws java.lang.NoSuchMethodException

Get the configuration checker class.

Throws:

java.lang.NoSuchMethodException

buildConfig

public static CVComponentConfig buildConfig(java.lang.ClassLoader loader,
                                            java.lang.Class<? extends CVComponentConfig> configClass,
                                            com.exalead.config.ConfigApi conf)
                                     throws MandatoryKeyMissingException,
                                            IllegalValueException,
                                            java.lang.ClassNotFoundException,
                                            java.lang.Exception

Static helper to build a CVComponentConfig corresponding to a given config class, using the provided ConfigApi object.

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfig

public static CVComponentConfig buildConfig(java.lang.ClassLoader loader,
                                            java.lang.Class<? extends CVComponentConfig> configClass,
                                            exa.bee.KeyValue kv)
                                     throws java.lang.NoSuchMethodException,
                                            MandatoryKeyMissingException,
                                            IllegalValueException,
                                            java.lang.ClassNotFoundException,
                                            java.lang.Exception

Static helper to build a CVComponentConfig corresponding to a given config class, using the provided root KeyValue object.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfig

public CVComponentConfig buildConfig(com.exalead.config.ConfigApi conf)
                              throws java.lang.NoSuchMethodException,
                                     MandatoryKeyMissingException,
                                     IllegalValueException,
                                     java.lang.ClassNotFoundException,
                                     java.lang.Exception

Build a new CVComponentConfig corresponding to the current class, using the provided ConfigApi object.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfig

public CVComponentConfig buildConfig(exa.bee.KeyValue root)
                              throws MandatoryKeyMissingException,
                                     IllegalValueException,
                                     java.lang.ClassNotFoundException,
                                     java.lang.Exception

Build a new CVComponentConfig corresponding to the current class, using the provided configuration root key.

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfig

public CVComponentConfig buildConfig(java.util.List<exa.bee.KeyValue> kv)
                              throws MandatoryKeyMissingException,
                                     IllegalValueException,
                                     java.lang.ClassNotFoundException,
                                     java.lang.Exception

Build a new CVComponentConfig corresponding to the current class, using the provided configuration keys.

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfig

public CVComponentConfig buildConfig(java.lang.String[] kv)
                              throws MandatoryKeyMissingException,
                                     IllegalValueException,
                                     java.lang.ClassNotFoundException,
                                     java.lang.Exception

Build a new CVComponentConfig corresponding to the current class, using the provided configuration keys.

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

buildConfigChecker

public CVComponentConfigCheck<CVComponentConfig> buildConfigChecker()
                                                             throws java.lang.NoSuchMethodException,
                                                                    java.lang.InstantiationException,
                                                                    java.lang.reflect.InvocationTargetException,
                                                                    java.lang.IllegalAccessException

Build a new CVComponentConfigCheck corresponding to the current class, using the provided configuration keys.

Throws:

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

checkConfig

public void checkConfig(CVComponentConfig config,
                        boolean useNow)
                 throws MandatoryKeyMissingException,
                        IllegalValueException,
                        java.lang.NoSuchMethodException,
                        java.lang.InstantiationException,
                        java.lang.reflect.InvocationTargetException,
                        java.lang.IllegalAccessException,
                        java.lang.Exception

Check a configuration using plugin's configuration checker.

Parameters:

useNow - if true, the configuration check should also include checks related to the current state of the plugin peers or environment ; that is, typically checking that a remote server is available, file path filled exist, etc. If useNow is false, the check should not assume that potentially configured resources are available now (remote servers(s) might be down, third-party configuration elements might be missing etc.)

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.Exception

getDefaultConfig

public CVComponentConfig getDefaultConfig()
                                   throws MandatoryKeyMissingException,
                                          IllegalValueException,
                                          java.lang.ClassNotFoundException,
                                          java.lang.Exception

Get the default component configuration.

Throws:

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getDefaultConfigKV

public exa.bee.KeyValue getDefaultConfigKV()
                                    throws java.lang.NoSuchMethodException,
                                           MandatoryKeyMissingException,
                                           IllegalValueException,
                                           java.lang.ClassNotFoundException,
                                           java.lang.Exception

Get the default component configuration as KeyValue.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getDefaultConfigKV

public exa.bee.KeyValue getDefaultConfigKV(boolean addDefaultValue)
                                    throws java.lang.NoSuchMethodException,
                                           MandatoryKeyMissingException,
                                           IllegalValueException,
                                           java.lang.ClassNotFoundException,
                                           java.lang.Exception

Get the default component configuration as KeyValue.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getDefaultBeanConfig

public ConfigBeanFiller.DefaultConfig getDefaultBeanConfig(boolean addDefaultValue)
                                                    throws java.lang.NoSuchMethodException,
                                                           java.lang.Exception

Return the default configuration as a DefaultConfig object.

Throws:

java.lang.NoSuchMethodException

java.lang.Exception

getDefaultBeanConfig

public ConfigBeanFiller.DefaultConfig getDefaultBeanConfig()
                                                    throws java.lang.NoSuchMethodException,
                                                           java.lang.Exception

Return the default configuration as a DefaultConfig object.

Throws:

java.lang.NoSuchMethodException

java.lang.Exception

getDescriptor

public Descriptor getDescriptor()
                         throws java.lang.NoSuchMethodException,
                                MandatoryKeyMissingException,
                                IllegalValueException,
                                java.lang.ClassNotFoundException,
                                java.lang.Exception

Get the default component configuration as KeyValue.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getConfigKV

public static exa.bee.KeyValue getConfigKV(CVComponentConfig config)
                                    throws java.lang.NoSuchMethodException,
                                           MandatoryKeyMissingException,
                                           IllegalValueException,
                                           java.lang.ClassNotFoundException,
                                           java.lang.Exception

Get the component configuration as KeyValue.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getConfigKV

public static exa.bee.KeyValue getConfigKV(CVComponentConfig config,
                                           boolean addDefaultValue)
                                    throws java.lang.NoSuchMethodException,
                                           MandatoryKeyMissingException,
                                           IllegalValueException,
                                           java.lang.ClassNotFoundException,
                                           java.lang.Exception

Get the component configuration as KeyValue.

Parameters:

config - The configuration

defaultValues - if true, always add a default value (especially for arrays)

Returns:

the component configuration

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

getDescriptorOf

public static Descriptor getDescriptorOf(CVComponentConfig config)
                                  throws java.lang.NoSuchMethodException,
                                         MandatoryKeyMissingException,
                                         IllegalValueException,
                                         java.lang.ClassNotFoundException,
                                         java.lang.Exception

Get the component Descriptor.

Throws:

java.lang.NoSuchMethodException

MandatoryKeyMissingException

IllegalValueException

java.lang.ClassNotFoundException

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Static main sample (debugging purpose). Example: ./bin/java com.exalead.mercury.component.config.CVComponentConfigHelper -class com.exalead.papi.connectors.filesystem.FilesystemConnector -output /tmp -pluginsDir ~/cloudview/builtin_plugins_deployed

Throws:

java.lang.Exception