UrlFileType.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2014 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package org.rhq.bundle.ant.type;

import java.io.File;

import org.apache.tools.ant.BuildException;

/**
 * A file to be copied during the bundle deployment. If the replace attribute is set to true, any template variables
 * (e.g. @@http.port@@) inside the file will be replaced with the value of the corresponding property.
 * 
 * This file is located at a remote location specified by a URL.
 *
 * @author Ian Springer
 * @author John Mazzitelli
 */
public class UrlFileType extends AbstractUrlFileType {
    private File destinationDir;
    private File destinationFile;
    private boolean replace;
    private HandoverHolder handoverHolder;

    public UrlFileType() {
        handoverHolder = new HandoverHolder();
    }

    public File getDestinationDir() {
        return this.destinationDir;
    }

    // Pass in a String, rather than a File, since we don't want Ant to resolve the path relative to basedir if it's relative.
    public void setDestinationDir(String destinationDir) {
        if (this.destinationFile != null) {
            throw new BuildException(
                "Both 'destinationDir' and 'destinationFile' attributes are defined - only one or the other may be specified.");
        }
        this.destinationDir = new File(destinationDir);
        ensureHandoverOrDestinationIsConfigured();
    }

    public File getDestinationFile() {
        if (this.destinationDir == null && this.destinationFile == null) {
            return new File(getBaseName()); // the default destination is the same relative path as that of its local name
        }
        return this.destinationFile;
    }

    public void setDestinationFile(String destinationFile) {
        if (this.destinationDir != null) {
            throw new BuildException(
                "Both 'destinationDir' and 'destinationFile' attributes are defined - only one or the other may be specified.");
        }
        this.destinationFile = new File(destinationFile);
        ensureHandoverOrDestinationIsConfigured();
    }

    public boolean isReplace() {
        return replace;
    }

    public void setReplace(boolean replace) {
        this.replace = replace;
    }

    @Override
    public void addConfigured(Handover handover) {
        handoverHolder.addConfigured(handover);
        ensureHandoverOrDestinationIsConfigured();
    }

    @Override
    public Handover getHandover() {
        return handoverHolder.getHandover();
    }

    private void ensureHandoverOrDestinationIsConfigured() {
        if (handoverHolder.getHandover() != null && (destinationDir != null || destinationFile != null)) {
            throw new BuildException("Configure either handover or destination");
        }
    }
}