Interface ComponentCustomizer

All Superinterfaces:

Ordered

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ComponentCustomizer
extends Ordered

Strategy for applying custom configuration to Component instances as they are created.

Customizers are discovered from the Registry and applied to each component during bootstrap, with isEnabled(String, Component) (and an optional ComponentCustomizer.Policy) deciding whether a given component is customized, and Ordered controlling the order. Use the builder() / forType(Class, ThrowingConsumer) helpers to target a concrete component type. This is the component-level counterpart to CamelContextCustomizer.

See CamelContext auto-configuration in the Camel user manual.

See Also:

• CamelContextCustomizer
• DataFormatCustomizer
• LanguageCustomizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ComponentCustomizer.Builder<T extends Component>	A fluent builder to create a ComponentCustomizer instance.
static interface	ComponentCustomizer.Policy	Used as additional filer mechanism to control if customizers need to be applied or not.

Field Summary

Fields inherited from interface Ordered

HIGHEST, LOWEST

Method Summary

Modifier and Type	Method	Description
static ComponentCustomizer.Builder<Component>	builder()	Create a generic ComponentCustomizer.Builder.
static <T extends Component> ComponentCustomizer.Builder<T>	builder(Class<T> type)	Create a typed ComponentCustomizer.Builder that can process a concrete component type instance.
void	configure(String name, Component target)	Customize the specified Component.
static <T extends Component> ComponentCustomizer	forType(Class<T> type, org.apache.camel.util.function.ThrowingConsumer<T, Exception> consumer)	Create a ComponentCustomizer that can process a concrete component type instance.
default int	getOrder()	Gets the order.
default boolean	isEnabled(String name, Component target)	Checks whether this customizer should be applied to the given Component.

Method Details

builder

static ComponentCustomizer.Builder<Component> builder()

Create a generic ComponentCustomizer.Builder.

Returns:

the ComponentCustomizer.Builder

builder

static <T extends Component>
ComponentCustomizer.Builder<T> builder(Class<T> type)

Create a typed ComponentCustomizer.Builder that can process a concrete component type instance.

Parameters:

type - the concrete type of the Component

Returns:

the ComponentCustomizer.Builder

forType

static <T extends Component> ComponentCustomizer forType(Class<T> type,
 org.apache.camel.util.function.ThrowingConsumer<T, Exception> consumer)

Create a ComponentCustomizer that can process a concrete component type instance.

Parameters:

type - the concrete type of the Component

consumer - the Component configuration logic

Returns:

the ComponentCustomizer

configure

void configure(String name,
 Component target)

Customize the specified Component.

Parameters:

name - the unique name of the component

target - the component to configure

isEnabled

default boolean isEnabled(String name,
 Component target)

Checks whether this customizer should be applied to the given Component.

Parameters:

name - the unique name of the component

target - the component to configure

Returns:

true if the customizer should be applied

getOrder

default int getOrder()

Description copied from interface: Ordered

Gets the order.

Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards. So if you want to be last then use Integer.MAX_VALUE or eg Ordered.LOWEST.

Specified by:

getOrder in interface Ordered

Returns:

the order