org.apache.flume.tools

Class FlumeBeanConfigurator

java.lang.Object

org.apache.flume.tools.FlumeBeanConfigurator

public class FlumeBeanConfigurator
extends Object

Utility class to enable runtime configuration of Java objects using provided Flume context objects (or equivalent). The methods use reflection to identify Fields on the configurable object and then looks for matching properties in the provided properties bundle.

Constructor Summary

Constructors

Constructor and Description
FlumeBeanConfigurator()

Method Summary

Modifier and Type	Method and Description
static void	setConfigurationFields(Object configurable, Context context) Utility method that will set properties on a Java bean (Object configurable) based on the provided Context.
static void	setConfigurationFields(Object configurable, Context context, String subPropertiesPrefix) Utility method that will set properties on a Java bean (Object configurable) based on the provided Context.
static void	setConfigurationFields(Object configurable, Map<String,String> properties) Utility method that will set properties on a Java bean (Object configurable) based on the provided properties bundle.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlumeBeanConfigurator

public FlumeBeanConfigurator()

Method Detail

setConfigurationFields

public static void setConfigurationFields(Object configurable,
                                          Map<String,String> properties)
                                   throws ConfigurationException

Utility method that will set properties on a Java bean (Object configurable) based on the provided properties bundle. If there is a type issue, or an access problem then a ConfigurationException will be thrown.

Parameters:

configurable - Any properties must be modifiable via setter methods.

properties - Map<String, String>

Throws:

ConfigurationException

setConfigurationFields

public static void setConfigurationFields(Object configurable,
                                          Context context)
                                   throws ConfigurationException

Utility method that will set properties on a Java bean (Object configurable) based on the provided Context. N.B. This method will take the Flume Context and look for sub-properties named after the class name of the configurable object. If there is a type issue, or an access problem then a ConfigurationException will be thrown.

Parameters:

configurable - Any properties must be modifiable via setter methods.

context -

Throws:

ConfigurationException

setConfigurationFields

public static void setConfigurationFields(Object configurable,
                                          Context context,
                                          String subPropertiesPrefix)
                                   throws ConfigurationException

Utility method that will set properties on a Java bean (Object configurable) based on the provided Context. N.B. This method will take the Flume Context and look for sub-properties named after the subPropertiesPrefix String. If there is a type issue, or an access problem then a ConfigurationException will be thrown.

Parameters:

configurable - Object: Any properties must be modifiable via setter methods.

context - org.apache.flume.Context;

subPropertiesPrefix - String

Throws:

ConfigurationException