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 */ 020package org.apache.directory.api.ldap.schemaextractor; 021 022 023import java.io.IOException; 024 025 026/** 027 * Extracts LDIF files for the schema repository. 028 * 029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 030 */ 031public interface SchemaLdifExtractor 032{ 033 /** 034 * Gets whether or not the content has been extracted previously by this 035 * extractor or another into the directory file structure. 036 * 037 * @return true if extracted at least once, false otherwise 038 */ 039 boolean isExtracted(); 040 041 042 /** 043 * Extracts the LDIF files from a Jar file or copies exploded LDIF resources. 044 * 045 * @param overwrite over write extracted structure if true, false otherwise 046 * @throws java.io.IOException if schema already extracted and on IO errors 047 */ 048 void extractOrCopy( boolean overwrite ) throws IOException; 049 050 051 /** 052 * Extracts the LDIF files from a Jar file or copies exploded LDIF 053 * resources without overwriting the resources if the schema has 054 * already been extracted. 055 * 056 * @throws java.io.IOException if schema already extracted and on IO errors 057 */ 058 void extractOrCopy() throws IOException; 059}