1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.ldap.client.api;
21
22
23 /**
24 * An LdapConnection validator intended to be used by a GenericObjectPool to
25 * determine whether or not a conneciton is still <i>usable</i>.
26 *
27 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
28 */
29 public interface LdapConnectionValidator
30 {
31 /**
32 * Return true if the connection is still valid. This means that if this
33 * connections is handed out to a user, it <i>should</i> allow for
34 * successful communication with the server.
35 *
36 * @param ldapConnection The connection to test
37 * @return True, if the connection is still valid
38 */
39 boolean validate( LdapConnection ldapConnection );
40 }