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