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