Package org.apache.log4j.net
Class UDPReceiver
- java.lang.Object
-
- org.apache.log4j.spi.ComponentBase
-
- org.apache.log4j.plugins.PluginSkeleton
-
- org.apache.log4j.plugins.Receiver
-
- org.apache.log4j.net.UDPReceiver
-
- All Implemented Interfaces:
NetworkBased,PortBased,Pauseable,Plugin,Component,org.apache.log4j.spi.OptionHandler,Thresholdable
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.- Author:
- Scott Deboy <sdeboy@apache.org>
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanpausedstatic StringZONEThe MulticastDNS zone advertised by a UDPReceiver-
Fields inherited from class org.apache.log4j.plugins.Receiver
thresholdLevel
-
Fields inherited from class org.apache.log4j.plugins.PluginSkeleton
active, name
-
Fields inherited from class org.apache.log4j.spi.ComponentBase
repository
-
-
Constructor Summary
Constructors Constructor Description UDPReceiver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactivateOptions()Returns true if this receiver is active.StringgetDecoder()StringgetEncoding()Returns value of the Encoding option.intgetPort()Returns the Port # that this net based thing is using.booleanisAdvertiseViaMulticastDNS()booleanisPaused()Get paused state.voidsetAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)voidsetDecoder(String decoder)voidsetEncoding(String encoding)The Encoding option specifies how the bytes are encoded.voidsetPaused(boolean b)Set paused state.voidsetPort(int port)voidshutdown()Call when the plugin should be stopped.-
Methods inherited from class org.apache.log4j.plugins.Receiver
doPost, getThreshold, isAsSevereAsThreshold, setThreshold
-
Methods inherited from class org.apache.log4j.plugins.PluginSkeleton
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getLoggerRepository, getName, isActive, isEquivalent, removePropertyChangeListener, removePropertyChangeListener, setLoggerRepository, setName
-
Methods inherited from class org.apache.log4j.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.net.NetworkBased
getName, isActive
-
-
-
-
Field Detail
-
paused
protected boolean paused
-
ZONE
public static final String ZONE
The MulticastDNS zone advertised by a UDPReceiver- See Also:
- Constant Field Values
-
-
Method Detail
-
getPort
public int getPort()
Description copied from interface:PortBasedReturns the Port # that this net based thing is using.
-
setPort
public void setPort(int port)
-
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.
-
getDecoder
public String getDecoder()
-
setDecoder
public void setDecoder(String decoder)
-
isPaused
public boolean isPaused()
Description copied from interface:PauseableGet paused state.
-
setPaused
public void setPaused(boolean b)
Description copied from interface:PauseableSet paused state.
-
setAdvertiseViaMulticastDNS
public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)
-
isAdvertiseViaMulticastDNS
public boolean isAdvertiseViaMulticastDNS()
-
shutdown
public void shutdown()
Description copied from interface:PluginCall when the plugin should be stopped.
-
activateOptions
public void activateOptions()
Returns true if this receiver is active.- Specified by:
activateOptionsin interfaceorg.apache.log4j.spi.OptionHandler
-
-