src/java.base/share/classes/sun/net/util/SocketExceptions.java
author michaelm
Tue, 29 Oct 2019 19:23:09 +0000
branchunixdomainchannels
changeset 58847 692de65ab293
parent 58801 119ac9128c1b
permissions -rw-r--r--
partial cleanup
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     1
/*
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     2
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     4
 *
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    10
 *
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    15
 * accompanied this code).
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    16
 *
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    20
 *
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    23
 * questions.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    24
 */
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    25
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    26
package sun.net.util;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    27
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    28
import java.io.IOException;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    29
import java.lang.reflect.Constructor;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    30
import java.net.InetSocketAddress;
58847
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    31
import java.nio.channels.UnixDomainSocketAddress;
58801
119ac9128c1b Initial implementation of unix domain channels. See j.n.c.{Server}SocketChannel apidoc
michaelm
parents: 51879
diff changeset
    32
import java.net.SocketAddress;
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    33
import java.security.AccessController;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    34
import java.security.PrivilegedAction;
51879
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    35
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    36
import sun.security.util.SecurityProperties;
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    37
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    38
public final class SocketExceptions {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    39
    private SocketExceptions() {}
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    40
51879
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    41
    private static final boolean enhancedExceptionText =
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    42
        SecurityProperties.includedInExceptions("hostInfo");
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    43
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    44
    /**
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    45
     * Utility which takes an exception and returns either the same exception
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    46
     * or a new exception of the same type with the same stack trace
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    47
     * and detail message enhanced with addressing information from the
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    48
     * given InetSocketAddress.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    49
     *
51879
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    50
     * If the system/security property "jdk.includeInExceptions" is not
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    51
     * set or does not contain the category hostInfo,
6ffa38b8da65 8207768: Improve exception messages during manifest parsing of jar archives
mbaesken
parents: 51236
diff changeset
    52
     * then the original exception is returned.
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    53
     *
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    54
     * Only specific IOException subtypes are supported.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    55
     */
58801
119ac9128c1b Initial implementation of unix domain channels. See j.n.c.{Server}SocketChannel apidoc
michaelm
parents: 51879
diff changeset
    56
    public static IOException of(IOException e, SocketAddress addr) {
58847
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    57
        if (addr instanceof UnixDomainSocketAddress)
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    58
            return ofUnixDomain(e, (UnixDomainSocketAddress)addr);
58801
119ac9128c1b Initial implementation of unix domain channels. See j.n.c.{Server}SocketChannel apidoc
michaelm
parents: 51879
diff changeset
    59
        if (!(addr instanceof InetSocketAddress))
119ac9128c1b Initial implementation of unix domain channels. See j.n.c.{Server}SocketChannel apidoc
michaelm
parents: 51879
diff changeset
    60
            return e;
58847
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    61
58801
119ac9128c1b Initial implementation of unix domain channels. See j.n.c.{Server}SocketChannel apidoc
michaelm
parents: 51879
diff changeset
    62
        InetSocketAddress address = (InetSocketAddress)addr;
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    63
        if (!enhancedExceptionText || address == null)
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    64
            return e;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    65
        int port = address.getPort();
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    66
        String host = address.getHostString();
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    67
        StringBuilder sb = new StringBuilder();
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    68
        sb.append(e.getMessage());
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    69
        sb.append(": ");
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    70
        sb.append(host);
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    71
        sb.append(':');
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    72
        sb.append(Integer.toString(port));
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    73
        String enhancedMsg = sb.toString();
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    74
        return create(e, enhancedMsg);
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    75
    }
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    76
58847
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    77
    private static IOException ofUnixDomain(IOException e, UnixDomainSocketAddress addr) {
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    78
        if (!enhancedExceptionText || addr == null)
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    79
            return e;
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    80
        String path = addr.getPath();
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    81
        StringBuilder sb = new StringBuilder();
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    82
        sb.append(e.getMessage());
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    83
        sb.append(": ");
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    84
        sb.append(path);
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    85
        String enhancedMsg = sb.toString();
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    86
        return create(e, enhancedMsg);
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    87
    }
692de65ab293 partial cleanup
michaelm
parents: 58801
diff changeset
    88
50722
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    89
    // return a new instance of the same type with the given detail
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    90
    // msg, or if the type doesn't support detail msgs, return given
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    91
    // instance.
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    92
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    93
    private static IOException create(IOException e, String msg) {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    94
        return AccessController.doPrivileged(new PrivilegedAction<IOException>() {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    95
            public IOException run() {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    96
                try {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    97
                    Class<?> clazz = e.getClass();
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    98
                    Constructor<?> ctor = clazz.getConstructor(String.class);
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
    99
                    IOException e1 = (IOException)(ctor.newInstance(msg));
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   100
                    e1.setStackTrace(e.getStackTrace());
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   101
                    return e1;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   102
                } catch (Exception e0) {
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   103
                    // Some eg AsynchronousCloseException have no detail msg
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   104
                    return e;
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   105
                }
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   106
            }
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   107
        });
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   108
    }
bc104aaf24e9 8204233: Add configurable option for enhanced socket IOException messages
michaelm
parents:
diff changeset
   109
}