| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| package org.apache.directory.server.xdbm; |
| |
| |
| /** |
| * A master table used to store indexable entries. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public interface MasterTable<ID, E> extends Table<ID, E> |
| { |
| /** the base name for the db file for this table */ |
| String DBF = "master"; |
| |
| /** the sequence key - stores last sequence value in the admin table */ |
| String SEQPROP_KEY = "__sequence__"; |
| |
| |
| /** |
| * Gets an entry from this MasterTable. |
| * |
| * @param id the id of the entry to retrieve. |
| * @return the entry with all user and operational attributes. |
| * @throws Exception if there is a read error on the underlying Db. |
| */ |
| E get( ID id ) throws Exception; |
| |
| |
| /** |
| * Puts an entry into this MasterTable with a specified unique id. Used |
| * both to create new entries and update existing ones. |
| * |
| * @param entry the entry to add |
| * @param id unique identifier of the entry to put |
| * @throws Exception if there is a write error on the underlying Db. |
| */ |
| void put( ID id, E entry ) throws Exception; |
| |
| |
| /** |
| * Deletes a entry from this MasterTable at an index specified by id. |
| * |
| * @param id unique identifier of the entry to delete |
| * @throws Exception if there is a write error on the underlying Db |
| */ |
| void delete( ID id ) throws Exception; |
| |
| |
| /** |
| * Gets the value of the id sequence from this MasterTable's sequence |
| * without affecting the value. |
| * |
| * @param entry the entry in case the id is derived from the entry. |
| * @return the current value of this MasterTable's sequence |
| * @throws Exception if the admin table storing sequences cannot be read |
| */ |
| ID getCurrentId( E entry ) throws Exception; |
| |
| |
| /** |
| * Gets the next value from the sequence of this MasterTable. This has |
| * the side-effect of incrementing the sequence values permanently. |
| * |
| * @param entry the entry in case the id is derived from the entry. |
| * @return the current value of this MasterTable's sequence incremented by one |
| * @throws Exception on failure to update the id sequence |
| */ |
| ID getNextId( E entry ) throws Exception; |
| |
| |
| /** |
| * Gets a persistent property associated with this MasterTable. |
| * |
| * @param property the key of the property to get the value of |
| * @return the value of the property |
| * @throws Exception on failure to read the property |
| */ |
| String getProperty( String property ) throws Exception; |
| |
| |
| /** |
| * Sets a persistent property associated with this MasterTable. |
| * |
| * @param property the key of the property to set the value of |
| * @param value the value of the property |
| * @throws Exception on failure to write the property |
| */ |
| void setProperty( String property, String value ) throws Exception; |
| } |