indexer-core/src/main/java/org/apache/maven/index/updater/IndexUpdater.java

package org.apache.maven.index.updater;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0    
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.io.IOException;

import org.apache.maven.index.packer.IndexPacker;

/**
 * An index updater provides functionality to update index for remote repositories using transfer format produced by the
 * {@link IndexPacker}.
 * <p>
 * The following snippet shows how to update/download remote index:
 * 
 * <pre>
 *   IndexingContext context = indexer.getIndexingContexts().get( indexId );
 *   Settings settings = embedder.getSettings();
 *   Proxy proxy = settings.getActiveProxy();
 *   ProxyInfo proxyInfo = null;
 *   if ( proxy != null )
 *   {
 *       proxyInfo = new ProxyInfo();
 *       proxyInfo.setHost( proxy.getHost() );
 *       proxyInfo.setPort( proxy.getPort() );
 *       proxyInfo.setNonProxyHosts( proxy.getNonProxyHosts() );
 *       proxyInfo.setUserName( proxy.getUsername() );
 *       proxyInfo.setPassword( proxy.getPassword() );
 *   }
 *   
 *   Date indexTime = updater.fetchAndUpdateIndex( context, transferListener, proxyInfo );
 *   ...
 * </pre>
 * 
 * @author Jason van Zyl
 * @author Eugene Kuleshov
 */
public interface IndexUpdater
{
    /**
     * @return IndexUpdateResult
     */
    IndexUpdateResult fetchAndUpdateIndex( IndexUpdateRequest updateRequest )
        throws IOException;
}