001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 * 
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 * 
019 */
020package org.apache.directory.ldap.client.api;
021
022
023/**
024 * An LdapConnection validator intended to be used by a GenericObjectPool to
025 * determine whether or not a conneciton is still <i>usable</i>.
026 * 
027 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028 */
029public interface LdapConnectionValidator
030{
031    /**
032     * Return true if the connection is still valid.  This means that if this
033     * connections is handed out to a user, it <i>should</i> allow for 
034     * successful communication with the server.
035     *
036     * @param ldapConnection The connection to test
037     * @return True, if the connection is still valid
038     */
039    boolean validate( LdapConnection ldapConnection );
040}