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   * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
33   * agreements. See the NOTICE file distributed with this work for additional information regarding
34   * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
35   * "License"); you may not use this file except in compliance with the License. You may obtain a
36   * copy of the License at
37   * 
38   * http://www.apache.org/licenses/LICENSE-2.0
39   * 
40   * Unless required by applicable law or agreed to in writing, software distributed under the License
41   * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
42   * or implied. See the License for the specific language governing permissions and limitations under
43   * the License.
44   */
45  import org.codehaus.mojo.wagon.shared.WagonDownload;
46  import org.codehaus.mojo.wagon.shared.WagonFileSet;
47  
48  /**
49   * Contains common configuration to scan for Wagon's files
50   */
51  public abstract class AbstractWagonListMojo
52      extends AbstractSingleWagonMojo
53  
54  {
55      /**
56       * Directory path relative to Wagon's URL
57       * @parameter expression="${wagon.fromDir}" default-value=""
58       */
59      protected String fromDir = "";
60  
61      /**
62       * Comma separated list of Ant's includes to scan for remote files     
63       * @parameter expression="${wagon.includes}" default-value="*";
64       */
65      protected String includes;
66  
67      /**
68       * Comma separated list of Ant's excludes to scan for remote files     
69       * @parameter expression="${wagon.excludes}"
70       * 
71       */
72      protected String excludes;
73  
74      /**
75       * Whether to consider remote path case sensitivity during scan
76       * @parameter expression="${wagon.caseSensitive}" default-value="true"
77       */
78      protected boolean caseSensitive = true;
79  
80      /**
81       * @component
82       */
83      protected WagonDownload wagonDownload;
84      
85      
86      protected WagonFileSet getWagonFileSet()
87      {
88          return this.getWagonFileSet( fromDir, includes, excludes, caseSensitive, "" );
89      }
90  
91  }