jdk/src/java.httpclient/share/classes/java/net/http/Log.java
author michaelm
Sat, 30 Apr 2016 00:30:31 +0100
changeset 37720 45cd7cc65382
parent 36665 8658fc0ab6e8
child 38381 a2105ea409ec
permissions -rw-r--r--
8087124: HTTP/2 implementation Reviewed-by: chegar

/*
 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 */
package java.net.http;

import java.util.Locale;

/**
 * -Djava.net.HttpClient.log=
 *          errors,requests,headers,
 *          frames[:type:type2:..],content,ssl,trace
 *
 * Any of errors, requests, headers or content are optional.
 *
 * Other handlers may be added. All logging is at level INFO
 *
 * Logger name is "java.net.http.HttpClient"
 */
// implements System.Logger in order to be skipped when printing the caller's
// information
abstract class Log implements System.Logger {

    static final String logProp = "java.net.http.HttpClient.log";

    public static final int OFF = 0;
    public static final int ERRORS = 0x1;
    public static final int REQUESTS = 0x2;
    public static final int HEADERS = 0x4;
    public static final int CONTENT = 0x8;
    public static final int FRAMES = 0x10;
    public static final int SSL = 0x20;
    public static final int TRACE = 0x40;
    static int logging;

    // Frame types: "control", "data", "window", "all"
    public static final int CONTROL = 1; // all except DATA and WINDOW_UPDATES
    public static final int DATA = 2;
    public static final int WINDOW_UPDATES = 4;
    public static final int ALL = CONTROL| DATA | WINDOW_UPDATES;
    static int frametypes;

    static final System.Logger logger;

    static {
        String s = Utils.getNetProperty(logProp);
        if (s == null) {
            logging = OFF;
        } else {
            String[] vals = s.split(",");
            for (String val : vals) {
                switch (val.toLowerCase(Locale.US)) {
                    case "errors":
                        logging |= ERRORS;
                        break;
                    case "requests":
                        logging |= REQUESTS;
                        break;
                    case "headers":
                        logging |= HEADERS;
                        break;
                    case "content":
                        logging |= CONTENT;
                        break;
                    case "ssl":
                        logging |= SSL;
                        break;
                    case "trace":
                        logging |= TRACE;
                        break;
                    case "all":
                        logging |= CONTENT|HEADERS|REQUESTS|FRAMES|ERRORS|TRACE;
                        break;
                }
                if (val.startsWith("frames")) {
                    logging |= FRAMES;
                    String[] types = val.split(":");
                    if (types.length == 1) {
                        frametypes = CONTROL | DATA | WINDOW_UPDATES;
                    } else {
                        for (String type : types) {
                            switch (type.toLowerCase()) {
                                case "control":
                                    frametypes |= CONTROL;
                                    break;
                                case "data":
                                    frametypes |= DATA;
                                    break;
                                case "window":
                                    frametypes |= WINDOW_UPDATES;
                                    break;
                                case "all":
                                    frametypes = ALL;
                                    break;
                            }
                        }
                    }
                }
            }
        }
        if (logging != OFF) {
            logger = System.getLogger("java.net.http.HttpClient");
        } else {
            logger = null;
        }
    }

    static boolean errors() {
        return (logging & ERRORS) != 0;
    }

    static boolean requests() {
        return (logging & REQUESTS) != 0;
    }

    static boolean headers() {
        return (logging & HEADERS) != 0;
    }

    static boolean trace() {
        return (logging & TRACE) != 0;
    }

    static boolean ssl() {
        return (logging & SSL) != 0;
    }

    static boolean frames() {
        return (logging & FRAMES) != 0;
    }

    static void logError(String s, Object... s1) {
        if (errors())
            logger.log(Level.INFO, "ERROR: " + s, s1);
    }

    static void logError(Throwable t) {
        if (errors()) {
            String s = Utils.stackTrace(t);
            logger.log(Level.INFO, "ERROR: " + s);
        }
    }

    static void logSSL(String s, Object... s1) {
        if (ssl())
            logger.log(Level.INFO, "SSL: " + s, s1);
    }

    static void logTrace(String s, Object... s1) {
        if (trace()) {
            String format = "TRACE: " + s;
            logger.log(Level.INFO, format, s1);
        }
    }

    static void logRequest(String s, Object... s1) {
        if (requests())
            logger.log(Level.INFO, "REQUEST: " + s, s1);
    }

    static void logResponse(String s, Object... s1) {
        if (requests())
            logger.log(Level.INFO, "RESPONSE: " + s, s1);
    }

    static void logHeaders(String s, Object... s1) {
        if (headers())
            logger.log(Level.INFO, "HEADERS: " + s, s1);
    }
// START HTTP2
    static boolean loggingFrame(Class<? extends Http2Frame> clazz) {
        if (frametypes == ALL) {
            return true;
        }
        if (clazz == DataFrame.class) {
            return (frametypes & DATA) != 0;
        } else if (clazz == WindowUpdateFrame.class) {
            return (frametypes & WINDOW_UPDATES) != 0;
        } else {
            return (frametypes & CONTROL) != 0;
        }
    }

    static void logFrames(Http2Frame f, String direction) {
        if (frames() && loggingFrame(f.getClass())) {
            logger.log(Level.INFO, "FRAME: " + direction + ": " + f.toString());
        }
    }

    // not instantiable
    private Log() {}

// END HTTP2
}