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.registries;
21
22
23 import java.util.Iterator;
24
25 import javax.naming.NamingException;
26
27 import org.apache.directory.shared.ldap.schema.SchemaObject;
28
29
30 /**
31 * Common schema object registry interface.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 * @version $Rev$, $Date$
35 */
36 public interface SchemaObjectRegistry
37 {
38 /**
39 * Gets the name of the schema this schema object is associated with.
40 *
41 * @param id the object identifier or the name
42 * @return the schema name
43 * @throws NamingException if the schema object does not exist
44 */
45 String getSchemaName( String id ) throws NamingException;
46
47
48 /**
49 * Gets an iterator over the registered schema objects in the registry.
50 *
51 * @return an Iterator of homogenious schema objects
52 */
53 Iterator<? extends SchemaObject> iterator();
54
55
56 /**
57 * Removes the SchemaObject registered with this registry.
58 *
59 * @param numericOid the numeric identifier
60 * @throws NamingException if the numeric identifier is invalid
61 */
62 void unregister( String numericOid ) throws NamingException;
63 }