Packet

java.lang.Object
- com.graveng.rci.Packet

```
public class Packet
extends java.lang.Object
```
RCIサーバとRCIクライアント間でxml形式で送受信されるパケット。
このクラスのpublicメソッドの多くは、RciとRciServerに使われることを想定しており、クライアントユーザが直接呼び出すのは返却値を受け取るgetResult, toResult程度である。

遠隔メソッドコール時のパラメータ領域のクラスがリモートで変更された場合もクライアントで反映される。

publicにしている大きな理由は、パッケージ間のアクセスがjavaではそうせざるを得ないということだけではなく、パケットを転送する際にオブジェクトをxmlにするためのXMLEncoderがpublicのsetter, getterを必要とするからである。 (そのためどこからも呼ばれないようなsetterも削除してはいけない。)

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected java.lang.Exception`	`exception` サーバで発生した例外
`protected int`	`instanceNumber` サーバ側でクラスのインスタンスを識別する番号
`static java.lang.String`	`OPTION_CALLBACK` サーバからイベント通知であることを示すオプション
`static java.lang.String`	`OPTION_LISTENER_HASHCODE` サーバでイベントを受け取るクラスのハッシュコード
`static java.lang.String`	`OPTION_LISTENER_NUMBER` サーバで発生したイベントをクライアントで受信してリスナーを起動する際に識別する番号
`static java.lang.String`	`OPTION_PARAMTYPES` パラメータの型を登録するオプション
`protected java.util.HashMap<java.lang.Object,java.lang.Object>`	`optionMap` 各種オプションを保持する領域
`protected java.lang.Object[]`	`params` メソッド名を含む可変パラメータ
`protected long`	`requestId` 要求に対する応答であることを識別する情報（特に使われていない）
`protected java.lang.Object`	`result` メソッドの返却値の相当するObject
`protected java.lang.String`	`serializedException` サーバで発生した例外をシリアライズする領域
`protected java.lang.String[]`	`serializedParams` パラメータをシリアライズして転送するための領域。

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

コンストラクタ
コンストラクタと説明

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

コンストラクタ
コンストラクタと説明
`Packet()` デフォルトコンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static <T> T`	`cast(T to, java.lang.Object from)`
`static java.lang.Class<?>`	`convertPrimitive(java.lang.Object obj)` オブジェクトの型を求める
`static boolean`	`copyObject(java.lang.Object from, java.lang.Object to)` オブジェクトをコピーする。
`static byte[]`	`deBase64Byte(java.lang.String text)` Base64文字列形式をバイナリに変換する。
`static byte[]`	`deDumpByte(java.lang.String text)` Base64形式をバイナリに変換する。
`static byte[]`	`deHexByte(java.lang.String text)` 16進数文字列形式をバイナリに変換する。
`void`	`deSerializeParam()` パラメータをデシリアライズする。
`static java.lang.String`	`enBase64Byte(byte[] buf)` バイナリの文字列(Base64)形式を返す
`static java.lang.String`	`enDumpByte(byte[] buf)` バイナリの文字列(Base64)形式を返す
`static java.lang.String`	`enHexByte(byte[] buf)` バイナリの文字列(16進数)形式を返す
`void`	`enSerializeParam()` パラメータをシリアライズする。
`static java.lang.Object`	`getDecode(byte[] buf)` オブジェクトをデシリアライズする。
`static java.lang.Object`	`getDecodeStr(java.lang.String obj)`
`static java.lang.Object`	`getDecodeXML(java.lang.String xmlObject)` XML形式の文字列からObjectを生成する。
`static byte[]`	`getEncode(java.lang.Object obj)` オブジェクトをシリアライズする。
`static java.lang.String`	`getEncodeStr(java.lang.Object obj)` オブジェクトをシリアライズしBase64にして返す。
`static java.lang.String`	`getEncodeXML(java.lang.Object obj)` ObjectをXML形式の文字列として返す。
`java.lang.Exception`	`getException()` サーバで発生した例外を取得する。
`int`	`getInstanceNumber()` インスタンス番号を取得する。
`static java.lang.String`	`getMethodName()` 実行しているメソッド名を取得する。
`java.util.HashMap<java.lang.Object,java.lang.Object>`	`getOptionMap()` オプションマップを取得する。
`java.lang.Object[]`	`getParams()` パラメータを取得する。
`long`	`getRequestId()` 要求電文と応答電文を関連づけるリクエストIDを取得する。
`java.lang.Object`	`getResult()` サーバで実行したメソッドの返却値相当を受け取る
`java.lang.String`	`getSerializedException()` シリアライズされたサーバで発生した例外を取得する。
`java.lang.String[]`	`getSerializedParams()` シリアライズされたパラメータを取得する。
`static java.lang.Boolean`	`isPrimitive(java.lang.Object obj)` オブジェクトのラッパークラスがプリミティブ型ならtrueを返す。
`void`	`setException(java.lang.Exception exception)` サーバで発生した例外を設定する。
`void`	`setInstanceNumber(int instanceNumber)` インスタンス番号を設定する。
`void`	`setOptionMap(java.util.HashMap<java.lang.Object,java.lang.Object> optionMap)` オプションマップを設定する。
`void`	`setParams(java.lang.Object[] params)` パラメータを設定する。
`void`	`setRequestId(long requestId)` 要求電文と応答電文を関連づけるリクエストIDを設定する。
`void`	`setResult(java.lang.Object result)` 遠隔メソッドコールの返却値を設定する。
`void`	`setSerializedException(java.lang.String serializedException)` シリアライズされたサーバで発生した例外を設定する。
`void`	`setSerializedParams(java.lang.String[] serializedParams)` シリアライズされたパラメータを設定する。
`<T> T`	`toResult(T to)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - OPTION_LISTENER_NUMBER
```
public static final java.lang.String OPTION_LISTENER_NUMBER
```
    サーバで発生したイベントをクライアントで受信してリスナーを起動する際に識別する番号
    
    関連項目:
    
    定数フィールド値
  - OPTION_CALLBACK
```
public static final java.lang.String OPTION_CALLBACK
```
    サーバからイベント通知であることを示すオプション
    
    関連項目:
    
    定数フィールド値
  - OPTION_LISTENER_HASHCODE
```
public static final java.lang.String OPTION_LISTENER_HASHCODE
```
    サーバでイベントを受け取るクラスのハッシュコード
    
    関連項目:
    
    定数フィールド値
  - OPTION_PARAMTYPES
```
public static final java.lang.String OPTION_PARAMTYPES
```
    パラメータの型を登録するオプション
    
    関連項目:
    
    定数フィールド値
  - requestId
```
protected long requestId
```
    要求に対する応答であることを識別する情報（特に使われていない）
  - params
```
protected java.lang.Object[] params
```
    メソッド名を含む可変パラメータ
  - serializedParams
```
protected java.lang.String[] serializedParams
```
    パラメータをシリアライズして転送するための領域。
  - instanceNumber
```
protected int instanceNumber
```
    サーバ側でクラスのインスタンスを識別する番号
  - result
```
protected java.lang.Object result
```
    メソッドの返却値の相当するObject
  - exception
```
protected java.lang.Exception exception
```
    サーバで発生した例外
  - serializedException
```
protected java.lang.String serializedException
```
    サーバで発生した例外をシリアライズする領域
  - optionMap
```
protected java.util.HashMap<java.lang.Object,java.lang.Object> optionMap
```
    各種オプションを保持する領域
- コンストラクタの詳細
  - Packet
```
public Packet()
```
    デフォルトコンストラクタ
- メソッドの詳細
  - getRequestId
```
public long getRequestId()
```
    要求電文と応答電文を関連づけるリクエストIDを取得する。
    
    戻り値:
    
    リクエストID
  - setRequestId
```
public void setRequestId(long requestId)
```
    要求電文と応答電文を関連づけるリクエストIDを設定する。
    
    パラメータ:
    
    requestId - リクエストID
  - getSerializedParams
```
public java.lang.String[] getSerializedParams()
```
    シリアライズされたパラメータを取得する。シリアライズしていない対応するパラメータはnullになっている。
    
    戻り値:
    
    シリアライズされたパラメータ
  - setSerializedParams
```
public void setSerializedParams(java.lang.String[] serializedParams)
```
    シリアライズされたパラメータを設定する。
    
    パラメータ:
    
    serializedParams - シリアライズされたパラメータ
  - getOptionMap
```
public java.util.HashMap<java.lang.Object,java.lang.Object> getOptionMap()
```
    オプションマップを取得する。
    
    戻り値:
    
    オプションマップ
  - setOptionMap
```
public void setOptionMap(java.util.HashMap<java.lang.Object,java.lang.Object> optionMap)
```
    オプションマップを設定する。
    
    パラメータ:
    
    optionMap - オプションマップ
  - getParams
```
public java.lang.Object[] getParams()
```
    パラメータを取得する。
    
    戻り値:
    
    パラメータ
  - setParams
```
public void setParams(java.lang.Object[] params)
```
    パラメータを設定する。
    
    パラメータ:
    
    params - パラメータ
  - getInstanceNumber
```
public int getInstanceNumber()
```
    インスタンス番号を取得する。
    
    戻り値:
    
    インスタンス番号
  - setInstanceNumber
```
public void setInstanceNumber(int instanceNumber)
```
    インスタンス番号を設定する。
    
    パラメータ:
    
    instanceNumber - インスタンス番号
  - getResult
```
public java.lang.Object getResult()
```
    サーバで実行したメソッドの返却値相当を受け取る
    
    戻り値:
    
    返却値
  - toResult
```
public <T> T toResult(T to)
```
  - setResult
```
public void setResult(java.lang.Object result)
```
    遠隔メソッドコールの返却値を設定する。
    
    パラメータ:
    
    result - 返却値
  - getException
```
public java.lang.Exception getException()
```
    サーバで発生した例外を取得する。
    
    戻り値:
    
    例外
  - setException
```
public void setException(java.lang.Exception exception)
```
    サーバで発生した例外を設定する。
    
    パラメータ:
    
    exception - 例外
  - getSerializedException
```
public java.lang.String getSerializedException()
```
    シリアライズされたサーバで発生した例外を取得する。
    
    戻り値:
    
    シリアライズされたBase64例外
  - setSerializedException
```
public void setSerializedException(java.lang.String serializedException)
```
    シリアライズされたサーバで発生した例外を設定する。
    
    パラメータ:
    
    serializedException - シリアライズされたBase64例外
  - enSerializeParam
```
public void enSerializeParam()
                      throws java.io.IOException
```
    パラメータをシリアライズする。
    
    例外:
    
    java.io.IOException - IO例外
  - deSerializeParam
```
public void deSerializeParam()
                      throws java.lang.Exception
```
    パラメータをデシリアライズする。
    
    例外:
    
    java.lang.Exception - 何らかの例外
  - getEncodeXML
```
public static java.lang.String getEncodeXML(java.lang.Object obj)
                                     throws java.io.IOException
```
    ObjectをXML形式の文字列として返す。
    
    パラメータ:
    
    obj - Object
    
    戻り値:
    
    Objectのxml形式
    
    例外:
    
    java.io.IOException - IO例外
  - getDecodeXML
```
public static java.lang.Object getDecodeXML(java.lang.String xmlObject)
                                     throws java.io.IOException
```
    XML形式の文字列からObjectを生成する。
    
    パラメータ:
    
    xmlObject - Objectのxml形式
    
    戻り値:
    
    Object
    
    例外:
    
    java.io.IOException - IO例外
  - getEncodeStr
```
public static java.lang.String getEncodeStr(java.lang.Object obj)
                                     throws java.io.IOException
```
    オブジェクトをシリアライズしBase64にして返す。
    
    パラメータ:
    
    obj - Obejct
    
    戻り値:
    
    ObjectシリアライズのBase64形式
    
    例外:
    
    java.io.IOException - IO例外
  - getEncode
```
public static byte[] getEncode(java.lang.Object obj)
                        throws java.io.IOException
```
    オブジェクトをシリアライズする。
    
    パラメータ:
    
    obj - Obejct
    
    戻り値:
    
    Objectシリアライズ
    
    例外:
    
    java.io.IOException - IO例外
  - getDecodeStr
```
public static java.lang.Object getDecodeStr(java.lang.String obj)
                                     throws java.lang.Exception
```
    例外:
    
    java.lang.Exception
  - getDecode
```
public static java.lang.Object getDecode(byte[] buf)
                                  throws java.io.IOException,
                                         java.lang.ClassNotFoundException
```
    オブジェクトをデシリアライズする。
    
    パラメータ:
    
    buf - Objectシリアライズ
    
    戻り値:
    
    Obejct
    
    例外:
    
    java.io.IOException - IO例外
    
    java.lang.ClassNotFoundException - クラスが見つからない
  - enDumpByte
```
public static java.lang.String enDumpByte(byte[] buf)
```
    バイナリの文字列(Base64)形式を返す
    
    パラメータ:
    
    buf - バイナリ
    
    戻り値:
    
    文字列(Base64)形式
  - enHexByte
```
public static java.lang.String enHexByte(byte[] buf)
```
    バイナリの文字列(16進数)形式を返す
    
    パラメータ:
    
    buf - バイナリ
    
    戻り値:
    
    文字列(16進数)形式
  - enBase64Byte
```
public static java.lang.String enBase64Byte(byte[] buf)
```
    バイナリの文字列(Base64)形式を返す
    
    パラメータ:
    
    buf - バイナリ
    
    戻り値:
    
    文字列(Base64)形式
  - deDumpByte
```
public static byte[] deDumpByte(java.lang.String text)
```
    Base64形式をバイナリに変換する。
    
    パラメータ:
    
    text - Base64形式
    
    戻り値:
    
    バイナリ
  - deHexByte
```
public static byte[] deHexByte(java.lang.String text)
```
    16進数文字列形式をバイナリに変換する。
    
    パラメータ:
    
    text - 16進数文字列
    
    戻り値:
    
    バイナリ
  - deBase64Byte
```
public static byte[] deBase64Byte(java.lang.String text)
```
    Base64文字列形式をバイナリに変換する。
    
    パラメータ:
    
    text - Base64形式文字列
    
    戻り値:
    
    バイナリ
  - getMethodName
```
public static java.lang.String getMethodName()
```
    実行しているメソッド名を取得する。
    
    戻り値:
    
    メソッド名
  - copyObject
```
public static boolean copyObject(java.lang.Object from,
                                 java.lang.Object to)
                          throws java.lang.IllegalArgumentException,
                                 java.lang.IllegalAccessException
```
    オブジェクトをコピーする。
    
    パラメータ:
    
    from - コピー元Object
    
    to - コピー先Object
    
    戻り値:
    
    コピーに成功したらtrue
    
    例外:
    
    java.lang.IllegalArgumentException - パラメータエラー
    
    java.lang.IllegalAccessException - 不正アクセス
  - convertPrimitive
```
public static java.lang.Class<?> convertPrimitive(java.lang.Object obj)
```
    オブジェクトの型を求める
    
    パラメータ:
    
    obj - Object
    
    戻り値:
    
    Objectの型
  - isPrimitive
```
public static java.lang.Boolean isPrimitive(java.lang.Object obj)
```
    オブジェクトのラッパークラスがプリミティブ型ならtrueを返す。
    
    パラメータ:
    
    obj - オブジェクト
    
    戻り値:
    
    ラッパークラスがプリミティブ型ならtrue
  - cast
```
public static <T> T cast(T to,
                         java.lang.Object from)
```

クラス Packet

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

OPTION_LISTENER_NUMBER

OPTION_CALLBACK

OPTION_LISTENER_HASHCODE

OPTION_PARAMTYPES

requestId

params

serializedParams

instanceNumber

result

exception

serializedException

optionMap

コンストラクタの詳細

Packet

メソッドの詳細

getRequestId

setRequestId

getSerializedParams

setSerializedParams

getOptionMap

setOptionMap

getParams

setParams

getInstanceNumber

setInstanceNumber

getResult

toResult

setResult

getException

setException

getSerializedException

setSerializedException

enSerializeParam

deSerializeParam

getEncodeXML

getDecodeXML

getEncodeStr

getEncode

getDecodeStr

getDecode

enDumpByte

enHexByte

enBase64Byte

deDumpByte

deHexByte

deBase64Byte

getMethodName

copyObject

convertPrimitive

isPrimitive

cast