com.JRcServer.client
インタフェース JRcConnection


public interface JRcConnection

JRcConnection.

JRcClientコネクションインターフェイス.

導入されたバージョン:
JRcClient 1.00
バージョン:
2006/09/10
作成者:
masahito suzuki

メソッドの概要
 void clearService()
          現在のサービス条件を破棄.
 void close()
          現在のコネクションをクローズ.
 void closeConnection()
          切断処理.
 void createService(java.lang.String name)
          新しいサービスでコネクション.
 JRcResult execution()
          現在の条件でサービスを呼び出す.
 JRcResult execution(java.lang.String command)
          コマンドによる直接指定で呼び出し.
 java.lang.String getApplicationName()
          アプリケーション名を取得.
 JRcClientSession getJRcClientSession()
          JRcClientSessionオブジェクトを取得.
 java.net.InetAddress getLocalAddress()
          ローカルアドレスを取得.
 int getLocalPort()
          ローカルポート番号を取得.
 java.lang.String[] getParameterKeys()
          パラメータキー名一覧を取得.
 int getParameterSize()
          パラメータ数を取得.
 byte[] getParameterToBinary(java.lang.String key)
          パラメータをバイナリで取得.
 java.lang.Boolean getParameterToBoolean(java.lang.String key)
          パラメータをフラグで取得.
 java.math.BigDecimal getParameterToDecimal(java.lang.String key)
          パラメータを浮動少数値(Decimal)で取得.
 java.lang.Double getParameterToDouble(java.lang.String key)
          パラメータを浮動少数値(Double)で取得.
 java.lang.Float getParameterToFloat(java.lang.String key)
          パラメータを浮動少数値(Float)で取得.
 java.lang.Integer getParameterToInteger(java.lang.String key)
          パラメータを数値(Integer)で取得.
 java.lang.Long getParameterToLong(java.lang.String key)
          パラメータを数値(Long)で取得.
 java.lang.Short getParameterToShort(java.lang.String key)
          パラメータを数値(Short)で取得.
 java.lang.String getParameterToString(java.lang.String key)
          パラメータを文字列で取得.
 java.util.Date getParameterToTimestamp(java.lang.String key)
          パラメータをタイムスタンプ(Timestamp)で取得.
 int getParameterType(java.lang.String key)
          パラメータタイプを取得.
 java.net.InetAddress getServerAddress()
          現在のコネクション先アドレスを取得.
 int getServerPort()
          現在のコネクション先ポート番号を取得.
 long getSessionID()
          セッションIDを取得.
 boolean isClosed()
          このオブジェクトが既にクローズされているかチェック.
 boolean isParameterName(java.lang.String key)
          パラメータ名が存在するかチェック.
 void removeParameter(java.lang.String key)
          対象のパラメータを削除.
 void retry()
          再コネクション.
 void setParameterToBinary(java.lang.String key, byte[] value)
          パラメータをバイナリで追加.
 void setParameterToBoolean(java.lang.String key, java.lang.Boolean value)
          パラメータをフラグで追加.
 void setParameterToDecimal(java.lang.String key, java.math.BigDecimal value)
          パラメータを浮動少数値(Decimal)で追加.
 void setParameterToDouble(java.lang.String key, java.lang.Double value)
          パラメータを浮動少数値(Double)で追加.
 void setParameterToFloat(java.lang.String key, java.lang.Float value)
          パラメータを浮動少数値(Float)で追加.
 void setParameterToInteger(java.lang.String key, java.lang.Integer value)
          パラメータを数値(Integer)で追加.
 void setParameterToLong(java.lang.String key, java.lang.Long value)
          パラメータを数値(Long)で追加.
 void setParameterToShort(java.lang.String key, java.lang.Short value)
          パラメータを数値(Short)で追加.
 void setParameterToString(java.lang.String key, java.lang.String value)
          パラメータを文字列で追加.
 void setParameterToTimestamp(java.lang.String key, java.util.Date value)
          パラメータをタイムスタンプ(Timestamp)で追加.
 

メソッドの詳細

close

void close()
現在のコネクションをクローズ.

現在のコネクション条件をクローズします.


retry

void retry()
           throws AccessException
再コネクション.

再コネクションを行います.

例外:
AccessException - アクセス例外.

closeConnection

void closeConnection()
切断処理.

通信を切断します.


createService

void createService(java.lang.String name)
                   throws InputException
新しいサービスでコネクション.

新しいサービス名を設定してコネクションを生成します.
そのため、設定途中の条件が存在する場合、その情報は破棄されます.

パラメータ:
name - 対象のサービス名を設定します.
例外:
InputException - 入力例外.

clearService

void clearService()
現在のサービス条件を破棄.

現在のサービスを破棄します.


execution

JRcResult execution()
                    throws JRCommandException,
                           ExecutionException
現在の条件でサービスを呼び出す.

設定されている現在の条件で、サービスを呼び出します.

戻り値:
JRcResult 処理結果の内容が返されます.
例外:
JRCommandException - JRCommon例外.
ExecutionException - 実行例外.

execution

JRcResult execution(java.lang.String command)
                    throws JRCommandException,
                           ExecutionException
コマンドによる直接指定で呼び出し.

コマンドによる直接指定で呼び出します.
また、このメソッドの場合は、[createService()]や パラメータ指定の条件は全て無視します.
代わりに、指定された文字列をコマンドとして、サービス名、 パラメータの順に定義して呼び出します.
呼び出す方法としては、以下の2点があります.
 その1:通常指定.
 hoge -param1 ジェイアールシー -param2 sv
 
 その2:URL指定.
 ?hoge&param1=%E3%82%B8%E3%82%A7%E3%82%A4%E3%82%A2%E3%83%BC%E3%83%AB%E3%82%B7%E3%83%BC&param2=sv
 
  ※先頭に必ず[?(半角)]が必要となります.

 
両方とも同様の[hoge]サービスを呼び出し、2つのパラメータ
[param1=ジェイアールシー],[param2=sv]を指定しています.
また、URLエンコードはUTF8のみサポートしているので、
それ以外の指定条件では設定できません.
(文字化けします)

設定されたパラメータの値はString以外の近い条件で設定します.
たとえば、Boolean変換したいものは、[true]や[false]を設定することで、
変換対象となります.
その中でも特殊なものとしては、Timestamp登録です.
以下に対応している日付フォーマット一覧です.

・yyyy/MM/dd,HH:mm:ss
・yyyy-MM-dd,HH:mm:ss
・yyyy年MM月dd日,HH:mm:ss
・yyyy/MM/dd
・yyyy-MM-dd
・yyyy年MM月dd日

もう1つ特殊なものとしては、Base64でのバイナリ指定があります.
方法としては、データ定義の初めに[base64-]を指定して以降にBase64の コードを指定します.
 <例>
 hoge -param1 base64-44GY44GH44GE44GC44O844KL44GX44O8c3Y=
 
 または
 ?hoge¶m1=base64-44GY44GH44GE44GC44O844KL44GX44O8c3Y=
 
このように定義しなければいけません.

最後に、ローカルファイルの内容を設定する方法として、以下のような
方法で、設定できます.
 <例>
 hoge -param1 file:/c:/dir/test.txt
 
 または
 ?hoge?param1=file:/c:/dir/test.txt
 
 
このように定義しなければいけません.

パラメータ:
command - コマンドによる直接指定で呼び出します.
戻り値:
JRcResult 処理結果の内容が返されます.
例外:
JRCommandException - JRCommon例外.
ExecutionException - 実行例外.

removeParameter

void removeParameter(java.lang.String key)
対象のパラメータを削除.

対象のパラメータ情報を削除します.

パラメータ:
key - 対象のKey名を設定します.

setParameterToBinary

void setParameterToBinary(java.lang.String key,
                          byte[] value)
                          throws InputException
パラメータをバイナリで追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToBinary

byte[] getParameterToBinary(java.lang.String key)
パラメータをバイナリで取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
byte[] パラメータ情報が返されます.

setParameterToString

void setParameterToString(java.lang.String key,
                          java.lang.String value)
                          throws InputException
パラメータを文字列で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToString

java.lang.String getParameterToString(java.lang.String key)
                                      throws ConvertException
パラメータを文字列で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
String パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToBoolean

void setParameterToBoolean(java.lang.String key,
                           java.lang.Boolean value)
                           throws InputException
パラメータをフラグで追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToBoolean

java.lang.Boolean getParameterToBoolean(java.lang.String key)
                                        throws ConvertException
パラメータをフラグで取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Boolean パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToShort

void setParameterToShort(java.lang.String key,
                         java.lang.Short value)
                         throws InputException
パラメータを数値(Short)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToShort

java.lang.Short getParameterToShort(java.lang.String key)
                                    throws ConvertException
パラメータを数値(Short)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Short パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToInteger

void setParameterToInteger(java.lang.String key,
                           java.lang.Integer value)
                           throws InputException
パラメータを数値(Integer)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToInteger

java.lang.Integer getParameterToInteger(java.lang.String key)
                                        throws ConvertException
パラメータを数値(Integer)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Integer パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToLong

void setParameterToLong(java.lang.String key,
                        java.lang.Long value)
                        throws InputException
パラメータを数値(Long)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToLong

java.lang.Long getParameterToLong(java.lang.String key)
                                  throws ConvertException
パラメータを数値(Long)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Long パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToFloat

void setParameterToFloat(java.lang.String key,
                         java.lang.Float value)
                         throws InputException
パラメータを浮動少数値(Float)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToFloat

java.lang.Float getParameterToFloat(java.lang.String key)
                                    throws ConvertException
パラメータを浮動少数値(Float)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Float パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToDouble

void setParameterToDouble(java.lang.String key,
                          java.lang.Double value)
                          throws InputException
パラメータを浮動少数値(Double)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToDouble

java.lang.Double getParameterToDouble(java.lang.String key)
                                      throws ConvertException
パラメータを浮動少数値(Double)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Double パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToDecimal

void setParameterToDecimal(java.lang.String key,
                           java.math.BigDecimal value)
                           throws InputException
パラメータを浮動少数値(Decimal)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToDecimal

java.math.BigDecimal getParameterToDecimal(java.lang.String key)
                                           throws ConvertException
パラメータを浮動少数値(Decimal)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
BigDecimal パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

setParameterToTimestamp

void setParameterToTimestamp(java.lang.String key,
                             java.util.Date value)
                             throws InputException
パラメータをタイムスタンプ(Timestamp)で追加.

パラメータ:
key - 対象のKey名を設定します.
value - 対象の内容を設定します.
例外:
InputException - 入力例外.

getParameterToTimestamp

java.util.Date getParameterToTimestamp(java.lang.String key)
                                       throws ConvertException
パラメータをタイムスタンプ(Timestamp)で取得.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
Date パラメータ情報が返されます.
例外:
ConvertException - コンバート例外.

getParameterType

int getParameterType(java.lang.String key)
パラメータタイプを取得.

リクエストを送ってきたクライアントからのパラメータタイプが返されます.

パラメータ:
key - 対象のKey名を設定します.
戻り値:
int パラメータタイプが返されます.
[JRcParameterType#TYPE_BINARY]が返された場合(byte[])情報です.
[JRcParameterType#TYPE_STRING]が返された場合(String)情報です.
[JRcParameterType#TYPE_BOOLEAN]が返された場合(Boolean)情報です.
[JRcParameterType#TYPE_SHORT]が返された場合(Short)情報です.
[JRcParameterType#TYPE_INTEGER]が返された場合(Integer)情報です.
[JRcParameterType#TYPE_LONG]が返された場合(Long)情報です.
[JRcParameterType#TYPE_FLOAT]が返された場合(Float)情報です.
[JRcParameterType#TYPE_DOUBLE]が返された場合(Double)情報です.
[JRcParameterType#TYPE_DECIMAL]が返された場合(BigDecimal)情報です.
[JRcParameterType#TYPE_TIMESTAMP]が返された場合(Date)情報です.
パラメータタイプが定義されていない場合かキー内容が存在しない場合、 [-1]が返されます.

getParameterKeys

java.lang.String[] getParameterKeys()
パラメータキー名一覧を取得.

パラメータキー名一覧を取得します.

戻り値:
String[] パラメータキー名一覧が返されます.

getParameterSize

int getParameterSize()
パラメータ数を取得.

リクエストを送ってきたクライアントからのパラメータ数が返されます.

戻り値:
int 設定されているパラメータ数が返されます.

isParameterName

boolean isParameterName(java.lang.String key)
パラメータ名が存在するかチェック.

リクエストを送ってきたクライアントからのパラメータ名が 存在するかチェックします.

パラメータ:
key - チェック対象Key名を設定します.
戻り値:
boolean チェック結果が返されます.
[true]が返された場合、対象Key名はパラメータに存在します.
[false]が返された場合、対象Key名はパラメータに存在しません.

getJRcClientSession

JRcClientSession getJRcClientSession()
JRcClientSessionオブジェクトを取得.

JRcClientSessionオブジェクトを取得します.

戻り値:
JRcClientSession JRcClientSessionオブジェクトが返されます.

getApplicationName

java.lang.String getApplicationName()
アプリケーション名を取得.

リクエストを送ってきたクライアントからのアプリケーション名を取得します.

戻り値:
String アプリケーション名が返されます.

getSessionID

long getSessionID()
セッションIDを取得.

現在のセッションIDを取得します.

戻り値:
long セッションIDが返されます.

getServerAddress

java.net.InetAddress getServerAddress()
現在のコネクション先アドレスを取得.

現在コネクションされているアドレス情報を取得します.

戻り値:
InetAddress コネクション先アドレスが返されます.

getServerPort

int getServerPort()
現在のコネクション先ポート番号を取得.

現在コネクションされているポート番号を取得します.

戻り値:
int コネクション先ポート番号が返されます.

getLocalAddress

java.net.InetAddress getLocalAddress()
ローカルアドレスを取得.

ローカルアドレスを取得します.

戻り値:
InetAddress ローカルアドレスが返されます.

getLocalPort

int getLocalPort()
ローカルポート番号を取得.

ローカルポート番号を取得します.

戻り値:
int ローカルポート番号が返されます.

isClosed

boolean isClosed()
このオブジェクトが既にクローズされているかチェック.

このオブジェクトが既にクローズされているかチェックします.

戻り値:
boolean クローズされているかチェックします.
[true]が返された場合、既にクローズされています.
[false]が返された場合、コネクション中です.