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.XmlElementRef;
023
024import org.apache.camel.Expression;
025import org.apache.camel.model.language.ExpressionDefinition;
026import org.apache.camel.spi.Metadata;
027
028/**
029 * Allows to declare options on sagas
030 *
031 */
032@Metadata(label = "eip,routing")
033@XmlAccessorType(XmlAccessType.FIELD)
034public class SagaOptionDefinition {
035
036    @XmlAttribute(required = true)
037    private String optionName;
038
039    @XmlElementRef
040    private ExpressionDefinition expression;
041
042
043    public SagaOptionDefinition() {
044    }
045
046    public SagaOptionDefinition(String optionName, Expression expression) {
047        setOptionName(optionName);
048        setExpression(ExpressionNodeHelper.toExpressionDefinition(expression));
049    }
050
051    @Override
052    public String toString() {
053        return "option:" + getOptionName() + "=" + getExpression();
054    }
055
056    /**
057     * Name of the option. It identifies the name of the header where the value of the expression will be stored when the
058     * compensation or completion routes will be called.
059     */
060    public void setOptionName(String optionName) {
061        this.optionName = optionName;
062    }
063
064    public String getOptionName() {
065        return optionName;
066    }
067
068    public ExpressionDefinition getExpression() {
069        return expression;
070    }
071
072    /**
073     * The expression to be used to determine the value of the option.
074     */
075    public void setExpression(ExpressionDefinition expression) {
076        this.expression = expression;
077    }
078}