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.server.core.api.entry;
21
22
23 import org.apache.directory.api.ldap.model.entry.Entry;
24 import org.apache.directory.api.ldap.model.exception.LdapException;
25 import org.apache.directory.api.ldap.model.name.Dn;
26
27
28 /**
29 * A factory which produces ServerEntry objects.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public interface ServerEntryFactory
34 {
35 /*
36 * NOTE:
37 *
38 * May want to add more newEntry() overrides, some with variable arguments
39 * to create entries in one method call.
40 */
41
42 /**
43 * Creates a new ServerEntry which has not yet been added to the
44 * directory.
45 *
46 * @param dn The entry Dn
47 * @return The created entry
48 * @throws LdapException If the new entry cannot be created
49 */
50 Entry newEntry( Dn dn ) throws LdapException;
51 }