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
23 import org.apache.directory.api.ldap.model.exception.LdapException;
24
25
26 /**
27 * Edits a supplied request adding specifics.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 */
31 public interface RequestBuilder<T>
32 {
33 /**
34 * Modifies the provided request adding specific information to it.
35 * The supplied request is typically a factory built request with just
36 * its Dn set. It is the responsibility of this method to fill in all
37 * of the details. The request will be sent to the LDAP server upon
38 * upon returning from this method.
39 *
40 * @param request The request to be modified
41 * @throws LdapException If something goes wrong
42 */
43 public void buildRequest( T request ) throws LdapException;
44 }