com.graveng.rci.client

クラス Rci

java.lang.Object

com.graveng.rci.client.Rci

public class Rci
extends java.lang.Object

RCIクライアントクラス

RCIサーバのIPアドレスとポート番号を指定しconnect後、遠隔クラス生成、遠隔メソッド実行を行う。

リスナー登録することでサーバからの非同期通知を受けることもできる。

メソッドコールは非同期ではないからRCIクライアントは基本的に同期通信である。複数のメソッドコールを スレッドでやりたい場合は、Rciのインスタンスをそれぞれのスレッドで動かすこと。 （RciServerはsshと同じように同じユーザでの複数同時接続を禁止していない。）

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

ネストされたクラス

修飾子とタイプ	クラスと説明
protected class	Rci.EventReceiver サーバからの非同期通知を受け取るクラス
class	Rci.Invoker １つのコネクションの送受信を行う(Rci内部で使用するクラス)

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Rci.Invoker	invoker １つのコネクションの送受信を行う。
protected boolean	isThrowException RCIサーバで発生した例外をシリアライズして受け、その例外を送出する場合はtrueにする。
protected boolean	isUseEventListener サーバからの非同期イベントの受信処理を有効にする場合はtrueにする。
protected java.util.HashMap<java.lang.Integer,java.util.EventListener>	listenerMap RCIサーバからの非同期通知を受け取るクラスを保持する。
protected int	listenerNumber RCIサーバからの非同期通知を受け取るインスタンスの番号（登録されるごとにインクリメントする）
static java.lang.String	logFileNameEnv ログファイル名を変更する場合の環境変数名
static java.lang.String	logLevelEnv ログレベルを変更する場合の環境変数名
protected java.net.Socket	socket クライアントソケット

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

コンストラクタ

コンストラクタと説明
Rci() デフォルトコンストラクタ、Rciクライアントを生成する

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	authUser(java.lang.String username, java.lang.String password, java.lang.String hashAlgorithm, int hashRepeat) 鍵の交換を行いログインする。
void	connect(java.lang.String server, int port) RCIサーバのソケットに接続する。
void	disconnect() ソケットを切断する。
Packet	exec(Packet result, java.lang.Object... objects) invokeで生成したインスタンス(かシングルトン)のメソッドを実行する。
Packet	execType(Packet result, java.lang.Class<?>[] paramTypes, java.lang.Object... objects) パラメータの型を指定してinvokeで生成したインスタンス(かシングルトン)のメソッドを実行する。
Rci.Invoker	getInvoker() RCIサーバとのコネクションにより通信を行うInvokerクラスのインスタンスを取得する。
Packet	invoke(java.lang.Object... objects) サーバ側でクラス生成か参照の取得かstaticメソッドを遠隔実行する。
Packet	invokeCertificateUser(java.lang.String username, java.lang.String password, java.lang.String hashAlgorithm, int hashRepeat) ログインする。
Packet	invokeExchangeKey() 公開鍵をサーバに送信し、共通鍵を受け取る。
protected void	invokeListener(Packet req) サーバからの非同期通知に対応するリスナークラスをクライアントで実行する。
Packet	invokeType(java.lang.Class<?>[] paramTypes, java.lang.Object... objects) invokeのパラメータの前にパラメータの型を指定し、サーバ側でクラス生成か参照の取得かstaticメソッドを遠隔実行する。
Packet	invokeUpdatePassword(java.lang.String hashAlgorithmName, java.lang.String loginPassword, java.lang.String registPassword, int loginCount, int registCount, java.lang.String pubKey) パスワードを変更する。
boolean	isThrowException() サーバで例外が発生した際にクライアントでも例外を送出する場合はtrue、例外を送出しない場合はfalseが返る。
boolean	isUseEventListener() サーバからの非同期通知を受けられる状態かを返す。
Packet	registListener(Packet result, java.lang.Class<?>[] paramTypes, java.util.EventListener clientRunListener, java.lang.Object... objects) パラメータの型を指定し、サーバ側でリスナー登録し、そのリスナーからの通知を受け取るクラスを登録する。
Packet	registListener(Packet result, java.util.EventListener clientRunListener, java.lang.Object... objects) サーバ側でリスナー登録し、そのリスナーからの通知を受け取るリスナーを登録する。
void	setCryptKeyPair(java.lang.String publicKey, java.lang.String secretKey) 公開鍵と秘密鍵に独自に生成したものを設定する。
void	setThrowException(boolean isThrowException) サーバで例外が発生した際にクライアントでも例外を送出するかを設定する。
void	setUseEventListener(boolean isUseEventListener) サーバからの非同期通知を受けられる状態かを設定する。
protected void	startReadThread() １つのコネクションの送受信を行うスレッドを起動する。
protected void	updateLogSetup() ログファイル名、ログレベルを環境変数から設定する場合はこのメソッドを呼び出す。

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

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

フィールドの詳細

logFileNameEnv

public static final java.lang.String logFileNameEnv

ログファイル名を変更する場合の環境変数名

関連項目:

定数フィールド値

logLevelEnv

public static final java.lang.String logLevelEnv

ログレベルを変更する場合の環境変数名

関連項目:

定数フィールド値

socket

protected java.net.Socket socket

クライアントソケット

invoker

protected Rci.Invoker invoker

１つのコネクションの送受信を行う。

isThrowException

protected boolean isThrowException

RCIサーバで発生した例外をシリアライズして受け、その例外を送出する場合はtrueにする。

isUseEventListener

protected boolean isUseEventListener

サーバからの非同期イベントの受信処理を有効にする場合はtrueにする。
リスナー登録により非同期イベントを受信しないならfalseにした方がやや効率がよい。

listenerNumber

protected int listenerNumber

RCIサーバからの非同期通知を受け取るインスタンスの番号（登録されるごとにインクリメントする）

listenerMap

protected java.util.HashMap<java.lang.Integer,java.util.EventListener> listenerMap

RCIサーバからの非同期通知を受け取るクラスを保持する。key:listenerNumber, value:リスナークラス

コンストラクタの詳細

Rci

public Rci()

デフォルトコンストラクタ、Rciクライアントを生成する

メソッドの詳細

isUseEventListener

public boolean isUseEventListener()

サーバからの非同期通知を受けられる状態かを返す。

戻り値:

isUseEventListener 非同期通知を受けられる状態ならtrue

setUseEventListener

public void setUseEventListener(boolean isUseEventListener)

サーバからの非同期通知を受けられる状態かを設定する。

パラメータ:

isUseEventListener - 非同期通知を受けられる状態ならtrue。同期通信のみで無限待ちにする場合はfalse

updateLogSetup

protected void updateLogSetup()

ログファイル名、ログレベルを環境変数から設定する場合はこのメソッドを呼び出す。

connect

public void connect(java.lang.String server,
                    int port)
             throws java.net.UnknownHostException,
                    java.io.IOException

RCIサーバのソケットに接続する。

パラメータ:

server - RCIサーバのホスト名かIPアドレス

port - RCIサーバのポート番号

例外:

java.net.UnknownHostException - ホストが見つからない場合

java.io.IOException - 何らかの通信に失敗した場合

startReadThread

protected void startReadThread()

１つのコネクションの送受信を行うスレッドを起動する。

isThrowException

public boolean isThrowException()

サーバで例外が発生した際にクライアントでも例外を送出する場合はtrue、例外を送出しない場合はfalseが返る。

戻り値:

サーバで例外が発生した際にクライアントでも例外を送出する場合はtrue

setThrowException

public void setThrowException(boolean isThrowException)

サーバで例外が発生した際にクライアントでも例外を送出するかを設定する。

パラメータ:

isThrowException - サーバで例外が発生した際にクライアントでも例外を送出する場合はtrue

getInvoker

public Rci.Invoker getInvoker()

RCIサーバとのコネクションにより通信を行うInvokerクラスのインスタンスを取得する。

戻り値:

Invokerクラスのインスタンス

invoke

public Packet invoke(java.lang.Object... objects)
              throws java.lang.Exception

サーバ側でクラス生成か参照の取得かstaticメソッドを遠隔実行する。

第１パラメータが実行するクラスの種類を表しており、以下の３種類がある。
new: インスタンスクラスの生成
static: スタティッククラスのメソッドの実行
single: シングルトンクラスへの参照の取得

第２パラメータはクラスの完全修飾名を設定する。例)"java.util.HashMap"

第３パラメータ以降は第１パラメータにより以下になる。
new: コンストラクタのパラメータがあれば、それを与える。
static: メソッド名に続きパラメータがあれば、それを与える。
single: インスタンスを取得するメソッド名に続きパラメータがあれば、それを与える。

例)
new: Packet date = rci.invoke("new", "java.util.Date");
static: Packet result = rci.invoke("static", "java.lang.System", "getProperty","user.dir");
single: Packet singleton = rci.invoke("single", "example.Singleton", "getInstance");

パラメータ:

objects - 上記形式の可変パラメータ

戻り値:

実行結果のPacket

例外:

java.lang.Exception - 何らかの例外

invokeType

public Packet invokeType(java.lang.Class<?>[] paramTypes,
                         java.lang.Object... objects)
                  throws java.lang.Exception

invokeのパラメータの前にパラメータの型を指定し、サーバ側でクラス生成か参照の取得かstaticメソッドを遠隔実行する。

パラメータの型を与えた方が適合するメソッドをより正確に見つけられる。

パラメータ:

paramTypes - パラメータの型。例) intなら{int.class}のようにする。

objects - 可変パラメータ

戻り値:

実行結果のPacket

例外:

java.lang.Exception - 何らかの例外

authUser

public void authUser(java.lang.String username,
                     java.lang.String password,
                     java.lang.String hashAlgorithm,
                     int hashRepeat)
              throws java.lang.Exception

鍵の交換を行いログインする。

パラメータ:

username - ユーザ名

password - パスワード

hashAlgorithm - ハッシュアルゴリズム名(MD2, MD5, SHA-1, SHA-256, SHA-384, SHA-512の何れか)

hashRepeat - パラメータとして与えられたパスワードに対して更にハッシュ化を繰り返す数

例外:

java.lang.Exception - 何らかの例外

関連項目:

HashCrypt

setCryptKeyPair

public void setCryptKeyPair(java.lang.String publicKey,
                            java.lang.String secretKey)

公開鍵と秘密鍵に独自に生成したものを設定する。（このメソッドを呼び出さなければ自動生成したものが使われる。）

サーバ側で公開鍵が登録されていると、ここで与えた公開鍵と一致判定を行う。公開鍵と秘密鍵はRSAKeyPairCryptで生成する。

パラメータ:

publicKey - 公開鍵

secretKey - 秘密鍵

関連項目:

RSAKeyPairCrypt

invokeExchangeKey

public Packet invokeExchangeKey()
                         throws java.lang.Exception

公開鍵をサーバに送信し、共通鍵を受け取る。

戻り値:

実行結果のPacket

例外:

java.lang.Exception - 何らかの例外

invokeCertificateUser

public Packet invokeCertificateUser(java.lang.String username,
                                    java.lang.String password,
                                    java.lang.String hashAlgorithm,
                                    int hashRepeat)
                             throws java.lang.Exception

ログインする。

パラメータ:

username - ユーザ名

password - パスワード

hashAlgorithm - ハッシュアルゴリズム名

hashRepeat - パラメータとして与えられたパスワードに対して更にハッシュ化を繰り返す数

戻り値:

実行結果のPacket

例外:

java.lang.Exception - 何らかの例外

invokeUpdatePassword

public Packet invokeUpdatePassword(java.lang.String hashAlgorithmName,
                                   java.lang.String loginPassword,
                                   java.lang.String registPassword,
                                   int loginCount,
                                   int registCount,
                                   java.lang.String pubKey)
                            throws java.lang.Exception

パスワードを変更する。

パラメータ:

hashAlgorithmName - ハッシュアルゴリズム名

loginPassword - ログイン時のパスワード

registPassword - 登録するパスワード

loginCount - ログイン時のハッシュ繰り返し回数

registCount - 登録するパスワードのハッシュ繰り返し回数

pubKey - 公開鍵

戻り値:

実行結果のPacket

例外:

java.lang.Exception - 何らかの例外

exec

public Packet exec(Packet result,
                   java.lang.Object... objects)
            throws java.lang.Exception

invokeで生成したインスタンス(かシングルトン)のメソッドを実行する。

例)
new: date = rci.exec(date, "getMonth");
single: singleton = rci.exec(singleton, "setNameAndAge", "Yamada", 21);

インスタンスの破棄はメソッド名以降なしで実行する。

例)
rci.exec(date);
rci.exec(singleton);

パラメータ:

result - invokeかinvokeTypeの返却値のPacket

objects - メソッド名、その後はパラメータ

戻り値:

実行結果Packet

例外:

java.lang.Exception - 何らかの例外

execType

public Packet execType(Packet result,
                       java.lang.Class<?>[] paramTypes,
                       java.lang.Object... objects)
                throws java.lang.Exception

パラメータの型を指定してinvokeで生成したインスタンス(かシングルトン)のメソッドを実行する。

パラメータ:

result - invokeかinvokeTypeの返却値のPacket

paramTypes - パラメータの型

objects - メソッド名、その後はパラメータ

戻り値:

実行結果Packet

例外:

java.lang.Exception - 何らかの例外

registListener

public Packet registListener(Packet result,
                             java.util.EventListener clientRunListener,
                             java.lang.Object... objects)
                      throws java.lang.Exception

サーバ側でリスナー登録し、そのリスナーからの通知を受け取るリスナーを登録する。

パラメータ:

result - invokeかinvokeTypeの返却値のPacket

clientRunListener - クライアント側でコールバックされるリスナー

objects - メソッド名、その後はパラメータ

戻り値:

実行結果Packet

例外:

java.lang.Exception - 何らかの例外

registListener

public Packet registListener(Packet result,
                             java.lang.Class<?>[] paramTypes,
                             java.util.EventListener clientRunListener,
                             java.lang.Object... objects)
                      throws java.lang.Exception

パラメータの型を指定し、サーバ側でリスナー登録し、そのリスナーからの通知を受け取るクラスを登録する。

パラメータ:

result - invokeかinvokeTypeの返却値のPacket

paramTypes - パラメータの型

clientRunListener - クライアント側でコールバックされるリスナー

objects - メソッド名、その後はパラメータ

戻り値:

実行結果Packet

例外:

java.lang.Exception - 何らかの例外

disconnect

public void disconnect()
                throws java.io.IOException

ソケットを切断する。

例外:

java.io.IOException - 通信例外

invokeListener

protected void invokeListener(Packet req)
                       throws java.lang.Exception

サーバからの非同期通知に対応するリスナークラスをクライアントで実行する。

パラメータ:

req - サーバから受け取ったPacket

例外:

java.lang.Exception - 何らかの例外