Class MulticastReceiver

java.lang.Object

org.apache.log4j.component.spi.ComponentBase

org.apache.log4j.component.plugins.PluginSkeleton

org.apache.log4j.component.plugins.Receiver

org.apache.log4j.receivers.net.MulticastReceiver

All Implemented Interfaces:

Pauseable, Plugin, Component, Thresholdable, AddressBased, NetworkBased, PortBased, org.apache.log4j.spi.OptionHandler

public class MulticastReceiver
extends Receiver
implements PortBased, AddressBased, Pauseable

Multicast-based receiver. Accepts LoggingEvents encoded using MulticastAppender and XMLLayout. The the XML data is converted back to a LoggingEvent and is posted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	MulticastReceiver.MulticastHandlerThread
(package private) class	MulticastReceiver.MulticastReceiverThread

Field Summary

Fields

Modifier and Type	Field	Description
private String	address
private boolean	advertiseViaMulticastDNS
private String	decoder
private Decoder	decoderImpl
private String	encoding
private MulticastReceiver.MulticastHandlerThread	handlerThread
private static final int	PACKET_LENGTH
private boolean	paused
private int	port
private MulticastReceiver.MulticastReceiverThread	receiverThread
private MulticastSocket	socket
private org.apache.log4j.net.ZeroConfSupport	zeroConf
static final String	ZONE	The MulticastDNS zone advertised by a MulticastReceiver

Fields inherited from class Receiver

thresholdLevel

Fields inherited from class PluginSkeleton

active, name

Fields inherited from class ComponentBase

repository

Constructor Summary

Constructors

Constructor	Description
MulticastReceiver()

Method Summary

Modifier and Type	Method	Description
void	activateOptions()
String	getAddress()	Returns a String representation of the Address this instance encompasses.
String	getDecoder()
String	getEncoding()	Returns value of the Encoding option.
int	getPort()	Returns the Port # that this net based thing is using.
boolean	isAdvertiseViaMulticastDNS()
boolean	isPaused()	Get paused state.
void	setAddress(String address)
void	setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)
void	setDecoder(String decoder)
void	setEncoding(String encoding)	The Encoding option specifies how the bytes are encoded.
void	setPaused(boolean b)	Set paused state.
void	setPort(int port)
void	shutdown()	Call when the plugin should be stopped.

Methods inherited from class Receiver

doPost, getThreshold, isAsSevereAsThreshold, setThreshold

Methods inherited from class PluginSkeleton

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getLoggerRepository, getName, isActive, isEquivalent, removePropertyChangeListener, removePropertyChangeListener, setLoggerRepository, setName

Methods inherited from class ComponentBase

getLogger, getNonFloodingLogger, resetErrorCount

Methods inherited from class Object

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

Methods inherited from interface NetworkBased

getName, isActive

Field Details

PACKET_LENGTH

private static final int PACKET_LENGTH

See Also:

• Constant Field Values

port

private int port

address

private String address

encoding

private String encoding

socket

private MulticastSocket socket

decoder

private String decoder

decoderImpl

private Decoder decoderImpl

handlerThread

private MulticastReceiver.MulticastHandlerThread handlerThread

receiverThread

private MulticastReceiver.MulticastReceiverThread receiverThread

paused

private boolean paused

advertiseViaMulticastDNS

private boolean advertiseViaMulticastDNS

zeroConf

private org.apache.log4j.net.ZeroConfSupport zeroConf

ZONE

public static final String ZONE

The MulticastDNS zone advertised by a MulticastReceiver

See Also:

• Constant Field Values

Constructor Details

MulticastReceiver

public MulticastReceiver()

Method Details

getDecoder

public String getDecoder()

setDecoder

public void setDecoder(String decoder)

getPort

public int getPort()

Description copied from interface: PortBased

Returns the Port # that this net based thing is using.

Specified by:

getPort in interface PortBased

Returns:

int port number

setPort

public void setPort(int port)

getAddress

public String getAddress()

Description copied from interface: AddressBased

Returns a String representation of the Address this instance encompasses.

Specified by:

getAddress in interface AddressBased

Returns:

String representation of the Address

setEncoding

public void setEncoding(String encoding)

The Encoding option specifies how the bytes are encoded. If this option is not specified, the system encoding will be used.

getEncoding

public String getEncoding()

Returns value of the Encoding option.

shutdown

public void shutdown()

Description copied from interface: Plugin

Call when the plugin should be stopped.

Specified by:

shutdown in interface Plugin

setAddress

public void setAddress(String address)

isPaused

public boolean isPaused()

Description copied from interface: Pauseable

Get paused state.

Specified by:

isPaused in interface Pauseable

Returns:

paused state.

setPaused

public void setPaused(boolean b)

Description copied from interface: Pauseable

Set paused state.

Specified by:

setPaused in interface Pauseable

Parameters:

b - new value

activateOptions

public void activateOptions()

Specified by:

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

setAdvertiseViaMulticastDNS

public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)

isAdvertiseViaMulticastDNS

public boolean isAdvertiseViaMulticastDNS()