001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Indicates that this method is to be used as a 
027 * <a href="http://camel.apache.org/dynamic-router.html">Dynamic Router</a> routing the incoming message
028 * through a series of processing steps.
029 *
030 * When a message {@link Exchange} is received from an {@link Endpoint} then the
031 * <a href="http://camel.apache.org/bean-integration.html">Bean Integration</a>
032 * mechanism is used to map the incoming {@link Message} to the method parameters.
033 *
034 * The return value of the method is then converted to either a {@link java.util.Collection} or array of objects where each
035 * element is converted to an {@link org.apache.camel.Endpoint} or a {@link String}, or if it is not a collection/array then it is converted
036 * to an {@link org.apache.camel.Endpoint} or {@link String}.
037 *
038 * Then for each endpoint or URI the message is routed in a pipes and filter fashion.
039 *
040 * @see org.apache.camel.RoutingSlip
041 * @version 
042 */
043@Retention(RetentionPolicy.RUNTIME)
044@Documented
045@Target({ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
046public @interface DynamicRouter {
047
048    /**
049     * Id of {@link CamelContext} to use
050     */
051    String context() default "";
052
053    /**
054     * Sets the uri delimiter to use
055     */
056    String delimiter() default ",";
057
058    /**
059     * Whether to ignore the invalidate endpoint exception when try to create a producer with that endpoint
060     */
061    boolean ignoreInvalidEndpoints() default false;
062}