org.apache.camel.util

Class EndpointHelper

java.lang.Object

org.apache.camel.util.EndpointHelper

public final class EndpointHelper
extends Object

Some helper methods for working with Endpoint instances

Method Summary

Modifier and Type	Method and Description
static String	browseRangeMessagesAsXml(BrowsableEndpoint endpoint, Integer fromIndex, Integer toIndex, Boolean includeBody) Browses the BrowsableEndpoint within the given range, and returns the messages as a XML payload.
static String	createEndpointId() A helper method for Endpoint implementations to create new Ids for Endpoints which also implement HasId
static Map<String,Object>	endpointProperties(CamelContext camelContext, String uri) Parses the endpoint uri and builds a map of documentation information for each option which is extracted from the component json documentation
static String	getRouteIdFromEndpoint(Endpoint endpoint) Gets the route id for the given endpoint in which there is a consumer listening.
static boolean	isReferenceParameter(String parameter) Is the given parameter a reference parameter (starting with a # char)
static String	lookupEndpointRegistryId(Endpoint endpoint) Lookup the id the given endpoint has been enlisted with in the Registry.
static boolean	matchEndpoint(CamelContext context, String uri, String pattern) Matches the endpoint with the given pattern.
static boolean	matchEndpoint(String uri, String pattern) Deprecated. use matchEndpoint(org.apache.camel.CamelContext, String, String) instead.
static boolean	matchPattern(String name, String pattern) Matches the name with the given pattern.
static void	pollEndpoint(Endpoint endpoint, Processor processor) Creates a PollingConsumer and polls all pending messages on the endpoint and invokes the given Processor to process each Exchange and then closes down the consumer and throws any exceptions thrown.
static void	pollEndpoint(Endpoint endpoint, Processor processor, long timeout) Creates a PollingConsumer and polls all pending messages on the endpoint and invokes the given Processor to process each Exchange and then closes down the consumer and throws any exceptions thrown.
static <T> T	resloveStringParameter(CamelContext context, String value, Class<T> type) Deprecated. use resolveParameter(org.apache.camel.CamelContext, String, Class)
static ExchangePattern	resolveExchangePatternFromUrl(String url) Attempts to resolve if the url has an exchangePattern option configured
static <T> T	resolveParameter(CamelContext context, String value, Class<T> type) Resolves a parameter, by doing a reference lookup if the parameter is a reference, and converting the parameter to the given type.
static <T> List<T>	resolveReferenceListParameter(CamelContext context, String value, Class<T> elementType) Resolves a reference list parameter by making lookups in the registry.
static <T> T	resolveReferenceParameter(CamelContext context, String value, Class<T> type) Resolves a reference parameter by making a lookup in the registry.
static <T> T	resolveReferenceParameter(CamelContext context, String value, Class<T> type, boolean mandatory) Resolves a reference parameter by making a lookup in the registry.
static void	setProperties(CamelContext context, Object bean, Map<String,Object> parameters) Sets the regular properties on the given bean
static void	setReferenceProperties(CamelContext context, Object bean, Map<String,Object> parameters) Sets the reference properties on the given bean This is convention over configuration, setting all reference parameters (using isReferenceParameter(String) by looking it up in registry and setting it on the bean if possible.

Methods inherited from class java.lang.Object

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

Method Detail

pollEndpoint

public static void pollEndpoint(Endpoint endpoint,
                                Processor processor,
                                long timeout)
                         throws Exception

Creates a PollingConsumer and polls all pending messages on the endpoint and invokes the given Processor to process each Exchange and then closes down the consumer and throws any exceptions thrown.

Throws:

Exception

pollEndpoint

public static void pollEndpoint(Endpoint endpoint,
                                Processor processor)
                         throws Exception

Creates a PollingConsumer and polls all pending messages on the endpoint and invokes the given Processor to process each Exchange and then closes down the consumer and throws any exceptions thrown.

Throws:

Exception

matchEndpoint

public static boolean matchEndpoint(CamelContext context,
                                    String uri,
                                    String pattern)

Matches the endpoint with the given pattern.

The endpoint will first resolve property placeholders using CamelContext.resolvePropertyPlaceholders(String).

The match rules are applied in this order:

• exact match, returns true
• wildcard match (pattern ends with a * and the uri starts with the pattern), returns true
• regular expression match, returns true
• otherwise returns false

Parameters:

context - the Camel context, if null then property placeholder resolution is skipped.

uri - the endpoint uri

pattern - a pattern to match

Returns:

true if match, false otherwise.

matchEndpoint

@Deprecated
public static boolean matchEndpoint(String uri,
                                                String pattern)

Deprecated. use matchEndpoint(org.apache.camel.CamelContext, String, String) instead.

Matches the endpoint with the given pattern.

See Also:

matchEndpoint(org.apache.camel.CamelContext, String, String)

matchPattern

public static boolean matchPattern(String name,
                                   String pattern)

Matches the name with the given pattern.

The match rules are applied in this order:

• exact match, returns true
• wildcard match (pattern ends with a * and the name starts with the pattern), returns true
• regular expression match, returns true
• otherwise returns false

Parameters:

name - the name

pattern - a pattern to match

Returns:

true if match, false otherwise.

setProperties

public static void setProperties(CamelContext context,
                                 Object bean,
                                 Map<String,Object> parameters)
                          throws Exception

Sets the regular properties on the given bean

Parameters:

context - the camel context

bean - the bean

parameters - parameters

Throws:

Exception - is thrown if setting property fails

setReferenceProperties

public static void setReferenceProperties(CamelContext context,
                                          Object bean,
                                          Map<String,Object> parameters)
                                   throws Exception

Sets the reference properties on the given bean

This is convention over configuration, setting all reference parameters (using isReferenceParameter(String) by looking it up in registry and setting it on the bean if possible.

Parameters:

context - the camel context

bean - the bean

parameters - parameters

Throws:

Exception - is thrown if setting property fails

isReferenceParameter

public static boolean isReferenceParameter(String parameter)

Is the given parameter a reference parameter (starting with a # char)

Parameters:

parameter - the parameter

Returns:

true if its a reference parameter

resolveReferenceParameter

public static <T> T resolveReferenceParameter(CamelContext context,
                                              String value,
                                              Class<T> type)

Resolves a reference parameter by making a lookup in the registry.

Type Parameters:

T - type of object to lookup.

Parameters:

context - Camel context to use for lookup.

value - reference parameter value.

type - type of object to lookup.

Returns:

lookup result.

Throws:

IllegalArgumentException - if referenced object was not found in registry.

resolveReferenceParameter

public static <T> T resolveReferenceParameter(CamelContext context,
                                              String value,
                                              Class<T> type,
                                              boolean mandatory)

Resolves a reference parameter by making a lookup in the registry.

Type Parameters:

T - type of object to lookup.

Parameters:

context - Camel context to use for lookup.

value - reference parameter value.

type - type of object to lookup.

Returns:

lookup result (or null only if mandatory is false).

Throws:

IllegalArgumentException - if object was not found in registry and mandatory is true.

resolveReferenceListParameter

public static <T> List<T> resolveReferenceListParameter(CamelContext context,
                                                        String value,
                                                        Class<T> elementType)

Resolves a reference list parameter by making lookups in the registry. The parameter value must be one of the following:

• a comma-separated list of references to beans of type T
• a single reference to a bean type T
• a single reference to a bean of type java.util.List

Parameters:

context - Camel context to use for lookup.

value - reference parameter value.

elementType - result list element type.

Returns:

list of lookup results, will always return a list.

Throws:

IllegalArgumentException - if any referenced object was not found in registry.

resolveParameter

public static <T> T resolveParameter(CamelContext context,
                                     String value,
                                     Class<T> type)

Resolves a parameter, by doing a reference lookup if the parameter is a reference, and converting the parameter to the given type.

Type Parameters:

T - type of object to convert the parameter value as.

Parameters:

context - Camel context to use for lookup.

value - parameter or reference parameter value.

type - type of object to lookup.

Returns:

lookup result if it was a reference parameter, or the value converted to the given type

Throws:

IllegalArgumentException - if referenced object was not found in registry.

resloveStringParameter

@Deprecated
public static <T> T resloveStringParameter(CamelContext context,
                                                       String value,
                                                       Class<T> type)

Deprecated. use resolveParameter(org.apache.camel.CamelContext, String, Class)

getRouteIdFromEndpoint

public static String getRouteIdFromEndpoint(Endpoint endpoint)

Gets the route id for the given endpoint in which there is a consumer listening.

Parameters:

endpoint - the endpoint

Returns:

the route id, or null if none found

createEndpointId

public static String createEndpointId()

A helper method for Endpoint implementations to create new Ids for Endpoints which also implement HasId

lookupEndpointRegistryId

public static String lookupEndpointRegistryId(Endpoint endpoint)

Lookup the id the given endpoint has been enlisted with in the Registry.

Parameters:

endpoint - the endpoint

Returns:

the endpoint id, or null if not found

browseRangeMessagesAsXml

public static String browseRangeMessagesAsXml(BrowsableEndpoint endpoint,
                                              Integer fromIndex,
                                              Integer toIndex,
                                              Boolean includeBody)

Browses the BrowsableEndpoint within the given range, and returns the messages as a XML payload.

Parameters:

endpoint - the browsable endpoint

fromIndex - from range

toIndex - to range

includeBody - whether to include the message body in the XML payload

Returns:

XML payload with the messages

Throws:

IllegalArgumentException - if the from and to range is invalid

See Also:

MessageHelper.dumpAsXml(org.apache.camel.Message)

resolveExchangePatternFromUrl

public static ExchangePattern resolveExchangePatternFromUrl(String url)
                                                     throws URISyntaxException

Attempts to resolve if the url has an exchangePattern option configured

Parameters:

url - the url

Returns:

the exchange pattern, or null if the url has no exchangePattern configured.

Throws:

URISyntaxException - is thrown if uri is invalid

endpointProperties

public static Map<String,Object> endpointProperties(CamelContext camelContext,
                                                    String uri)
                                             throws Exception

Parses the endpoint uri and builds a map of documentation information for each option which is extracted from the component json documentation

Parameters:

camelContext - the Camel context

uri - the endpoint uri

Returns:

a map for each option in the uri with the corresponding information from the json

Throws:

Exception - is thrown in case of error