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 */
20 package org.apache.directory.server.xdbm;
21
22
23 import org.apache.directory.api.ldap.model.entry.Entry;
24
25
26 /**
27 * A master table used to store indexable entries.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 */
31 public interface MasterTable extends Table<String, Entry>
32 {
33 /** the base name for the db file for this table */
34 String DBF = "master";
35
36 /** the sequence key - stores last sequence value in the admin table */
37 String SEQPROP_KEY = "__sequence__";
38
39
40 /**
41 * Gets the next value from the sequence of this MasterTable. This has
42 * the side-effect of incrementing the sequence values permanently.
43 *
44 * @param entry the entry in case the id is derived from the entry.
45 * @return the current value of this MasterTable's sequence incremented by one
46 */
47 String getNextId( Entry entry );
48 }