org.apache.log4j.net

Class SocketAppender

Implemented Interfaces:
Appender, OptionHandler

public class SocketAppender
extends AppenderSkeleton

Sends LoggingEvent objects to a remote a log server, usually a SocketNode.

The SocketAppender has the following properties:

Author:
Ceki Gülcü
Since:
0.8.4

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

SocketAppender()
SocketAppender(InetAddress address, int port)
Connects to remote server at address and port.
SocketAppender(String host, int port)
Connects to remote server at host and port.

Method Summary

void
activateOptions()
Connect to the specified RemoteHost and Port.
void
append(LoggingEvent event)
Subclasses of AppenderSkeleton should implement this method to perform actual logging.
void
cleanUp()
Drop the connection to the remote host and release the underlying connector thread if it has been created
void
close()
Close this appender.
boolean
getLocationInfo()
Returns value of the LocationInfo option.
int
getPort()
Returns value of the Port option.
int
getReconnectionDelay()
Returns value of the ReconnectionDelay option.
String
getRemoteHost()
Returns value of the RemoteHost option.
boolean
requiresLayout()
The SocketAppender does not use a layout.
void
setLocationInfo(boolean locationInfo)
The LocationInfo option takes a boolean value.
void
setPort(int port)
The Port option takes a positive integer representing the port where the server is waiting for connections.
void
setReconnectionDelay(int delay)
The ReconnectionDelay option takes a positive integer representing the number of milliseconds to wait between each failed connection attempt to the server.
void
setRemoteHost(String host)
The RemoteHost option takes a string value which should be the host name of the server where a SocketNode is running.

Methods inherited from class org.apache.log4j.AppenderSkeleton

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

Constructor Details

SocketAppender

public SocketAppender()

SocketAppender

public SocketAppender(InetAddress address,
                      int port)
Connects to remote server at address and port.

SocketAppender

public SocketAppender(String host,
                      int port)
Connects to remote server at host and port.

Method Details

activateOptions

public void activateOptions()
Connect to the specified RemoteHost and Port.
Specified by:
activateOptions in interface OptionHandler
Overrides:
activateOptions in interface AppenderSkeleton

append

public void append(LoggingEvent event)
Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton.doAppend method.
Overrides:
append in interface AppenderSkeleton
Since:
0.9.0

cleanUp

public void cleanUp()
Drop the connection to the remote host and release the underlying connector thread if it has been created

close

public void close()
Specified by:
close in interface Appender

getLocationInfo

public boolean getLocationInfo()
Returns value of the LocationInfo option.

getPort

public int getPort()
Returns value of the Port option.

getReconnectionDelay

public int getReconnectionDelay()
Returns value of the ReconnectionDelay option.

getRemoteHost

public String getRemoteHost()
Returns value of the RemoteHost option.

requiresLayout

public boolean requiresLayout()
The SocketAppender does not use a layout. Hence, this method returns false.
Specified by:
requiresLayout in interface Appender

setLocationInfo

public void setLocationInfo(boolean locationInfo)
The LocationInfo option takes a boolean value. If true, the information sent to the remote host will include location information. By default no location information is sent to the server.

setPort

public void setPort(int port)
The Port option takes a positive integer representing the port where the server is waiting for connections.

setReconnectionDelay

public void setReconnectionDelay(int delay)
The ReconnectionDelay option takes a positive integer representing the number of milliseconds to wait between each failed connection attempt to the server. The default value of this option is 30000 which corresponds to 30 seconds.

Setting this option to zero turns off reconnection capability.


setRemoteHost

public void setRemoteHost(String host)

Copyright 2000-2005 Apache Software Foundation.