Tomcat 10.1.19 · org.apache.tomcat.util.log.SystemLogHandler

Modifier and Type	Field and Description
private static final ThreadLocal<Deque<CaptureLog>>	logs Thread <-> CaptureLog associations.
private final PrintStream	out Hides java.io.FilterOutputStream.out. Wrapped PrintStream.
private static final Queue<CaptureLog>	reuse Spare CaptureLog ready for reuse.

Access	Constructor and Description
public	SystemLogHandler(PrintStream The stream to capture wrapped) Construct the handler to capture the output of the given steam.

Method Summary

Modifier and Type	Method and Description
public boolean	checkError() Overrides java.io.PrintStream.checkError. Flushes the stream if it's not closed and checks its error state.
public void	close() Overrides java.io.PrintStream.close. Implements java.io.Closeable.close. Closes the stream.
protected PrintStream	Returns: the print stream findStream() Find PrintStream to which the output must be written to.
public void	flush() Overrides java.io.PrintStream.flush. Implements java.io.Flushable.flush. Flushes the stream.
public void	print(boolean The `boolean` to be printed b) Overrides java.io.PrintStream.print. Prints a boolean value.
public void	print(char The `char` to be printed c) Overrides java.io.PrintStream.print. Prints a character.
public void	print(int The `int` to be printed i) Overrides java.io.PrintStream.print. Prints an integer.
public void	print(long The `long` to be printed l) Overrides java.io.PrintStream.print. Prints a long integer.
public void	print(float The `float` to be printed f) Overrides java.io.PrintStream.print. Prints a floating-point number.
public void	print(double The `double` to be printed d) Overrides java.io.PrintStream.print. Prints a double-precision floating-point number.
public void	print(char[] The array of chars to be printed s) Overrides java.io.PrintStream.print. Prints an array of characters.
public void	print(String The `String` to be printed s) Overrides java.io.PrintStream.print. Prints a string.
public void	print(Object The `Object` to be printed obj) Overrides java.io.PrintStream.print. Prints an object.
public void	println() Overrides java.io.PrintStream.println. Terminates the current line by writing the line separator string.
public void	println(boolean The `boolean` to be printed x) Overrides java.io.PrintStream.println. Prints a boolean and then terminates the line.
public void	println(char The `char` to be printed. x) Overrides java.io.PrintStream.println. Prints a character and then terminates the line.
public void	println(int The `int` to be printed. x) Overrides java.io.PrintStream.println. Prints an integer and then terminates the line.
public void	println(long a The `long` to be printed. x) Overrides java.io.PrintStream.println. Prints a long and then terminates the line.
public void	println(float The `float` to be printed. x) Overrides java.io.PrintStream.println. Prints a float and then terminates the line.
public void	println(double The `double` to be printed. x) Overrides java.io.PrintStream.println. Prints a double and then terminates the line.
public void	println(char[] an array of chars to print. x) Overrides java.io.PrintStream.println. Prints an array of characters and then terminates the line.
public void	println(String The `String` to be printed. x) Overrides java.io.PrintStream.println. Prints a String and then terminates the line.
public void	println(Object The `Object` to be printed. x) Overrides java.io.PrintStream.println. Prints an Object and then terminates the line.
protected void	setError() Overrides java.io.PrintStream.setError. Sets the error state of the stream to `true`.
public static void	startCapture() Start capturing thread's output.
public static String	Returns: The captured data stopCapture() Stop capturing thread's output.
public void	write(int The byte to be written b) Overrides java.io.PrintStream.write. Writes the specified byte to this stream.
public void	write(byte[] A byte array b) Overrides java.io.PrintStream.write. Writes all bytes from the specified byte array to this stream.
public void	write(byte[] A byte array buf, int Offset from which to start taking bytes off, int Number of bytes to write len) Overrides java.io.PrintStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this stream.

Inherited from java.io.PrintStream:: append append append charset clearError format format printf printf writeBytes

logs	back to summary
private static final ThreadLocal<Deque<CaptureLog>> logs Thread <-> CaptureLog associations.

out	back to summary
private final PrintStream out Hides java.io.FilterOutputStream.out. Wrapped PrintStream.

reuse	back to summary
private static final Queue<CaptureLog> reuse Spare CaptureLog ready for reuse.

SystemLogHandler	back to summary
public SystemLogHandler(PrintStream wrapped) Construct the handler to capture the output of the given steam. Parameters wrapped:PrintStream The stream to capture

Method Detail

checkError back to summary

checkError	back to summary
public boolean checkError() Overrides java.io.PrintStream.checkError. Doc from java.io.PrintStream.checkError. Flushes the stream if it's not closed and checks its error state. Returns:boolean `true` if and only if this stream has encountered an `IOException`, or the `setError` method has been invoked Annotations @Override

public boolean checkError()

Overrides java.io.PrintStream.checkError.

Doc from java.io.PrintStream.checkError.

Flushes the stream if it's not closed and checks its error state.

Returns:boolean

true if and only if this stream has encountered an IOException, or the setError method has been invoked

Annotations

@Override

close	back to summary
public void close() Overrides java.io.PrintStream.close. Implements java.io.Closeable.close. Doc from java.io.PrintStream.close. Closes the stream. This is done by flushing the stream and then closing the underlying output stream. Annotations @Override

back to summary

public void close()

Overrides java.io.PrintStream.close.

Implements java.io.Closeable.close.

Doc from java.io.PrintStream.close.

Closes the stream. This is done by flushing the stream and then closing the underlying output stream.

Annotations

@Override

findStream	back to summary
protected PrintStream findStream() Find PrintStream to which the output must be written to. Returns:PrintStream the print stream

findStream

back to summary

protected PrintStream findStream()

Find PrintStream to which the output must be written to.

Returns:PrintStream: the print stream

flush	back to summary
public void flush() Overrides java.io.PrintStream.flush. Implements java.io.Flushable.flush. Doc from java.io.PrintStream.flush. Flushes the stream. This is done by writing any buffered output bytes to the underlying output stream and then flushing that stream. Annotations @Override

flush

back to summary

public void flush()

Overrides java.io.PrintStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.PrintStream.flush.

Flushes the stream. This is done by writing any buffered output bytes to the underlying output stream and then flushing that stream.

Annotations

@Override

print back to summary

print	back to summary
public void print(boolean b) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a boolean value. The string produced by `java.lang.String#valueOf(boolean)` is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters b:boolean The `boolean` to be printed Annotations @Override

public void print(boolean b)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a boolean value. The string produced by java.lang.String#valueOf(boolean) is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

b:boolean: The boolean to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(char c) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a character. The character is translated into one or more bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the `write(int)` method. Parameters c:char The `char` to be printed Annotations @Override

public void print(char c)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a character. The character is translated into one or more bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the write(int) method.

Parameters

c:char: The char to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(int i) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints an integer. The string produced by `java.lang.String#valueOf(int)` is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters i:int The `int` to be printed Annotations @Override

public void print(int i)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints an integer. The string produced by java.lang.String#valueOf(int) is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

i:int: The int to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(long l) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a long integer. The string produced by `java.lang.String#valueOf(long)` is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters l:long The `long` to be printed Annotations @Override

public void print(long l)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a long integer. The string produced by java.lang.String#valueOf(long) is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

l:long: The long to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(float f) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a floating-point number. The string produced by `java.lang.String#valueOf(float)` is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters f:float The `float` to be printed Annotations @Override

public void print(float f)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a floating-point number. The string produced by java.lang.String#valueOf(float) is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

f:float: The float to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(double d) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a double-precision floating-point number. The string produced by `java.lang.String#valueOf(double)` is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters d:double The `double` to be printed Annotations @Override

public void print(double d)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a double-precision floating-point number. The string produced by java.lang.String#valueOf(double) is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

d:double: The double to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(char[] s) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints an array of characters. The characters are converted into bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the `write(int)` method. Parameters s:char[] The array of chars to be printed Annotations @Override

public void print(char[] s)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints an array of characters. The characters are converted into bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the write(int) method.

Parameters

s:char[]: The array of chars to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(String s) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints a string. If the argument is `null` then the string `"null"` is printed. Otherwise, the string's characters are converted into bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the `write(int)` method. Parameters s:String The `String` to be printed Annotations @Override

public void print(String s)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are converted into bytes according to the character encoding given to the constructor, or the default charset if none specified. These bytes are written in exactly the manner of the write(int) method.

Parameters

s:String: The String to be printed

Annotations

@Override

print back to summary

print	back to summary
public void print(Object obj) Overrides java.io.PrintStream.print. Doc from java.io.PrintStream.print. Prints an object. The string produced by the `java.lang.String#valueOf(Object)` method is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the `write(int)` method. Parameters obj:Object The `Object` to be printed Annotations @Override

public void print(Object obj)

Overrides java.io.PrintStream.print.

Doc from java.io.PrintStream.print.

Prints an object. The string produced by the java.lang.String#valueOf(Object) method is translated into bytes according to the default charset, and these bytes are written in exactly the manner of the write(int) method.

Parameters

obj:Object: The Object to be printed

Annotations

@Override

println back to summary

println	back to summary
public void println() Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Terminates the current line by writing the line separator string. The line separator string is defined by the system property `line.separator`, and is not necessarily a single newline character (`'\n'`). Annotations @Override

public void println()

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Terminates the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').

Annotations

@Override

println back to summary

println	back to summary
public void println(boolean x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a boolean and then terminates the line. This method behaves as though it invokes `print(boolean)` and then `println()`. Parameters x:boolean The `boolean` to be printed Annotations @Override

public void println(boolean x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a boolean and then terminates the line. This method behaves as though it invokes print(boolean) and then println().

Parameters

x:boolean: The boolean to be printed

Annotations

@Override

println back to summary

println	back to summary
public void println(char x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a character and then terminates the line. This method behaves as though it invokes `print(char)` and then `println()`. Parameters x:char The `char` to be printed. Annotations @Override

public void println(char x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a character and then terminates the line. This method behaves as though it invokes print(char) and then println().

Parameters

x:char: The char to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(int x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints an integer and then terminates the line. This method behaves as though it invokes `print(int)` and then `println()`. Parameters x:int The `int` to be printed. Annotations @Override

public void println(int x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints an integer and then terminates the line. This method behaves as though it invokes print(int) and then println().

Parameters

x:int: The int to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(long x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a long and then terminates the line. This method behaves as though it invokes `print(long)` and then `println()`. Parameters x:long a The `long` to be printed. Annotations @Override

public void println(long x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a long and then terminates the line. This method behaves as though it invokes print(long) and then println().

Parameters

x:long: a The long to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(float x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a float and then terminates the line. This method behaves as though it invokes `print(float)` and then `println()`. Parameters x:float The `float` to be printed. Annotations @Override

public void println(float x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a float and then terminates the line. This method behaves as though it invokes print(float) and then println().

Parameters

x:float: The float to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(double x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a double and then terminates the line. This method behaves as though it invokes `print(double)` and then `println()`. Parameters x:double The `double` to be printed. Annotations @Override

public void println(double x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a double and then terminates the line. This method behaves as though it invokes print(double) and then println().

Parameters

x:double: The double to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(char[] x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints an array of characters and then terminates the line. This method behaves as though it invokes `print(char[])` and then `println()`. Parameters x:char[] an array of chars to print. Annotations @Override

public void println(char[] x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints an array of characters and then terminates the line. This method behaves as though it invokes print(char[]) and then println().

Parameters

x:char[]: an array of chars to print.

Annotations

@Override

println back to summary

println	back to summary
public void println(String x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints a String and then terminates the line. This method behaves as though it invokes `print(String)` and then `println()`. Parameters x:String The `String` to be printed. Annotations @Override

public void println(String x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints a String and then terminates the line. This method behaves as though it invokes print(String) and then println().

Parameters

x:String: The String to be printed.

Annotations

@Override

println back to summary

println	back to summary
public void println(Object x) Overrides java.io.PrintStream.println. Doc from java.io.PrintStream.println. Prints an Object and then terminates the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes `print(String)` and then `println()`. Parameters x:Object The `Object` to be printed. Annotations @Override

public void println(Object x)

Overrides java.io.PrintStream.println.

Doc from java.io.PrintStream.println.

Prints an Object and then terminates the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes print(String) and then println().

Parameters

x:Object: The Object to be printed.

Annotations

@Override

setError back to summary

setError	back to summary
protected void setError() Overrides java.io.PrintStream.setError. Doc from java.io.PrintStream.setError. Sets the error state of the stream to `true`. This method will cause subsequent invocations of `checkError()` to return `true` until `clearError()` is invoked. Annotations @Override

protected void setError()

Overrides java.io.PrintStream.setError.

Doc from java.io.PrintStream.setError.

Sets the error state of the stream to true.

This method will cause subsequent invocations of checkError() to return true until clearError() is invoked.

Annotations

@Override

startCapture	back to summary
public static void startCapture() Start capturing thread's output.

stopCapture	back to summary
public static String stopCapture() Stop capturing thread's output. Returns:String The captured data

stopCapture

back to summary

public static String stopCapture()

Stop capturing thread's output.

Returns:String: The captured data

write back to summary

write	back to summary
public void write(int b) Overrides java.io.PrintStream.write. Doc from java.io.PrintStream.write. Writes the specified byte to this stream. If the byte is a newline and automatic flushing is enabled then the `flush` method will be invoked on the underlying output stream. Note that the byte is written as given; to write a character that will be translated according to the default charset, use the `print(char)` or `println(char)` methods. Parameters b:int The byte to be written Annotations @Override

public void write(int b)

Overrides java.io.PrintStream.write.

Doc from java.io.PrintStream.write.

Writes the specified byte to this stream. If the byte is a newline and automatic flushing is enabled then the flush method will be invoked on the underlying output stream.

Note that the byte is written as given; to write a character that will be translated according to the default charset, use the print(char) or println(char) methods.

Parameters

b:int: The byte to be written

Annotations

@Override

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Overrides java.io.PrintStream.write. Doc from java.io.PrintStream.write. Writes all bytes from the specified byte array to this stream. If automatic flushing is enabled then the `flush` method will be invoked on the underlying output stream. Note that the bytes will be written as given; to write characters that will be translated according to the default charset, use the `print(char[])` or `println(char[])` methods. Parameters b:byte[] A byte array Annotations @Override Exceptions IOException: If an I/O error occurs.

public void write(byte[] b) throws IOException

Overrides java.io.PrintStream.write.

Doc from java.io.PrintStream.write.

Writes all bytes from the specified byte array to this stream. If automatic flushing is enabled then the flush method will be invoked on the underlying output stream.

Note that the bytes will be written as given; to write characters that will be translated according to the default charset, use the print(char[]) or println(char[]) methods.

Parameters

b:byte[]: A byte array

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] buf, int off, int len) Overrides java.io.PrintStream.write. Doc from java.io.PrintStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this stream. If automatic flushing is enabled then the `flush` method will be invoked on the underlying output stream. Note that the bytes will be written as given; to write characters that will be translated according to the default charset, use the `print(char)` or `println(char)` methods. Parameters buf:byte[] A byte array off:int Offset from which to start taking bytes len:int Number of bytes to write Annotations @Override

public void write(byte[] buf, int off, int len)

Overrides java.io.PrintStream.write.

Doc from java.io.PrintStream.write.

Writes len bytes from the specified byte array starting at offset off to this stream. If automatic flushing is enabled then the flush method will be invoked on the underlying output stream.

Note that the bytes will be written as given; to write characters that will be translated according to the default charset, use the print(char) or println(char) methods.

Parameters

buf:byte[]: A byte array
off:int: Offset from which to start taking bytes
len:int: Number of bytes to write

Annotations

@Override

public Class SystemLogHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail