View Javadoc

1   /*
2    *   Copyright 2004 The Apache Software Foundation
3    *
4    *   Licensed under the Apache License, Version 2.0 (the "License");
5    *   you may not use this file except in compliance with the License.
6    *   You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *   Unless required by applicable law or agreed to in writing, software
11   *   distributed under the License is distributed on an "AS IS" BASIS,
12   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *   See the License for the specific language governing permissions and
14   *   limitations under the License.
15   *
16   */
17  package org.apache.ldap.server;
18  
19  
20  import javax.naming.Name;
21  
22  
23  /***
24   * ContextPartitions are indivisible BackingStores associated with a naming
25   * context as a base suffix.  All JNDI Attributes entries at and under the
26   * context of this suffix are stored within this partition.
27   *
28   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29   * @version $Rev: 160364 $
30   */
31  public interface ContextPartition extends BackingStore
32  {
33      /***
34       * Gets the distinguished/absolute name of the suffix for all entries
35       * stored within this BackingStore.
36       *
37       * @param normalized boolean value used to control the normalization of the
38       * returned Name.  If true the normalized Name is returned, otherwise the 
39       * original user provided Name without normalization is returned.
40       * @return Name representing the distinguished/absolute name of this
41       * BackingStores root context.
42       */
43      Name getSuffix( boolean normalized ) ;
44  }