Package org.apache.log4j.extras
Class SoundAppender
java.lang.Object
org.apache.log4j.AppenderSkeleton
org.apache.log4j.extras.SoundAppender
- All Implemented Interfaces:
org.apache.log4j.Appender
,org.apache.log4j.spi.OptionHandler
public final class SoundAppender
extends org.apache.log4j.AppenderSkeleton
This class is equivalent to org.apache.log4j.varia.SoundAppender
except for a package change to aid in use with OSGi.
Plays a sound clip created using Applet.newAudioClip when an event is received.
If the audio format is not supported, a message stating the SoundAppender could
not be initialized is logged.
Use a filter in combination with this appender to control when the appender is
triggered.
For example, in the appender definition, include a LevelMatchFilter configured
to accept WARN or greater, followed by a DenyAllFilter.
-
Field Summary
FieldsFields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Attempt to initialize the appender by creating a reference to an AudioClip.protected void
append
(org.apache.log4j.spi.LoggingEvent event) Play the sound if an event is being processedvoid
close()
Accessorboolean
Gets whether appender requires a layout.void
setAudioURL
(String audioURL) Mutator - common format for a file-based url: file:///c:/path/someaudioclip.wavMethods inherited from class org.apache.log4j.AppenderSkeleton
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
-
Field Details
-
clip
-
audioURL
-
-
Constructor Details
-
SoundAppender
public SoundAppender()
-
-
Method Details
-
activateOptions
public void activateOptions()Attempt to initialize the appender by creating a reference to an AudioClip. Will log a message if format is not supported, file not found, etc.- Specified by:
activateOptions
in interfaceorg.apache.log4j.spi.OptionHandler
- Overrides:
activateOptions
in classorg.apache.log4j.AppenderSkeleton
-
getAudioURL
Accessor- Returns:
- audio file
-
setAudioURL
Mutator - common format for a file-based url: file:///c:/path/someaudioclip.wav- Parameters:
audioURL
-
-
append
protected void append(org.apache.log4j.spi.LoggingEvent event) Play the sound if an event is being processed- Specified by:
append
in classorg.apache.log4j.AppenderSkeleton
-
close
public void close() -
requiresLayout
public boolean requiresLayout()Gets whether appender requires a layout.- Returns:
- false
-