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 import javax.naming.NamingException; 24 25 import org.apache.directory.server.schema.bootstrap.ProducerTypeEnum; 26 import org.apache.directory.server.schema.registries.Registries; 27 28 29 /** 30 * A schema object producer which uses a callback to announce object creation 31 * rather than completely returning objects in bulk. This way registries can 32 * be populated while the producer is doing is creating schema objects. 33 * 34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 35 * @version $Rev: 491471 $ 36 */ 37 public interface BootstrapProducer 38 { 39 /** 40 * Gets the type of producer this is. 41 * 42 * @return the type of the BootstrapProducer as a enum 43 */ 44 ProducerTypeEnum getType(); 45 46 47 /** 48 * Produces schema objects announcing each one after creation via the 49 * callback before continuing on to create more objects. 50 * 51 * @param registries the registry set used by this producer 52 * @param cb the producer's callback 53 * @throws NamingException callbacks often operate upon registries and can 54 * throw these exceptions so we must throw this as well since 55 * implementations will have to call the callback methods 56 */ 57 void produce( Registries registries, ProducerCallback cb ) throws NamingException; 58 }