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.api.ldap.schema.extractor; 21 22 23 import java.io.IOException; 24 25 26 /** 27 * Extracts LDIF files for the schema repository. 28 * 29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 30 */ 31 public interface SchemaLdifExtractor 32 { 33 /** 34 * Gets whether or not the content has been extracted previously by this 35 * extractor or another into the directory file structure. 36 * 37 * @return true if extracted at least once, false otherwise 38 */ 39 boolean isExtracted(); 40 41 42 /** 43 * Extracts the LDIF files from a Jar file or copies exploded LDIF resources. 44 * 45 * @param overwrite over write extracted structure if true, false otherwise 46 * @throws java.io.IOException if schema already extracted and on IO errors 47 */ 48 void extractOrCopy( boolean overwrite ) throws IOException; 49 50 51 /** 52 * Extracts the LDIF files from a Jar file or copies exploded LDIF 53 * resources without overwriting the resources if the schema has 54 * already been extracted. 55 * 56 * @throws java.io.IOException if schema already extracted and on IO errors 57 */ 58 void extractOrCopy() throws IOException; 59 }