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     */
017    package org.apache.camel;
018    
019    import java.lang.annotation.Documented;
020    import java.lang.annotation.ElementType;
021    import java.lang.annotation.Retention;
022    import java.lang.annotation.RetentionPolicy;
023    import java.lang.annotation.Target;
024    
025    /**
026     * Indicates that this method is to be used as a 
027     * <a href="http://camel.apache.org/recipient-list.html">Dynamic Recipient List</a> routing the incoming message
028     * to one or more endpoints.
029     *
030     * When a message {@link org.apache.camel.Exchange} is received from an {@link org.apache.camel.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 org.apache.camel.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 Endpoint} or a {@link String}, or if it is not a collection/array then it is converted
036     * to an {@link Endpoint} or {@link String}.
037     *
038     * Then for each endpoint or URI the message is forwarded a separate copy.
039     *
040     * @version 
041     */
042    @Retention(RetentionPolicy.RUNTIME)
043    @Documented
044    @Target({ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR })
045    public @interface RecipientList {
046        String context() default "";
047        String delimiter() default ",";
048        boolean parallelProcessing() default false;
049        boolean stopOnException() default false;
050        boolean streaming() default false;
051        boolean ignoreInvalidEndpoints() default false;
052        String strategyRef() default "";
053        String executorServiceRef() default "";
054        long timeout() default 0;
055        String onPrepareRef() default "";
056        @Deprecated
057        boolean shareUnitOfWork() default false;
058    }