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  
21  package org.apache.directory.server.protocol.shared.catalog;
22  
23  
24  /**
25   * The interface for resolving search-base DN's from zone or realm names.
26   *
27   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
28   * @version $Rev: 542104 $, $Date: 2007-05-28 06:18:59 +0200 (Mo, 28 Mai 2007) $
29   */
30  public interface Catalog
31  {
32      /**
33       * Returns the base DN for searches, given a zone or realm name.
34       *
35       * @param name
36       * @return The base DN for searches.
37       */
38      public String getBaseDn( String name );
39  }