All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.camel.support.EndpointHelper Maven / Gradle / Ivy

There is a newer version: 4.8.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.support;

import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicLong;

import org.apache.camel.CamelContext;
import org.apache.camel.DelegateEndpoint;
import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.ExchangePattern;
import org.apache.camel.ExtendedCamelContext;
import org.apache.camel.PollingConsumer;
import org.apache.camel.Processor;
import org.apache.camel.ResolveEndpointFailedException;
import org.apache.camel.Route;
import org.apache.camel.support.service.ServiceHelper;
import org.apache.camel.util.StringHelper;
import org.apache.camel.util.URISupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.apache.camel.util.StringHelper.after;

/**
 * Some helper methods for working with {@link Endpoint} instances
 */
public final class EndpointHelper {

    private static final Logger LOG = LoggerFactory.getLogger(EndpointHelper.class);
    private static final AtomicLong ENDPOINT_COUNTER = new AtomicLong(0);

    private EndpointHelper() {
        //Utility Class
    }

    /**
     * Creates a {@link PollingConsumer} and polls all pending messages on the endpoint
     * and invokes the given {@link Processor} to process each {@link Exchange} and then closes
     * down the consumer and throws any exceptions thrown.
     */
    public static void pollEndpoint(Endpoint endpoint, Processor processor, long timeout) throws Exception {
        PollingConsumer consumer = endpoint.createPollingConsumer();
        try {
            ServiceHelper.startService(consumer);

            while (true) {
                Exchange exchange = consumer.receive(timeout);
                if (exchange == null) {
                    break;
                } else {
                    processor.process(exchange);
                }
            }
        } finally {
            try {
                ServiceHelper.stopAndShutdownService(consumer);
            } catch (Exception e) {
                LOG.warn("Failed to stop PollingConsumer: " + consumer + ". This example is ignored.", e);
            }
        }
    }

    /**
     * Creates a {@link PollingConsumer} and polls all pending messages on the
     * endpoint and invokes the given {@link Processor} to process each
     * {@link Exchange} and then closes down the consumer and throws any
     * exceptions thrown.
     */
    public static void pollEndpoint(Endpoint endpoint, Processor processor) throws Exception {
        pollEndpoint(endpoint, processor, 1000L);
    }

    /**
     * Matches the endpoint with the given pattern.
     * 

* The endpoint will first resolve property placeholders using {@link 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
  • *
* * @param context the Camel context, if null then property placeholder resolution is skipped. * @param uri the endpoint uri * @param pattern a pattern to match * @return true if match, false otherwise. */ public static boolean matchEndpoint(CamelContext context, String uri, String pattern) { if (context != null) { try { uri = context.resolvePropertyPlaceholders(uri); } catch (Exception e) { throw new ResolveEndpointFailedException(uri, e); } } // normalize uri so we can do endpoint hits with minor mistakes and parameters is not in the same order try { uri = URISupport.normalizeUri(uri); } catch (Exception e) { throw new ResolveEndpointFailedException(uri, e); } // we need to test with and without scheme separators (//) if (uri.contains("://")) { // try without :// also String scheme = StringHelper.before(uri, "://"); String path = after(uri, "://"); if (PatternHelper.matchPattern(scheme + ":" + path, pattern)) { return true; } } else { // try with :// also String scheme = StringHelper.before(uri, ":"); String path = after(uri, ":"); if (PatternHelper.matchPattern(scheme + "://" + path, pattern)) { return true; } } // and fallback to test with the uri as is return PatternHelper.matchPattern(uri, pattern); } /** * Sets the regular properties on the given bean * * @param context the camel context * @param bean the bean * @param parameters parameters * @throws Exception is thrown if setting property fails * @deprecated use PropertyBindingSupport */ @Deprecated public static void setProperties(CamelContext context, Object bean, Map parameters) throws Exception { // use the property binding which can do more advanced configuration PropertyBindingSupport.build().bind(context, bean, parameters); } /** * Sets the reference properties on the given bean *

* This is convention over configuration, setting all reference parameters (using {@link #isReferenceParameter(String)} * by looking it up in registry and setting it on the bean if possible. * * @param context the camel context * @param bean the bean * @param parameters parameters * @throws Exception is thrown if setting property fails * @deprecated use PropertyBindingSupport */ @Deprecated public static void setReferenceProperties(CamelContext context, Object bean, Map parameters) throws Exception { Iterator> it = parameters.entrySet().iterator(); while (it.hasNext()) { Map.Entry entry = it.next(); String name = entry.getKey(); Object v = entry.getValue(); String value = v != null ? v.toString() : null; if (isReferenceParameter(value)) { boolean hit = context.adapt(ExtendedCamelContext.class).getBeanIntrospection().setProperty(context, context.getTypeConverter(), bean, name, null, value, true, false, false); if (hit) { // must remove as its a valid option and we could configure it it.remove(); } } } } /** * Is the given parameter a reference parameter (starting with a # char) * * @param parameter the parameter * @return true if its a reference parameter */ public static boolean isReferenceParameter(String parameter) { return parameter != null && parameter.trim().startsWith("#"); } /** * Resolves a reference parameter by making a lookup in the registry. * * @param type of object to lookup. * @param context Camel context to use for lookup. * @param value reference parameter value. * @param type type of object to lookup. * @return lookup result. * @throws IllegalArgumentException if referenced object was not found in registry. */ public static T resolveReferenceParameter(CamelContext context, String value, Class type) { return resolveReferenceParameter(context, value, type, true); } /** * Resolves a reference parameter by making a lookup in the registry. * * @param type of object to lookup. * @param context Camel context to use for lookup. * @param value reference parameter value. * @param type type of object to lookup. * @return lookup result (or null only if * mandatory is false). * @throws IllegalArgumentException if object was not found in registry and * mandatory is true. */ public static T resolveReferenceParameter(CamelContext context, String value, Class type, boolean mandatory) { String valueNoHash = StringHelper.replaceAll(value, "#", ""); if (mandatory) { return CamelContextHelper.mandatoryLookupAndConvert(context, valueNoHash, type); } else { return CamelContextHelper.lookupAndConvert(context, valueNoHash, type); } } /** * 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
  • *
* * @param context Camel context to use for lookup. * @param value reference parameter value. * @param elementType result list element type. * @return list of lookup results, will always return a list. * @throws IllegalArgumentException if any referenced object was not found in registry. */ @SuppressWarnings({"unchecked", "rawtypes"}) public static List resolveReferenceListParameter(CamelContext context, String value, Class elementType) { if (value == null) { return new ArrayList<>(); } List elements = Arrays.asList(value.split(",")); if (elements.size() == 1) { Object bean = resolveReferenceParameter(context, elements.get(0).trim(), Object.class); if (bean instanceof List) { // The bean is a list return (List) bean; } else { // The bean is a list element List singleElementList = new ArrayList<>(); singleElementList.add(elementType.cast(bean)); return singleElementList; } } else { // more than one list element List result = new ArrayList<>(elements.size()); for (String element : elements) { result.add(resolveReferenceParameter(context, element.trim(), elementType)); } return result; } } /** * Resolves a parameter, by doing a reference lookup if the parameter is a reference, and converting * the parameter to the given type. * * @param type of object to convert the parameter value as. * @param context Camel context to use for lookup. * @param value parameter or reference parameter value. * @param type type of object to lookup. * @return 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. */ public static T resolveParameter(CamelContext context, String value, Class type) { T result; if (EndpointHelper.isReferenceParameter(value)) { result = EndpointHelper.resolveReferenceParameter(context, value, type); } else { result = context.getTypeConverter().convertTo(type, value); } return result; } /** * Gets the route id for the given endpoint in which there is a consumer listening. * * @param endpoint the endpoint * @return the route id, or null if none found */ public static String getRouteIdFromEndpoint(Endpoint endpoint) { if (endpoint == null || endpoint.getCamelContext() == null) { return null; } List routes = endpoint.getCamelContext().getRoutes(); for (Route route : routes) { if (route.getEndpoint().equals(endpoint) || route.getEndpoint().getEndpointKey().equals(endpoint.getEndpointKey())) { return route.getId(); } } return null; } /** * A helper method for Endpoint implementations to create new Ids for Endpoints which also implement * {@link org.apache.camel.spi.HasId} */ public static String createEndpointId() { return "endpoint" + ENDPOINT_COUNTER.incrementAndGet(); } /** * Lookup the id the given endpoint has been enlisted with in the {@link org.apache.camel.spi.Registry}. * * @param endpoint the endpoint * @return the endpoint id, or null if not found */ public static String lookupEndpointRegistryId(Endpoint endpoint) { if (endpoint == null || endpoint.getCamelContext() == null) { return null; } // it may be a delegate endpoint, which we need to match as well Endpoint delegate = null; if (endpoint instanceof DelegateEndpoint) { delegate = ((DelegateEndpoint) endpoint).getEndpoint(); } Map map = endpoint.getCamelContext().getRegistry().findByTypeWithName(Endpoint.class); for (Map.Entry entry : map.entrySet()) { if (entry.getValue().equals(endpoint) || entry.getValue().equals(delegate)) { return entry.getKey(); } } // not found return null; } /** * Attempts to resolve if the url has an exchangePattern option configured * * @param url the url * @return the exchange pattern, or null if the url has no exchangePattern configured. * @throws URISyntaxException is thrown if uri is invalid */ public static ExchangePattern resolveExchangePatternFromUrl(String url) throws URISyntaxException { int idx = url.indexOf("?"); if (idx > 0) { url = url.substring(idx + 1); } Map parameters = URISupport.parseQuery(url, true); String pattern = (String) parameters.get("exchangePattern"); if (pattern != null) { return ExchangePattern.asEnum(pattern); } return null; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy