1 package org.apache.maven.index.updater;
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 org.apache.lucene.store.Directory;
23 import org.apache.maven.index.context.IndexingContext;
24
25 /**
26 * Ability to spread index updates to (possible) plugin receivers. (NEXUS-2644) Implement this as Plexus component to
27 * add new behaviour.
28 *
29 * @author Toni Menzel
30 */
31 public interface IndexUpdateSideEffect
32 {
33
34 /**
35 * Given a full or partial (see context partial parameter) lucene index (directory + context it has been integrated
36 * into), this can let other participants (implementations of this type) know about the update. Any activity should
37 * not influence the callers further process (not fail via unchecked exception) if possible. Implementations are
38 * most likely optional plugins.
39 *
40 * @param directory - the directory to merge
41 * @param context - original context
42 * @param partial - this update is partial (true) or a full update (false).
43 */
44 void updateIndex( Directory directory, IndexingContext context, boolean partial );
45
46 }