AbstractDoubleWagonMojo.java

package org.codehaus.mojo.wagon;

/*
 * 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.
 */


/**
 * Provides base functionality for dealing with I/O using single wagon.
 * 
 */
public abstract class AbstractDoubleWagonMojo
    extends AbstractWagonMojo
{

    /**
     * The URL to the source repository.
     * 
     * @parameter expression="${wagon.source}"
     * @required
     */
    protected String source;

    /**
     * The URL to the target repository.
     * 
     * @parameter expression="${wagon.target}"
     * @required
     */
    protected String target;

    /**
     * settings.xml's server id of the source repository. 
     * This is used when wagon needs extra authentication information.
     * 
     * @parameter expression="${wagon.sourceId}" default-value="source"
     */
    protected String sourceId;

    /**
     * settings.xml's server id of the target repository. 
     * This is used when wagon needs extra authentication information.
     * 
     * @parameter expression="${wagon.targetId}" default-value="target"
     */
    protected String targetId;
    
    /**
     * Optimize the  upload by locally compressed all files in one bundle, 
     * upload the bundle, and finally remote uncompress the bundle.
     * This only works with SCP's URL
     * @parameter expression="${wagon.optimize}" default-value="false";
     */
    
    protected boolean optimize = false;
    

}