JBoss Log Manager 3.1.2.Final · org.jboss.logmanager.handlers.DelayedHandler

Modifier and Type	Field and Description
private volatile boolean	activated
private volatile boolean	callerCalculationRequired
private final LogContext	logContext
private final int	queueLimit
private final Map<Level, Deque<ExtLogRecord>>	queues
private final Level	warnThreshold

Access	Constructor and Description
public	DelayedHandler() Construct a new instance.
public	DelayedHandler(LogContext the log context to use for level checks on replay, or `null` for none logContext) Construct a new instance, with the given log context used to recheck log levels on replay.
public	DelayedHandler(int the queue limit queueLimit) Construct a new instance.
public	DelayedHandler(LogContext the log context to use for level checks on replay, or `null` for none logContext, int the queue limit queueLimit) Construct a new instance, with the given log context used to recheck log levels on replay.
public	DelayedHandler(int the queue limit queueLimit, Level the threshold level to report queue overruns for warnThreshold) Construct a new instance.
public	DelayedHandler(LogContext the log context to use for level checks on replay, or `null` for none logContext, int the queue limit queueLimit, Level the threshold level to report queue overruns for warnThreshold) Construct a new instance, with the given log context used to recheck log levels on replay.

Method Summary

Modifier and Type	Method and Description
private void	activate()
public void	addHandler(final Handler the handler to add handler) Overrides org.jboss.logmanager.ExtHandler.addHandler. Add a sub-handler to this handler.
public Handler[]	clearHandlers() Overrides org.jboss.logmanager.ExtHandler.clearHandlers. A convenience method to atomically get and clear all sub-handlers.
public final void	close() Overrides org.jboss.logmanager.ExtHandler.close. Implements java.lang.AutoCloseable.close. Close all child handlers.
protected void	doPublish(final ExtLogRecord the log record to publish record) Overrides org.jboss.logmanager.ExtHandler.doPublish. Do the actual work of publication; the record will have been filtered already.
private Supplier<ExtLogRecord>	drain()
private void	enqueueOrdered(Deque<ExtLogRecord> the queue q, ExtLogRecord the record record) Enqueue the log record such that the queue's order (by sequence number) is maintained.
public final boolean	Returns: `true` if the handler has been activated, otherwise `false` isActivated() Indicates whether or not this handler has been activated.
public boolean	isCallerCalculationRequired() Overrides org.jboss.logmanager.ExtHandler.isCallerCalculationRequired. Indicates whether or not the formatter associated with this handler or a formatter from a child handler requires the caller to be calculated.
private static <E> Deque<E>	newDeque(Object ignored)
public void	removeHandler(final Handler the handler to remove handler) Overrides org.jboss.logmanager.ExtHandler.removeHandler. Remove a sub-handler from this handler.
public void	setCallerCalculationRequired(final boolean `true` if the caller information should always be calculated before the record is being placed in the queue callerCalculationRequired) Sets whether or not caller information will be required when formatting records.
public Handler[]	setHandlers(final Handler[] the new sub-handlers newHandlers) Overrides org.jboss.logmanager.ExtHandler.setHandlers. A convenience method to atomically get and replace the sub-handler array.

Field Detail

activated	back to summary
private volatile boolean activated

callerCalculationRequired	back to summary
private volatile boolean callerCalculationRequired

logContext	back to summary
private final LogContext logContext

queueLimit	back to summary
private final int queueLimit

queues	back to summary
private final Map<Level, Deque<ExtLogRecord>> queues

warnThreshold	back to summary
private final Level warnThreshold

Constructor Detail

DelayedHandler	back to summary
public DelayedHandler() Construct a new instance.

DelayedHandler back to summary

DelayedHandler	back to summary
public DelayedHandler(LogContext logContext) Construct a new instance, with the given log context used to recheck log levels on replay. Parameters logContext:LogContext the log context to use for level checks on replay, or `null` for none

public DelayedHandler(LogContext logContext)

Construct a new instance, with the given log context used to recheck log levels on replay.

Parameters

logContext:LogContext: the log context to use for level checks on replay, or null for none

DelayedHandler	back to summary
public DelayedHandler(int queueLimit) Construct a new instance. The given queue limit value is used to limit the length of each level queue. Parameters queueLimit:int the queue limit

DelayedHandler

back to summary

public DelayedHandler(int queueLimit)

Construct a new instance. The given queue limit value is used to limit the length of each level queue.

Parameters

queueLimit:int: the queue limit

DelayedHandler back to summary

DelayedHandler	back to summary
public DelayedHandler(LogContext logContext, int queueLimit) Construct a new instance, with the given log context used to recheck log levels on replay. The given queue limit value is used to limit the length of each level queue. Parameters logContext:LogContext the log context to use for level checks on replay, or `null` for none queueLimit:int the queue limit

public DelayedHandler(LogContext logContext, int queueLimit)

Construct a new instance, with the given log context used to recheck log levels on replay. The given queue limit value is used to limit the length of each level queue.

Parameters

logContext:LogContext: the log context to use for level checks on replay, or null for none
queueLimit:int: the queue limit

DelayedHandler	back to summary
public DelayedHandler(int queueLimit, Level warnThreshold) Construct a new instance. The given queue limit value is used to limit the length of each level queue. The warning threshold specifies that only queues with the threshold level or higher will report overrun errors. Parameters queueLimit:int the queue limit warnThreshold:Level the threshold level to report queue overruns for

DelayedHandler

back to summary

public DelayedHandler(int queueLimit, Level warnThreshold)

Construct a new instance. The given queue limit value is used to limit the length of each level queue. The warning threshold specifies that only queues with the threshold level or higher will report overrun errors.

Parameters

queueLimit:int: the queue limit
warnThreshold:Level: the threshold level to report queue overruns for

DelayedHandler back to summary

DelayedHandler	back to summary
public DelayedHandler(LogContext logContext, int queueLimit, Level warnThreshold) Construct a new instance, with the given log context used to recheck log levels on replay. The given queue limit value is used to limit the length of each level queue. The warning threshold specifies that only queues with the threshold level or higher will report overrun errors. Parameters logContext:LogContext the log context to use for level checks on replay, or `null` for none queueLimit:int the queue limit warnThreshold:Level the threshold level to report queue overruns for

public DelayedHandler(LogContext logContext, int queueLimit, Level warnThreshold)

Construct a new instance, with the given log context used to recheck log levels on replay. The given queue limit value is used to limit the length of each level queue. The warning threshold specifies that only queues with the threshold level or higher will report overrun errors.

Parameters

logContext:LogContext: the log context to use for level checks on replay, or null for none
queueLimit:int: the queue limit
warnThreshold:Level: the threshold level to report queue overruns for

Method Detail

activate	back to summary
private void activate()

addHandler back to summary

addHandler	back to summary
public void addHandler(final Handler handler) throws SecurityException Overrides org.jboss.logmanager.ExtHandler.addHandler. Doc from org.jboss.logmanager.ExtHandler.addHandler. Add a sub-handler to this handler. Some handler types do not utilize sub-handlers. Note that once this is invoked the handler will be activated and the messages will no longer be queued. If more than one child handler is required the `setHandlers(Handler[])` should be used. Parameters handler:Handler the handler to add Annotations @Override Exceptions SecurityException: if a security manager exists and if the caller does not have `LoggingPermission(control)` See Also `setHandlers(Handler[])`

public void addHandler(final Handler handler) throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.addHandler.

Doc from org.jboss.logmanager.ExtHandler.addHandler.

Add a sub-handler to this handler. Some handler types do not utilize sub-handlers.

Note that once this is invoked the handler will be activated and the messages will no longer be queued. If more than one child handler is required the setHandlers(Handler[]) should be used.

Parameters

handler:Handler: the handler to add

Annotations

@Override

Exceptions

SecurityException:: if a security manager exists and if the caller does not have LoggingPermission(control)

See Also

setHandlers(Handler[])

clearHandlers back to summary

clearHandlers	back to summary
public Handler[] clearHandlers() throws SecurityException Overrides org.jboss.logmanager.ExtHandler.clearHandlers. Doc from org.jboss.logmanager.ExtHandler.clearHandlers. A convenience method to atomically get and clear all sub-handlers. Note that once this is invoked the handler will no longer be activated and messages will again be queued. Returns:Handler[] the old sub-handler array Annotations @Override Exceptions SecurityException: if a security manager exists and if the caller does not have `LoggingPermission(control)` See Also `removeHandler(Handler)`

public Handler[] clearHandlers() throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.clearHandlers.

Doc from org.jboss.logmanager.ExtHandler.clearHandlers.

A convenience method to atomically get and clear all sub-handlers.

Note that once this is invoked the handler will no longer be activated and messages will again be queued.

Returns:Handler[]

the old sub-handler array

Annotations

@Override

Exceptions

SecurityException:: if a security manager exists and if the caller does not have LoggingPermission(control)

See Also

removeHandler(Handler)

close back to summary

close	back to summary
public final void close() throws SecurityException Overrides org.jboss.logmanager.ExtHandler.close. Implements java.lang.AutoCloseable.close. Doc from org.jboss.logmanager.ExtHandler.close. Close all child handlers. Annotations @Override Exceptions SecurityException: Doc from java.util.logging.Handler.close. if a security manager exists and if the caller does not have `LoggingPermission("control")`.

public final void close() throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.close.

Implements java.lang.AutoCloseable.close.

Doc from org.jboss.logmanager.ExtHandler.close.

Close all child handlers.

Annotations

@Override

Exceptions

SecurityException:

Doc from java.util.logging.Handler.close.

if a security manager exists and if the caller does not have LoggingPermission("control").

doPublish back to summary

doPublish	back to summary
protected void doPublish(final ExtLogRecord record) Overrides org.jboss.logmanager.ExtHandler.doPublish. Doc from org.jboss.logmanager.ExtHandler.doPublish. Do the actual work of publication; the record will have been filtered already. The default implementation does nothing except to flush if the `autoFlush` property is set to `true`; if this behavior is to be preserved in a subclass then this method should be called after the record is physically written. Parameters record:ExtLogRecord the log record to publish Annotations @Override

protected void doPublish(final ExtLogRecord record)

Overrides org.jboss.logmanager.ExtHandler.doPublish.

Doc from org.jboss.logmanager.ExtHandler.doPublish.

Do the actual work of publication; the record will have been filtered already. The default implementation does nothing except to flush if the autoFlush property is set to true; if this behavior is to be preserved in a subclass then this method should be called after the record is physically written.

Parameters

record:ExtLogRecord: the log record to publish

Annotations

@Override

drain	back to summary
private Supplier<ExtLogRecord> drain()

enqueueOrdered	back to summary
private void enqueueOrdered(Deque<ExtLogRecord> q, ExtLogRecord record) Enqueue the log record such that the queue's order (by sequence number) is maintained. Parameters q:Deque<ExtLogRecord> the queue record:ExtLogRecord the record

enqueueOrdered

back to summary

private void enqueueOrdered(Deque<ExtLogRecord> q, ExtLogRecord record)

Enqueue the log record such that the queue's order (by sequence number) is maintained.

Parameters

q:Deque<ExtLogRecord>: the queue
record:ExtLogRecord: the record

isActivated back to summary

isActivated	back to summary
public final boolean isActivated() Indicates whether or not this handler has been activated. Returns:boolean `true` if the handler has been activated, otherwise `false`

public final boolean isActivated()

Indicates whether or not this handler has been activated.

Returns:boolean: true if the handler has been activated, otherwise false

isCallerCalculationRequired back to summary

isCallerCalculationRequired	back to summary
public boolean isCallerCalculationRequired() Overrides org.jboss.logmanager.ExtHandler.isCallerCalculationRequired. Doc from org.jboss.logmanager.ExtHandler.isCallerCalculationRequired. Indicates whether or not the formatter associated with this handler or a formatter from a child handler requires the caller to be calculated. Calculating the caller on a log record can be an expensive operation. Some handlers may be required to copy some data from the log record, but may not need the caller information. If the formatter is a `ExtFormatter` the `ExtFormatter#isCallerCalculationRequired()` is used to determine if calculation of the caller is required. This can be overridden to always require the caller calculation by setting the `setCallerCalculationRequired(boolean)` value to `true`. Returns:boolean `true` if the caller should be calculated, otherwise `false` if it can be skipped Annotations @Override See Also `setCallerCalculationRequired(boolean)`

public boolean isCallerCalculationRequired()

Overrides org.jboss.logmanager.ExtHandler.isCallerCalculationRequired.

Doc from org.jboss.logmanager.ExtHandler.isCallerCalculationRequired.

Indicates whether or not the formatter associated with this handler or a formatter from a child handler requires the caller to be calculated.

Calculating the caller on a log record can be an expensive operation. Some handlers may be required to copy some data from the log record, but may not need the caller information. If the formatter is a ExtFormatter the ExtFormatter#isCallerCalculationRequired() is used to determine if calculation of the caller is required.

This can be overridden to always require the caller calculation by setting the setCallerCalculationRequired(boolean) value to true.

Returns:boolean

true if the caller should be calculated, otherwise false if it can be skipped

Annotations

@Override

See Also

setCallerCalculationRequired(boolean)

newDeque	back to summary
private static <E> Deque<E> newDeque(Object ignored)

removeHandler back to summary

removeHandler	back to summary
public void removeHandler(final Handler handler) throws SecurityException Overrides org.jboss.logmanager.ExtHandler.removeHandler. Doc from org.jboss.logmanager.ExtHandler.removeHandler. Remove a sub-handler from this handler. Some handler types do not utilize sub-handlers. Note that if the last child handler is removed the handler will no longer be activated and the messages will again be queued. Parameters handler:Handler the handler to remove Annotations @Override Exceptions SecurityException: if a security manager exists and if the caller does not have `LoggingPermission(control)` See Also `clearHandlers()`

public void removeHandler(final Handler handler) throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.removeHandler.

Doc from org.jboss.logmanager.ExtHandler.removeHandler.

Remove a sub-handler from this handler. Some handler types do not utilize sub-handlers.

Note that if the last child handler is removed the handler will no longer be activated and the messages will again be queued.

Parameters

handler:Handler: the handler to remove

Annotations

@Override

Exceptions

SecurityException:: if a security manager exists and if the caller does not have LoggingPermission(control)

See Also

clearHandlers()

setCallerCalculationRequired back to summary

setCallerCalculationRequired	back to summary
public void setCallerCalculationRequired(final boolean callerCalculationRequired) Sets whether or not caller information will be required when formatting records. If set to `true` the caller information will be calculated for each record that is placed in the queue. A value of `false` means the `super#isCallerCalculationRequired()` will be used. Note that the caller information is only attempted to be calculated when the handler has not been activated. Once activated it's up to the children handlers to determine how the record is processed. Parameters callerCalculationRequired:boolean `true` if the caller information should always be calculated before the record is being placed in the queue

public void setCallerCalculationRequired(final boolean callerCalculationRequired)

Sets whether or not caller information will be required when formatting records.

If set to true the caller information will be calculated for each record that is placed in the queue. A value of false means the super#isCallerCalculationRequired() will be used.

Note that the caller information is only attempted to be calculated when the handler has not been activated. Once activated it's up to the children handlers to determine how the record is processed.

Parameters

callerCalculationRequired:boolean: true if the caller information should always be calculated before the record is being placed in the queue

setHandlers back to summary

setHandlers	back to summary
public Handler[] setHandlers(final Handler[] newHandlers) throws SecurityException Overrides org.jboss.logmanager.ExtHandler.setHandlers. Doc from org.jboss.logmanager.ExtHandler.setHandlers. A convenience method to atomically get and replace the sub-handler array. Note that once this is invoked the handler will be activated and the messages will no longer be queued. Parameters newHandlers:Handler[] the new sub-handlers Returns:Handler[] the old sub-handler array Annotations @Override Exceptions SecurityException: if a security manager exists and if the caller does not have `LoggingPermission(control)`

public Handler[] setHandlers(final Handler[] newHandlers) throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.setHandlers.

Doc from org.jboss.logmanager.ExtHandler.setHandlers.

A convenience method to atomically get and replace the sub-handler array.

Note that once this is invoked the handler will be activated and the messages will no longer be queued.

Parameters

newHandlers:Handler[]: the new sub-handlers

Returns:Handler[]

the old sub-handler array

Annotations

@Override

Exceptions

SecurityException:: if a security manager exists and if the caller does not have LoggingPermission(control)

public Class DelayedHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail