org.apache.camel.spring.boot.util

Class CamelPropertiesHelper

java.lang.Object

org.apache.camel.spring.boot.util.CamelPropertiesHelper

public final class CamelPropertiesHelper
extends Object

To help configuring Camel properties that have been defined in Spring Boot configuration files.

Method Summary

Modifier and Type	Method and Description
static void	resolvePropertyPlaceholders(org.apache.camel.CamelContext camelContext, Object target) Inspects the given object and resolves any property placeholders from its properties.
static boolean	setCamelProperties(org.apache.camel.CamelContext context, Object target, Map<String,Object> properties, boolean failIfNotSet) Sets the properties on the target bean.

Methods inherited from class java.lang.Object

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

Method Detail

setCamelProperties

public static boolean setCamelProperties(org.apache.camel.CamelContext context,
                                         Object target,
                                         Map<String,Object> properties,
                                         boolean failIfNotSet)
                                  throws Exception

Sets the properties on the target bean.

This implementation sets the properties using the following algorithm:

• Value as reference lookup - If the value uses Camel reference syntax, eg #beanId then the bean is looked up from Registry and set on the target
• Value as-is - The value is attempted to be converted to the class type of the bean setter method; this is for regular types like String, numbers etc
• Value as lookup - the bean is looked up from Registry and if there is a bean then its set on the target

When an option has been set on the target bean, then its removed from the given properties map. If all the options has been set, then the map will be empty.

Parameters:

context - the CamelContext

target - the target bean

properties - the properties

failIfNotSet - whether to fail if an option either does not exists on the target bean or if the option cannot be due no suitable setter methods with the given type

Returns:

true if at least one option was configured

Throws:

IllegalArgumentException - is thrown if an option cannot be configured on the bean because there is no suitable setter method and failOnNoSet is true.

Exception - for any other kind of error

resolvePropertyPlaceholders

public static void resolvePropertyPlaceholders(org.apache.camel.CamelContext camelContext,
                                               Object target)
                                        throws Exception

Inspects the given object and resolves any property placeholders from its properties.

This implementation will check all the getter/setter pairs on this instance and for all the values (which is a String type) will be property placeholder resolved.

Parameters:

camelContext - the Camel context

target - the object that should have the properties (eg getter/setter) resolved

Throws:

Exception - is thrown if property placeholders was used and there was an error resolving them

See Also:

CamelContext.resolvePropertyPlaceholders(String), PropertiesComponent