001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2011-2014 ForgeRock AS. 015 */ 016 017package org.forgerock.opendj.ldap; 018 019/** 020 * A handler interface for accepting new connections from clients. 021 * 022 * @param <C> 023 * The type of client context. 024 * @param <R> 025 * The type of request context. 026 */ 027public interface RequestHandlerFactory<C, R extends RequestContext> { 028 /** 029 * Invoked when a new client connection is accepted by the associated 030 * listener. Implementations should return a {@code RequestHandler} which 031 * will be used to handle requests from the client connection. 032 * 033 * @param clientContext 034 * The protocol dependent context information associated with the 035 * client connection. Depending on the protocol this may contain 036 * information about the client such as their address and level 037 * connection security. It may also be used to manage the state 038 * of the client's connection. 039 * @return A {@code RequestHandler} which will be used to handle requests 040 * from a client connection. 041 * @throws LdapException 042 * If this request handler factory cannot accept the client 043 * connection. 044 */ 045 RequestHandler<R> handleAccept(C clientContext) throws LdapException; 046}