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 package org.apache.directory.server.core.factory;
20
21
22 import org.apache.commons.collections.Factory;
23 import org.apache.directory.server.core.api.DirectoryService;
24
25
26 /**
27 * A factory used to generate differently configured DirectoryService objects.
28 * Since the DirectoryService itself is what is configured then a factory for
29 * these objects acts as a configurator. Tests can provide different factory
30 * methods to be used.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public interface DirectoryServiceFactory
35 {
36
37 /**
38 * Inits the directory service factory.
39 *
40 * @param name the name
41 * @throws Exception If the DirectoryService initialization failed
42 */
43 void init( String name ) throws Exception;
44
45
46 /**
47 * Gets the directory service.
48 *
49 * @return the directory service
50 * @throws Exception If the DirectoryService cannot be returned
51 */
52 DirectoryService getDirectoryService() throws Exception;
53
54
55 /**
56 * Gets the partition factory.
57 *
58 * @return the partition {@link Factory}
59 * @throws Exception If the partition cannot be created
60 */
61 PartitionFactory getPartitionFactory() throws Exception;
62 }