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.model;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.Expression;
025import org.apache.camel.Processor;
026import org.apache.camel.builder.ExpressionBuilder;
027import org.apache.camel.model.language.ExpressionDefinition;
028import org.apache.camel.processor.SetHeaderProcessor;
029import org.apache.camel.spi.Metadata;
030import org.apache.camel.spi.RouteContext;
031import org.apache.camel.util.ObjectHelper;
032
033/**
034 * Sets the value of a message header
035 */
036@Metadata(label = "eip,transformation")
037@XmlRootElement(name = "setHeader")
038@XmlAccessorType(XmlAccessType.FIELD)
039public class SetHeaderDefinition extends NoOutputExpressionNode {
040    @XmlAttribute(required = true)
041    private String headerName;
042
043    public SetHeaderDefinition() {
044    }
045
046    public SetHeaderDefinition(String headerName, ExpressionDefinition expression) {
047        super(expression);
048        setHeaderName(headerName);
049    }
050
051    public SetHeaderDefinition(String headerName, Expression expression) {
052        super(expression);
053        setHeaderName(headerName);
054    }
055
056    public SetHeaderDefinition(String headerName, String value) {
057        super(ExpressionBuilder.constantExpression(value));
058        setHeaderName(headerName);
059    }
060
061    @Override
062    public String toString() {
063        return "SetHeader[" + getHeaderName() + ", " + getExpression() + "]";
064    }
065
066    @Override
067    public String getShortName() {
068        return "setHeader";
069    }
070
071    @Override
072    public String getLabel() {
073        return "setHeader[" + getHeaderName() + "]";
074    }
075
076    @Override
077    public Processor createProcessor(RouteContext routeContext) throws Exception {
078        ObjectHelper.notNull(headerName, "headerName");
079        Expression expr = getExpression().createExpression(routeContext);
080        Expression nameExpr = ExpressionBuilder.parseSimpleOrFallbackToConstantExpression(getHeaderName(), routeContext.getCamelContext());
081        return new SetHeaderProcessor(nameExpr, expr);
082    }
083
084    /**
085     * Expression to return the value of the header
086     */
087    @Override
088    public void setExpression(ExpressionDefinition expression) {
089        // override to include javadoc what the expression is used for
090        super.setExpression(expression);
091    }
092
093    /**
094     * Name of message header to set a new value
095     * <p/>
096     * The <tt>simple</tt> language can be used to define a dynamic evaluated header name to be used.
097     * Otherwise a constant name will be used.
098     */
099    public void setHeaderName(String headerName) {
100        this.headerName = headerName;
101    }
102
103    public String getHeaderName() {
104        return headerName;
105    }
106
107}