org.apache.camel.model

Class ProcessorDefinitionHelper

java.lang.Object

org.apache.camel.model.ProcessorDefinitionHelper

public final class ProcessorDefinitionHelper
extends Object

Helper class for ProcessorDefinition and the other model classes.

Method Summary

Modifier and Type	Method and Description
static void	addPropertyPlaceholdersChangeRevertAction(Runnable action)
static Runnable	createPropertyPlaceholdersChangeReverter() Creates a Runnable which when run will revert property placeholder updates to the camel route definitions that were done after this method is called.
static <T> Iterator<T>	filterTypeInOutputs(List<ProcessorDefinition<?>> outputs, Class<T> type) Looks for the given type in the list of outputs and recurring all the children as well.
static <T> Iterator<T>	filterTypeInOutputs(List<ProcessorDefinition<?>> outputs, Class<T> type, int maxDeep) Looks for the given type in the list of outputs and recurring all the children as well.
static <T extends ProcessorDefinition> T	findFirstParentOfType(Class<T> parentType, ProcessorDefinition<?> node, boolean recursive) Is the given node parent(s) of the given type
static <T> T	findFirstTypeInOutputs(List<ProcessorDefinition<?>> outputs, Class<T> type) Looks for the given type in the list of outputs and recurring all the children as well.
static Set<String>	gatherAllNodeIds(ProcessorDefinition<?> node, Set<String> set, boolean onlyCustomId, boolean includeAbstract) Traverses the node, including its children (recursive), and gathers all the node ids.
static ExecutorService	getConfiguredExecutorService(org.apache.camel.spi.RouteContext routeContext, String name, ExecutorServiceAwareDefinition<?> definition, boolean useDefault) Will lookup and get the configured ExecutorService from the given definition.
static ScheduledExecutorService	getConfiguredScheduledExecutorService(org.apache.camel.spi.RouteContext routeContext, String name, ExecutorServiceAwareDefinition<?> definition, boolean useDefault) Will lookup and get the configured ScheduledExecutorService from the given definition.
static RouteDefinition	getRoute(org.apache.camel.NamedNode node) Gets the route definition the given node belongs to.
static String	getRouteId(org.apache.camel.NamedNode node) Gets the route id the given node belongs to.
static boolean	hasOutputs(List<ProcessorDefinition<?>> outputs, boolean excludeAbstract) Is there any outputs in the given list.
static boolean	isFirstChildOfType(Class<?> parentType, ProcessorDefinition<?> node) Is the given child the first in the outputs from the parent?
static boolean	isParentOfType(Class<? extends ProcessorDefinition> parentType, ProcessorDefinition<?> node, boolean recursive) Is the given node parent(s) of the given type
static ExecutorService	lookupExecutorServiceRef(org.apache.camel.spi.RouteContext routeContext, String name, Object source, String executorServiceRef) Will lookup in Registry for a ExecutorService registered with the given executorServiceRef name.
static ScheduledExecutorService	lookupScheduledExecutorServiceRef(org.apache.camel.spi.RouteContext routeContext, String name, Object source, String executorServiceRef) Will lookup in Registry for a ScheduledExecutorService registered with the given executorServiceRef name.
static void	resolvePropertyPlaceholders(org.apache.camel.CamelContext camelContext, Object definition) Inspects the given definition and resolves any property placeholders from its properties.
static boolean	willCreateNewThreadPool(org.apache.camel.spi.RouteContext routeContext, ExecutorServiceAwareDefinition<?> definition, boolean useDefault) Determines whether a new thread pool will be created or not.

Methods inherited from class java.lang.Object

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

Method Detail

filterTypeInOutputs

public static <T> Iterator<T> filterTypeInOutputs(List<ProcessorDefinition<?>> outputs,
                                                  Class<T> type)

Looks for the given type in the list of outputs and recurring all the children as well.

Parameters:

outputs - list of outputs, can be null or empty.

type - the type to look for

Returns:

the found definitions, or null if not found

filterTypeInOutputs

public static <T> Iterator<T> filterTypeInOutputs(List<ProcessorDefinition<?>> outputs,
                                                  Class<T> type,
                                                  int maxDeep)

Looks for the given type in the list of outputs and recurring all the children as well.

Parameters:

outputs - list of outputs, can be null or empty.

type - the type to look for

maxDeep - maximum levels deep to traverse

Returns:

the found definitions, or null if not found

findFirstTypeInOutputs

public static <T> T findFirstTypeInOutputs(List<ProcessorDefinition<?>> outputs,
                                           Class<T> type)

Looks for the given type in the list of outputs and recurring all the children as well. Will stop at first found and return it.

Parameters:

outputs - list of outputs, can be null or empty.

type - the type to look for

Returns:

the first found type, or null if not found

isFirstChildOfType

public static boolean isFirstChildOfType(Class<?> parentType,
                                         ProcessorDefinition<?> node)

Is the given child the first in the outputs from the parent?

Parameters:

parentType - the type the parent must be

node - the node

Returns:

true if first child, false otherwise

isParentOfType

public static boolean isParentOfType(Class<? extends ProcessorDefinition> parentType,
                                     ProcessorDefinition<?> node,
                                     boolean recursive)

Is the given node parent(s) of the given type

Parameters:

parentType - the parent type

node - the current node

recursive - whether or not to check grand parent(s) as well

Returns:

true if parent(s) is of given type, false otherwise

findFirstParentOfType

public static <T extends ProcessorDefinition> T findFirstParentOfType(Class<T> parentType,
                                                                      ProcessorDefinition<?> node,
                                                                      boolean recursive)

Is the given node parent(s) of the given type

Parameters:

parentType - the parent type

node - the current node

recursive - whether or not to check grand parent(s) as well

Returns:

true if parent(s) is of given type, false otherwise

getRoute

public static RouteDefinition getRoute(org.apache.camel.NamedNode node)

Gets the route definition the given node belongs to.

Parameters:

node - the node

Returns:

the route, or null if not possible to find

getRouteId

public static String getRouteId(org.apache.camel.NamedNode node)

Gets the route id the given node belongs to.

Parameters:

node - the node

Returns:

the route id, or null if not possible to find

gatherAllNodeIds

public static Set<String> gatherAllNodeIds(ProcessorDefinition<?> node,
                                           Set<String> set,
                                           boolean onlyCustomId,
                                           boolean includeAbstract)

Traverses the node, including its children (recursive), and gathers all the node ids.

Parameters:

node - the target node

set - set to store ids, if null a new set will be created

onlyCustomId - whether to only store custom assigned ids (ie. OptionalIdentifiedDefinition.hasCustomIdAssigned()

includeAbstract - whether to include abstract nodes (ie. ProcessorDefinition.isAbstract()

Returns:

the set with the found ids.

hasOutputs

public static boolean hasOutputs(List<ProcessorDefinition<?>> outputs,
                                 boolean excludeAbstract)

Is there any outputs in the given list.

Is used for check if the route output has any real outputs (non abstracts)

Parameters:

outputs - the outputs

excludeAbstract - whether or not to exclude abstract outputs (e.g. skip onException etc.)

Returns:

true if has outputs, otherwise false is returned

willCreateNewThreadPool

public static boolean willCreateNewThreadPool(org.apache.camel.spi.RouteContext routeContext,
                                              ExecutorServiceAwareDefinition<?> definition,
                                              boolean useDefault)

Determines whether a new thread pool will be created or not.

This is used to know if a new thread pool will be created, and therefore is not shared by others, and therefore exclusive to the definition.

Parameters:

routeContext - the route context

definition - the node definition which may leverage executor service.

useDefault - whether to fallback and use a default thread pool, if no explicit configured

Returns:

true if a new thread pool will be created, false if not

See Also:

getConfiguredExecutorService(org.apache.camel.spi.RouteContext, String, ExecutorServiceAwareDefinition, boolean)

lookupExecutorServiceRef

public static ExecutorService lookupExecutorServiceRef(org.apache.camel.spi.RouteContext routeContext,
                                                       String name,
                                                       Object source,
                                                       String executorServiceRef)

Will lookup in Registry for a ExecutorService registered with the given executorServiceRef name.

This method will lookup for configured thread pool in the following order

• from the Registry if found
• from the known list of ThreadPoolProfile(s).
• if none found, then null is returned.

Parameters:

routeContext - the route context

name - name which is appended to the thread name, when the ExecutorService is created based on a ThreadPoolProfile.

source - the source to use the thread pool

executorServiceRef - reference name of the thread pool

Returns:

the executor service, or null if none was found.

getConfiguredExecutorService

public static ExecutorService getConfiguredExecutorService(org.apache.camel.spi.RouteContext routeContext,
                                                           String name,
                                                           ExecutorServiceAwareDefinition<?> definition,
                                                           boolean useDefault)
                                                    throws IllegalArgumentException

Will lookup and get the configured ExecutorService from the given definition.

This method will lookup for configured thread pool in the following order

• from the definition if any explicit configured executor service.
• from the Registry if found
• from the known list of ThreadPoolProfile(s).
• if none found, then null is returned.

The various ExecutorServiceAwareDefinition should use this helper method to ensure they support configured executor services in the same coherent way.

Parameters:

routeContext - the route context

name - name which is appended to the thread name, when the ExecutorService is created based on a ThreadPoolProfile.

definition - the node definition which may leverage executor service.

useDefault - whether to fallback and use a default thread pool, if no explicit configured

Returns:

the configured executor service, or null if none was configured.

Throws:

IllegalArgumentException - is thrown if lookup of executor service in Registry was not found

lookupScheduledExecutorServiceRef

public static ScheduledExecutorService lookupScheduledExecutorServiceRef(org.apache.camel.spi.RouteContext routeContext,
                                                                         String name,
                                                                         Object source,
                                                                         String executorServiceRef)

Will lookup in Registry for a ScheduledExecutorService registered with the given executorServiceRef name.

This method will lookup for configured thread pool in the following order

• from the Registry if found
• from the known list of ThreadPoolProfile(s).
• if none found, then null is returned.

Parameters:

routeContext - the route context

name - name which is appended to the thread name, when the ExecutorService is created based on a ThreadPoolProfile.

source - the source to use the thread pool

executorServiceRef - reference name of the thread pool

Returns:

the executor service, or null if none was found.

getConfiguredScheduledExecutorService

public static ScheduledExecutorService getConfiguredScheduledExecutorService(org.apache.camel.spi.RouteContext routeContext,
                                                                             String name,
                                                                             ExecutorServiceAwareDefinition<?> definition,
                                                                             boolean useDefault)
                                                                      throws IllegalArgumentException

Will lookup and get the configured ScheduledExecutorService from the given definition.

This method will lookup for configured thread pool in the following order

• from the definition if any explicit configured executor service.
• from the Registry if found
• from the known list of ThreadPoolProfile(s).
• if none found, then null is returned.

The various ExecutorServiceAwareDefinition should use this helper method to ensure they support configured executor services in the same coherent way.

Parameters:

routeContext - the rout context

name - name which is appended to the thread name, when the ExecutorService is created based on a ThreadPoolProfile.

definition - the node definition which may leverage executor service.

useDefault - whether to fallback and use a default thread pool, if no explicit configured

Returns:

the configured executor service, or null if none was configured.

Throws:

IllegalArgumentException - is thrown if the found instance is not a ScheduledExecutorService type, or lookup of executor service in Registry was not found

createPropertyPlaceholdersChangeReverter

public static Runnable createPropertyPlaceholdersChangeReverter()

Creates a Runnable which when run will revert property placeholder updates to the camel route definitions that were done after this method is called. The Runnable MUST be executed and MUST be executed in the same thread this method is called from. Therefore it's recommend you use it in try/finally block like in the following example:

 Runnable undo = ProcessorDefinitionHelper.createPropertyPlaceholdersChangeReverter();
 try {
     // All property resolutions in this block will be reverted.
 } finally {
     undo.run();
 }
 

Returns:

a Runnable that when run, will revert any property place holder changes that occurred on the current thread .

addPropertyPlaceholdersChangeRevertAction

public static void addPropertyPlaceholdersChangeRevertAction(Runnable action)

resolvePropertyPlaceholders

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

Inspects the given definition 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. Additional properties are also resolved if the definition implements OtherAttributesAware. Also known constant fields on Exchange is replaced with their actual constant value, eg Exchange.FILE_NAME is replaced with CamelFileName.

Parameters:

camelContext - the Camel context

definition - the definition which should implement OtherAttributesAware

Throws:

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

See Also:

CamelContext.resolvePropertyPlaceholders(String), org.apache.camel.component.properties.PropertiesComponent