org.apache.camel.support

Class PropertyBindingSupport

java.lang.Object

org.apache.camel.support.PropertyBindingSupport

public final class PropertyBindingSupport
extends Object

A convenient support class for binding String valued properties to an instance which uses a set of conventions:

• property placeholders - Keys and values using Camels property placeholder will be resolved
• nested - Properties can be nested using the dot syntax (OGNL and builder pattern using with as prefix), eg foo.bar=123
• map
- Properties can lookup in Map's using map syntax, eg foo[bar] where foo is the name of the property that is a Map instance, and bar is the name of the key.
• list
- Properties can refer or add to in List's using list syntax, eg foo[0] where foo is the name of the property that is a List instance, and 0 is the index. To refer to the last element, then use last as key.
• reference by bean id - Values can refer to other beans in the registry by prefixing with with # or #bean: eg #myBean or #bean:myBean
• reference by type - Values can refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType
• autowire by type - Values can refer to singleton beans by auto wiring by setting the value to #autowired
• reference new class - Values can refer to creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. The class is created using a default no-arg constructor, however if you need to create the instance via a factory method then you specify the method as shown: #class:com.foo.MyClassType#myFactoryMethod
.
• ignore case - Whether to ignore case for property keys

This implementations reuses parts of IntrospectionSupport.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyBindingSupport.Builder To use a fluent builder style to configure this property binding support.
static interface	PropertyBindingSupport.OnAutowiring

Method Summary

Modifier and Type	Method and Description
static boolean	autowireSingletonPropertiesFromRegistry(org.apache.camel.CamelContext camelContext, Object target) This will discover all the properties on the target, and automatic bind the properties that are null by looking up in the registry to see if there is a single instance of the same type as the property.
static boolean	autowireSingletonPropertiesFromRegistry(org.apache.camel.CamelContext camelContext, Object target, boolean bindNullOnly, boolean deepNesting, PropertyBindingSupport.OnAutowiring callback) This will discover all the properties on the target, and automatic bind the properties by looking up in the registry to see if there is a single instance of the same type as the property.
static void	bindMandatoryProperty(org.apache.camel.CamelContext camelContext, Object target, String name, Object value) Binds the mandatory property to the target object (will fail if not set/bound).
static void	bindMandatoryProperty(org.apache.camel.CamelContext camelContext, Object target, String name, Object value, boolean ignoreCase) Binds the mandatory property to the target object (will fail if not set/bound).
static boolean	bindProperties(org.apache.camel.CamelContext camelContext, Object target, Map<String,Object> properties) Binds the properties to the target object, and removes the property that was bound from properties.
static boolean	bindProperties(org.apache.camel.CamelContext camelContext, Object target, Map<String,Object> properties, boolean ignoreCase) Binds the properties to the target object, and removes the property that was bound from properties.
static boolean	bindProperties(org.apache.camel.CamelContext camelContext, Object target, Map<String,Object> properties, String optionPrefix) Binds the properties with the given prefix to the target object, and removes the property that was bound from properties.
static boolean	bindProperties(org.apache.camel.CamelContext camelContext, Object target, Map<String,Object> properties, String optionPrefix, boolean ignoreCase) Binds the properties with the given prefix to the target object, and removes the property that was bound from properties.
static boolean	bindProperties(org.apache.camel.CamelContext camelContext, Object target, Map<String,Object> properties, String optionPrefix, boolean ignoreCase, boolean nesting, boolean deepNesting, boolean fluentBuilder, boolean allowPrivateSetter, boolean reference, boolean placeholder) Binds the properties with the given prefix to the target object, and removes the property that was bound from properties.
static boolean	bindProperty(org.apache.camel.CamelContext camelContext, Object target, String name, Object value) Binds the property to the target object.
static boolean	bindProperty(org.apache.camel.CamelContext camelContext, Object target, String name, Object value, boolean ignoreCase) Binds the property to the target object.
static PropertyBindingSupport.Builder	build()

Methods inherited from class java.lang.Object

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

Method Detail

build

public static PropertyBindingSupport.Builder build()

autowireSingletonPropertiesFromRegistry

public static boolean autowireSingletonPropertiesFromRegistry(org.apache.camel.CamelContext camelContext,
                                                              Object target)

This will discover all the properties on the target, and automatic bind the properties that are null by looking up in the registry to see if there is a single instance of the same type as the property. This is used for convention over configuration to automatic configure resources such as DataSource, Amazon Logins and so on.

Parameters:

camelContext - the camel context

target - the target object

Returns:

true if one ore more properties was auto wired

autowireSingletonPropertiesFromRegistry

public static boolean autowireSingletonPropertiesFromRegistry(org.apache.camel.CamelContext camelContext,
                                                              Object target,
                                                              boolean bindNullOnly,
                                                              boolean deepNesting,
                                                              PropertyBindingSupport.OnAutowiring callback)

This will discover all the properties on the target, and automatic bind the properties by looking up in the registry to see if there is a single instance of the same type as the property. This is used for convention over configuration to automatic configure resources such as DataSource, Amazon Logins and so on.

Parameters:

camelContext - the camel context

target - the target object

bindNullOnly - whether to only autowire if the property has no default value or has not been configured explicit

deepNesting - whether to attempt to walk as deep down the object graph by creating new empty objects on the way if needed (Camel can only create new empty objects if they have a default no-arg constructor, also mind that this may lead to creating many empty objects, even if they will not have any objects autowired from the registry, so use this with caution)

callback - optional callback when a property was auto wired

Returns:

true if one ore more properties was auto wired

bindProperties

public static boolean bindProperties(org.apache.camel.CamelContext camelContext,
                                     Object target,
                                     Map<String,Object> properties)

Binds the properties to the target object, and removes the property that was bound from properties.

Parameters:

camelContext - the camel context

target - the target object

properties - the properties where the bound properties will be removed from

Returns:

true if one or more properties was bound

bindProperties

public static boolean bindProperties(org.apache.camel.CamelContext camelContext,
                                     Object target,
                                     Map<String,Object> properties,
                                     boolean ignoreCase)

Binds the properties to the target object, and removes the property that was bound from properties.

Parameters:

camelContext - the camel context

target - the target object

properties - the properties where the bound properties will be removed from

ignoreCase - whether to ignore case for property keys

Returns:

true if one or more properties was bound

bindProperties

public static boolean bindProperties(org.apache.camel.CamelContext camelContext,
                                     Object target,
                                     Map<String,Object> properties,
                                     String optionPrefix)

Binds the properties with the given prefix to the target object, and removes the property that was bound from properties. Note that the prefix is removed from the key before the property is bound.

Parameters:

camelContext - the camel context

target - the target object

properties - the properties where the bound properties will be removed from

optionPrefix - the prefix used to filter properties

Returns:

true if one or more properties was bound

bindProperties

public static boolean bindProperties(org.apache.camel.CamelContext camelContext,
                                     Object target,
                                     Map<String,Object> properties,
                                     String optionPrefix,
                                     boolean ignoreCase)

Binds the properties with the given prefix to the target object, and removes the property that was bound from properties. Note that the prefix is removed from the key before the property is bound.

Parameters:

camelContext - the camel context

target - the target object

properties - the properties where the bound properties will be removed from

optionPrefix - the prefix used to filter properties

ignoreCase - whether to ignore case for property keys

Returns:

true if one or more properties was bound

bindProperties

public static boolean bindProperties(org.apache.camel.CamelContext camelContext,
                                     Object target,
                                     Map<String,Object> properties,
                                     String optionPrefix,
                                     boolean ignoreCase,
                                     boolean nesting,
                                     boolean deepNesting,
                                     boolean fluentBuilder,
                                     boolean allowPrivateSetter,
                                     boolean reference,
                                     boolean placeholder)

Binds the properties with the given prefix to the target object, and removes the property that was bound from properties. Note that the prefix is removed from the key before the property is bound.

Parameters:

camelContext - the camel context

target - the target object

properties - the properties where the bound properties will be removed from

optionPrefix - the prefix used to filter properties

ignoreCase - whether to ignore case for property keys

nesting - whether nesting is in use

deepNesting - whether deep nesting is in use, where Camel will attempt to walk as deep as possible by creating new objects in the OGNL graph if a property has a setter and the object can be created from a default no-arg constructor.

fluentBuilder - whether fluent builder is allowed as a valid getter/setter

allowPrivateSetter - whether autowiring components allows to use private setter method when setting the value

reference - whether reference parameter (syntax starts with #) is in use

placeholder - whether to use Camels property placeholder to resolve placeholders on keys and values

Returns:

true if one or more properties was bound

bindProperty

public static boolean bindProperty(org.apache.camel.CamelContext camelContext,
                                   Object target,
                                   String name,
                                   Object value)
                            throws org.apache.camel.PropertyBindingException

Binds the property to the target object.

Parameters:

camelContext - the camel context

target - the target object

name - name of property

value - value of property

Returns:

true if property was bound, false otherwise

Throws:

org.apache.camel.PropertyBindingException - is thrown if error binding property

bindProperty

public static boolean bindProperty(org.apache.camel.CamelContext camelContext,
                                   Object target,
                                   String name,
                                   Object value,
                                   boolean ignoreCase)
                            throws org.apache.camel.PropertyBindingException

Binds the property to the target object.

Parameters:

camelContext - the camel context

target - the target object

name - name of property

value - value of property

ignoreCase - whether to ignore case for property keys

Returns:

true if property was bound, false otherwise

Throws:

org.apache.camel.PropertyBindingException - is thrown if error binding property

bindMandatoryProperty

public static void bindMandatoryProperty(org.apache.camel.CamelContext camelContext,
                                         Object target,
                                         String name,
                                         Object value)
                                  throws org.apache.camel.PropertyBindingException

Binds the mandatory property to the target object (will fail if not set/bound).

Parameters:

camelContext - the camel context

target - the target object

name - name of property

value - value of property

Throws:

org.apache.camel.PropertyBindingException - is thrown if error binding property, or the property was not bound

bindMandatoryProperty

public static void bindMandatoryProperty(org.apache.camel.CamelContext camelContext,
                                         Object target,
                                         String name,
                                         Object value,
                                         boolean ignoreCase)
                                  throws org.apache.camel.PropertyBindingException

Binds the mandatory property to the target object (will fail if not set/bound).

Parameters:

camelContext - the camel context

target - the target object

name - name of property

value - value of property

ignoreCase - whether to ignore case for property keys

Throws:

org.apache.camel.PropertyBindingException - is thrown if error binding property, or the property was not bound