/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions Copyright 2014 ForgeRock AS
 */

package org.forgerock.opendj.ldap;

/**
 * A handler interface for accepting new connections from clients.
 * <p>
 * A connection listener implementation, such as {@link LDAPListener} or
 * {@link Connections#newInternalConnectionFactory newInternalConnectionFactory}
 * , invoke the method {@link #handleAccept(Object) handleAccept} whenever a new
 * client connection is accepted.
 *
 * @param <C>
 *            The type of client context.
 * @param <R>
 *            The type of request context.
 * @see LDAPListener
 * @see Connections#newInternalConnectionFactory(ServerConnectionFactory,
 *      Object) newInternalConnectionFactory
 */
public interface ServerConnectionFactory<C, R> {
    /**
     * Invoked when a new client connection is accepted by the associated
     * listener. Implementations should return a {@code ServerConnection} which
     * will be used to handle requests from the client connection.
     *
     * @param clientContext
     *            The protocol dependent context information associated with the
     *            client connection. Depending on the protocol this may contain
     *            information about the client such as their address and level
     *            connection security. It may also be used to manage the state
     *            of the client's connection.
     * @return A {@code ServerConnection} which will be used to handle requests
     *         from a client connection.
     * @throws LdapException
     *             If this server connection factory cannot accept the client
     *             connection.
     */
    ServerConnection<R> handleAccept(C clientContext) throws LdapException;
}
