001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2010 Sun Microsystems, Inc.
025 *      Portions Copyright 2013-2014 ForgeRock AS.
026 */
027
028package org.forgerock.opendj.ldap;
029
030import java.io.Closeable;
031
032/**
033 * A load balancing algorithm distributes connection requests across one or more
034 * underlying connection factories in an implementation defined manner.
035 *
036 * @see Connections#newLoadBalancer(LoadBalancingAlgorithm) newLoadBalancer
037 */
038public interface LoadBalancingAlgorithm extends Closeable {
039
040    /**
041     * Releases any resources associated with this algorithm, including any
042     * associated connection factories.
043     */
044    @Override
045    void close();
046
047    /**
048     * Returns a connection factory which should be used in order to satisfy the
049     * next connection request.
050     *
051     * @return The connection factory.
052     * @throws LdapException
053     *             If no connection factories are available for use.
054     */
055    ConnectionFactory getConnectionFactory() throws LdapException;
056}