Modifier and Type	Class and Description
public static record	DebugLogger.LoggerConfig A DebugLogger configuration is composed of three levels.

Modifier and Type	Field and Description
private final DebugLogger.LoggerConfig	config
private final Supplier<String>	dbgTag
private final boolean	debugOn
pack-priv static final System.Logger	HPACK
pack-priv static final String	HPACK_NAME
pack-priv static final System.Logger	HTTP
pack-priv static final String	HTTP_NAME
private final System.Logger	logger
private final int	minSeverity
private static final DebugLogger	NO_HPACK_LOGGER
private static final DebugLogger	NO_HTTP_LOGGER
private static final DebugLogger	NO_WS_LOGGER
pack-priv static final long	START_NANOS
private final boolean	traceOn
pack-priv static final System.Logger	WS
pack-priv static final String	WS_NAME

Access	Constructor and Description
private	DebugLogger(System.Logger The internal logger to which messages will be forwarded. This is typically either `WS`, `HPACK`, or `HTTP`; logger, Supplier<String> A lambda that returns a string that identifies the caller (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))") dbgTag, DebugLogger.LoggerConfig The levels at or above which messages will be printed to the corresponding destination. config) Create a logger for debug traces.The logger should only be used with levels whose severity is `<= DEBUG`.

Method Summary

Modifier and Type	Method and Description
public static DebugLogger	createHpackLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)
public static DebugLogger	createHttpLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)
public static DebugLogger	createWebSocketLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)
private StringBuilder	decorate(StringBuilder sb, String msg)
private StringBuilder	format(StringBuilder sb, String format, Object[] params)
public String	getName() Implements java.lang.System.Logger.getName. Returns the name of this logger.
private boolean	isEnabled(System.Logger.Level level)
public boolean	isLoggable(System.Logger.Level level) Implements java.lang.System.Logger.isLoggable. Checks if a message of the given level would be logged by this logger.
private static boolean	levelEnabledFor(System.Logger.Level level, DebugLogger.LoggerConfig config, System.Logger logger)
public void	log(System.Logger.Level level, ResourceBundle unused, String format, Object... params) Implements java.lang.System.Logger.log. Logs a message with resource bundle and an optional list of parameters.
public void	log(System.Logger.Level level, ResourceBundle unused, String msg, Throwable thrown) Implements java.lang.System.Logger.log. Logs a localized message associated with a given throwable.
public final boolean	on() Overrides default jdk.internal.net.http.common.Logger.on. Tells whether this logger is on.
private void	print(PrintStream out, System.Logger.Level level, String msg, Object[] params, Throwable t)
private boolean	useStringFormat(String format)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

config	back to summary
private final DebugLogger.LoggerConfig config

dbgTag	back to summary
private final Supplier<String> dbgTag

debugOn	back to summary
private final boolean debugOn

HPACK	back to summary
pack-priv static final System.Logger HPACK

HPACK_NAME	back to summary
pack-priv static final String HPACK_NAME

HTTP	back to summary
pack-priv static final System.Logger HTTP

HTTP_NAME	back to summary
pack-priv static final String HTTP_NAME

logger	back to summary
private final System.Logger logger

minSeverity	back to summary
private final int minSeverity

NO_HPACK_LOGGER	back to summary
private static final DebugLogger NO_HPACK_LOGGER

NO_HTTP_LOGGER	back to summary
private static final DebugLogger NO_HTTP_LOGGER

NO_WS_LOGGER	back to summary
private static final DebugLogger NO_WS_LOGGER

START_NANOS	back to summary
pack-priv static final long START_NANOS

traceOn	back to summary
private final boolean traceOn

WS	back to summary
pack-priv static final System.Logger WS

WS_NAME	back to summary
pack-priv static final String WS_NAME

Constructor Detail

DebugLogger back to summary

DebugLogger	back to summary
private DebugLogger(System.Logger logger, Supplier<String> dbgTag, DebugLogger.LoggerConfig config) Create a logger for debug traces.The logger should only be used with levels whose severity is `<= DEBUG`. By default, this logger will print message whose severity is above the severity configured in the logger `config` If `config.outLevel()` is not Level.OFF, messages whose severity are at or above that severity will be directly printed on System.out If `config.errLevel()` is not Level.OFF, messages whose severity are at or above that severity will be directly printed on System.err If `config.logLevel()` is not Level.OFF, messages whose severity are at or above that severity will be forwarded to the supplied `logger`. The logger will add some decoration to the printed message, in the form of `<Level>:[<thread-name>] [<elapsed-time>] <dbgTag>: <formatted message>` API Note To obtain a logger that will always print things on stderr in addition to forwarding to the internal logger, use `new DebugLogger(logger, this::dbgTag, LoggerConfig.LOG.withErrLevel(Level.ALL));`. To obtain a logger that will only forward to the internal logger, use `new DebugLogger(logger, this::dbgTag, LoggerConfig.LOG);`. Parameters logger:System.Logger The internal logger to which messages will be forwarded. This is typically either `WS`, `HPACK`, or `HTTP`; dbgTag:Supplier<String> A lambda that returns a string that identifies the caller (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))") config:DebugLogger.LoggerConfig The levels at or above which messages will be printed to the corresponding destination.

private DebugLogger(System.Logger logger, Supplier<String> dbgTag, DebugLogger.LoggerConfig config)

Create a logger for debug traces.The logger should only be used with levels whose severity is <= DEBUG.

By default, this logger will print message whose severity is above the severity configured in the logger config

If config.outLevel() is not Level.OFF, messages whose severity are at or above that severity will be directly printed on System.out
If config.errLevel() is not Level.OFF, messages whose severity are at or above that severity will be directly printed on System.err
If config.logLevel() is not Level.OFF, messages whose severity are at or above that severity will be forwarded to the supplied logger.

The logger will add some decoration to the printed message, in the form of <Level>:[<thread-name>] [<elapsed-time>] <dbgTag>: <formatted message>

API Note

To obtain a logger that will always print things on stderr in addition to forwarding to the internal logger, use new DebugLogger(logger, this::dbgTag, LoggerConfig.LOG.withErrLevel(Level.ALL));. To obtain a logger that will only forward to the internal logger, use new DebugLogger(logger, this::dbgTag, LoggerConfig.LOG);.

Parameters

logger:System.Logger: The internal logger to which messages will be forwarded. This is typically either WS, HPACK, or HTTP;
dbgTag:Supplier<String>: A lambda that returns a string that identifies the caller (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))")
config:DebugLogger.LoggerConfig: The levels at or above which messages will be printed to the corresponding destination.

Method Detail

createHpackLogger	back to summary
public static DebugLogger createHpackLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)

createHttpLogger	back to summary
public static DebugLogger createHttpLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)

createWebSocketLogger	back to summary
public static DebugLogger createWebSocketLogger(Supplier<String> dbgTag, DebugLogger.LoggerConfig config)

decorate	back to summary
private StringBuilder decorate(StringBuilder sb, String msg)

format	back to summary
private StringBuilder format(StringBuilder sb, String format, Object[] params)

getName	back to summary
public String getName() Implements java.lang.System.Logger.getName. Doc from java.lang.System.Logger.getName. Returns the name of this logger. Annotations @Override

getName

back to summary

public String getName()

Implements java.lang.System.Logger.getName.

Doc from java.lang.System.Logger.getName.

Returns the name of this logger.

Annotations

@Override

isEnabled	back to summary
private boolean isEnabled(System.Logger.Level level)

isLoggable	back to summary
public boolean isLoggable(System.Logger.Level level) Implements java.lang.System.Logger.isLoggable. Doc from java.lang.System.Logger.isLoggable. Checks if a message of the given level would be logged by this logger. Annotations @Override

isLoggable

back to summary

public boolean isLoggable(System.Logger.Level level)

Implements java.lang.System.Logger.isLoggable.

Doc from java.lang.System.Logger.isLoggable.

Checks if a message of the given level would be logged by this logger.

Annotations

@Override

levelEnabledFor	back to summary
private static boolean levelEnabledFor(System.Logger.Level level, DebugLogger.LoggerConfig config, System.Logger logger)

log back to summary

log	back to summary
public void log(System.Logger.Level level, ResourceBundle unused, String format, Object... params) Implements java.lang.System.Logger.log. Doc from java.lang.System.Logger.log. Logs a message with resource bundle and an optional list of parameters. If the given resource bundle is non-`null`, the `format` string is localized using the given resource bundle. Otherwise the `format` string is not localized. Annotations @Override

public void log(System.Logger.Level level, ResourceBundle unused, String format, Object... params)

Implements java.lang.System.Logger.log.

Doc from java.lang.System.Logger.log.

Logs a message with resource bundle and an optional list of parameters. If the given resource bundle is non-null, the format string is localized using the given resource bundle. Otherwise the format string is not localized.

Annotations

@Override

log back to summary

log	back to summary
public void log(System.Logger.Level level, ResourceBundle unused, String msg, Throwable thrown) Implements java.lang.System.Logger.log. Doc from java.lang.System.Logger.log. Logs a localized message associated with a given throwable. If the given resource bundle is non-`null`, the `msg` string is localized using the given resource bundle. Otherwise the `msg` string is not localized. Annotations @Override

public void log(System.Logger.Level level, ResourceBundle unused, String msg, Throwable thrown)

Implements java.lang.System.Logger.log.

Doc from java.lang.System.Logger.log.

Logs a localized message associated with a given throwable. If the given resource bundle is non-null, the msg string is localized using the given resource bundle. Otherwise the msg string is not localized.

Annotations

@Override

on	back to summary
public final boolean on() Overrides default jdk.internal.net.http.common.Logger.on. Doc from jdk.internal.net.http.common.Logger.on. Tells whether this logger is on. Annotations @Override

back to summary

public final boolean on()

Overrides default jdk.internal.net.http.common.Logger.on.

Doc from jdk.internal.net.http.common.Logger.on.

Tells whether this logger is on.

Annotations

@Override

print	back to summary
private void print(PrintStream out, System.Logger.Level level, String msg, Object[] params, Throwable t)

useStringFormat	back to summary
private boolean useStringFormat(String format)

jdk.internal.net.http.common back to summary

public final Record DebugLogger.LoggerConfig

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.internal.net.http.common.DebugLogger.LoggerConfig

Record Components

outLevel:System.Logger.Level: the level at or above which messages will be directly printed to System#out
errLevel:System.Logger.Level: the level at or above which messages will be directly printed to System#err
logLevel:System.Logger.Level: the level at or above which messages will be forwarded to an underlying System.Logger

A DebugLogger configuration is composed of three levels. The three levels can be configured independently, but are typically either Level.ALL or Level.OFF.

Field Summary

Modifier and Type	Field and Description
private final System.Logger.Level	errLevel Record Component accessed by errLevel(). the level at or above which messages will be directly printed to `System#err`
public static final DebugLogger.LoggerConfig	ERRLOG logs on both System.err and System.Logger
public static final DebugLogger.LoggerConfig	ERROUT logs on both System.err and System.out
public static final DebugLogger.LoggerConfig	LOG Forward to System.Logger, doesn't log directly to System.out or System.err
private final System.Logger.Level	logLevel Record Component accessed by logLevel(). the level at or above which messages will be forwarded to an underlying `System.Logger`
public static final DebugLogger.LoggerConfig	OFF does not log anywhere
private final System.Logger.Level	outLevel Record Component accessed by outLevel(). the level at or above which messages will be directly printed to `System#out`
public static final DebugLogger.LoggerConfig	STDERR Logs on `System#err` only, does not forward to System.Logger
public static final DebugLogger.LoggerConfig	STDOUT Logs on `System#out` only, does not forward to System.Logger

Constructor Summary

Access	Constructor and Description
public	LoggerConfig(System.Logger.Level outLevel, System.Logger.Level errLevel, System.Logger.Level logLevel)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public System.Logger.Level	errLevel() Record Component getter of errLevel. Record Component the level at or above which messages will be directly printed to `System#err`
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public boolean	levelEnabledFor(System.Logger.Level level, System.Logger logger)
public System.Logger.Level	logLevel() Record Component getter of logLevel. Record Component the level at or above which messages will be forwarded to an underlying `System.Logger`
public int	minSeverity()
public static DebugLogger.LoggerConfig	of(DebugLogger.LoggerConfig config)
public boolean	on()
public System.Logger.Level	outLevel() Record Component getter of outLevel. Record Component the level at or above which messages will be directly printed to `System#out`
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public DebugLogger.LoggerConfig	withErrLevel(System.Logger.Level errLevel)
public DebugLogger.LoggerConfig	withLogLevel(System.Logger.Level logLevel)
public DebugLogger.LoggerConfig	withOutLevel(System.Logger.Level outLevel)

Field Detail

errLevel back to summary

errLevel	back to summary
private final System.Logger.Level errLevel Record Component accessed by errLevel(). the level at or above which messages will be directly printed to `System#err`

private final System.Logger.Level errLevel

Record Component accessed by errLevel().

the level at or above which messages will be directly printed to System#err

ERRLOG	back to summary
public static final DebugLogger.LoggerConfig ERRLOG logs on both System.err and System.Logger

ERROUT	back to summary
public static final DebugLogger.LoggerConfig ERROUT logs on both System.err and System.out

LOG	back to summary
public static final DebugLogger.LoggerConfig LOG Forward to System.Logger, doesn't log directly to System.out or System.err

logLevel back to summary

logLevel	back to summary
private final System.Logger.Level logLevel Record Component accessed by logLevel(). the level at or above which messages will be forwarded to an underlying `System.Logger`

private final System.Logger.Level logLevel

Record Component accessed by logLevel().

the level at or above which messages will be forwarded to an underlying System.Logger

OFF	back to summary
public static final DebugLogger.LoggerConfig OFF does not log anywhere

outLevel back to summary

outLevel	back to summary
private final System.Logger.Level outLevel Record Component accessed by outLevel(). the level at or above which messages will be directly printed to `System#out`

private final System.Logger.Level outLevel

Record Component accessed by outLevel().

the level at or above which messages will be directly printed to System#out

STDERR	back to summary
public static final DebugLogger.LoggerConfig STDERR Logs on `System#err` only, does not forward to System.Logger

STDOUT	back to summary
public static final DebugLogger.LoggerConfig STDOUT Logs on `System#out` only, does not forward to System.Logger

Constructor Detail

LoggerConfig	back to summary
public LoggerConfig(System.Logger.Level outLevel, System.Logger.Level errLevel, System.Logger.Level logLevel)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

errLevel back to summary

errLevel	back to summary
public System.Logger.Level errLevel() Record Component getter of errLevel. Record Component the level at or above which messages will be directly printed to `System#err`

public System.Logger.Level errLevel()

Record Component getter of errLevel.

Record Component: the level at or above which messages will be directly printed to System#err

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

levelEnabledFor	back to summary
public boolean levelEnabledFor(System.Logger.Level level, System.Logger logger)

logLevel back to summary

public System.Logger.Level logLevel()

Record Component getter of logLevel.

Record Component: the level at or above which messages will be forwarded to an underlying System.Logger

minSeverity	back to summary
public int minSeverity()

of	back to summary
public static DebugLogger.LoggerConfig of(DebugLogger.LoggerConfig config)

on	back to summary
public boolean on()

outLevel back to summary

public System.Logger.Level outLevel()

Record Component getter of outLevel.

Record Component: the level at or above which messages will be directly printed to System#out

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

withErrLevel	back to summary
public DebugLogger.LoggerConfig withErrLevel(System.Logger.Level errLevel)

withLogLevel	back to summary
public DebugLogger.LoggerConfig withLogLevel(System.Logger.Level logLevel)

withOutLevel	back to summary
public DebugLogger.LoggerConfig withOutLevel(System.Logger.Level outLevel)

pack-priv final Class DebugLogger

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record DebugLogger.LoggerConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail