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
022
023import org.apache.directory.api.ldap.model.exception.LdapException;
024
025
026/**
027 * Edits a supplied request adding specifics.
028 * 
029 * @param <T> The request type
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface RequestBuilder<T>
034{
035    /**
036     * Modifies the provided request adding specific information to it.
037     * The supplied request is typically a factory built request with just
038     * its Dn set.  It is the responsibility of this method to fill in all
039     * of the details.  The request will be sent to the LDAP server upon
040     * upon returning from this method.
041     *
042     * @param request The request to be modified
043     * @throws LdapException If something goes wrong
044     */
045    void buildRequest( T request ) throws LdapException;
046}