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 java.io.IOException;
22
23 /**
24 * An index updater provides functionality to update index for remote repositories using transfer format produced by the
25 * {@link org.apache.maven.index.packer.IndexPacker}.
26 * <p>
27 * The following snippet shows how to update/download remote index:
28 *
29 * <pre>
30 * IndexingContext context = indexer.getIndexingContexts().get( indexId );
31 * Settings settings = embedder.getSettings();
32 * Proxy proxy = settings.getActiveProxy();
33 * ProxyInfo proxyInfo = null;
34 * if ( proxy != null )
35 * {
36 * proxyInfo = new ProxyInfo();
37 * proxyInfo.setHost( proxy.getHost() );
38 * proxyInfo.setPort( proxy.getPort() );
39 * proxyInfo.setNonProxyHosts( proxy.getNonProxyHosts() );
40 * proxyInfo.setUserName( proxy.getUsername() );
41 * proxyInfo.setPassword( proxy.getPassword() );
42 * }
43 *
44 * Date indexTime = updater.fetchAndUpdateIndex( context, transferListener, proxyInfo );
45 * ...
46 * </pre>
47 *
48 * @author Jason van Zyl
49 * @author Eugene Kuleshov
50 */
51 public interface IndexUpdater {
52 /**
53 * @return IndexUpdateResult
54 */
55 IndexUpdateResult fetchAndUpdateIndex(IndexUpdateRequest updateRequest) throws IOException;
56 }