View Javadoc

1   /**
2    * Copyright 2008-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.codehaus.mojo.wagon;
17  
18  /*
19   * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
20   * agreements. See the NOTICE file distributed with this work for additional information regarding
21   * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
22   * "License"); you may not use this file except in compliance with the License. You may obtain a
23   * copy of the License at
24   *
25   * http://www.apache.org/licenses/LICENSE-2.0
26   *
27   * Unless required by applicable law or agreed to in writing, software distributed under the License
28   * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
29   * or implied. See the License for the specific language governing permissions and limitations under
30   * the License.
31   */
32  
33  /**
34   * Provides base functionality for dealing with I/O using two wagons
35   *
36   */
37  public abstract class AbstractDoubleWagonMojo extends AbstractWagonMojo {
38  
39      /**
40       * The URL to the source repository.
41       *
42       * @parameter expression="${wagon.source}"
43       * @required
44       */
45      protected String source;
46  
47      /**
48       * The URL to the target repository.
49       *
50       * @parameter expression="${wagon.target}"
51       * @required
52       */
53      protected String target;
54  
55      /**
56       * settings.xml's server id of the source repository. This is used when wagon needs extra authentication
57       * information.
58       *
59       * @parameter expression="${wagon.sourceId}" default-value="source"
60       */
61      protected String sourceId;
62  
63      /**
64       * settings.xml's server id of the target repository. This is used when wagon needs extra authentication
65       * information.
66       *
67       * @parameter expression="${wagon.targetId}" default-value="target"
68       */
69      protected String targetId;
70  
71      /**
72       * Optimize the upload by locally compressed all files in one bundle, upload the bundle, and finally remote
73       * uncompress the bundle. This only works with SCP's URL
74       *
75       * @parameter expression="${wagon.optimize}" default-value="false";
76       */
77  
78      protected boolean optimize = false;
79  
80  }