View Javadoc

1   package org.apache.maven.index;
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.context.IndexingContext;
25  
26  /**
27   * An indexer engine used to index, update and remote artifacts to the indexing context.
28   */
29  public interface IndexerEngine
30  {
31      /**
32       * Add new artifact to the index
33       */
34      void index( IndexingContext context, ArtifactContext ac )
35          throws IOException;
36  
37      /**
38       * Replace data for a previously indexed artifact
39       */
40      void update( IndexingContext context, ArtifactContext ac )
41          throws IOException;
42  
43      /**
44       * Remove artifact to the index
45       */
46      void remove( IndexingContext context, ArtifactContext ac )
47          throws IOException;
48  
49  }