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.bootstrap;
021    
022    
023    import javax.naming.NamingException;
024    
025    import org.apache.directory.server.schema.bootstrap.ProducerTypeEnum;
026    import org.apache.directory.server.schema.registries.Registries;
027    
028    
029    /**
030     * A schema object producer which uses a callback to announce object creation
031     * rather than completely returning objects in bulk. This way registries can
032     * be populated while the producer is doing is creating schema objects.
033     *
034     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035     * @version $Rev: 491471 $
036     */
037    public interface BootstrapProducer
038    {
039        /**
040         * Gets the type of producer this is.
041         *
042         * @return the type of the BootstrapProducer as a enum
043         */
044        ProducerTypeEnum getType();
045    
046    
047        /**
048         * Produces schema objects announcing each one after creation via the
049         * callback before continuing on to create more objects.
050         *
051         * @param registries the registry set used by this producer
052         * @param cb the producer's callback
053         * @throws NamingException callbacks often operate upon registries and can
054         * throw these exceptions so we must throw this as well since
055         * implementations will have to call the callback methods
056         */
057        void produce( Registries registries, ProducerCallback cb ) throws NamingException;
058    }