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