This helper class assists with the logging associated with invalid input data. A developer may want all instances of invalid input data logged to assist with debugging whereas in production it is likely to be desirable not to log anything for invalid data. The following settings may be used:

NOTHING: Log nothing.
DEBUG_ALL: Log all problems at DEBUG log level.
INFO_THEN_DEBUG: Log first problem at INFO log level and any further issues in the following TBD (configurable) seconds at DEBUG level
INFO_ALL: Log all problems at INFO log level.

By default, INFO_THEN_DEBUG is used with a suppression time of 24 hours.

Note

This class is not completely thread-safe. When using INFO_THEN_DEBUG it is possible that several INFO messages will be logged before dropping to DEBUG.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	UserDataHelper.Config
public static enum	UserDataHelper.Mode Log mode for the next log message.

Field Summary

Modifier and Type	Field and Description
private final UserDataHelper.Config	config
private volatile long	lastInfoTime
private final Log	log
private final long	suppressionTime

Access	Constructor and Description
public	UserDataHelper(Log log)

Method Summary

Modifier and Type	Method and Description
public UserDataHelper.Mode	Returns: Log mode, or `null` getNextMode() Returns log mode for the next log message, or `null` if the message should not be logged.
private boolean	logAtInfo()

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

Field Detail

config	back to summary
private final UserDataHelper.Config config

lastInfoTime	back to summary
private volatile long lastInfoTime

log	back to summary
private final Log log

suppressionTime	back to summary
private final long suppressionTime

UserDataHelper	back to summary
public UserDataHelper(Log log)

Method Detail

getNextMode back to summary

getNextMode	back to summary
public UserDataHelper.Mode getNextMode() Returns log mode for the next log message, or `null` if the message should not be logged. If `INFO_THEN_DEBUG` configuration option is enabled, this method might change internal state of this object. Returns:UserDataHelper.Mode Log mode, or `null`

public UserDataHelper.Mode getNextMode()

Returns log mode for the next log message, or null if the message should not be logged.

If INFO_THEN_DEBUG configuration option is enabled, this method might change internal state of this object.

Returns:UserDataHelper.Mode: Log mode, or null

logAtInfo	back to summary
private boolean logAtInfo()

org.apache.tomcat.util.log back to summary

private final Enum UserDataHelper.Config

Class Inheritance

extends Enum<UserDataHelper.Config>

java.lang.Object
java.lang.Enum
org.apache.tomcat.util.log.UserDataHelper.Config

Field Summary

Modifier and Type	Field and Description
public static final UserDataHelper.Config	DEBUG_ALL
public static final UserDataHelper.Config	INFO_ALL
public static final UserDataHelper.Config	INFO_THEN_DEBUG
public static final UserDataHelper.Config	NONE

Constructor Summary

Access	Constructor and Description
private	Config()

Method Summary

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

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

Field Detail

DEBUG_ALL	back to summary
public static final UserDataHelper.Config DEBUG_ALL

INFO_ALL	back to summary
public static final UserDataHelper.Config INFO_ALL

INFO_THEN_DEBUG	back to summary
public static final UserDataHelper.Config INFO_THEN_DEBUG

NONE	back to summary
public static final UserDataHelper.Config NONE

Constructor Detail

Config	back to summary
private Config()

Method Detail

valueOf	back to summary
public static UserDataHelper.Config valueOf(String name)

values	back to summary
public static UserDataHelper.Config[] values()

org.apache.tomcat.util.log back to summary

public final Enum UserDataHelper.Mode

Class Inheritance

extends Enum<UserDataHelper.Mode>

java.lang.Object
java.lang.Enum
org.apache.tomcat.util.log.UserDataHelper.Mode

Log mode for the next log message.

Field Summary

Modifier and Type	Field and Description
public static final UserDataHelper.Mode	DEBUG
public static final UserDataHelper.Mode	INFO
public static final UserDataHelper.Mode	INFO_THEN_DEBUG

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

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

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

Field Detail

DEBUG	back to summary
public static final UserDataHelper.Mode DEBUG

INFO	back to summary
public static final UserDataHelper.Mode INFO

INFO_THEN_DEBUG	back to summary
public static final UserDataHelper.Mode INFO_THEN_DEBUG

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

valueOf	back to summary
public static UserDataHelper.Mode valueOf(String name)

values	back to summary
public static UserDataHelper.Mode[] values()

public Class UserDataHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum UserDataHelper.Config

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum UserDataHelper.Mode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail