Class DatagramOutputTarget

java.lang.Object

org.apache.log.output.AbstractTarget

org.apache.log.output.AbstractOutputTarget

org.apache.log.output.net.DatagramOutputTarget

All Implemented Interfaces:

ErrorAware, LogTarget, Closeable

public class DatagramOutputTarget
extends AbstractOutputTarget

A datagram output target. Useful for writing using custom protocols or writing to syslog daemons.

Author:

Avalon Development Team, Peter Donald

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DEFAULT_ENCODING	Default encoding of datagram
private String	m_encoding	The encoding to use when creating byte array from string
private DatagramSocket	m_socket	Socket on which to send datagrams

Constructor Summary

Constructors

Constructor	Description
DatagramOutputTarget(InetAddress address, int port)	Create a output target with end point specified by address and port.
DatagramOutputTarget(InetAddress address, int port, Formatter formatter)	Create a output target with end point specified by address and port.
DatagramOutputTarget(InetAddress address, int port, Formatter formatter, String encoding)	Create a output target with end point specified by address and port.

Method Summary

Modifier and Type	Method	Description
void	close()	Shutdown target.
protected void	write(String stringData)	Method to write output to datagram.

Methods inherited from class AbstractOutputTarget

doProcessEvent, getFormatter, open

Methods inherited from class AbstractTarget

getErrorHandler, isOpen, processEvent, setErrorHandler

Methods inherited from class Object

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

Field Details

DEFAULT_ENCODING

private static final String DEFAULT_ENCODING

Default encoding of datagram

See Also:

• Constant Field Values

m_socket

private DatagramSocket m_socket

Socket on which to send datagrams

m_encoding

private String m_encoding

The encoding to use when creating byte array from string

Constructor Details

DatagramOutputTarget

public DatagramOutputTarget(InetAddress address,
 int port,
 Formatter formatter,
 String encoding)
                     throws IOException

Create a output target with end point specified by address and port.

Parameters:

address - the address endpoint

port - the address port

formatter - the message formatter

encoding - the encoding to use when encoding string

Throws:

IOException - if an error occurs

DatagramOutputTarget

public DatagramOutputTarget(InetAddress address,
 int port,
 Formatter formatter)
                     throws IOException

Create a output target with end point specified by address and port.

Parameters:

address - the address endpoint

port - the address port

formatter - the message formatter

Throws:

IOException - if an error occurs

DatagramOutputTarget

public DatagramOutputTarget(InetAddress address,
 int port)
                     throws IOException

Create a output target with end point specified by address and port.

Parameters:

address - the address endpoint

port - the address port

Throws:

IOException - if an error occurs

Method Details

write

protected void write(String stringData)

Method to write output to datagram.

Overrides:

write in class AbstractOutputTarget

Parameters:

stringData - the data to be output

close

public void close()

Shutdown target. Attempting to write to target after close() will cause errors to be logged.

Specified by:

close in interface Closeable

Overrides:

close in class AbstractOutputTarget