org.openqa.selenium.server.IOHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-server
The newest version!
package org.openqa.selenium.server;

import org.apache.commons.logging.Log;
import org.mortbay.log.LogFactory;

import java.io.ByteArrayOutputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * Utility class for java.io annoyances.
 */
public class IOHelper {

    private static final Log LOGGER = LogFactory.getLog(IOHelper.class);
    private static final int DEFAULT_COPY_BUFFER_SIZE = 1024;

    public static void close(InputStream stream) {
        if (null == stream) {
            return;
        }
        try {
            stream.close();
        } catch (IOException e) {
            LOGGER.info("Ignoring exception while closing " + stream);
        }
    }

    /**
     * Read a file on the file system and return its content as a stream of bytes.
     *
     * @param filePath  Path of the file to read. Cannot be null.
     * @return File content. Never null.
     *
     * @throws IOException on error
     */
    public static byte[] readFile(String filePath) throws IOException {
        final ByteArrayOutputStream outputStream;
        FileInputStream inputStream = null;

        try {
            inputStream = new FileInputStream(filePath);
            outputStream = new ByteArrayOutputStream();
            copyStream(inputStream, outputStream);

            return outputStream.toByteArray();
        } finally {
            close(inputStream);
        }
    }

    
    /**
     * Copy remaining stream content to another stream.
     *
     * @param in                Input stream to copy (remaining) content from. Cannot be null.
     * @param out               Output stream to copy content to. Cannot be null.
     * @throws IOException on IO error.
     * @throws java.lang.AssertionError  If in or out is null.
     */
    public static void copyStream(InputStream in, OutputStream out) throws IOException {
        copyStream(in, out, DEFAULT_COPY_BUFFER_SIZE);
    }


    /**
     * Copy remaining stream content to another stream.
     *
     * @param in                Input stream to copy (remaining) content from. Cannot be null.
     * @param out               Output stream to copy content to. Cannot be null.
     * @param copyBufferSize    Size of the maximum chunk of data that will be copied in one step. A buffer a this
     *                          size will be allocated internally so beware of the usual speed vs. memory tradeoff.
     *                          Must be strictly positive.
     * @throws IOException on IO error.
     * @throws java.lang.AssertionError
     *             If copyBufferSize is negative, in is null or out is null.
     */
    public static void copyStream(InputStream in, OutputStream out, int copyBufferSize) throws IOException {
        final byte[] buffer;
        int bytesRead;

        buffer = new byte[copyBufferSize];
        while (true) {
            bytesRead = in.read(buffer);
            if (bytesRead < 0) {    /* End of stream */
                break;
            }
            out.write(buffer, 0, bytesRead);
        }
        out.flush();
    }

}