View Javadoc

1   package org.sonatype.aether.connector.wagon;
2   
3   /*******************************************************************************
4    * Copyright (c) 2010-2011 Sonatype, Inc.
5    * All rights reserved. This program and the accompanying materials
6    * are made available under the terms of the Eclipse Public License v1.0
7    * which accompanies this distribution, and is available at
8    *   http://www.eclipse.org/legal/epl-v10.html
9    *******************************************************************************/
10  
11  import org.apache.maven.wagon.Wagon;
12  
13  /**
14   * A component to configure wagon instances with provider-specific parameters.
15   * 
16   * @author Benjamin Bentmann
17   */
18  public interface WagonConfigurator
19  {
20  
21      /**
22       * Configures the specified wagon instance with the given configuration.
23       * 
24       * @param wagon The wagon instance to configure, must not be {@code null}.
25       * @param configuration The configuration to apply to the wagon instance, must not be {@code null}.
26       * @throws Exception If the configuration could not be applied to the wagon.
27       */
28      void configure( Wagon wagon, Object configuration )
29          throws Exception;
30  
31  }