com.sun.mail.util.logging

Class DurationFilter

java.lang.Object

com.sun.mail.util.logging.DurationFilter

public static class DurationFilter
extends java.lang.Object

A filter used to limit log records based on a maximum generation rate. The duration specified is used to compute the record rate and the amount of time the filter will reject records once the rate has been exceeded. Once the rate is exceeded records are not allowed until the duration has elapsed.

By default each DurationFilter is initialized using the following LogManager configuration properties where <filter-name> refers to the fully qualified class name of the handler. If properties are not defined, or contain invalid values, then the specified default values are used.

• <filter-name>.records the max number of records per duration. A numeric long integer or a multiplication expression can be used as the value. (defaults to 1000)
• <filter-name>.duration the number of milliseconds to suppress log records from being published. This is also used as duration to determine the log record rate. A numeric long integer or a multiplication expression can be used as the value. If the java.time package is available then an ISO-8601 duration format of PnDTnHnMn.nS can be used as the value. The suffixes of "D", "H", "M" and "S" are for days, hours, minutes and seconds. The suffixes must occur in order. The seconds can be specified with a fractional component to declare milliseconds. (defaults to PT15M)

For example, the settings to limit MailHandler with a default capacity to only send a maximum of two email messages every six minutes would be as follows:

 
  com.sun.mail.util.logging.MailHandler.filter = com.sun.mail.util.logging.DurationFilter
  com.sun.mail.util.logging.MailHandler.capacity = 1000
  com.sun.mail.util.logging.DurationFilter.records = 2L * 1000L
  com.sun.mail.util.logging.DurationFilter.duration = PT6M
 
 

Since:

JavaMail 1.5.5

See Also:

Serialized Form

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait