jp.go.aist.dmrc.platform.beans.io

クラス PFNetworkClient

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.PFNetworkClient

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFEventSource, PFProcessRequestEventSource, PFProcessTerminateEventSource

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

ネットワークに接続して情報を取得するためのコンポーネント。 提供する機能は以下の通り。

• ホスト名とIPアドレスの変換
• NTPサーバに接続して日時を取得する
• URL指定で文字列などのデータを取得する
• SSH接続でポート転送を実行

このコンポーネントから発生するイベントは以下の通り。

• 処理完了イベント

  トリガ	結果データ	イベント番号
  接続エラー	メッセージ(String)	0
  日時の取得要求	日時情報(Date)	1
  SSH接続ポート転送開始	転送開始メッセージ(String)	2
  SSH接続ポート転送終了	メッセージ(String)	3

  
  
• 処理要求イベント

  トリガ	要求データ	イベント番号
  HTTP接続時の認証要求	NULL	0

  
  

NTPサーバへの接続にはApache Commons Netを、SSH接続ポート転送の実現にはJSchを利用している。

関連項目:

直列化された形式

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。
void	addPFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
boolean	canGetContentFromURL(java.lang.String url) URL指定でデータが取得可能か判定する。
void	connectViaNTP(java.lang.String hostname) NTPサーバに接続して日時情報を要求する。
protected java.lang.Object	firePFProcessRequested(PFProcessRequestEvent event) 処理要求イベントを発生させる。
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() コンポーネントの文字列表現を取得する。
java.lang.String	getContentAsTextFromURL(java.lang.String url) URL指定でデータを文字列として取得する。
java.util.Date	getDateByNTP(java.lang.String hostname) NTPサーバから日時情報を取得する。
java.lang.String	getHostAddress(java.lang.String hostname) ホスト名からIPアドレスを文字列として取得する。
java.lang.String	getHostName(java.lang.String address) IPアドレスの文字列表現からホスト名を取得する。
java.lang.String	getHTMLContentAsTextFromURL(java.lang.String url, java.lang.String post) URL指定でHTML文字列を取得する。
java.util.Date	getLastModifiedFromURL(java.lang.String url) URL指定でデータの最終更新日時を取得する。
java.util.Iterator	getPFProcessRequestListenerList() 処理要求イベントリスナ配列を取得する。
java.util.Iterator	getPFProcessTerminateListenerList() 処理完了イベントリスナ配列を取得する。
int	getSshPort() SSH接続ポート番号を取得する。
int	getTimeout() 接続のタイムアウト時間を取得する。
java.lang.String	getURLEncodedString(java.lang.String str) URLエンコードした文字列を取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isSshStrictHostKeyDisabled() ホストキーの厳密チェック無効化を取得する。
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFProcessRequestListener(PFProcessRequestListener lis) 引数で与えられたイベントリスナを削除し、 処理要求イベント発生時に処理を行う対象から外す。
void	removePFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
void	saveContentFromURL(java.lang.String url, java.lang.String filename) URL指定でデータをダウンロードして保存する。
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	setSshKnownHostsFile(java.lang.String pathname) SSH接続既知ホストファイル名を設定する。
void	setSshPort(int port) SSH接続ポート番号を設定する。
void	setSshPrivateKeyFile(java.lang.String pathname) SSH接続秘密鍵ファイル名を設定する。
void	setSshStrictHostKeyDisabled(boolean disabled) ホストキーの厳密チェック無効化を設定する。
void	setTimeout(int duration) 接続のタイムアウト時間を設定する。
void	startSshPortForwarding(java.lang.String user, java.lang.String password, java.lang.String host, int portLocal, java.lang.String hostRemote, int portRemote) SSH接続でポート転送を開始する。
void	stopSshConnection() SSH接続を終了する。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

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

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

コンストラクタの詳細

PFNetworkClient

public PFNetworkClient()

コンストラクタ。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

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

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

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

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

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

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

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

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

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

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

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

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

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

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()

処理完了イベントリスナ配列を取得する。

定義:

getPFProcessTerminateListenerList インタフェース内 PFProcessTerminateEventSource

戻り値:

イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)

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

定義:

addPFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)

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

定義:

removePFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 削除対象イベントリスナ

firePFProcessTerminated

protected void firePFProcessTerminated(PFProcessTerminateEvent event)
                                throws PFMethodException,
                                       PFRuntimeException

処理完了イベントを発生させる。

パラメータ:

event - 処理完了イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

getPFProcessRequestListenerList

public java.util.Iterator getPFProcessRequestListenerList()

処理要求イベントリスナ配列を取得する。

定義:

getPFProcessRequestListenerList インタフェース内 PFProcessRequestEventSource

戻り値:

イベントリスナイテレータ

addPFProcessRequestListener

public void addPFProcessRequestListener(PFProcessRequestListener lis)

引数で与えられたイベントリスナを登録し、 処理要求イベント発生時に処理を行う対象とする。

定義:

addPFProcessRequestListener インタフェース内 PFProcessRequestEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessRequestListener

public void removePFProcessRequestListener(PFProcessRequestListener lis)

引数で与えられたイベントリスナを削除し、 処理要求イベント発生時に処理を行う対象から外す。

定義:

removePFProcessRequestListener インタフェース内 PFProcessRequestEventSource

パラメータ:

lis - 削除対象イベントリスナ

firePFProcessRequested

protected java.lang.Object firePFProcessRequested(PFProcessRequestEvent event)
                                           throws PFMethodException,
                                                  PFRuntimeException

処理要求イベントを発生させる。

パラメータ:

event - 処理要求イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

関連項目:

PFComponent.localeUpdated()

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

getDateByNTP

public java.util.Date getDateByNTP(java.lang.String hostname)
                            throws PFComponentException

NTPサーバから日時情報を取得する。 取得に失敗した場合はnullを返す。このメソッドの実行でイベントは発生しない。 Apache Commons NetのNTPUDPClientを利用している。

パラメータ:

hostname - サーバ名

戻り値:

サーバの日時(Date)

例外:

PFComponentException - 取得失敗

connectViaNTP

public void connectViaNTP(java.lang.String hostname)
                   throws PFException

NTPサーバに接続して日時情報を要求する。 要求の結果は処理完了イベントで通知される。 Apache Commons NetのNTPUDPClientを利用している。

パラメータ:

hostname - サーバ名

例外:

PFException - イベント処理失敗

getHostAddress

public java.lang.String getHostAddress(java.lang.String hostname)

ホスト名からIPアドレスを文字列として取得する。 取得できない場合は空文字を返す。

パラメータ:

hostname - ホスト名

戻り値:

IPアドレスの文字列表現

getHostName

public java.lang.String getHostName(java.lang.String address)

IPアドレスの文字列表現からホスト名を取得する。 取得できない場合は空文字を返す。

パラメータ:

address - IPアドレスの文字列表現

戻り値:

ホスト名

canGetContentFromURL

public boolean canGetContentFromURL(java.lang.String url)

URL指定でデータが取得可能か判定する。 指定先へのアクセスに認証が必要な場合、処理要求イベントが発生する。 処理要求イベントの戻り値として、IDとパスワードの2つの文字列を要素としたPFObjectListを指定すると、 それらの情報で認証を実施する。

パラメータ:

url - データのURL

戻り値:

取得可能な場合true

getLastModifiedFromURL

public java.util.Date getLastModifiedFromURL(java.lang.String url)
                                      throws PFComponentException

URL指定でデータの最終更新日時を取得する。 不明な場合は現在の日時が返る。

パラメータ:

url - データのURL

戻り値:

最終更新日時

例外:

PFComponentException

saveContentFromURL

public void saveContentFromURL(java.lang.String url,
                               java.lang.String filename)
                        throws PFComponentException

URL指定でデータをダウンロードして保存する。

パラメータ:

url - ダウンロード元URL

filename - 保存するファイル名

例外:

PFComponentException - 各種例外：URLが存在しない場合など

getContentAsTextFromURL

public java.lang.String getContentAsTextFromURL(java.lang.String url)
                                         throws PFComponentException

URL指定でデータを文字列として取得する。

パラメータ:

url - ダウンロード元URL

例外:

PFComponentException - 各種例外：URLが存在しない場合など

getHTMLContentAsTextFromURL

public java.lang.String getHTMLContentAsTextFromURL(java.lang.String url,
                                                    java.lang.String post)
                                             throws PFComponentException

URL指定でHTML文字列を取得する。

パラメータ:

url - URL(GETパラメータ含む)

post - POSTパラメータ(GETの場合は空文字かnullを指定)

例外:

PFComponentException - 各種例外：URLが存在しない場合など

startSshPortForwarding

public void startSshPortForwarding(java.lang.String user,
                                   java.lang.String password,
                                   java.lang.String host,
                                   int portLocal,
                                   java.lang.String hostRemote,
                                   int portRemote)
                            throws PFException

SSH接続でポート転送を開始する。 通常はパスワードで認証し、秘密鍵ファイルを事前に設定していればキーペア接続となる。 キーペア接続の場合はパスフレーズを引数で指定する。パスフレーズが空の場合は空文字でよい。 正常に転送を開始したら処理完了イベントが発生する。 すでに接続済みの場合は例外が発生する。

パラメータ:

user - ユーザ名

password - パスワード/パスフレーズ

host - SSH接続先

portLocal - ローカルのポート番号

hostRemote - SSH接続先からの転送先

portRemote - 転送先のポート番号

例外:

PFException - イベント処理の例外

PFComponentException - すでに接続済みの場合および接続処理中の例外発生

stopSshConnection

public void stopSshConnection()
                       throws PFException

SSH接続を終了する。 接続終了処理が成功すると処理完了イベントが発生する。 接続していない場合は何もせず、イベントも発生しない。

例外:

PFException - イベント処理の例外

setSshPort

public void setSshPort(int port)

SSH接続ポート番号を設定する。 デフォルトは22。

パラメータ:

port - ポート番号

getSshPort

public int getSshPort()

SSH接続ポート番号を取得する。 デフォルトは22。

戻り値:

ポート番号(int)

setSshPrivateKeyFile

public void setSshPrivateKeyFile(java.lang.String pathname)

SSH接続秘密鍵ファイル名を設定する。 ここで有効なファイル名を指定すると、以降のSSH接続はキーペア接続となる。 キーペア接続を解除するためにはこのメソッドで空文字を設定する。

パラメータ:

pathname - ファイルパス名

setSshKnownHostsFile

public void setSshKnownHostsFile(java.lang.String pathname)

SSH接続既知ホストファイル名を設定する。 ここで有効なファイル名を指定すると、以降のSSH接続でこのファイルが用いられる。 既知ホストの設定を解除するためには、このメソッドで空文字を設定する。

パラメータ:

pathname - ファイルパス名

isSshStrictHostKeyDisabled

public boolean isSshStrictHostKeyDisabled()

ホストキーの厳密チェック無効化を取得する。

戻り値:

無効化の場合true

setSshStrictHostKeyDisabled

public void setSshStrictHostKeyDisabled(boolean disabled)

ホストキーの厳密チェック無効化を設定する。

パラメータ:

disabled - 無効化の場合true

getURLEncodedString

public java.lang.String getURLEncodedString(java.lang.String str)
                                     throws PFComponentException

URLエンコードした文字列を取得する。

パラメータ:

str - 文字列

戻り値:

URLエンコードした文字列

例外:

PFComponentException - エンコード失敗

getTimeout

public int getTimeout()

接続のタイムアウト時間を取得する。 デフォルト値は5秒。

戻り値:

時間(msec)

setTimeout

public void setTimeout(int duration)

接続のタイムアウト時間を設定する。

パラメータ:

duration - 時間(msec)