001    /*
002     *   Licensed to the Apache Software Foundation (ASF) under one
003     *   or more contributor license agreements.  See the NOTICE file
004     *   distributed with this work for additional information
005     *   regarding copyright ownership.  The ASF licenses this file
006     *   to you under the Apache License, Version 2.0 (the
007     *   "License"); you may not use this file except in compliance
008     *   with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     *   Unless required by applicable law or agreed to in writing,
013     *   software distributed under the License is distributed on an
014     *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *   KIND, either express or implied.  See the License for the
016     *   specific language governing permissions and limitations
017     *   under the License.
018     *
019     */
020    package org.apache.directory.server.schema.registries;
021    
022    
023    import java.util.Iterator;
024    
025    import javax.naming.NamingException;
026    
027    import org.apache.directory.shared.ldap.schema.SchemaObject;
028    
029    
030    /**
031     * Common schema object registry interface.
032     *
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev$, $Date$
035     */
036    public interface SchemaObjectRegistry
037    {
038        /**
039         * Gets the name of the schema this schema object is associated with.
040         *
041         * @param id the object identifier or the name
042         * @return the schema name
043         * @throws NamingException if the schema object does not exist
044         */
045        String getSchemaName( String id ) throws NamingException;
046    
047        
048        /**
049         * Gets an iterator over the registered schema objects in the registry.
050         *
051         * @return an Iterator of homogenious schema objects
052         */
053        Iterator<? extends SchemaObject> iterator();
054    
055    
056        /**
057         * Removes the SchemaObject registered with this registry.
058         * 
059         * @param numericOid the numeric identifier
060         * @throws NamingException if the numeric identifier is invalid
061         */
062        void unregister( String numericOid ) throws NamingException;
063    }