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.template;
21
22 import org.apache.directory.api.ldap.model.exception.LdapException;
23 import org.apache.directory.ldap.client.api.LdapConnection;
24
25 /**
26 * A callback for running code against a managed {@link LdapConnection}.
27 *
28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29 */
30 public interface ConnectionCallback<T>
31 {
32 /**
33 * Provides a managed connection to the implementation of this method.
34 * The implementation is not responsible for open/close or borrow/return.
35 *
36 * @param connection The connection supplied to the implementation.
37 * @return Anything you want
38 * @throws LdapException If you want to
39 */
40 public T doWithConnection( LdapConnection connection ) throws LdapException;
41 }