java-design-patterns/throttling/src/main/java/com/iluwatar/tls/Tenant.java

/**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.iluwatar.tls;

import java.security.InvalidParameterException;

/**
 * A Pojo class to create a basic Tenant with the allowed calls per second.
 */
public class Tenant {

  private String name;
  private int allowedCallsPerSecond;

  /**
   *
   * @param name Name of the tenant
   * @param allowedCallsPerSecond The number of calls allowed for a particular tenant.
   * @throws InvalidParameterException If number of calls is less than 0, throws exception.
   */
  public Tenant(String name, int allowedCallsPerSecond) {
    if (allowedCallsPerSecond < 0) {
      throw new InvalidParameterException("Number of calls less than 0 not allowed");
    }
    this.name = name;
    this.allowedCallsPerSecond = allowedCallsPerSecond;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public int getAllowedCallsPerSecond() {
    return allowedCallsPerSecond;
  }

  public void setAllowedCallsPerSecond(int allowedCallsPerSecond) {
    this.allowedCallsPerSecond = allowedCallsPerSecond;
  }
}