001    /**
002     * Copyright 2008-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.codehaus.mojo.wagon;
017    
018    /*
019     * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
020     * agreements. See the NOTICE file distributed with this work for additional information regarding
021     * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
022     * "License"); you may not use this file except in compliance with the License. You may obtain a
023     * copy of the License at
024     *
025     * http://www.apache.org/licenses/LICENSE-2.0
026     *
027     * Unless required by applicable law or agreed to in writing, software distributed under the License
028     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
029     * or implied. See the License for the specific language governing permissions and limitations under
030     * the License.
031     */
032    
033    /**
034     * Provides base functionality for dealing with I/O using two wagons
035     *
036     */
037    public abstract class AbstractDoubleWagonMojo extends AbstractWagonMojo {
038    
039        /**
040         * The URL to the source repository.
041         *
042         * @parameter expression="${wagon.source}"
043         * @required
044         */
045        protected String source;
046    
047        /**
048         * The URL to the target repository.
049         *
050         * @parameter expression="${wagon.target}"
051         * @required
052         */
053        protected String target;
054    
055        /**
056         * settings.xml's server id of the source repository. This is used when wagon needs extra authentication
057         * information.
058         *
059         * @parameter expression="${wagon.sourceId}" default-value="source"
060         */
061        protected String sourceId;
062    
063        /**
064         * settings.xml's server id of the target repository. This is used when wagon needs extra authentication
065         * information.
066         *
067         * @parameter expression="${wagon.targetId}" default-value="target"
068         */
069        protected String targetId;
070    
071        /**
072         * Optimize the upload by locally compressed all files in one bundle, upload the bundle, and finally remote
073         * uncompress the bundle. This only works with SCP's URL
074         *
075         * @parameter expression="${wagon.optimize}" default-value="false";
076         */
077    
078        protected boolean optimize = false;
079    
080    }