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.shared.ldap.schema.ldif.extractor; 021 022 023 import 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 * @version $Rev$ 031 */ 032 public interface SchemaLdifExtractor 033 { 034 /** 035 * Gets whether or not the content has been extracted previously by this 036 * extractor or another into the directory file structure. 037 * 038 * @return true if extracted at least once, false otherwise 039 */ 040 boolean isExtracted(); 041 042 043 /** 044 * Extracts the LDIF files from a Jar file or copies exploded LDIF resources. 045 * 046 * @param overwrite over write extracted structure if true, false otherwise 047 * @throws java.io.IOException if schema already extracted and on IO errors 048 */ 049 void extractOrCopy( boolean overwrite ) throws IOException; 050 051 052 /** 053 * Extracts the LDIF files from a Jar file or copies exploded LDIF 054 * resources without overwriting the resources if the schema has 055 * already been extracted. 056 * 057 * @throws java.io.IOException if schema already extracted and on IO errors 058 */ 059 void extractOrCopy() throws IOException; 060 }