org.apache.log4j.net

Class SocketHubAppender

Implemented Interfaces:
Appender, OptionHandler

public class SocketHubAppender
extends AppenderSkeleton

Sends LoggingEvent objects to a set of remote log servers, usually a SocketNodes.

Acts just like SocketAppender except that instead of connecting to a given remote log server, SocketHubAppender accepts connections from the remote log servers as clients. It can accept more than one connection. When a log event is received, the event is sent to the set of currently connected remote log servers. Implemented this way it does not require any update to the configuration file to send data to another remote log server. The remote log server simply connects to the host and port the SocketHubAppender is running on.

The SocketHubAppender does not store events such that the remote side will events that arrived after the establishment of its connection. Once connected, events arrive in order as guaranteed by the TCP protocol.

This implementation borrows heavily from the SocketAppender.

The SocketHubAppender has the following characteristics:

Author:
Mark Womack

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

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

Constructor Summary

SocketHubAppender()
SocketHubAppender(int _port)
Connects to remote server at address and port.

Method Summary

void
activateOptions()
Set up the socket server on the specified port.
void
append(LoggingEvent event)
Append an event to all of current connections.
void
cleanUp()
Release the underlying ServerMonitor thread, and drop the connections to all connected remote servers.
void
close()
Close this appender.
boolean
getLocationInfo()
Returns value of the LocationInfo option.
int
getPort()
Returns value of the Port option.
boolean
requiresLayout()
The SocketHubAppender 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.

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

SocketHubAppender

public SocketHubAppender()

SocketHubAppender

public SocketHubAppender(int _port)
Connects to remote server at address and port.

Method Details

activateOptions

public void activateOptions()
Set up the socket server on the specified port.
Specified by:
activateOptions in interface OptionHandler
Overrides:
activateOptions in interface AppenderSkeleton

append

public void append(LoggingEvent event)
Append an event to all of current connections.
Overrides:
append in interface AppenderSkeleton

cleanUp

public void cleanUp()
Release the underlying ServerMonitor thread, and drop the connections to all connected remote servers.

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.

requiresLayout

public boolean requiresLayout()
The SocketHubAppender 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.

Copyright 2000-2005 Apache Software Foundation.