Modifier and Type	Class and Description
private static class	DebugContext.LogRecord
public static enum	DebugContext.TracingThreshold Tracing threshold - used for configuration granularity of information that will be sent in tracing headers.
public static enum	DebugContext.TracingType Type of tracing - used for tracing configuration.
public static enum	DebugContext.Type Type of the record - used to graphically distinguish these message types in the log.

Modifier and Type	Field and Description
private List<DebugContext.LogRecord>	logRecords
private String	sessionId
private final long	startTimestamp
private Map<String, List<String>>	tracingHeaders
private final Level	tracingLevel

Access	Constructor and Description
public	DebugContext(DebugContext.TracingThreshold tracing threshold. tracingThreshold) Constructor that configures tracing to be ON and accepts tracing threshold as a parameter.
public	DebugContext() Constructor that configures tracing to be OFF.

Method Summary

Modifier and Type	Method and Description
public void	appendLogMessage(Logger logger to be used to log the message. logger, Level message level. loggingLevel, DebugContext.Type type of the message. type, Object... message parts that will be concatenated to create a log message. messageParts) Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.
public void	appendLogMessageWithThrowable(Logger logger to be used to log the message. logger, Level message level. loggingLevel, DebugContext.Type type of the message. type, Throwable throwable that has been thrown. t, Object... message parts that will be stringified and concatenated to create a log message. messageParts) Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.
public void	appendStandardOutputMessage(DebugContext.Type type of the message. type, String message to be logged. message) Write a message to the standard output, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.
public void	appendTraceMessage(Logger logger to be used to log the message. logger, Level message level. loggingLevel, DebugContext.Type type of the message. type, Object... message parts that will be stringified and concatenated to create a log message. messageParts) Append a message to the log and to the list of trace messages that are sent in handshake response.
public void	appendTraceMessageWithThrowable(Logger logger to be used to log the message. logger, Level message level. loggingLevel, DebugContext.Type type of the message. type, Throwable throwable that has been thrown. t, Object... message parts that will be stringified and concatenated to create a log message. messageParts) Append a message to the log and to the list of trace messages that are sent in handshake response.
private void	appendTracingHeader(String message)
public void	flush() Write pending messages to the log.
private String	formatLogMessage(String message, DebugContext.Type type, long timestamp)
public Map<String, List<String>>	Returns: tracing headers. getTracingHeaders() Get headers containing tracing messages.
public void	setSessionId(String session ID. sessionId) Set a session ID that will be used as a common identifier for logged messages related to the same upgrade request.
private String	stringifyMessageParts(Object... messageParts)

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

Field Detail

logRecords	back to summary
private List<DebugContext.LogRecord> logRecords

sessionId	back to summary
private String sessionId

startTimestamp	back to summary
private final long startTimestamp

tracingHeaders	back to summary
private Map<String, List<String>> tracingHeaders

tracingLevel	back to summary
private final Level tracingLevel

Constructor Detail

DebugContext	back to summary
public DebugContext(DebugContext.TracingThreshold tracingThreshold) Constructor that configures tracing to be ON and accepts tracing threshold as a parameter. Parameters tracingThreshold:DebugContext.TracingThreshold tracing threshold.

DebugContext

back to summary

public DebugContext(DebugContext.TracingThreshold tracingThreshold)

Constructor that configures tracing to be ON and accepts tracing threshold as a parameter.

Parameters

tracingThreshold:DebugContext.TracingThreshold: tracing threshold.

DebugContext	back to summary
public DebugContext() Constructor that configures tracing to be OFF.

Method Detail

appendLogMessage	back to summary
public void appendLogMessage(Logger logger, Level loggingLevel, DebugContext.Type type, Object... messageParts) Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created. Parameters logger:Logger logger to be used to log the message. loggingLevel:Level message level. type:DebugContext.Type type of the message. messageParts:Object[] message parts that will be concatenated to create a log message.

appendLogMessage

back to summary

public void appendLogMessage(Logger logger, Level loggingLevel, DebugContext.Type type, Object... messageParts)

Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.

Parameters

logger:Logger: logger to be used to log the message.
loggingLevel:Level: message level.
type:DebugContext.Type: type of the message.
messageParts:Object[]: message parts that will be concatenated to create a log message.

appendLogMessageWithThrowable	back to summary
public void appendLogMessageWithThrowable(Logger logger, Level loggingLevel, DebugContext.Type type, Throwable t, Object... messageParts) Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created. Parameters logger:Logger logger to be used to log the message. loggingLevel:Level message level. type:DebugContext.Type type of the message. t:Throwable throwable that has been thrown. messageParts:Object[] message parts that will be stringified and concatenated to create a log message.

appendLogMessageWithThrowable

back to summary

public void appendLogMessageWithThrowable(Logger logger, Level loggingLevel, DebugContext.Type type, Throwable t, Object... messageParts)

Append a message to the log, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.

Parameters

logger:Logger: logger to be used to log the message.
loggingLevel:Level: message level.
type:DebugContext.Type: type of the message.
t:Throwable: throwable that has been thrown.
messageParts:Object[]: message parts that will be stringified and concatenated to create a log message.

appendStandardOutputMessage	back to summary
public void appendStandardOutputMessage(DebugContext.Type type, String message) Write a message to the standard output, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created. Parameters type:DebugContext.Type type of the message. message:String message to be logged.

appendStandardOutputMessage

back to summary

public void appendStandardOutputMessage(DebugContext.Type type, String message)

Write a message to the standard output, the logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.

Parameters

type:DebugContext.Type: type of the message.
message:String: message to be logged.

appendTraceMessage	back to summary
public void appendTraceMessage(Logger logger, Level loggingLevel, DebugContext.Type type, Object... messageParts) Append a message to the log and to the list of trace messages that are sent in handshake response. The logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created. Parameters logger:Logger logger to be used to log the message. loggingLevel:Level message level. type:DebugContext.Type type of the message. messageParts:Object[] message parts that will be stringified and concatenated to create a log message.

appendTraceMessage

back to summary

public void appendTraceMessage(Logger logger, Level loggingLevel, DebugContext.Type type, Object... messageParts)

Append a message to the log and to the list of trace messages that are sent in handshake response. The logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created.

Parameters

logger:Logger: logger to be used to log the message.
loggingLevel:Level: message level.
type:DebugContext.Type: type of the message.
messageParts:Object[]: message parts that will be stringified and concatenated to create a log message.

appendTraceMessageWithThrowable	back to summary
public void appendTraceMessageWithThrowable(Logger logger, Level loggingLevel, DebugContext.Type type, Throwable t, Object... messageParts) Append a message to the log and to the list of trace messages that are sent in handshake response. The logging will be postponed until the message can be provided with a session ID. Randomly generated session ID is used if a session has not been created. Parameters logger:Logger logger to be used to log the message. loggingLevel:Level message level. type:DebugContext.Type type of the message. t:Throwable throwable that has been thrown. messageParts:Object[] message parts that will be stringified and concatenated to create a log message.

appendTraceMessageWithThrowable

back to summary

public void appendTraceMessageWithThrowable(Logger logger, Level loggingLevel, DebugContext.Type type, Throwable t, Object... messageParts)

Parameters

logger:Logger: logger to be used to log the message.
loggingLevel:Level: message level.
type:DebugContext.Type: type of the message.
t:Throwable: throwable that has been thrown.
messageParts:Object[]: message parts that will be stringified and concatenated to create a log message.

appendTracingHeader	back to summary
private void appendTracingHeader(String message)

flush	back to summary
public void flush() Write pending messages to the log.

formatLogMessage	back to summary
private String formatLogMessage(String message, DebugContext.Type type, long timestamp)

getTracingHeaders	back to summary
public Map<String, List<String>> getTracingHeaders() Get headers containing tracing messages. Returns:Map<String, List<String>> tracing headers.

getTracingHeaders

back to summary

public Map<String, List<String>> getTracingHeaders()

Get headers containing tracing messages.

Returns:Map<String, List<String>>: tracing headers.

setSessionId	back to summary
public void setSessionId(String sessionId) Set a session ID that will be used as a common identifier for logged messages related to the same upgrade request. Setting the session ID will cause the pending messages to be written into the log. Parameters sessionId:String session ID.

setSessionId

back to summary

public void setSessionId(String sessionId)

Set a session ID that will be used as a common identifier for logged messages related to the same upgrade request. Setting the session ID will cause the pending messages to be written into the log.

Parameters

sessionId:String: session ID.

stringifyMessageParts	back to summary
private String stringifyMessageParts(Object... messageParts)

org.glassfish.tyrus.core back to summary

private Class DebugContext.LogRecord

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.core.DebugContext.LogRecord

Field Summary

Modifier and Type	Field and Description
private Logger	logger Logger that will be used to log the message.
private Level	loggingLevel Logger level that will be used when logging the message.
private String	message Message to be logged.
private boolean	printToSout `true` if the record should be printed into standard output - used if a message should be "logged" even though the logging has been turned off or the configured logging level is too high.
private Throwable	t Throwable to be logged.
private long	timestamp Time when a the logged even has occurred.
private DebugContext.Type	type Type of the record - used for graphical purposes when logging.

Constructor Summary

Access	Constructor and Description
pack-priv	LogRecord(Logger logger, Level loggingLevel, DebugContext.Type Type, String message, Throwable t, boolean printToSout)

Method Summary

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

Field Detail

logger	back to summary
private Logger logger Logger that will be used to log the message.

loggingLevel	back to summary
private Level loggingLevel Logger level that will be used when logging the message.

message	back to summary
private String message Message to be logged.

printToSout	back to summary
private boolean printToSout `true` if the record should be printed into standard output - used if a message should be "logged" even though the logging has been turned off or the configured logging level is too high.

t	back to summary
private Throwable t Throwable to be logged.

timestamp	back to summary
private long timestamp Time when a the logged even has occurred.

type	back to summary
private DebugContext.Type type Type of the record - used for graphical purposes when logging.

Constructor Detail

LogRecord	back to summary
pack-priv LogRecord(Logger logger, Level loggingLevel, DebugContext.Type Type, String message, Throwable t, boolean printToSout)

org.glassfish.tyrus.core back to summary

public final Enum DebugContext.TracingThreshold

Class Inheritance

extends Enum<DebugContext.TracingThreshold>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.DebugContext.TracingThreshold

Tracing threshold - used for configuration granularity of information that will be sent in tracing headers.

Field Summary

Modifier and Type	Field and Description
public static final DebugContext.TracingThreshold	SUMMARY A less verbose tracing, an equivalent to `java.util.logging.Level#FINER` logging level.
public static final DebugContext.TracingThreshold	TRACE A more verbose tracing, an equivalent to `java.util.logging.Level#FINE` logging level.

Constructor Summary

Access	Constructor and Description
private	TracingThreshold()

Method Summary

Modifier and Type	Method and Description
public static DebugContext.TracingThreshold	valueOf(String name)
public static DebugContext.TracingThreshold[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

SUMMARY	back to summary
public static final DebugContext.TracingThreshold SUMMARY A less verbose tracing, an equivalent to `java.util.logging.Level#FINER` logging level.

TRACE back to summary

TRACE	back to summary
public static final DebugContext.TracingThreshold TRACE A more verbose tracing, an equivalent to `java.util.logging.Level#FINE` logging level. The default tracing threshold.

public static final DebugContext.TracingThreshold TRACE

A more verbose tracing, an equivalent to java.util.logging.Level#FINE logging level.

The default tracing threshold.

Constructor Detail

TracingThreshold	back to summary
private TracingThreshold()

Method Detail

valueOf	back to summary
public static DebugContext.TracingThreshold valueOf(String name)

values	back to summary
public static DebugContext.TracingThreshold[] values()

org.glassfish.tyrus.core back to summary

public final Enum DebugContext.TracingType

Class Inheritance

extends Enum<DebugContext.TracingType>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.DebugContext.TracingType

Type of tracing - used for tracing configuration.

Field Summary

Modifier and Type	Field and Description
public static final DebugContext.TracingType	ALL Tracing headers will be present in all handshake responses.
public static final DebugContext.TracingType	OFF No tracing headers will be ever sent in handshake response.
public static final DebugContext.TracingType	ON_DEMAND Tracing headers will be sent in handshake response only if X-Tyrus-Tracing-Accept header is present in handshake request.

Constructor Summary

Access	Constructor and Description
private	TracingType()

Method Summary

Modifier and Type	Method and Description
public static DebugContext.TracingType	valueOf(String name)
public static DebugContext.TracingType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL	back to summary
public static final DebugContext.TracingType ALL Tracing headers will be present in all handshake responses.

OFF	back to summary
public static final DebugContext.TracingType OFF No tracing headers will be ever sent in handshake response.

ON_DEMAND	back to summary
public static final DebugContext.TracingType ON_DEMAND Tracing headers will be sent in handshake response only if X-Tyrus-Tracing-Accept header is present in handshake request.

Constructor Detail

TracingType	back to summary
private TracingType()

Method Detail

valueOf	back to summary
public static DebugContext.TracingType valueOf(String name)

values	back to summary
public static DebugContext.TracingType[] values()

org.glassfish.tyrus.core back to summary

public final Enum DebugContext.Type

Class Inheritance

extends Enum<DebugContext.Type>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.DebugContext.Type

Type of the record - used to graphically distinguish these message types in the log.

Field Summary

Modifier and Type	Field and Description
public static final DebugContext.Type	MESSAGE_IN
public static final DebugContext.Type	MESSAGE_OUT
public static final DebugContext.Type	OTHER

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static DebugContext.Type	valueOf(String name)
public static DebugContext.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MESSAGE_IN	back to summary
public static final DebugContext.Type MESSAGE_IN

MESSAGE_OUT	back to summary
public static final DebugContext.Type MESSAGE_OUT

OTHER	back to summary
public static final DebugContext.Type OTHER

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static DebugContext.Type valueOf(String name)

values	back to summary
public static DebugContext.Type[] values()

public Class DebugContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DebugContext.LogRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum DebugContext.TracingThreshold

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DebugContext.TracingType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DebugContext.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail