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