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.entry;
021
022
023import org.apache.directory.api.ldap.model.entry.Entry;
024import org.apache.directory.api.ldap.model.exception.LdapException;
025import org.apache.directory.api.ldap.model.name.Dn;
026
027
028/**
029 * A factory which produces ServerEntry objects.
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface ServerEntryFactory
034{
035    /*
036     * NOTE: 
037     * 
038     * May want to add more newEntry() overrides, some with variable arguments 
039     * to create entries in one method call.
040     */
041
042    /**
043     * Creates a new ServerEntry which has not yet been added to the 
044     * directory.
045     * 
046     * @param dn The entry Dn
047     * @return The created entry
048     * @throws LdapException If the new entry cannot be created
049     */
050    Entry newEntry( Dn dn ) throws LdapException;
051}