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.schema.bootstrap;
21  
22  
23  /**
24   * Base schema interface.
25   *
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   * @version $Rev$
28   */
29  public interface Schema
30  {
31      /**
32       * Checks whether or not this schema is enabled or disabled.
33       * 
34       * @return true if this schema is disabled, false otherwise
35       */
36      boolean isDisabled();
37      
38      /**
39       * Gets the name of the owner of the schema objects within this
40       * Schema.
41       *
42       * @return the identifier for the owner of this set's objects
43       */
44      String getOwner();
45  
46  
47      /**
48       * Gets the name of the logical schema the objects of this Schema
49       * belong to: e.g. krb5-kdc may be the logical LDAP schema name.
50       *
51       * @return the name of the logical schema
52       */
53      String getSchemaName();
54  
55  
56      /**
57       * Gets the names of other schemas that the objects within this
58       * Schema depends upon.
59       *
60       * @return the String names of schema dependencies
61       */
62      String[] getDependencies();
63  }