Package org.apache.log4j.varia
Class SoundAppender
- java.lang.Object
-
- org.apache.log4j.AppenderSkeleton
-
- org.apache.log4j.varia.SoundAppender
-
- All Implemented Interfaces:
org.apache.log4j.Appender
,org.apache.log4j.spi.OptionHandler
public final class SoundAppender extends org.apache.log4j.AppenderSkeleton
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.
-
-
Constructor Summary
Constructors Constructor Description SoundAppender()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activateOptions()
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()
java.lang.String
getAudioURL()
Accessorboolean
requiresLayout()
Gets whether appender requires a layout.void
setAudioURL(java.lang.String audioURL)
Mutator - common format for a file-based url: file:///c:/path/someaudioclip.wav
-
-
-
Method Detail
-
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
public java.lang.String getAudioURL()
Accessor- Returns:
- audio file
-
setAudioURL
public void setAudioURL(java.lang.String audioURL)
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
-
-