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
21 package org.apache.directory.api.ldap.model.message;
22
23
24 import org.apache.directory.api.ldap.model.entry.Entry;
25 import org.apache.directory.api.ldap.model.name.Dn;
26
27
28 /**
29 * Add protocol operation request used to add a new entry to the DIT.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public interface AddRequest extends SingleReplyRequest, AbandonableRequest
34 {
35 /**
36 * Gets the distinguished name of the entry to add.
37 *
38 * @return the Dn of the added entry.
39 */
40 Dn getEntryDn();
41
42
43 /**
44 * Sets the distinguished name of the entry to add.
45 *
46 * @param entry the Dn of the added entry.
47 * @return The AddRequest instance
48 */
49 AddRequest setEntryDn( Dn entry );
50
51
52 /**
53 * Gets the entry to add.
54 *
55 * @return the added Entry
56 */
57 Entry getEntry();
58
59
60 /**
61 * Sets the Entry to add.
62 *
63 * @param entry the added Entry
64 * @return The AddRequest instance
65 */
66 AddRequest setEntry( Entry entry );
67
68
69 /**
70 * {@inheritDoc}
71 */
72 AddRequest setMessageId( int messageId );
73
74
75 /**
76 * {@inheritDoc}
77 */
78 AddRequest addControl( Control control );
79
80
81 /**
82 * {@inheritDoc}
83 */
84 AddRequest addAllControls( Control[] controls );
85
86
87 /**
88 * {@inheritDoc}
89 */
90 AddRequest removeControl( Control control );
91 }