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.loadbalancer;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlElement;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.Expression;
025import org.apache.camel.model.ExpressionNodeHelper;
026import org.apache.camel.model.ExpressionSubElementDefinition;
027import org.apache.camel.model.LoadBalancerDefinition;
028import org.apache.camel.model.language.ExpressionDefinition;
029import org.apache.camel.spi.Metadata;
030
031/**
032 * Sticky load balancer Sticky load balancing using an Expression to calculate a
033 * correlation key to perform the sticky load balancing; rather like jsessionid
034 * in the web or JMSXGroupID in JMS.
035 */
036@Metadata(label = "eip,routing,loadbalance")
037@XmlRootElement(name = "sticky")
038@XmlAccessorType(XmlAccessType.FIELD)
039public class StickyLoadBalancerDefinition extends LoadBalancerDefinition {
040    @XmlElement(name = "correlationExpression", required = true)
041    private ExpressionSubElementDefinition correlationExpression;
042
043    public StickyLoadBalancerDefinition() {
044    }
045
046    public ExpressionSubElementDefinition getCorrelationExpression() {
047        return correlationExpression;
048    }
049
050    /**
051     * The correlation expression to use to calculate the correlation key
052     */
053    public void setCorrelationExpression(ExpressionSubElementDefinition correlationExpression) {
054        this.correlationExpression = correlationExpression;
055    }
056
057    public void setCorrelationExpression(Expression expression) {
058        ExpressionDefinition def = ExpressionNodeHelper.toExpressionDefinition(expression);
059        this.correlationExpression = new ExpressionSubElementDefinition();
060        this.correlationExpression.setExpressionType(def);
061    }
062
063    @Override
064    public String toString() {
065        return "StickyLoadBalancer[" + correlationExpression + "]";
066    }
067}