org.codehaus.mojo.wagon.AbstractWagonListMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2008-2012 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.
 */
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.
 *//*
 * 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.
 */
import org.codehaus.mojo.wagon.shared.WagonDownload;
import org.codehaus.mojo.wagon.shared.WagonFileSet;

/**
 * Contains common configuration to scan for Wagon's files
 */
public abstract class AbstractWagonListMojo extends AbstractSingleWagonMojo {

    /**
     * Directory path relative to Wagon's URL
     *
     * @parameter expression="${wagon.fromDir}" default-value=""
     */
    protected String fromDir = "";

    /**
     * Comma separated list of Ant's includes to scan for remote files
     *
     * @parameter expression="${wagon.includes}" default-value="**";
     */
    protected String includes;

    /**
     * Comma separated list of Ant's excludes to scan for remote files
     *
     * @parameter expression="${wagon.excludes}"
     *
     */
    protected String excludes;

    /**
     * Whether to consider remote path case sensitivity during scan
     *
     * @parameter expression="${wagon.caseSensitive}" default-value="true"
     */
    protected boolean caseSensitive = true;

    /**
     * @component
     */
    protected WagonDownload wagonDownload;

    protected WagonFileSet getWagonFileSet() {
        return this.getWagonFileSet(fromDir, includes, excludes, caseSensitive, "");
    }

}