1 package org.apache.maven.index.packer; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.io.IOException; 23 24 /** 25 * An index packer used to create transfer index format that can be used by the 26 * {@link org.apache.maven.index.updater.IndexUpdater}. 27 * 28 * @author Tamas Cservenak 29 */ 30 public interface IndexPacker 31 { 32 String ROLE = IndexPacker.class.getName(); 33 34 /** 35 * Pack a context into a target directory. If the directory does not exists, it will be created. If the directory 36 * exists, it should be writable. 37 * 38 * @param request the request to process. 39 * @throws IllegalArgumentException when the targetDir already exists and is not a writable directory. 40 * @throws IOException on lethal IO problem 41 */ 42 void packIndex( IndexPackingRequest request ) 43 throws IOException, IllegalArgumentException; 44 45 }