com.caucho.cloud.loadbalance.LoadBalanceBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.cloud.loadbalance;

import java.util.*;

import com.caucho.cloud.topology.CloudPod;
import com.caucho.config.*;
import com.caucho.network.balance.ClientSocketFactory;
import com.caucho.server.cluster.ServletService;
import com.caucho.util.L10N;

/**
 * LoadBalanceService distributes requests across a group of clients.
 */
public class LoadBalanceBuilder
{
  private static final L10N L = new L10N(LoadBalanceBuilder.class);
  
  private LoadBalanceStrategy _strategy = LoadBalanceStrategy.ADAPTIVE;
  private String _meterCategory = null;
  
  private LoadBalanceBackend _defaults = new LoadBalanceBackend();
  
  private ArrayList _clientList 
    = new ArrayList();
  
  /**
   * Sets the load balance strategy.
   */
  public void setStrategy(LoadBalanceStrategy strategy)
  {
    if (strategy == null)
      throw new NullPointerException();
    
    _strategy = strategy;
  }

  /**
   * The load balance strategy.
   */
  public LoadBalanceStrategy getStrategy()
  {
    return _strategy;
  }
  
  /**
   * The request-sticky generator
   */
  public void setStickyRequestHashGenerator(StickyRequestHashGenerator gen)
  {
    
  }
  
  public void setTargetCluster(String clusterId)
  {
    throw new IllegalStateException(L.l("{0}: setCluster requires Resin Professional.",
                                        this));
  }

  public void setTargetCluster(CloudPod pod)
  {
    throw new IllegalStateException(L.l("{0}: setCluster requires Resin Professional.",
                                        this));
  }
  
  public void setTargetPort(int port)
  {
    throw new IllegalStateException(L.l("{0}: setPort requires Resin Professional.",
                                        this));
  }
  
  public void setConnectTimeout(long connectTimeout)
  {
    _defaults.setConnectTimeoutMs(connectTimeout);
  }
  
  public void setConnectionMin(int connectionMin)
  {
    _defaults.setConnectionMin(connectionMin);
  }

  public void setSocketTimeout(long socketTimeout)
  {
    _defaults.setSocketTimeoutMs(socketTimeout);
  }

  public void setIdleTime(long idleTime)
  {
    _defaults.setIdleTimeMs(idleTime);
  }

  public void setRecoverTime(long recoverTime)
  {
    _defaults.setRecoverTimeMs(recoverTime);
  }
  
  public void setWarmupTime(long warmupTime)
  {
    _defaults.setWarmupTimeMs(warmupTime);
  }
  
  public void setSSL(boolean isSSL)
  {
    _defaults.setSSL(isSSL);
  }
  
  public LoadBalanceBackend getDefaults()
  {
    return _defaults;
  }
  
  /**
   * The statistics meter category.
   */
  public void setMeterCategory(String category)
  {
    _meterCategory = category;
  }
  
  /**
   * The statistics meter category.
   */
  public String getMeterCategory()
  {
    return _meterCategory;
  }
  
  public void addAddress(String address)
  {
    addBackend(new LoadBalanceBackend(address));
  }
  
  public void addBackend(LoadBalanceBackend backend)
  {
    addClient(createClientSocketFactory(backend));
  }
  
  /**
   * Adds a client pool factory.
   */
  public void addClient(ClientSocketFactory client)
  {
    client.init();
    client.start();
    
    _clientList.add(client);
  }
  
  public ArrayList getClientList()
  {
    return _clientList;
  }
  
  /**
   * Returns the load balance manager.
   */
  public LoadBalanceManager create()
  {
    ClientSocketFactory socketFactory = null;
    if (getClientList().size() > 0)
      socketFactory = getClientList().get(0);

    return new SingleLoadBalanceManager(socketFactory, getMeterCategory());
  }
  
  protected ClientSocketFactory createClientSocketFactory(String address,
                                                          boolean isSecure)
  {
    int p = address.lastIndexOf(':');
    int q = address.lastIndexOf(']');

    if (p < 0 && q <= p)
      throw new ConfigException(L.l("'{0}' is an invalid address because it does not specify the port.",
                                    address));

    String host = address.substring(0, p);
    int port = Integer.parseInt(address.substring(p + 1));

    ServletService server = ServletService.getCurrent();

    ClientSocketFactory factory
      = new ClientSocketFactory(server.getServerId(),
                                address,
                                getMeterCategory(),
                                address,
                                host,
                                port,
                                isSecure);
    
    applyDefaults(factory);
    
    return factory;
  }
  
  protected ClientSocketFactory createClientSocketFactory(LoadBalanceBackend backend)
  {
    ClientSocketFactory factory = createClientSocketFactory(backend.getAddress(),
                                                            _defaults.isSSL());
    applyBackendConfig(factory, backend);
    
    return factory;
  }
  
  protected void applyDefaults(ClientSocketFactory factory)
  {
    applyBackendConfig(factory, _defaults);
  }
  
  protected void applyBackendConfig(ClientSocketFactory factory, LoadBalanceBackend backend)
  {
    if (backend.hasConnectionMin())
      factory.setLoadBalanceConnectionMin(backend.getConnectionMin());
    
    if (backend.hasConnectTimeout())
      factory.setLoadBalanceConnectTimeout(backend.getConnectTimeout());
    
    if (backend.hasIdleTime())
      factory.setLoadBalanceIdleTime(backend.getIdleTime());
    
    if (backend.hasRecoverTime())
      factory.setLoadBalanceRecoverTime(backend.getRecoverTime());
    
    if (backend.hasBusyRecoverTime())
      factory.setLoadBalanceBusyRecoverTime(backend.getBusyRecoverTime());
    
    if (backend.hasSocketTimeout())
      factory.setLoadBalanceSocketTimeout(backend.getSocketTimeout());
    
    if (backend.hasWarmupTime())
      factory.setLoadBalanceWarmupTime(backend.getWarmupTime());
    
    if (backend.hasWeight())
      factory.setLoadBalanceWeight(backend.getWeight());
  }

  @Override
  public String toString()
  {
    return getClass().getSimpleName() + "[]";
  }
}