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;
21
22
23 import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
24 import org.apache.directory.api.ldap.model.name.Dn;
25
26
27 /**
28 * A factory for DNs, with a cache.
29 *
30 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31 */
32 public interface DnFactory
33 {
34
35 /**
36 * Creates a Dn from user provided RDNs.
37 *
38 * @param upRdns the user provided RDNs
39 * @return the created Dn
40 * @throws LdapInvalidDnException if one of the strings isn't a valid Rdn
41 */
42 Dn create( String... upRdns ) throws LdapInvalidDnException;
43
44
45 /**
46 * Creates a Dn form a user provided Dn.
47 *
48 * @param upDn the user provided Dn
49 * @return the created Dn
50 * @throws LdapInvalidDnException if the string isn't a valid Dn
51 */
52 Dn create( String upDn ) throws LdapInvalidDnException;
53
54 }