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 * Subscribes a method to an {@link Endpoint} either via its
027 * <a href="http://camel.apache.org/uris.html">URI</a> or via the name of the endpoint reference
028 * which is then resolved in a registry such as the Spring Application Context.
029 * <p/>
030 * When a message {@link Exchange} is received from the {@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 * @version 
035 */
036@Retention(RetentionPolicy.RUNTIME)
037@Documented
038@Target({ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR })
039public @interface Consume {
040
041    /**
042     * The uri to consume from
043     */
044    String uri() default "";
045
046    /**
047     * Reference to endpoint to consume from
048     */
049    String ref() default "";
050
051    /**
052     * Use the field or getter on the bean to provide the uri to consume from
053     */
054    String property() default "";
055
056    /**
057     * Id of {@link CamelContext} to use
058     */
059    String context() default "";
060
061    /**
062     * Optional predicate (using simple language) to only consume if the predicate matches .
063     * This can be used to filter messages.
064     * <p/>
065     * Notice that only the first method that matches the predicate will be used.
066     * And if no predicate matches then the message is dropped.
067     */
068    String predicate() default "";
069}