// SMSLib for Java v3
// A Java API library for sending and receiving SMS via a GSM modem
// or other supported gateways.
// Web Site: http://www.smslib.org
//
// Copyright (C) 2002-2009, Thanasis Delenikas, Athens/GREECE.
// SMSLib is distributed under the terms of the Apache License version 2.0
//
// Licensed 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 org.smslib.balancing;

import java.util.ArrayList;
import org.smslib.AGateway;
import org.smslib.OutboundMessage;
import org.smslib.Service;

/**
 * Load Balancing base class. Implements default trivial Load Balancing - just
 * picking first available Gateway to send message. Create subclasses to
 * implement custom functionality.
 * 
 * @author Tomek Cejner
 */
public class LoadBalancer
{
	protected Service service;

	public LoadBalancer(Service myService)
	{
		this.service = myService;
	}

	/**
	 * Core of Load Balancing. Default is trivial selection of first candidate.
	 * 
	 * @param msg
	 *            Message to be sent.
	 * @param candidates
	 *            List of candidate gateways to choose from
	 */
	public AGateway balance(OutboundMessage msg, ArrayList<AGateway> candidates)
	{
		return candidates.get(0);
	}
}