org.apache.camel.util

Class CamelContextHelper

java.lang.Object

org.apache.camel.util.CamelContextHelper

public final class CamelContextHelper
extends Object

A number of helper methods

Version:

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_BASE
static String	COMPONENT_DESCRIPTOR
static String	COMPONENT_DOCUMENTATION_PREFIX
static String	MODEL_DESCRIPTOR
static String	MODEL_DOCUMENTATION_PREFIX

Method Summary

Modifier and Type	Method and Description
static <T> T	convertTo(CamelContext context, Class<T> type, Object value) Converts the given value to the requested type
static <T> T	findByType(CamelContext camelContext, Class<T> type) Look up a bean of the give type in the Registry on the CamelContext returning an instance if only one bean is present,
static SortedMap<String,Properties>	findComponents(CamelContext camelContext) Finds all possible Components on the classpath, already registered in CamelContext, and from the Registry.
static SortedMap<String,Properties>	findComponents(CamelContext camelContext, Enumeration<URL> componentDescriptionIter)
static SortedMap<String,Properties>	findEips(CamelContext camelContext) Find information about all the EIPs from camel-core.
static Endpoint	getEndpointInjection(CamelContext camelContext, String uri, String ref, String injectionPointName, boolean mandatory) Evaluates the @EndpointInject annotation using the given context
static Endpoint	getMandatoryEndpoint(CamelContext camelContext, String uri) Returns the mandatory endpoint for the given URI or the NoSuchEndpointException is thrown
static <T extends Endpoint> T	getMandatoryEndpoint(CamelContext camelContext, String uri, Class<T> type) Returns the mandatory endpoint for the given URI and type or the NoSuchEndpointException is thrown
static int	getMaximumCachePoolSize(CamelContext camelContext) Gets the maximum cache pool size.
static int	getMaximumEndpointCacheSize(CamelContext camelContext) Gets the maximum endpoint cache size.
static int	getMaximumTransformerCacheSize(CamelContext camelContext) Gets the maximum transformer cache size.
static int	getMaximumValidatorCacheSize(CamelContext camelContext) Gets the maximum validator cache size.
static int	getRouteStartupOrder(CamelContext camelContext, String routeId) Gets the route startup order for the given route id
static boolean	isEipInUse(CamelContext camelContext, String name) Checks if any of the Camel routes is using an EIP with the given name
static Object	lookup(CamelContext context, String name) Look up the given named bean in the Registry on the CamelContext
static <T> T	lookup(CamelContext context, String name, Class<T> beanType) Look up the given named bean of the given type in the Registry on the CamelContext
static Component	lookupPropertiesComponent(CamelContext camelContext, boolean autoCreate) Lookup the PropertiesComponent from the CamelContext.
static <T> T	mandatoryConvertTo(CamelContext context, Class<T> type, Object value) Converts the given value to the specified type throwing an IllegalArgumentException if the value could not be converted to a non null value
static Object	mandatoryLookup(CamelContext context, String name) Look up the given named bean in the Registry on the CamelContext or throws NoSuchBeanException if not found.
static <T> T	mandatoryLookup(CamelContext context, String name, Class<T> beanType) Look up the given named bean of the given type in the Registry on the CamelContext or throws NoSuchBeanException if not found.
static <T> T	newInstance(CamelContext context, Class<T> beanType) Creates a new instance of the given type using the Injector on the given CamelContext
static Boolean	parseBoolean(CamelContext camelContext, String text) Parses the given text and converts it to an Boolean and handling property placeholders as well
static Double	parseDouble(CamelContext camelContext, String text) Parses the given text and converts it to a Double and handling property placeholders as well
static Integer	parseInteger(CamelContext camelContext, String text) Parses the given text and converts it to an Integer and handling property placeholders as well
static Long	parseLong(CamelContext camelContext, String text) Parses the given text and converts it to an Long and handling property placeholders as well
static String	parseText(CamelContext camelContext, String text) Parses the given text and handling property placeholders as well
static void	resolvePropertyPlaceholders(CamelContext camelContext, Object target) Inspects the given object and resolves any property placeholders from its properties.

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_BASE

public static final String COMPONENT_BASE

See Also:

Constant Field Values

COMPONENT_DESCRIPTOR

public static final String COMPONENT_DESCRIPTOR

See Also:

Constant Field Values

COMPONENT_DOCUMENTATION_PREFIX

public static final String COMPONENT_DOCUMENTATION_PREFIX

See Also:

Constant Field Values

MODEL_DESCRIPTOR

public static final String MODEL_DESCRIPTOR

See Also:

Constant Field Values

MODEL_DOCUMENTATION_PREFIX

public static final String MODEL_DOCUMENTATION_PREFIX

See Also:

Constant Field Values

Method Detail

getMandatoryEndpoint

public static Endpoint getMandatoryEndpoint(CamelContext camelContext,
                                            String uri)
                                     throws NoSuchEndpointException

Returns the mandatory endpoint for the given URI or the NoSuchEndpointException is thrown

Throws:

NoSuchEndpointException

getMandatoryEndpoint

public static <T extends Endpoint> T getMandatoryEndpoint(CamelContext camelContext,
                                                          String uri,
                                                          Class<T> type)

Returns the mandatory endpoint for the given URI and type or the NoSuchEndpointException is thrown

convertTo

public static <T> T convertTo(CamelContext context,
                              Class<T> type,
                              Object value)

Converts the given value to the requested type

mandatoryConvertTo

public static <T> T mandatoryConvertTo(CamelContext context,
                                       Class<T> type,
                                       Object value)

Converts the given value to the specified type throwing an IllegalArgumentException if the value could not be converted to a non null value

newInstance

public static <T> T newInstance(CamelContext context,
                                Class<T> beanType)

Creates a new instance of the given type using the Injector on the given CamelContext

lookup

public static Object lookup(CamelContext context,
                            String name)

Look up the given named bean in the Registry on the CamelContext

lookup

public static <T> T lookup(CamelContext context,
                           String name,
                           Class<T> beanType)

Look up the given named bean of the given type in the Registry on the CamelContext

findByType

public static <T> T findByType(CamelContext camelContext,
                               Class<T> type)

Look up a bean of the give type in the Registry on the CamelContext returning an instance if only one bean is present,

mandatoryLookup

public static Object mandatoryLookup(CamelContext context,
                                     String name)

Look up the given named bean in the Registry on the CamelContext or throws NoSuchBeanException if not found.

mandatoryLookup

public static <T> T mandatoryLookup(CamelContext context,
                                    String name,
                                    Class<T> beanType)

Look up the given named bean of the given type in the Registry on the CamelContext or throws NoSuchBeanException if not found.

getEndpointInjection

public static Endpoint getEndpointInjection(CamelContext camelContext,
                                            String uri,
                                            String ref,
                                            String injectionPointName,
                                            boolean mandatory)

Evaluates the @EndpointInject annotation using the given context

getMaximumCachePoolSize

public static int getMaximumCachePoolSize(CamelContext camelContext)
                                   throws IllegalArgumentException

Gets the maximum cache pool size.

Will use the property set on CamelContext with the key Exchange.MAXIMUM_CACHE_POOL_SIZE. If no property has been set, then it will fallback to return a size of 1000.

Parameters:

camelContext - the camel context

Returns:

the maximum cache size

Throws:

IllegalArgumentException - is thrown if the property is illegal

getMaximumEndpointCacheSize

public static int getMaximumEndpointCacheSize(CamelContext camelContext)
                                       throws IllegalArgumentException

Gets the maximum endpoint cache size.

Will use the property set on CamelContext with the key Exchange.MAXIMUM_ENDPOINT_CACHE_SIZE. If no property has been set, then it will fallback to return a size of 1000.

Parameters:

camelContext - the camel context

Returns:

the maximum cache size

Throws:

IllegalArgumentException - is thrown if the property is illegal

getMaximumTransformerCacheSize

public static int getMaximumTransformerCacheSize(CamelContext camelContext)
                                          throws IllegalArgumentException

Gets the maximum transformer cache size.

Will use the property set on CamelContext with the key Exchange.MAXIMUM_TRANSFORMER_CACHE_SIZE. If no property has been set, then it will fallback to return a size of 1000.

Parameters:

camelContext - the camel context

Returns:

the maximum cache size

Throws:

IllegalArgumentException - is thrown if the property is illegal

getMaximumValidatorCacheSize

public static int getMaximumValidatorCacheSize(CamelContext camelContext)
                                        throws IllegalArgumentException

Gets the maximum validator cache size.

Will use the property set on CamelContext with the key Exchange.MAXIMUM_VALIDATOR_CACHE_SIZE. If no property has been set, then it will fallback to return a size of 1000.

Parameters:

camelContext - the camel context

Returns:

the maximum cache size

Throws:

IllegalArgumentException - is thrown if the property is illegal

parseText

public static String parseText(CamelContext camelContext,
                               String text)
                        throws Exception

Parses the given text and handling property placeholders as well

Parameters:

camelContext - the camel context

text - the text

Returns:

the parsed text, or null if the text was null

Throws:

Exception - is thrown if illegal argument

parseInteger

public static Integer parseInteger(CamelContext camelContext,
                                   String text)
                            throws Exception

Parses the given text and converts it to an Integer and handling property placeholders as well

Parameters:

camelContext - the camel context

text - the text

Returns:

the integer vale, or null if the text was null

Throws:

Exception - is thrown if illegal argument or type conversion not possible

parseLong

public static Long parseLong(CamelContext camelContext,
                             String text)
                      throws Exception

Parses the given text and converts it to an Long and handling property placeholders as well

Parameters:

camelContext - the camel context

text - the text

Returns:

the long vale, or null if the text was null

Throws:

Exception - is thrown if illegal argument or type conversion not possible

parseDouble

public static Double parseDouble(CamelContext camelContext,
                                 String text)
                          throws Exception

Parses the given text and converts it to a Double and handling property placeholders as well

Parameters:

camelContext - the camel context

text - the text

Returns:

the double vale, or null if the text was null

Throws:

Exception - is thrown if illegal argument or type conversion not possible

parseBoolean

public static Boolean parseBoolean(CamelContext camelContext,
                                   String text)
                            throws Exception

Parses the given text and converts it to an Boolean and handling property placeholders as well

Parameters:

camelContext - the camel context

text - the text

Returns:

the boolean vale, or null if the text was null

Throws:

Exception - is thrown if illegal argument or type conversion not possible

findComponents

public static SortedMap<String,Properties> findComponents(CamelContext camelContext)
                                                   throws LoadPropertiesException

Finds all possible Components on the classpath, already registered in CamelContext, and from the Registry.

Throws:

LoadPropertiesException

findComponents

public static SortedMap<String,Properties> findComponents(CamelContext camelContext,
                                                          Enumeration<URL> componentDescriptionIter)
                                                   throws LoadPropertiesException

Throws:

LoadPropertiesException

findEips

public static SortedMap<String,Properties> findEips(CamelContext camelContext)
                                             throws LoadPropertiesException

Find information about all the EIPs from camel-core.

Throws:

LoadPropertiesException

getRouteStartupOrder

public static int getRouteStartupOrder(CamelContext camelContext,
                                       String routeId)

Gets the route startup order for the given route id

Parameters:

camelContext - the camel context

routeId - the id of the route

Returns:

the startup order, or 0 if not possible to determine

lookupPropertiesComponent

public static Component lookupPropertiesComponent(CamelContext camelContext,
                                                  boolean autoCreate)

Lookup the PropertiesComponent from the CamelContext.

Parameters:

camelContext - the camel context

autoCreate - whether to automatic create a new default PropertiesComponent if no custom component has been configured.

Returns:

the properties component, or null if none has been defined, and auto create is false.

isEipInUse

public static boolean isEipInUse(CamelContext camelContext,
                                 String name)

Checks if any of the Camel routes is using an EIP with the given name

Parameters:

camelContext - the Camel context

name - the name of the EIP

Returns:

true if in use, false if not

resolvePropertyPlaceholders

public static void resolvePropertyPlaceholders(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