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 import org.apache.maven.index.updater.IndexUpdater;
25
26 /**
27 * An index packer used to create transfer index format that can be used by the {@link IndexUpdater}.
28 *
29 * @author Tamas Cservenak
30 */
31 public interface IndexPacker
32 {
33 String ROLE = IndexPacker.class.getName();
34
35 /**
36 * Pack a context into a target directory. If the directory does not exists, it will be created. If the directory
37 * exists, it should be writable.
38 *
39 * @param context the context to pack-up
40 * @param targetDir the directory where to write results, has to be non-null
41 * @throws IllegalArgumentException when the targetDir already exists and is not a writable directory.
42 * @throws IOException on lethal IO problem
43 */
44 void packIndex( IndexPackingRequest request )
45 throws IOException, IllegalArgumentException;
46
47 }