org.jinterop.dcom.transport.utils.IoUtils Maven / Gradle / Ivy

Go to download
/*
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.jinterop.dcom.transport.utils;

import java.io.IOException;
import java.net.Socket;
import java.util.logging.Level;
import java.util.logging.Logger;

public final class IoUtils {

    private static final Logger LOGGER = Logger.getLogger("org.jinterop");

    /** Disable instantiation */
    private IoUtils() {
    }

    /**
     * Close given closable.
     * If any error occur, it is logged and ignored.
     *
     * @param  the {@code Closeable} type, used to ease return assignment
     * @param toClose the object to close
     * @param name name used on error message
     * @return {@code null}
     */
    public static  T closeSilent(T toClose, String name) {
        if (toClose != null) {
            try {
                toClose.close();
            } catch (Exception ex) {
                LOGGER.log(Level.FINE, ex, () -> "Failed to close " + name + ".");
            }
        }
        return null;
    }

    /**
     * Close given closable.
     * If any error occur, it is logged and ignored.
     *
     * @param  the {@code Closeable} type, used to ease return assignment
     * @param toClose the object to close
     * @return {@code null}
     */
    public static  T closeSilent(T toClose) {
        return closeSilent(toClose, String.valueOf(toClose));
    }

    /**
     * Close given socket and shutdown inner input / output.
     * If any error occur, it is logged and ignored.
     *
     * @param  the {@code Socket} type, used to ease return assignment
     * @param socket the socket to close
     * @param name name used on error message
     * @return {@code null}
     */
    public static  T closeSilent(T socket, String name) {
        if (socket != null) {
            try {
                socket.shutdownInput();
                socket.shutdownOutput();
            } catch (IOException | RuntimeException ex) {
                LOGGER.log(Level.FINE, ex, () -> "Failed to shutwown socket " + name + " inner streams.");
            }
            try {
                socket.close();
            } catch (IOException | RuntimeException ex) {
                LOGGER.log(Level.FINE, ex, () -> "Failed to close " + name + ".");
            }
        }
        return null;
    }

    /**
     * Close given socket and shutdown inner input / output.
     * If any error occur, it is logged and ignored.
     *
     * @param  the {@code Socket} type, used to ease return assignment
     * @param socket the socket to close
     * @return {@code null}
     */
    public static  T closeSilent(T socket) {
        return closeSilent(socket, String.valueOf(socket));
    }
}