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.Processor;
025import org.apache.camel.processor.RemoveHeaderProcessor;
026import org.apache.camel.spi.Metadata;
027import org.apache.camel.spi.RouteContext;
028import org.apache.camel.util.ObjectHelper;
029
030/**
031 * Removes a named header from the message
032 */
033@Metadata(label = "eip,transformation")
034@XmlRootElement(name = "removeHeader")
035@XmlAccessorType(XmlAccessType.FIELD)
036public class RemoveHeaderDefinition extends NoOutputDefinition<RemoveHeaderDefinition> {
037    @XmlAttribute(required = true)
038    private String headerName;   
039    
040    public RemoveHeaderDefinition() {
041    }
042    
043    public RemoveHeaderDefinition(String headerName) {
044        setHeaderName(headerName);
045    }
046    
047    @Override
048    public String toString() {
049        return "RemoveHeader[" + getHeaderName() + "]";
050    }
051
052    @Override
053    public String getLabel() {
054        return "removeHeader[" + getHeaderName() + "]";
055    }
056
057    @Override
058    public Processor createProcessor(RouteContext routeContext) throws Exception {
059        ObjectHelper.notNull(getHeaderName(), "headerName", this);
060        return new RemoveHeaderProcessor(getHeaderName());
061    }
062
063    /**
064     * Name of header to remove
065     */
066    public void setHeaderName(String headerName) {
067        this.headerName = headerName;
068    }
069
070    public String getHeaderName() {
071        return headerName;
072    }
073}