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