View Javadoc

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.core.changelog;
21  
22  import org.apache.directory.server.core.partition.Partition;
23  
24  
25  /**
26   * TODO TaggableSearchableChangeLogStore.
27   *
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   * @version $Rev$, $Date$
30   */
31  public interface TaggableSearchableChangeLogStore extends TaggableChangeLogStore, SearchableChangeLogStore
32  {
33      /**
34       * Get's the tag search engine for this TaggableSearchableChangeLogStore.
35       *
36       * @return the snapshot query engine for this store.
37       */
38      TagSearchEngine getTagSearchEngine();
39      
40      /**
41       * 
42       * Gets the read only Partition backed by this ChangeLogStore.
43       * The init() method on this partition needs to be called by the caller.<br><br>
44       * Note: This partition allows add/delete operation on the tags container
45       *       The revisions container is read-only.<br><br>  
46       * The default containers of the partition are
47       *    <li>ou=changelog</li>
48       *    <li>ou=tags,ou=changelog</li>
49       *    <li>ou=revisions,ou=changelog</li> 
50       * 
51       * @param partitionSuffix the suffix of the partition e.x ou=chnagelog
52       * @param revContainerName the container's name for holding the revisions ex. ou=revisions
53       * @param tagContainerName the container's name for holding the tags ex. ou=tags
54       * 
55       * @return the partial-write enabled uninitialized partition
56       */
57      Partition getPartition( String partitionSuffix, String revContainerName, String tagContainerName );
58  }