api/src/main/java/com/datatorrent/api/AffinityRule.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.datatorrent.api;

import java.io.Serializable;
import java.util.LinkedList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.datatorrent.api.DAG.Locality;

/**
 * Affinity rule specifies constraints for physical deployment of operator
 * containers. There are two types of rules that can be specified: Affinity and
 * Anti-affinity. Each rule contains list of operators or pair of 2 operators or
 * a regex that should match at least 2 operators. Based on the type of rule,
 * affinity or anti-affinity, the operators will be deployed together or away
 * from each other. The locality indicates the level at which the rule should be
 * applied. E.g. CONTAINER_LOCAL affinity would indicate operators Should be
 * allocated within same container NODE_LOCAL anti-affinity indicates that the
 * operators should not be allocated on the same node. The rule can be either
 * strict or relaxed.
 *
 *
 * @since 3.4.0
 */
public class AffinityRule implements Serializable
{
  Logger LOG = LoggerFactory.getLogger(AffinityRule.class);

  @Override
  public String toString()
  {
    return "AffinityRule {operatorsList=" + operatorsList + ", operatorRegex=" + operatorRegex + ", locality=" + locality + ", type=" + type + ", relaxLocality=" + relaxLocality + "}";
  }

  private static final long serialVersionUID = 107131504929875386L;

  /**
   * Type of affinity rule setting affects how operators are scheduled for
   * deployment by the platform.
   */
  public static enum Type
  {
    /**
     * AFFINITY indicates that operators in the rule should be deployed within
     * locality specified in the rule
     */
    AFFINITY,
    /**
     * ANTI_AFFINITY indicates that operators in the rule should NOT deployed
     * within same locality as specified in rule
     */
    ANTI_AFFINITY
  }

  private List<String> operatorsList;
  private String operatorRegex;
  private Locality locality;
  private Type type;
  private boolean relaxLocality;

  public AffinityRule()
  {
  }

  public AffinityRule(Type type, Locality locality, boolean relaxLocality)
  {
    this.type = type;
    this.locality = locality;
    this.setRelaxLocality(relaxLocality);
  }

  public AffinityRule(Type type, Locality locality, boolean relaxLocality, String firstOperator, String... otherOperators)
  {
    this(type, locality, relaxLocality);
    LinkedList<String> operators = new LinkedList<String>();
    if (firstOperator != null && otherOperators.length >= 1) {
      operators.add(firstOperator);

      for (String operator : otherOperators) {
        operators.add(operator);
      }
      this.setOperatorsList(operators);
    } else {
      LOG.warn("Affinity rule should specify at least two operators to be applied");
    }
  }

  public AffinityRule(Type type, List<String> operatorsList, Locality locality, boolean relaxLocality)
  {
    this(type, locality, relaxLocality);
    this.operatorsList = operatorsList;
  }

  public AffinityRule(Type type, String operatorRegex, Locality locality, boolean relaxLocality)
  {
    this(type, locality, relaxLocality);
    this.operatorRegex = operatorRegex;
  }

  public Locality getLocality()
  {
    return locality;
  }

  public void setLocality(Locality locality)
  {
    this.locality = locality;
  }

  public Type getType()
  {
    return type;
  }

  public void setType(Type type)
  {
    this.type = type;
  }

  public boolean isRelaxLocality()
  {
    return relaxLocality;
  }

  public void setRelaxLocality(boolean relaxLocality)
  {
    this.relaxLocality = relaxLocality;
  }

  public List<String> getOperatorsList()
  {
    return operatorsList;
  }

  public void setOperatorsList(List<String> operatorsList)
  {
    this.operatorsList = operatorsList;
  }

  public String getOperatorRegex()
  {
    return operatorRegex;
  }

  public void setOperatorRegex(String operatorRegex)
  {
    this.operatorRegex = operatorRegex;
  }

}