patterntesting.exception.net.DetailedSocketException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-exception Show documentation

PatternTesting Exception (patterntesting-exception) is a framework round about exceptions. It wraps some common exception (like IOException) to provide some more information as the original exception (e.g. the filename with the absolute pathname). On the other it allows you to provoke exceptions for better testing.

The newest version!

/*
 * Copyright (c) 2019 by Oliver Boehm
 *
 * Licensed 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.
 *
 * (c)reated 29.05.2019 by oboehm ([email protected])
 */
package patterntesting.exception.net;

import org.apache.commons.lang3.StringUtils;

import java.net.SocketException;

/**
 * The DetailedSocketException provides (in contradiction to
 * {@link SocketException}) an constructor with a {@link Throwable} as
 * argument.
 *
 * @author oboehm
 * @since 2.0 (29.05.2019)
 */
public class DetailedSocketException extends SocketException {

    /**
     * Constructs a new {@code SocketException} with the
     * specified detail message and the given cause.
     *
     * @param msg   the detail message.
     * @param cause the cause
     */
    public DetailedSocketException(String msg, Throwable cause) {
        super(msg);
        initCause(cause);
    }

    /**
     * The given SocketException is checked if it contains the host in the
     * error message. If not it is appended.
     *
     * @param e    the original SocketException
     * @param host the host
     * @param port the port
     * @return a socket exception with more details
     * @since 2.0
     */
    public static SocketException of(SocketException e, String host, int port) {
        String msg = e.getMessage();
        if (StringUtils.contains(msg, host)) {
            return e;
        }
        String betterMsg = msg + " (can't connect " + host + ":" + port + ")";
        return new DetailedSocketException(betterMsg, e);
    }

}