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.xdbm; 021 022 023import org.apache.directory.api.ldap.model.entry.Entry; 024 025 026/** 027 * A master table used to store indexable entries. 028 * 029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 030 */ 031public interface MasterTable extends Table<String, Entry> 032{ 033 /** the base name for the db file for this table */ 034 String DBF = "master"; 035 036 /** the sequence key - stores last sequence value in the admin table */ 037 String SEQPROP_KEY = "__sequence__"; 038 039 040 /** 041 * Gets the next value from the sequence of this MasterTable. This has 042 * the side-effect of incrementing the sequence values permanently. 043 * 044 * @param entry the entry in case the id is derived from the entry. 045 * @return the current value of this MasterTable's sequence incremented by one 046 */ 047 String getNextId( Entry entry ); 048}