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.template;
021
022import org.apache.directory.api.ldap.model.exception.LdapException;
023import org.apache.directory.ldap.client.api.LdapConnection;
024
025/**
026 * A callback for running code against a managed {@link LdapConnection}.
027 * 
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public interface ConnectionCallback<T>
031{
032    /**
033     * Provides a managed connection to the implementation of this method.
034     * The implementation is not responsible for open/close or borrow/return.
035     *
036     * @param connection The connection supplied to the implementation.
037     * @return Anything you want
038     * @throws LdapException If you want to
039     */
040    public T doWithConnection( LdapConnection connection ) throws LdapException;
041}