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.language;
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
025import org.apache.camel.component.bean.XPathAnnotationExpressionFactory;
026
027/**
028 * Used to inject an XPath expression into a field, property, method or parameter when using
029 * <a href="http://camel.apache.org/bean-integration.html">Bean Integration</a>.
030 *
031 * @version 
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Documented
035@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
036@LanguageAnnotation(language = "xpath", factory = XPathAnnotationExpressionFactory.class)
037public @interface XPath {
038    /**
039     * @return The XPath which will be applied
040     */
041    String value();
042
043    NamespacePrefix[] namespaces() default {
044    @NamespacePrefix(prefix = "soap", uri = "http://www.w3.org/2003/05/soap-envelope"),
045    @NamespacePrefix(prefix = "xsd", uri = "http://www.w3.org/2001/XMLSchema")};
046    
047    Class<?> resultType() default Object.class;
048    
049    /**
050     * @return The name of the header we want to apply the XPath expression to.
051     *  If this is empty then the XPath expression will be applied to the body instead.
052     */
053    String headerName() default "";
054}