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.server.core.api;
021
022
023import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
024import org.apache.directory.api.ldap.model.name.Dn;
025
026
027/**
028 * A factory for DNs, with a cache.
029 *
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public interface DnFactory
033{
034
035    /**
036     * Creates a Dn from user provided RDNs.
037     *
038     * @param upRdns the user provided RDNs
039     * @return the created Dn
040     * @throws LdapInvalidDnException if one of the strings isn't a valid Rdn
041     */
042    Dn create( String... upRdns ) throws LdapInvalidDnException;
043
044
045    /**
046     * Creates a Dn form a user provided Dn.
047     *
048     * @param upDn the user provided Dn
049     * @return the created Dn
050     * @throws LdapInvalidDnException if the string isn't a valid Dn
051     */
052    Dn create( String upDn ) throws LdapInvalidDnException;
053
054}