Log4j Version 1.1.3: クラス SMTPAppender

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.apache.log4j.net
クラス SMTPAppender

java.lang.Object
  |
  +--org.apache.log4j.AppenderSkeleton
        |
        +--org.apache.log4j.net.SMTPAppender

すべての実装インタフェース:: Appender, OptionHandler

public class SMTPAppender
extends AppenderSkeleton

Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.

指定したロギングイベントが、一般的には、エラーまたは致命的エラー上で発生した時、電子メールを送信します。

The number of logging events delivered in this e-mail depend on the value of BufferSize option. The SMTPAppender keeps only the last BufferSize logging events in its cyclic buffer. This keeps memory requirements at a reasonable level while still delivering useful application context.

この電子メールに出力されるロギングイベントの数は、BufferSize オプションの値により決まります。 SMTPAppender は、循環バッファ内に最終的な BufferSizeのロギングイベントを保持します。これにより、有効なアプリケーションのコンテキストを書き込む間、納得のいくレベルでメモリを要求し続けます。

導入されたバージョン:: 1.0
作成者:: Ceki Gülcü

フィールドの概要

static String BUFFER_SIZE_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

protected CyclicBuffer cb


protected TriggeringEventEvaluator evaluator


static String EVALUATOR_CLASS_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

static String FROM_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

static String LOCATION_INFO_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

protected javax.mail.Message msg


static String SMTP_HOST_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

static String SUBJECT_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

static String TO_OPTION
          推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

クラス org.apache.log4j.AppenderSkeleton から継承したフィールド

closed, errorHandler, headFilter, layout, name, tailFilter, threshold, THRESHOLD_OPTION

コンストラクタの概要

SMTPAppender()
          The default constructor will instantiate the appender with a TriggeringEventEvaluator that will trigger on events with priority ERROR or higher.

SMTPAppender(TriggeringEventEvaluator evaluator)
          Use evaluator passed as parameter as the TriggeringEventEvaluator for this SMTPAppender.

メソッドの概要

void activateOptions()
          Activate the specified options, such as the smtp host, the recipient, from, etc.

void append(LoggingEvent event)
          Perform SMTPAppender specific appending actions, mainly adding the event to a cyclic buffer and checking if the event triggers an e-mail to be sent.

protected boolean checkEntryConditions()
          This method determines if there is a sense in attempting to append.

void close()
          Release any resources allocated within the appender such as file handles, network connections, etc.

int getBufferSize()
          Returns value of the BufferSize option.

String getEvaluatorClass()
          Returns value of the EvaluatorClass option.

String getFrom()
          Returns value of the From option.

boolean getLocationInfo()
          Returns value of the LocationInfo option.

String[] getOptionStrings()
          推奨されていません。 We now use JavaBeans introspection to configure components. Options strings are no longer needed.
今日、私たちは、コンポーネントの設定には、JavaBeansのイントロスペクションを使用します。オプション文字列は、もう必要ありません。

String getSMTPHost()
          Returns value of the SMTPHost option.

String getSubject()
          Returns value of the Subject option.

String getTo()
          Returns value of the To option.

boolean requiresLayout()
          The SMTPAppender requires a layout.

protected void sendBuffer()
          Send the contents of the cyclic buffer as an e-mail message.

void setBufferSize(int bufferSize)
          The BufferSize option takes a positive integer representing the maximum number of logging events to collect in a cyclic buffer.

void setEvaluatorClass(String value)
          The EvaluatorClass option takes a string value representing the name of the class implementing the TriggeringEventEvaluator interface.

void setFrom(String from)
          The From option takes a string value which should be a e-mail address of the sender.

void setLocationInfo(boolean locationInfo)
          The LocationInfo option takes a boolean value.

void setOption(String option, String value)
          Set option to value.

void setSMTPHost(String smtpHost)
          The SMTPHost option takes a string value which should be a the host name of the SMTP server that will send the e-mail message.

void setSubject(String subject)
          The Subject option takes a string value which should be a the subject of the e-mail message.

void setTo(String to)
          The To option takes a string value which should be a comma separated list of e-mail address of the recipients.

クラス 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

フィールドの詳細

cb

protected CyclicBuffer cb

msg

protected javax.mail.Message msg

TO_OPTION

public static final String TO_OPTION

推奨されていません。 Options are now handled using the JavaBeans paradigm. This constant will be removed in the near term.
今日、オプションは、JavaBeansパラダイムを使用して処理されます。この定数は、近いうちに削除されるでしょう。

A string constant used in naming the To field of outgoing e-mail output file. Current value of this string constant is To.

送信する電子メールの出力ファイルのToフィールドを指定する時に使用される文字列定数です。この文字列定数の現在の値は、Toです。

Note that all option keys are case sensitive.