Package org.apache.log4j.receivers.net
Class UDPReceiver
- 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.UDPReceiver
-
- All Implemented Interfaces:
Pauseable
,Plugin
,Component
,Thresholdable
,NetworkBased
,PortBased
,org.apache.log4j.spi.OptionHandler
public class UDPReceiver extends Receiver implements PortBased, Pauseable
Receive LoggingEvents encoded with an XMLLayout, convert the XML data to a LoggingEvent and post the LoggingEvent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
UDPReceiver.UDPHandlerThread
(package private) class
UDPReceiver.UDPReceiverThread
-
Field Summary
Fields Modifier and Type Field Description private boolean
advertiseViaMulticastDNS
private boolean
closed
private java.lang.String
decoder
private Decoder
decoderImpl
private java.lang.String
encoding
(package private) UDPReceiver.UDPHandlerThread
handlerThread
private static int
PACKET_LENGTH
protected boolean
paused
private int
port
private UDPReceiver.UDPReceiverThread
receiverThread
private java.net.DatagramSocket
socket
private org.apache.log4j.net.ZeroConfSupport
zeroConf
static java.lang.String
ZONE
The MulticastDNS zone advertised by a UDPReceiver-
Fields inherited from class org.apache.log4j.component.plugins.Receiver
thresholdLevel
-
Fields inherited from class org.apache.log4j.component.plugins.PluginSkeleton
active, name
-
Fields inherited from class org.apache.log4j.component.spi.ComponentBase
repository
-
-
Constructor Summary
Constructors Constructor Description UDPReceiver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activateOptions()
Returns true if this receiver is active.java.lang.String
getDecoder()
java.lang.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
setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)
void
setDecoder(java.lang.String decoder)
void
setEncoding(java.lang.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 org.apache.log4j.component.plugins.Receiver
doPost, getThreshold, isAsSevereAsThreshold, setThreshold
-
Methods inherited from class org.apache.log4j.component.plugins.PluginSkeleton
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getLoggerRepository, getName, isActive, isEquivalent, removePropertyChangeListener, removePropertyChangeListener, setLoggerRepository, setName
-
Methods inherited from class org.apache.log4j.component.spi.ComponentBase
getLogger, getNonFloodingLogger, resetErrorCount
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.log4j.receivers.net.NetworkBased
getName, isActive
-
-
-
-
Field Detail
-
PACKET_LENGTH
private static final int PACKET_LENGTH
- See Also:
- Constant Field Values
-
receiverThread
private UDPReceiver.UDPReceiverThread receiverThread
-
encoding
private java.lang.String encoding
-
decoder
private java.lang.String decoder
-
decoderImpl
private Decoder decoderImpl
-
paused
protected boolean paused
-
closed
private transient boolean closed
-
port
private int port
-
socket
private java.net.DatagramSocket socket
-
handlerThread
UDPReceiver.UDPHandlerThread handlerThread
-
advertiseViaMulticastDNS
private boolean advertiseViaMulticastDNS
-
zeroConf
private org.apache.log4j.net.ZeroConfSupport zeroConf
-
ZONE
public static final java.lang.String ZONE
The MulticastDNS zone advertised by a UDPReceiver- See Also:
- Constant Field Values
-
-
Method Detail
-
getPort
public int getPort()
Description copied from interface:PortBased
Returns the Port # that this net based thing is using.
-
setPort
public void setPort(int port)
-
setEncoding
public void setEncoding(java.lang.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 java.lang.String getEncoding()
Returns value of the Encoding option.
-
getDecoder
public java.lang.String getDecoder()
-
setDecoder
public void setDecoder(java.lang.String decoder)
-
isPaused
public boolean isPaused()
Description copied from interface:Pauseable
Get paused state.
-
setPaused
public void setPaused(boolean b)
Description copied from interface:Pauseable
Set paused state.
-
setAdvertiseViaMulticastDNS
public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)
-
isAdvertiseViaMulticastDNS
public boolean isAdvertiseViaMulticastDNS()
-
shutdown
public void shutdown()
Description copied from interface:Plugin
Call when the plugin should be stopped.
-
activateOptions
public void activateOptions()
Returns true if this receiver is active.- Specified by:
activateOptions
in interfaceorg.apache.log4j.spi.OptionHandler
-
-