org.apache.ace.test/src/org/apache/ace/test/utils/FileUtils.java

/*
 * 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.
 */
package org.apache.ace.test.utils;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.channels.FileChannel;
import java.util.jar.Attributes;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;

import org.osgi.framework.Version;

public class FileUtils {

    /**
     * Convenience method for creating temp files. It creates a temp file, and then deletes it. This is done so the same
     * (unique) filename can be used to create a directory.
     * 
     * If you use null as the baseDirectoryName, a tempfile is created in the platform specific temp directory.
     * 
     * @throws IOException
     */
    public static File createTempFile(File baseDirectory) throws IOException {
        return createTempFile(baseDirectory, "");
    }

    public static File createTempFile(File baseDirectory, String extension) throws IOException {
        File tempFile = File.createTempFile("test", extension, baseDirectory);
        tempFile.delete();
        tempFile.deleteOnExit();
        return tempFile;
    }

    public static File createEmptyBundle(String bsn, Version version, String... headers) throws IOException {
        return createEmptyBundle(null, bsn, version, headers);
    }
    
    public static File createEmptyBundle(File baseDirectory, String bsn, Version version, String... headers) throws IOException {
        Manifest m = new Manifest();
        Attributes mainAttrs = m.getMainAttributes();
        mainAttrs.put(Attributes.Name.MANIFEST_VERSION, "1.0");
        mainAttrs.putValue("Bundle-ManifestVersion", "2");
        mainAttrs.putValue("Bundle-SymbolicName", bsn);
        mainAttrs.putValue("Bundle-Version", version.toString());
        for (int i = 0; i < headers.length; i += 2) {
            mainAttrs.putValue(headers[i], headers[i + 1]);
        }

        File result = createTempFile(baseDirectory, ".jar");

        try (FileOutputStream fos = new FileOutputStream(result); JarOutputStream jos = new JarOutputStream(fos, m)) {
            jos.close();
        }

        return result;
    }

    public static void copy(File input, File output) throws IOException {
        FileInputStream fis = new FileInputStream(input);
        FileOutputStream fos = new FileOutputStream(output);

        try {
            FileChannel ic = fis.getChannel();
            FileChannel oc = fos.getChannel();
            try {
                oc.transferFrom(ic, 0, ic.size());
            }
            finally {
                oc.close();
                ic.close();
            }
        }
        finally {
            fis.close();
            fos.close();
        }
    }

    /**
     * Remove the given directory and all it's files and subdirectories
     * 
     * @param directory
     *            the name of the directory to remove
     */
    public static void removeDirectoryWithContent(File directory) {
        if ((directory == null) || !directory.exists()) {
            return;
        }
        File[] filesAndSubDirs = directory.listFiles();
        for (int i = 0; i < filesAndSubDirs.length; i++) {
            File file = filesAndSubDirs[i];
            if (file.isDirectory()) {
                removeDirectoryWithContent(file);
            }
            // else just remove the file
            file.delete();
        }
        directory.delete();
    }
}