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    package org.apache.directory.server.core.factory;
020    
021    
022    import org.apache.directory.server.core.DirectoryService;
023    
024    
025    /**
026     * A factory used to generate differently configured DirectoryService objects.
027     * Since the DirectoryService itself is what is configured then a factory for
028     * these objects acts as a configurator.  Tests can provide different factory
029     * methods to be used.
030     *
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev$, $Date$
033     */
034    public interface DirectoryServiceFactory
035    {
036    
037        /**
038         * Inits the directory service factory.
039         * 
040         * @param name the name
041         */
042        void init( String name ) throws Exception;
043    
044    
045        /**
046         * Gets the directory service.
047         * 
048         * @return the directory service
049         */
050        DirectoryService getDirectoryService() throws Exception;
051    
052    
053        /**
054         * Gets the partition factory.
055         * 
056         * @return the partition factory
057         */
058        PartitionFactory getPartitionFactory() throws Exception;
059    }