Log4j 1.3alpha-7

org.apache.log4j.varia
Class SoundAppender

java.lang.Object
  extended byorg.apache.log4j.spi.ComponentBase
      extended byorg.apache.log4j.AppenderSkeleton
          extended byorg.apache.log4j.varia.SoundAppender
All Implemented Interfaces:
Appender, Component, OptionHandler

public final class SoundAppender
extends 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.

Author:
Scott Deboy

Field Summary
 
Fields inherited from class org.apache.log4j.AppenderSkeleton
active, closed, headFilter, layout, name, tailFilter, threshold
 
Fields inherited from class org.apache.log4j.spi.ComponentBase
repository
 
Constructor Summary
SoundAppender()
           
 
Method Summary
 void activateOptions()
          Attempt to initialize the appender by creating a reference to an AudioClip.
protected  void append(LoggingEvent event)
          Play the sound if an event is being processed
 void close()
          Release any resources allocated within the appender such as file handles, network connections, etc.
 String getAudioURL()
          Accessor
 void setAudioURL(String audioURL)
          Mutator - common format for a file-based url: file:///c:/path/someaudioclip.wav
 
Methods inherited from class org.apache.log4j.AppenderSkeleton
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isActive, isAsSevereAsThreshold, isClosed, setErrorHandler, setLayout, setName, setThreshold
 
Methods inherited from class org.apache.log4j.spi.ComponentBase
getLogger, getLoggerRepository, getNonFloodingLogger, resetErrorCount, setLoggerRepository
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.log4j.Appender
setLoggerRepository
 

Constructor Detail

SoundAppender

public SoundAppender()
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 interface OptionHandler
Overrides:
activateOptions in class AppenderSkeleton

getAudioURL

public final String getAudioURL()
Accessor

Returns:
audio file

setAudioURL

public void setAudioURL(String audioURL)
Mutator - common format for a file-based url: file:///c:/path/someaudioclip.wav

Parameters:
audioURL -

append

protected void append(LoggingEvent event)
Play the sound if an event is being processed

Specified by:
append in class AppenderSkeleton

close

public void close()
Description copied from interface: Appender
Release any resources allocated within the appender such as file handles, network connections, etc.

It is a programming error to append to a closed appender.


Log4j 1.3alpha-7

Copyright 2000-2005 Apache Software Foundation.