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 java.io.File;
23
24 import org.apache.directory.api.ldap.model.schema.SchemaManager;
25 import org.apache.directory.server.core.api.DnFactory;
26 import org.apache.directory.server.core.api.partition.Partition;
27 import org.apache.directory.server.xdbm.Index;
28
29
30 /**
31 * A factory used to generate {@link Partition}s and their {@link Index}es.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public interface PartitionFactory
36 {
37
38 /**
39 * Creates a new Partition.
40 *
41 * @param schemaManager The SchemaManager instance
42 * @param dnFactory The DnFactory instance
43 * @param id the partition id
44 * @param suffix the suffix
45 * @param cacheSize the cache size
46 * @param workingDirectory the working directory
47 * @return the partition
48 * @throws Exception the exception
49 */
50 Partition createPartition( SchemaManager schemaManager, DnFactory dnFactory, String id, String suffix,
51 int cacheSize, File workingDirectory ) throws Exception;
52
53
54 /**
55 * Adds a partition-specific index to the partition.
56 *
57 * @param partition the partition
58 * @param attributeId the attribute id
59 * @param cacheSize the cache size
60 * @throws Exception the exception
61 */
62 void addIndex( Partition partition, String attributeId, int cacheSize ) throws Exception;
63
64 }