org.apache.log4j.net
クラス MulticastAppender

java.lang.Object
  上位を拡張 org.apache.log4j.AppenderSkeleton
      上位を拡張 org.apache.log4j.net.MulticastAppender
すべての実装されたインタフェース:
org.apache.log4j.Appender, NetworkBased, PortBased, org.apache.log4j.spi.OptionHandler

public class MulticastAppender
extends org.apache.log4j.AppenderSkeleton
implements PortBased

Multicast-based Appender. Works in conjunction with the MulticastReceiver, which expects a LoggingEvent encoded using XMLLayout. Sends log information as a multicast datagrams.

Messages are not sent as LoggingEvent objects but as text after applying XMLLayout.

The port and remoteHost properties can be set in configuration properties. By setting the remoteHost to a broadcast address any number of clients can listen for log messages.

This was inspired and really extended/copied from SocketAppender. Please see the docs for the proper credit to the authors of that class.

作成者:
Kevin Brown, Scott Deboy

フィールドの概要
static java.lang.String ZONE
          The MulticastDNS zone advertised by a MulticastAppender the MulticastAppender also adds a 'multicastAddress' property with the multicast address value as a string
 
クラス org.apache.log4j.AppenderSkeleton から継承されたフィールド
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
 
コンストラクタの概要
MulticastAppender()
           
 
メソッドの概要
 void activateOptions()
          Open the multicast sender for the RemoteHost and Port.
 void append(org.apache.log4j.spi.LoggingEvent event)
           
 void cleanUp()
          Close the Socket and release the underlying connector thread if it has been created
 void close()
          Close this appender.
 java.lang.String getApplication()
          Returns value of the App option.
 java.lang.String getEncoding()
          Returns value of the Encoding option.
 boolean getLocationInfo()
          Returns value of the LocationInfo option.
 int getPort()
          Returns value of the Port option.
 java.lang.String getRemoteHost()
          Returns value of the RemoteHost option.
 int getTimeToLive()
          Returns value of the Time to Live option.
 boolean isActive()
          Get if item is active.
 boolean isAdvertiseViaMulticastDNS()
           
 boolean requiresLayout()
          Gets whether appender requires a layout.
 void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)
           
 void setApplication(java.lang.String app)
          The App option takes a string value which should be the name of the application getting logged.
 void setEncoding(java.lang.String encoding)
          The Encoding option specifies how the bytes are encoded.
 void setLocationInfo(boolean locationInfo)
          The LocationInfo option takes a boolean value.
 void setPort(int port)
          The Port option takes a positive integer representing the port where multicast packets will be sent.
 void setRemoteHost(java.lang.String host)
          The RemoteHost option takes a string value which should be the host name or ipaddress to send the multicast packets.
 void setTimeToLive(int timeToLive)
          The Time to live option takes a positive integer representing the time to live value.
 
クラス org.apache.log4j.AppenderSkeleton から継承されたメソッド
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
 
クラス java.lang.Object から継承されたメソッド
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース org.apache.log4j.net.NetworkBased から継承されたメソッド
getName
 

フィールドの詳細

ZONE

public static final java.lang.String ZONE
The MulticastDNS zone advertised by a MulticastAppender the MulticastAppender also adds a 'multicastAddress' property with the multicast address value as a string

関連項目:
定数フィールド値
コンストラクタの詳細

MulticastAppender

public MulticastAppender()
メソッドの詳細

activateOptions

public void activateOptions()
Open the multicast sender for the RemoteHost and Port.

定義:
インタフェース org.apache.log4j.spi.OptionHandler 内の activateOptions
オーバーライド:
クラス org.apache.log4j.AppenderSkeleton 内の activateOptions

close

public void close()
Close this appender.

This will mark the appender as closed and call then cleanUp() method.

定義:
インタフェース org.apache.log4j.Appender 内の close

cleanUp

public void cleanUp()
Close the Socket and release the underlying connector thread if it has been created


append

public void append(org.apache.log4j.spi.LoggingEvent event)
定義:
クラス org.apache.log4j.AppenderSkeleton 内の append

setRemoteHost

public void setRemoteHost(java.lang.String host)
The RemoteHost option takes a string value which should be the host name or ipaddress to send the multicast packets.


getRemoteHost

public java.lang.String getRemoteHost()
Returns value of the RemoteHost option.


setLocationInfo

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.


getLocationInfo

public boolean getLocationInfo()
Returns value of the LocationInfo option.


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 is used.


getEncoding

public java.lang.String getEncoding()
Returns value of the Encoding option.


setApplication

public void setApplication(java.lang.String app)
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.


getApplication

public java.lang.String getApplication()
Returns value of the App option.


setTimeToLive

public void setTimeToLive(int timeToLive)
The Time to live option takes a positive integer representing the time to live value.


getTimeToLive

public int getTimeToLive()
Returns value of the Time to Live option.


setPort

public void setPort(int port)
The Port option takes a positive integer representing the port where multicast packets will be sent.


getPort

public int getPort()
Returns value of the Port option.

定義:
インタフェース PortBased 内の getPort
戻り値:
int port number

isActive

public boolean isActive()
インタフェース NetworkBased の記述:
Get if item is active.

定義:
インタフェース NetworkBased 内の isActive
戻り値:
if true, item is active.

requiresLayout

public boolean requiresLayout()
Gets whether appender requires a layout.

定義:
インタフェース org.apache.log4j.Appender 内の requiresLayout
戻り値:
false

isAdvertiseViaMulticastDNS

public boolean isAdvertiseViaMulticastDNS()

setAdvertiseViaMulticastDNS

public void setAdvertiseViaMulticastDNS(boolean advertiseViaMulticastDNS)


Copyright © 2010 Apache Software Foundation. All Rights Reserved.