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 package org.apache.maven.index.packer;
20
21 import java.io.IOException;
22
23 /**
24 * An index packer used to create transfer index format that can be used by the
25 * {@link org.apache.maven.index.updater.IndexUpdater}.
26 *
27 * @author Tamas Cservenak
28 */
29 public interface IndexPacker {
30 /**
31 * Pack a context into a target directory. If the directory does not exists, it will be created. If the directory
32 * exists, it should be writable.
33 *
34 * @param request the request to process.
35 * @throws IllegalArgumentException when the targetDir already exists and is not a writable directory.
36 * @throws IOException on lethal IO problem
37 */
38 void packIndex(IndexPackingRequest request) throws IOException, IllegalArgumentException;
39 }