nablarch.common.mail

クラス MailSender

java.lang.Object

nablarch.core.db.support.DbAccessSupport

nablarch.fw.action.BatchActionBase<D>

nablarch.fw.action.BatchAction<SqlRow>

nablarch.common.mail.MailSender

すべての実装されたインタフェース:

DataReaderFactory<SqlRow>, Handler<SqlRow,Result>, ExecutionHandlerCallback<CommandLine,Result>, TransactionEventCallback<SqlRow>

public class MailSender
extends BatchAction<SqlRow>

メール送信要求管理テーブル上の各レコードごとにメール送信を行うバッチアクション。

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.TransactionEventCallback

TransactionEventCallback.Provider<TData>

フィールドのサマリー

インタフェースから継承されたフィールド nablarch.fw.TransactionEventCallback

REQUEST_DATA_REQUEST_SCOPE_KEY

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MailSender() コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	addBodyContent(javax.mail.internet.MimeMessage mimeMessage, MailRequestTable.MailRequest mailRequest, java.util.List<? extends MailAttachedFileTable.MailAttachedFile> attachedFiles, ExecutionContext context) 指定されたMimeMessageにメールメッセージ本文（添付ファイル含む）を追加する。
protected void	containsInvalidCharacter(java.lang.String target, java.lang.String mailRequestId) メールヘッダ・インジェクションチェック チェック対象文字列に\rもしくは\nを含んでいるかのチェック。
protected javax.mail.internet.MimeMessage	createMimeMessage(SqlRow data, java.lang.String mailRequestId, MailRequestTable.MailRequest mailRequest, javax.mail.Session session, MailRecipientTable mailRecipientTable) メールデータを作成する。
DataReader<SqlRow>	createReader(ExecutionContext ctx) このタスクの入力データを読み込むデータリーダを生成して返す。
Result	handle(SqlRow data, ExecutionContext context) メール送信要求を元にメールを送信する。
protected Result	handleException(SqlRow data, ExecutionContext context, MailRequestTable.MailRequest mailRequest, MailConfig mailConfig, java.lang.Exception e) メール送信時の例外のハンドル処理を行う。
protected void	updateToFailed(SqlRow data, ExecutionContext context) 処理ステータスを異常終了に更新する。
protected void	updateToSuccess(SqlRow data, ExecutionContext context) 処理ステータスを正常終了に更新する。
protected void	writeCreateMailFailedLog(SqlRow data, MailRequestTable.MailRequest mailRequest, MailConfig mailConfig, javax.mail.MessagingException e) メール作成が失敗した場合に、障害検知ログに出力する。
protected void	writeSendMailFailedLog(SqlRow data, MailRequestTable.MailRequest mailRequest, MailConfig mailConfig, javax.mail.SendFailedException e) メール送信失敗時のSendFailedException例外の障害検知ログに出力する。

クラスから継承されたメソッド nablarch.fw.action.BatchActionBase

error, errorInExecution, initialize, postExecution, preExecution, terminate, transactionAbnormalEnd, transactionFailure, transactionNormalEnd, transactionSuccess, writeErrorLog, writeFatalLog, writeLog

クラスから継承されたメソッド nablarch.core.db.support.DbAccessSupport

countByParameterizedSql, countByStatementSql, getParameterizedSqlStatement, getParameterizedSqlStatement, getSqlCStatement, getSqlPStatement, search

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

MailSender

@Published(tag="architect")
public MailSender()

コンストラクタ。

メソッドの詳細

handle

public Result handle(SqlRow data,
                     ExecutionContext context)

メール送信要求を元にメールを送信する。

定義:

handle インタフェース内 Handler<SqlRow,Result>

定義:

handle クラス内 BatchAction<SqlRow>

パラメータ:

data - 入力データ（メール送信要求のレコード）

context - 実行コンテキスト

戻り値:

処理結果

handleException

@Published(tag="architect")
protected Result handleException(SqlRow data,
                                                             ExecutionContext context,
                                                             MailRequestTable.MailRequest mailRequest,
                                                             MailConfig mailConfig,
                                                             java.lang.Exception e)

メール送信時の例外のハンドル処理を行う。

本クラスでは、障害ログを出力し、送信ステータスを送信失敗にしてリトライを行う。 本メソッドでは、すべての例外をリトライ対象としてSendMailRetryableExceptionを送出している。 独自の処理を実施したい場合は本メソッドをオーバーライドすることで行うことができる。

パラメータ:

data - 入力データ（メール送信要求のレコード）

context - 実行コンテキスト

mailRequest - メール送信要求

mailConfig - メール設定

e - メール送信時の例外

戻り値:

handle(SqlRow, ExecutionContext) が返す処理結果

writeSendMailFailedLog

@Published(tag="architect")
protected void writeSendMailFailedLog(SqlRow data,
                                                                  MailRequestTable.MailRequest mailRequest,
                                                                  MailConfig mailConfig,
                                                                  javax.mail.SendFailedException e)

メール送信失敗時のSendFailedException例外の障害検知ログに出力する。

メール送信失敗時に、独自の処理を実施したい場合は本メソッドをオーバーライドすることで行うことができる。

パラメータ:

data - 入力データ（メール送信要求のレコード）

mailRequest - メール送信要求

mailConfig - メール設定

e - メール送信失敗時のSendFailedException例外

writeCreateMailFailedLog

@Published(tag="architect")
protected void writeCreateMailFailedLog(SqlRow data,
                                                                    MailRequestTable.MailRequest mailRequest,
                                                                    MailConfig mailConfig,
                                                                    javax.mail.MessagingException e)

メール作成が失敗した場合に、障害検知ログに出力する。

メール作成が失敗した時に、独自の処理を実施したい場合は本メソッドをオーバーライドすることで行うことができる。

パラメータ:

data - 入力データ（メール送信要求のレコード）

mailRequest - メール送信要求

mailConfig - メール設定

e - MessagingException

createMimeMessage

@Published(tag="architect")
protected javax.mail.internet.MimeMessage createMimeMessage(SqlRow data,
                                                                                        java.lang.String mailRequestId,
                                                                                        MailRequestTable.MailRequest mailRequest,
                                                                                        javax.mail.Session session,
                                                                                        MailRecipientTable mailRecipientTable)
                                                                                 throws javax.mail.MessagingException

メールデータを作成する。

パラメータ:

data - 入力データ（メール送信要求のレコード）

mailRequestId - メール送信要求ID

mailRequest - メール送信先情報

session - メールセッション

mailRecipientTable - メール送信先管理テーブルのスキーマ

戻り値:

メールデータ

例外:

javax.mail.MessagingException - メールメッセージの生成に失敗した場合

addBodyContent

@Published(tag="architect")
protected void addBodyContent(javax.mail.internet.MimeMessage mimeMessage,
                                                          MailRequestTable.MailRequest mailRequest,
                                                          java.util.List<? extends MailAttachedFileTable.MailAttachedFile> attachedFiles,
                                                          ExecutionContext context)
                                                   throws javax.mail.MessagingException

指定されたMimeMessageにメールメッセージ本文（添付ファイル含む）を追加する。

メッセージ本文を暗号化する場合や、電子署名を付加する場合には本メソッドをオーバライドし処理を本文の追加処理を変更すること。

パラメータ:

mimeMessage - MimeMessage

mailRequest - メール送信要求管理の情報

attachedFiles - 添付ファイルの情報

context - 実行コンテキスト

例外:

javax.mail.MessagingException - メールメッセージの生成に失敗した場合

containsInvalidCharacter

@Published(tag="architect")
protected void containsInvalidCharacter(java.lang.String target,
                                                                    java.lang.String mailRequestId)
                                                             throws InvalidCharacterException

メールヘッダ・インジェクションチェック
チェック対象文字列に\rもしくは\nを含んでいるかのチェック。

チェック内容を変更する場合や、チェック結果の振る舞いを変更する場合には本メソッドをオーバライドし処理をチェック処理を変更すること。

パラメータ:

target - チェック対象文字列

mailRequestId - メール送信要求ID

例外:

InvalidCharacterException - チェック対象文字列に\rもしくは\nを含んでいた場合

createReader

@Published(tag="architect")
public DataReader<SqlRow> createReader(ExecutionContext ctx)

このタスクの入力データを読み込むデータリーダを生成して返す。 メール送信要求を読み込むDatabaseRecordReaderを生成する。

定義:

createReader インタフェース内 DataReaderFactory<SqlRow>

定義:

createReader クラス内 BatchAction<SqlRow>

パラメータ:

ctx - 実行コンテキスト

戻り値:

データリーダ

updateToFailed

@Published(tag="architect")
protected void updateToFailed(SqlRow data,
                                                          ExecutionContext context)

処理ステータスを異常終了に更新する。

更新時に例外が発生した場合は、ProcessAbnormalEndを送出する。

パラメータ:

data - 送信対象データ

context - 実行コンテキスト

updateToSuccess

@Published(tag="architect")
protected void updateToSuccess(SqlRow data,
                                                           ExecutionContext context)

処理ステータスを正常終了に更新する。

パラメータ:

data - 送信対象データ

context - 実行コンテキスト