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