jp.go.aist.dmrc.platform.beans.mail
クラス PFSimpleMailSender

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.mail.PFSimpleMailSender
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFEventSource, PFProcessTerminateEventSource

public class PFSimpleMailSender
extends java.lang.Object
implements PFComponent, PFProcessTerminateEventSource, PFXMLSerializable

簡易的なメール送信コンポーネント。 SMTPサーバでメールを送信する。POP before SMTPのためにPOP認証の機能を有するが、POPによるメールの受信はできない。 また、SMTP認証には対応していない。メール送信とPOP認証ではそれぞれ標準ポート番号をデフォルトで使用しているが、 通常使用するポート番号を指定や送信と認証時に個別にポート番号を指定することも可能。 このコンポーネントから以下のイベントが発生します。

関連項目:
直列化された形式

フィールドの概要
static int standardPOPPortNumber
          POP認証用の標準ポート番号
static int standardSMTPPortNumber
          SMTP送信用の標準ポート番号
 
コンストラクタの概要
PFSimpleMailSender()
          デフォルトコンストラクタ
 
メソッドの概要
 void addPFProcessTerminateListener(PFProcessTerminateListener lis)
          引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
 boolean authenticate(java.lang.String popHost, java.lang.String id, java.lang.String password)
          POPサーバに接続して認証を行う。
 boolean authenticate(java.lang.String popHost, java.lang.String id, java.lang.String password, int portNumber)
          ポート番号指定でPOPサーバに接続して認証を行う。
protected  void firePFProcessTerminated(PFProcessTerminateEvent event)
          処理完了イベントを発生させる。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 int getDefaultPOPPortNumber()
          通常使用するPOP用ポート番号を取得する。
 int getDefaultSMTPPortNumber()
          通常使用するSMTP用ポート番号を取得する。
 java.lang.String getFrom()
          差出人名を取得する。
 java.util.Iterator getPFProcessTerminateListenerList()
          処理完了イベントリスナ配列を取得する。
 java.lang.String getSMTPHost()
          SMTPホスト名を取得する。
static int getStandardPOPPortNumber()
          標準POPポート番号(110)を取得する。
static int getStandardSMTPPortNumber()
          標準SMTPポート番号(25)を取得する。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFProcessTerminateListener(PFProcessTerminateListener lis)
          引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
 boolean send(PFObjectList toList, java.lang.String subject, java.lang.String contents, PFObjectList fileNameList)
          メールを送信する。
 boolean send(PFObjectList toList, java.lang.String subject, java.lang.String contents, PFObjectList fileNameList, int portNumber)
          ポート番号を指定してメールを送信する。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントのキー情報を設定する
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setDefaultPOPPortNumber(int number)
          通常使用するPOP用ポート番号を設定する。
 void setDefaultSMTPPortNumber(int number)
          通常使用するSMTP用ポート番号を設定する。
 void setFrom(java.lang.String from)
          差出人名を設定する。
 void setSMTPHost(java.lang.String host)
          SMTPホスト名を設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

standardSMTPPortNumber

public static final int standardSMTPPortNumber
SMTP送信用の標準ポート番号

関連項目:
定数フィールド値

standardPOPPortNumber

public static final int standardPOPPortNumber
POP認証用の標準ポート番号

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

PFSimpleMailSender

public PFSimpleMailSender()
デフォルトコンストラクタ

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名
関連項目:
PFComponent.getComponentName()

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列
関連項目:
PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントのキー情報を設定する

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - 設定するコンポーネントのキー
関連項目:
PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID
関連項目:
PFComponent.getComponentID()

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID
関連項目:
PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
コンポーネントの文字列表現を返す。
関連項目:
PFComponent.getComponentString()

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()
処理完了イベントリスナ配列を取得する。

定義:
インタフェース PFProcessTerminateEventSource 内の getPFProcessTerminateListenerList
戻り値:
イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)
引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。

定義:
インタフェース PFProcessTerminateEventSource 内の addPFProcessTerminateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)
引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。

定義:
インタフェース PFProcessTerminateEventSource 内の removePFProcessTerminateListener
パラメータ:
lis - 削除対象イベントリスナ

firePFProcessTerminated

protected void firePFProcessTerminated(PFProcessTerminateEvent event)
                                throws PFMethodException,
                                       PFRuntimeException
処理完了イベントを発生させる。

パラメータ:
event - 処理完了イベント
例外:
PFMethodException - イベント伝播先のメソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated
関連項目:
PFComponent.localeUpdated()

send

public boolean send(PFObjectList toList,
                    java.lang.String subject,
                    java.lang.String contents,
                    PFObjectList fileNameList)
             throws PFException
メールを送信する。 処理完了イベントが発生する。

パラメータ:
toList - 宛先リスト
subject - 件名
contents - 本文
fileNameList - 添付ファイル名リスト
戻り値:
真偽値
例外:
PFException

send

public boolean send(PFObjectList toList,
                    java.lang.String subject,
                    java.lang.String contents,
                    PFObjectList fileNameList,
                    int portNumber)
             throws PFException
ポート番号を指定してメールを送信する。 処理完了イベントが発生する。

パラメータ:
toList - 宛先リスト
subject - 件名
contents - 本文
fileNameList - 添付ファイル名リスト
portNumber - ポート番号
戻り値:
真偽値
例外:
PFException

getFrom

public java.lang.String getFrom()
差出人名を取得する。

戻り値:
差出人名

setFrom

public void setFrom(java.lang.String from)
差出人名を設定する。

パラメータ:
from - 差出人名

getSMTPHost

public java.lang.String getSMTPHost()
SMTPホスト名を取得する。

戻り値:
SMTPホスト名

setSMTPHost

public void setSMTPHost(java.lang.String host)
SMTPホスト名を設定する。

パラメータ:
host - SMTPホスト名

getDefaultSMTPPortNumber

public int getDefaultSMTPPortNumber()
通常使用するSMTP用ポート番号を取得する。 初期値は25。

戻り値:
ポート番号

setDefaultSMTPPortNumber

public void setDefaultSMTPPortNumber(int number)
通常使用するSMTP用ポート番号を設定する。 初期値は25。

パラメータ:
number - ポート番号

getDefaultPOPPortNumber

public int getDefaultPOPPortNumber()
通常使用するPOP用ポート番号を取得する。 初期値は110。

戻り値:
ポート番号

setDefaultPOPPortNumber

public void setDefaultPOPPortNumber(int number)
通常使用するPOP用ポート番号を設定する。 初期値は110。

パラメータ:
number - ポート番号

authenticate

public boolean authenticate(java.lang.String popHost,
                            java.lang.String id,
                            java.lang.String password)
                     throws PFException
POPサーバに接続して認証を行う。 処理完了イベントが発生する。

このメソッドは、ユーザがメール送信で使用するSMTPサーバがPOP before SMTPを採用していて、 メール送信前にPOP認証を必要とする場合に用いる。

パラメータ:
popHost - POPサーバ名
id - ユーザID
password - パスワード
戻り値:
成功かどうか
例外:
PFException

authenticate

public boolean authenticate(java.lang.String popHost,
                            java.lang.String id,
                            java.lang.String password,
                            int portNumber)
                     throws PFException
ポート番号指定でPOPサーバに接続して認証を行う。 処理完了イベントが発生する。

このメソッドは、ユーザがメール送信で使用するSMTPサーバがPOP before SMTPを採用していて、 メール送信前にPOP認証を必要とする場合に用いる。

パラメータ:
popHost - POPサーバ名
id - ユーザID
password - パスワード
portNumber - ポート番号
戻り値:
成功かどうか
例外:
PFException

getStandardSMTPPortNumber

public static int getStandardSMTPPortNumber()
標準SMTPポート番号(25)を取得する。

戻り値:
ポート番号(25)

getStandardPOPPortNumber

public static int getStandardPOPPortNumber()
標準POPポート番号(110)を取得する。

戻り値:
ポート番号(110)