org.olat.instantMessaging
Class IMAppender

java.lang.Object
  org.apache.log4j.AppenderSkeleton
      org.olat.instantMessaging.IMAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class IMAppender
extends org.apache.log4j.AppenderSkeleton

IMAppender appends logging requests through instant messaging network.

Author:

Rafael Luque & Ruth Zamorano

Constructor Summary

IMAppender()
The default constructor will instantiate the appender with a default TriggeringEventEvaluator that will trigger on events with level ERROR or higher.

IMAppender(org.apache.log4j.spi.TriggeringEventEvaluator evaluator)

Method Summary

void	activateOptions() Options are activated and become effective only after calling this method.
void	append(org.apache.log4j.spi.LoggingEvent event) This method called by AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)method does most of the real appending work.
void	close() Close this IMAppender.
int	getBufferSize()
java.lang.String	getEvaluatorClass()
java.lang.String	getHost()
java.lang.String	getNickname()
java.lang.String	getPassword()
int	getPort()
java.lang.String	getRecipients()
java.lang.String	getUsername()
boolean	isChatroom()
boolean	requiresLayout() The IMAppender requires a layout.
void	setBufferSize(int bufferSize)
void	setChatroom(boolean chatroom)
void	setEvaluatorClass(java.lang.String value) The EvaluatorClass option takes a string value representing the name of the class implementing the interface.
void	setHost(java.lang.String host)
void	setNickname(java.lang.String nickname)
void	setPassword(java.lang.String password)
void	setPort(int port)
void	setRecipients(java.lang.String recipients)
void	setUsername(java.lang.String username)

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

IMAppender

public IMAppender()

The default constructor will instantiate the appender with a default TriggeringEventEvaluator that will trigger on events with level ERROR or higher.

IMAppender

public IMAppender(org.apache.log4j.spi.TriggeringEventEvaluator evaluator)

Method Detail

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getRecipients

public java.lang.String getRecipients()

setRecipients

public void setRecipients(java.lang.String recipients)

isChatroom

public boolean isChatroom()

setChatroom

public void setChatroom(boolean chatroom)

getNickname

public java.lang.String getNickname()

setNickname

public void setNickname(java.lang.String nickname)

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int bufferSize)

setEvaluatorClass

public void setEvaluatorClass(java.lang.String value)

The EvaluatorClass option takes a string value representing the name of the class implementing the interface. A corresponding object will be instantiated and assigned as the triggering event evaluator for the SMTPAppender.

getEvaluatorClass

public java.lang.String getEvaluatorClass()

activateOptions

public void activateOptions()

Options are activated and become effective only after calling this method.

Specified by:

activateOptions in interface org.apache.log4j.spi.OptionHandler

Overrides:

activateOptions in class org.apache.log4j.AppenderSkeleton

close

public void close()

Close this IMAppender. Closing all resources used by the appender. A closed appender cannot be re-opened.

Specified by:

close in interface org.apache.log4j.Appender

Specified by:

close in class org.apache.log4j.AppenderSkeleton

append

public void append(org.apache.log4j.spi.LoggingEvent event)

This method called by AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)method does most of the real appending work. Adds the event to a buffer and checks if the event triggers a message to be sent.

Specified by:

append in class org.apache.log4j.AppenderSkeleton

requiresLayout

public boolean requiresLayout()

The IMAppender requires a layout. Hence, this method returns true.

Specified by:

requiresLayout in interface org.apache.log4j.Appender

Specified by:

requiresLayout in class org.apache.log4j.AppenderSkeleton