File	Doc	Category	Size	Date	Package
SocketAppender.java	API Doc	Apache log4j 1.2.15	12569	Sat Aug 25 00:09:40 BST 2007	org.apache.log4j.net

SocketAppender

• java.lang.Object
  • org.apache.log4j.AppenderSkeleton

Fields Summary
public static final int	DEFAULT_PORT The default port number of remote logging server (4560).
static final int	DEFAULT_RECONNECTION_DELAY The default reconnection delay (30000 milliseconds or 30 seconds).
String	remoteHost We remember host name as String in addition to the resolved InetAddress so that it can be returned via getOption().
InetAddress	address
int	port
ObjectOutputStream	oos
int	reconnectionDelay
boolean	locationInfo
private String	application
private Connector	connector
int	counter
private static final int	RESET_FREQUENCY

Constructors Summary
public SocketAppender()
public SocketAppender(InetAddress address, int port) Connects to remote server at address and port. this.address = address; this.remoteHost = address.getHostName(); this.port = port; connect(address, port);
public SocketAppender(String host, int port) Connects to remote server at host and port. this.port = port; this.address = getAddressByName(host); this.remoteHost = host; connect(address, port);

Methods Summary
public void	activateOptions() Connect to the specified RemoteHost and Port. connect(address, port);
public void	append(org.apache.log4j.spi.LoggingEvent event) if(event == null) return; if(address==null) { errorHandler.error("No remote host is set for SocketAppender named \""+ this.name+"\"."); return; } if(oos != null) { try { if(locationInfo) { event.getLocationInformation(); } if (application != null) { event.setProperty("application", application); } oos.writeObject(event); //LogLog.debug("=========Flushing."); oos.flush(); if(++counter >= RESET_FREQUENCY) { counter = 0; // Failing to reset the object output stream every now and // then creates a serious memory leak. //System.err.println("Doing oos.reset()"); oos.reset(); } } catch(IOException e) { oos = null; LogLog.warn("Detected problem with connection: "+e); if(reconnectionDelay > 0) { fireConnector(); } else { errorHandler.error("Detected problem with connection, not reconnecting.", e, ErrorCode.GENERIC_FAILURE); } } }
public void	cleanUp() Drop the connection to the remote host and release the underlying connector thread if it has been created if(oos != null) { try { oos.close(); } catch(IOException e) { LogLog.error("Could not close oos.", e); } oos = null; } if(connector != null) { //LogLog.debug("Interrupting the connector."); connector.interrupted = true; connector = null; // allow gc }
public synchronized void	close() Close this appender. This will mark the appender as closed and call then {@link #cleanUp} method. if(closed) return; this.closed = true; cleanUp();
void	connect(java.net.InetAddress address, int port) if(this.address == null) return; try { // First, close the previous connection if any. cleanUp(); oos = new ObjectOutputStream(new Socket(address, port).getOutputStream()); } catch(IOException e) { String msg = "Could not connect to remote log4j server at [" +address.getHostName()+"]."; if(reconnectionDelay > 0) { msg += " We will try again later."; fireConnector(); // fire the connector thread } else { msg += " We are not retrying."; errorHandler.error(msg, e, ErrorCode.GENERIC_FAILURE); } LogLog.error(msg); }
void	fireConnector() if(connector == null) { LogLog.debug("Starting a new connector thread."); connector = new Connector(); connector.setDaemon(true); connector.setPriority(Thread.MIN_PRIORITY); connector.start(); }
static java.net.InetAddress	getAddressByName(java.lang.String host) try { return InetAddress.getByName(host); } catch(Exception e) { LogLog.error("Could not find address of ["+host+"].", e); return null; }
public java.lang.String	getApplication() Returns value of the Application option. return application;
public boolean	getLocationInfo() Returns value of the LocationInfo option. return locationInfo;
public int	getPort() Returns value of the Port option. return port;
public int	getReconnectionDelay() Returns value of the ReconnectionDelay option. return reconnectionDelay;
public java.lang.String	getRemoteHost() Returns value of the RemoteHost option. return remoteHost;
public boolean	requiresLayout() The SocketAppender does not use a layout. Hence, this method returns false. return false;
public void	setApplication(java.lang.String lapp) The App option takes a string value which should be the name of the application getting logged. If property was already set (via system property), don't set here. this.application = lapp;
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. this.locationInfo = locationInfo;
public void	setPort(int port) The Port option takes a positive integer representing the port where the server is waiting for connections. this.port = port;
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. this.reconnectionDelay = delay;
public void	setRemoteHost(java.lang.String host) The RemoteHost option takes a string value which should be the host name of the server where a {@link SocketNode} is running. address = getAddressByName(host); remoteHost = host;