trunk/core-api/src/main/java/org/apache/directory/server/core/api/DnFactory.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.server.core.api;


import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
import org.apache.directory.api.ldap.model.name.Dn;


/**
 * A factory for DNs, with a cache.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface DnFactory
{

    /**
     * Creates a Dn from user provided RDNs.
     *
     * @param upRdns the user provided RDNs
     * @return the created Dn
     * @throws LdapInvalidDnException if one of the strings isn't a valid Rdn
     */
    Dn create( String... upRdns ) throws LdapInvalidDnException;


    /**
     * Creates a Dn form a user provided Dn.
     *
     * @param upDn the user provided Dn
     * @return the created Dn
     * @throws LdapInvalidDnException if the string isn't a valid Dn
     */
    Dn create( String upDn ) throws LdapInvalidDnException;

}