CTGクラス

本章では、CTGクラスの使用方法について説明します。

1. 概要

以下は、J2EE ECIアプリケーション・プログラムの開発のために提供するクラスの一覧と、発生する可能性のある例外クラスの一覧です。続く節では、各クラスについて説明します。

開発クラス

クラス	説明
CCILocalTransaction	ECIコネクターのトランザクション状態を制御します。
CICSConnection	現在、単独では使用できません。（ECIConnectionを参照）
CICSConnectionFactory	現在、単独では使用できません。（ECIConnectionFactoryを参照）
CICSConnectionSpec	現在、単独では使用できません。（ECIConnectionSpecを参照）
CICSInteraction	現在、単独では使用できませ。（ECIInteractionを参照）
CICSInteractionSpec	現在、単独では使用できません。（ECIInteractionSpecを参照）
CICSManagedConnectionFactory	現在、単独では使用できません。（ECIManagedConnectionFactoryを参照）
ECIConnection	OSCサーバーへの接続を表すクラスです。このオブジェクトを介して対話(Interaction)を作成し、CICSに送受信します。
ECIConnectionFactory	OSCサーバーへの接続を取得するクラスです。
ECIConnectionSpec	OSCサーバーへの接続のプロパティを定義したクラスです。getConnectionを実行するとき、このクラスで定義されたプロパティが使用されます。
ECIInteraction	ECIConnectionオブジェクトを介したOSCサーバーとの対話を表すクラスです。
ECIInteractionSpec	CICSサーバーとの対話のプロパティを定義したクラスです。
ECIManagedConnectionFactory	ECIConnectionオブジェクトを作成するために使用される上位クラスです。このクラスには、CICSサーバーへの接続に必要なすべての情報が含まれています。

クラス

説明

CCILocalTransaction

ECIコネクターのトランザクション状態を制御します。

CICSConnection

現在、単独では使用できません。（ECIConnectionを参照）

CICSConnectionFactory

現在、単独では使用できません。（ECIConnectionFactoryを参照）

CICSConnectionSpec

現在、単独では使用できません。（ECIConnectionSpecを参照）

CICSInteraction

現在、単独では使用できませ。（ECIInteractionを参照）

CICSInteractionSpec

現在、単独では使用できません。（ECIInteractionSpecを参照）

CICSManagedConnectionFactory

現在、単独では使用できません。（ECIManagedConnectionFactoryを参照）

ECIConnection

OSCサーバーへの接続を表すクラスです。このオブジェクトを介して対話(Interaction)を作成し、CICSに送受信します。

ECIConnectionFactory

OSCサーバーへの接続を取得するクラスです。

ECIConnectionSpec

OSCサーバーへの接続のプロパティを定義したクラスです。getConnectionを実行するとき、このクラスで定義されたプロパティが使用されます。

ECIInteraction

ECIConnectionオブジェクトを介したOSCサーバーとの対話を表すクラスです。

ECIInteractionSpec

CICSサーバーとの対話のプロパティを定義したクラスです。

ECIManagedConnectionFactory

ECIConnectionオブジェクトを作成するために使用される上位クラスです。このクラスには、CICSサーバーへの接続に必要なすべての情報が含まれています。

例外クラス

例外	説明
ECIResourceAdapterRc	CICSResourceExceptionクラスのエラーコード定数を定義したクラスです。OSCアプリケーション・サーバーの実行中に発生したエラーの定数を定義しています。
CICSResourceException	ECIInteractionで要求を処理中に発生したエラーに関する例外情報を定義したクラスです。

例外

説明

ECIResourceAdapterRc

CICSResourceExceptionクラスのエラーコード定数を定義したクラスです。OSCアプリケーション・サーバーの実行中に発生したエラーの定数を定義しています。

CICSResourceException

ECIInteractionで要求を処理中に発生したエラーに関する例外情報を定義したクラスです。

2. CCILocalTransaction

CCILocalTransactionクラスは、ECIコネクターのトランザクション状態を制御します。ECIConnection.getLocalTransaction()メソッドによってのみアクセスできます。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CCILocalTransaction
implements javax.resource.cci.LocalTransaction

メソッド

以下は、CCILocalTransactionクラスのメソッドです。

メソッド	説明
public void begin()	新しいローカル・トランザクションを開始します。スローする例外 ResourceException : トランザクションの開始に失敗した場合に発生します。
public void commit()	現行のローカル・トランザクションをコミットします。スローする例外 ResourceException : トランザクションのコミットに失敗した場合に発生します。
public void rollback()	現行のローカル・トランザクションをロールバックします。スローする例外 ResourceException : トランザクションのロールバックに失敗した場合に発生します。

メソッド

説明

public void begin()

新しいローカル・トランザクションを開始します。

スローする例外
- ResourceException : トランザクションの開始に失敗した場合に発生します。

public void commit()

現行のローカル・トランザクションをコミットします。

スローする例外
- ResourceException : トランザクションのコミットに失敗した場合に発生します。

public void rollback()

現行のローカル・トランザクションをロールバックします。

スローする例外
- ResourceException : トランザクションのロールバックに失敗した場合に発生します。

3. CICSConnection

現在、CICSConnectionを単独では使用できません。詳細については、ECIConnectionを参照してください。

4. CICSConnectionFactory

現在、CICSConnectionFactoryを単独では使用できません。詳細については、ECIConnectionFactoryを参照してください。

5. CICSConnectionSpec

現在、CICSConnectionSpecを単独では使用できません。詳細については、ECIConnectionSpecを参照してください。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CICSConnectionSpec
implements javax.resource.cci.ConnectionSpec

メソッド

以下は、CICSConnectionSpecクラスのメソッドです。

メソッド	説明
public void setUserName(java.lang.String newUser)	プログラムの実行時にTACF認証に使用されるユーザー名を設定します。ECIInteractionSpecクラスのsetUserID()が呼び出された場合は、このメソッドを使用して設定した値は無視されます。
public java.lang.String getUserName()	プログラムの実行時にTACF認証に使用されるユーザー名を返します。
public void setPassword(java.lang.String newPass)	プログラムの実行時にTACF認証に使用されるパスワードを設定します。ECIInteractionSpecクラスのsetPassword()が呼び出された場合は、このメソッドを使用して設定した値は無視されます。
public java.lang.String getPassword()	プログラムの実行時にTACF認証に使用されるパスワードを返します。
String getHost()	OSCサーバーのホストのアドレスを取得します。
void setHost(String host)	OSCサーバーのホストのアドレスを設定します。
int getHost_port()	OSCサーバーのホストのポート番号を取得します。
void setHost_port(Integer host_port)	OSCサーバーのホストのポート番号を取得します。
String getBackup()	OSCサーバーのバックアップ・ホストのアドレスを取得します。
void setBackup(String backup)	OSCサーバーのバックアップ・ホストのアドレスを設定します。
int getBackup_port()	OSCサーバーのバックアップ・ホストのポート番号を取得します。
void setBackup_port(Integer backup_port)	OSCサーバーのバックアップ・ホストのポート番号を設定します。
int getConnectTimeout()	OSCサーバーへの接続タイムアウトを取得します(単位: 秒)。
void setConnectTimeout(Integer connectTimeout)	OSCサーバーへの接続タイムアウトを設定します。

メソッド

説明

public void setUserName(java.lang.String newUser)

プログラムの実行時にTACF認証に使用されるユーザー名を設定します。ECIInteractionSpecクラスのsetUserID()が呼び出された場合は、このメソッドを使用して設定した値は無視されます。

public java.lang.String getUserName()

プログラムの実行時にTACF認証に使用されるユーザー名を返します。

public void setPassword(java.lang.String newPass)

プログラムの実行時にTACF認証に使用されるパスワードを設定します。ECIInteractionSpecクラスのsetPassword()が呼び出された場合は、このメソッドを使用して設定した値は無視されます。

public java.lang.String getPassword()

プログラムの実行時にTACF認証に使用されるパスワードを返します。

String getHost()

OSCサーバーのホストのアドレスを取得します。

void setHost(String host)

OSCサーバーのホストのアドレスを設定します。

int getHost_port()

OSCサーバーのホストのポート番号を取得します。

void setHost_port(Integer host_port)

OSCサーバーのホストのポート番号を取得します。

String getBackup()

OSCサーバーのバックアップ・ホストのアドレスを取得します。

void setBackup(String backup)

OSCサーバーのバックアップ・ホストのアドレスを設定します。

int getBackup_port()

OSCサーバーのバックアップ・ホストのポート番号を取得します。

void setBackup_port(Integer backup_port)

OSCサーバーのバックアップ・ホストのポート番号を設定します。

int getConnectTimeout()

OSCサーバーへの接続タイムアウトを取得します(単位: 秒)。

void setConnectTimeout(Integer connectTimeout)

OSCサーバーへの接続タイムアウトを設定します。

6. CICSInteraction

CICSサーバーとの対話を表すクラスです。このクラスは接続情報を保持し、CICSサーバーとの送受信を実行します。現在、CICSInteractionを単独では使用できません。詳細については、ECIInteractionを参照してください。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CICSInteractionSpec
implements javax.resource.cci.Interaction

メソッド

以下は、CICSInteractionクラスのメソッドです。

メソッド	説明
public Connection getConnection()	自身のインスタンス(CICSInteraction)を作成したECIConnectinonクラスのインスタンスを返します。
public ResourceWarning getWarnings()	対話でexecute()メソッドの実行中にエラーが発生した場合、エラー情報が含まれているCICSResourceExceptionクラスを返します。エラーが発生していない場合は、NULLを返します。スローする例外 ResourceException : ResourceWarning情報のリターンに失敗した場合に発生します。
public void clearWarnings()	対話中に保存されたResourceWarning情報を削除します。スローする例外 ResourceException : ResourceWarning情報の削除に失敗した場合に発生します。
public boolean execute(InteractionSpec aspec, Record sndRecord, Record rcvRecord)	このメソッドは直接呼び出すことができません。必ずECIInteractionクラスを使用します。スローする例外 ResourceException : CICSサーバーとのメッセージの送受信に失敗した場合に発生します。
public void close()	対話に該当するECIConnection接続を閉じます。スローする例外 ResourceException : 接続のクローズに失敗した場合に発生します。

メソッド

説明

public Connection getConnection()

自身のインスタンス(CICSInteraction)を作成したECIConnectinonクラスのインスタンスを返します。

public ResourceWarning getWarnings()

対話でexecute()メソッドの実行中にエラーが発生した場合、エラー情報が含まれているCICSResourceExceptionクラスを返します。

エラーが発生していない場合は、NULLを返します。

スローする例外
- ResourceException : ResourceWarning情報のリターンに失敗した場合に発生します。

public void clearWarnings()

対話中に保存されたResourceWarning情報を削除します。

スローする例外
- ResourceException : ResourceWarning情報の削除に失敗した場合に発生します。

public boolean execute(InteractionSpec aspec, Record sndRecord, Record rcvRecord)

このメソッドは直接呼び出すことができません。必ずECIInteractionクラスを使用します。

スローする例外
- ResourceException : CICSサーバーとのメッセージの送受信に失敗した場合に発生します。

public void close()

対話に該当するECIConnection接続を閉じます。

スローする例外
- ResourceException : 接続のクローズに失敗した場合に発生します。

7. CICSInteractionSpec

現在、CICSInteractionSpecを単独では使用できません。詳細については、ECIInteractionSpecを参照してください。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CICSInteractionSpec
implements javax.resource.cci.InteractionSpec

メソッド

以下は、CICSInteractionSpeクラスのメソッドです。

メソッド	説明
public int getInteractionVerb()	当該インスタンスに保存されたInteractionVerbを取得します。使用される対話のタイプを示します。以下のいずれかの値を返します。 SYNC_SEND : 現在サポートしていません。 SYNC_RECEIVE : 現在サポートしていません。 SYNC_SEND_RECEIVE : DPL方式で要求を送信し、応答を受信します。
public void setInteractionVerb(int newVerb)	新しいInteractionVerbを設定します。 newVerb : SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかの値を指定します。現在は、SYNC_SEND_RECEIVEのみサポートしています。
public void addPropertyChange Listener(PropertyChangeListener pcl)	PropertyChangeListenerを追加します。
public void removePropertyChange Listener(PropertyChangeListener pcl)	PropertyChangeListenerを削除します。

メソッド

説明

public int getInteractionVerb()

当該インスタンスに保存されたInteractionVerbを取得します。使用される対話のタイプを示します。

以下のいずれかの値を返します。

SYNC_SEND : 現在サポートしていません。
SYNC_RECEIVE : 現在サポートしていません。
SYNC_SEND_RECEIVE : DPL方式で要求を送信し、応答を受信します。

public void setInteractionVerb(int newVerb)

新しいInteractionVerbを設定します。

newVerb : SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかの値を指定します。現在は、SYNC_SEND_RECEIVEのみサポートしています。

public void addPropertyChange Listener(PropertyChangeListener pcl)

PropertyChangeListenerを追加します。

public void removePropertyChange Listener(PropertyChangeListener pcl)

PropertyChangeListenerを削除します。

8. CICSManagedConnectionFactory

現在、CICSManagedConnectionFactoryを単独では使用できません。詳細については、ECIManagedConnectionFactoryを参照してください。各メソッドのデフォルト設定値は、リソース・アダプターに定義した設定値が保存されています。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CICSManagedConnectionFactory
implements com.tmax.ofctg.connector.cics.CICSLogTraceLevels,
    java.io.Serializable,
    javax.resource.spi.ManagedConnectionFactory,
    javax.resource.spi.ResourceAdapterAssociation,
    javax.resource.spi.ValidatingManagedConnectionFactory

9. CICSResourceException

ECIInteractionで要求を処理中に発生したエラーに関する例外情報を保持しています。

ECIInteractionクラスのgetWarnings()メソッドを使用して最初の例外情報を取得することができます。また、ECIInteractionクラスのexecute()メソッドを実行中に例外が発生した場合は、ABENDコードなどの追加エラー情報を取得することができます。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class CICSResourceException
extends javax.resource.cci.ResourceWarning

メソッド

以下は、CICSResourceExceptionクラスのメソッドです。

メソッド	説明
public String getAbendCode()	要求を処理中に異常終了が発生した場合に、ABENDコードを返します。ABENDコードが存在しない場合は、NULLを返します。
public int getCicsRespCode()	ECIResourceAdapterRcクラスに定義されている応答コード定数を返します。エラーの詳細については、ECIResourceAdapterRcを参照してください。
public int getCicsServerStatus()	ECIResourceAdapterRcクラスに定義されているサーバー・ステータス定数を返します。エラーの詳細については、ECIResourceAdapterRcを参照してください。

メソッド

説明

public String getAbendCode()

要求を処理中に異常終了が発生した場合に、ABENDコードを返します。ABENDコードが存在しない場合は、NULLを返します。

public int getCicsRespCode()

ECIResourceAdapterRcクラスに定義されている応答コード定数を返します。エラーの詳細については、ECIResourceAdapterRcを参照してください。

public int getCicsServerStatus()

ECIResourceAdapterRcクラスに定義されているサーバー・ステータス定数を返します。エラーの詳細については、ECIResourceAdapterRcを参照してください。

10. ECIConnection

OSCサーバーへの接続を表すクラスです。このオブジェクトを介して対話(Interaction)を作成し、CICSに送受信します。ECIConnectionFactoryクラスのgetConnection()メソッドを使用してオブジェクトを作成します。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class ECIConnection
extends CICSConnection
implements javax.resource.cci.Connection

メソッド

以下は、ECIConnectionクラスのメソッドです。

メソッド	説明
public void close()	接続を閉じます。スローする例外 ResourceException : 接続のクローズに失敗した場合に発生します。
public Interaction createInteraction()	接続を介して実行するECIInteractionを作成します。スローする例外 ResourceException : ECIInteractionの作成に失敗した場合に発生します。
public LocalTransaction getLocalTransaction()	接続のトランザクション状態を制御するために使用されるローカル・トランザクション・オブジェクトを取得します。スローする例外 ResourceException : ローカル・トランザクションの作成に失敗した場合に発生します。

メソッド

説明

public void close()

接続を閉じます。

スローする例外
- ResourceException : 接続のクローズに失敗した場合に発生します。

public Interaction createInteraction()

接続を介して実行するECIInteractionを作成します。

スローする例外
- ResourceException : ECIInteractionの作成に失敗した場合に発生します。

public LocalTransaction getLocalTransaction()

接続のトランザクション状態を制御するために使用されるローカル・トランザクション・オブジェクトを取得します。

スローする例外
- ResourceException : ローカル・トランザクションの作成に失敗した場合に発生します。

11. ECIConnectionFactory

ECI接続を取得するクラスです。ユーザーはリソース・アダプターの設定によりこのクラスをルックアップします。getConnectionを使用してリソース・アダプターの設定、または接続仕様の設定が適用された接続を取得します。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class ECIConnectionFactory
extends com.tmax.ofctg.connector.cics.CICSConnectionFactory

メソッド

以下は、ECIConnectionFactoryクラスのメソッドです。

メソッド	説明
public Connection getConnection(ConnectionSpec connectionSpec)	接続のトランザクション状態を制御するために使用されるローカル・トランザクション・オブジェクトを取得します。パラメータ connectionSpec : 接続に適用する仕様です。接続を作成するときは、デフォルトでファクトリに設定されたプロパティ値が適用されます。このパラメータがNULLではなく、host、host_port、backup、backup_port、connectionTimeoutが設定された場合は、接続仕様に設定された値が優先して適用されます。ECIConnectionSpecオブジェクトを作成して、引数として渡します。スローする例外 ResourceException : 接続の作成に失敗した場合に発生します。

メソッド

説明

public Connection getConnection(ConnectionSpec connectionSpec)

接続のトランザクション状態を制御するために使用されるローカル・トランザクション・オブジェクトを取得します。

パラメータ
- connectionSpec : 接続に適用する仕様です。
  
  接続を作成するときは、デフォルトでファクトリに設定されたプロパティ値が適用されます。このパラメータがNULLではなく、host、host_port、backup、backup_port、connectionTimeoutが設定された場合は、接続仕様に設定された値が優先して適用されます。ECIConnectionSpecオブジェクトを作成して、引数として渡します。
スローする例外
- ResourceException : 接続の作成に失敗した場合に発生します。

12. ECIConnectionSpec

ECI接続のプロパティを定義したクラスです。getConnectionの実行時に、このクラスのオブジェクトが保持する接続プロパティを使用します。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class ECIConnectionSpec
extends com.tmax.ofctg.connector.cics.CICSConnectionSpec

コンストラクター

メソッド	説明
public ECIConnectionSpec()	ECIConnectionSpecオブジェクトを作成します。
public ECIConnectionSpec(java.lang.String user, java.lang.String pass)	ユーザー名とパスワードを使用して新しいECIConnectionSpecを作成します。

メソッド

説明

public ECIConnectionSpec()

ECIConnectionSpecオブジェクトを作成します。

public ECIConnectionSpec(java.lang.String user, java.lang.String pass)

ユーザー名とパスワードを使用して新しいECIConnectionSpecを作成します。

メソッド

詳細については、CICSConnectionSpecを参照してください。

13. ECIInteraction

ECI接続を介したOSCリージョン・サーバーとの対話を表すクラスです。このクラスは接続情報を保持し、その情報に基づいてOSCリージョン・サーバーとの送受信を実行します。ECIConnectionクラスのcreateInteraction()メソッドを使用してオブジェクトを作成します。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class ECIInteraction
extends com.tmax.ofctg.connector.cics.CICSInteraction

メソッド

以下は、ECIInteractionクラスのメソッドです。

メソッド	説明
public Connection getConnection()	自身のインスタンス(CICSConnection)を作成したECIConnectionクラスのインスタンスを返します。
public ResourceWarning getWarnings()	対話でexecute()メソッドの実行中にエラーが発生した場合、エラー情報が含まれているCICSResourceExceptionを返します。エラーが発生していない場合は、NULLを返します。スローする例外 ResourceException : ResourceWarning情報のリターンに失敗した場合に発生します。
public void close()	対話に該当するECIConnection接続を閉じます。スローする例外 ResourceException : 接続のクローズに失敗した場合に発生します。
public boolean execute(InteractionSpec aspec, Record sndRecord, Record rcvRecord)	パラメータ aspec : 実行する対話に該当するInteractionSpecです。 sndRecord : 送信するデータが含まれているレコード・オブジェクトです。 rcvRecord : 受信するデータが含まれているレコード・オブジェクトです。 [注意] レコード・インターフェースはSerializableインターフェースを継承しますが、Javaオブジェクトのデータを非JVM環境に送信する場合には不適切です。したがって、レコード・インターフェースとjavax.resource.cci.Streamableインターフェースの両方を実装して、レコード・インスタンスのデータをCOMMAREA形式に合わせて送信するように作成する必要があります。現在、execute()メソッドでは、レコード・オブジェクトにStreamableが含まれていない場合、例外としてCICSResourceExceptionを発生させます。戻り値 true : 正常に実行された場合です。 false : 実行に失敗した場合です。スローする例外 CICSResourceException : 実行に失敗した場合に発生します。エラー状況に応じて、CICSのABENDコードを確認することができます。 ResourceException : 実行に失敗した場合に発生します。

メソッド

説明

public Connection getConnection()

自身のインスタンス(CICSConnection)を作成したECIConnectionクラスのインスタンスを返します。

public ResourceWarning getWarnings()

対話でexecute()メソッドの実行中にエラーが発生した場合、エラー情報が含まれているCICSResourceExceptionを返します。

エラーが発生していない場合は、NULLを返します。

スローする例外
- ResourceException : ResourceWarning情報のリターンに失敗した場合に発生します。

public void close()

対話に該当するECIConnection接続を閉じます。

スローする例外
- ResourceException : 接続のクローズに失敗した場合に発生します。

public boolean execute(InteractionSpec aspec, Record sndRecord, Record rcvRecord)

パラメータ
- aspec : 実行する対話に該当するInteractionSpecです。
- sndRecord : 送信するデータが含まれているレコード・オブジェクトです。
- rcvRecord : 受信するデータが含まれているレコード・オブジェクトです。
  
  [注意]
  
  レコード・インターフェースはSerializableインターフェースを継承しますが、Javaオブジェクトのデータを非JVM環境に送信する場合には不適切です。したがって、レコード・インターフェースとjavax.resource.cci.Streamableインターフェースの両方を実装して、レコード・インスタンスのデータをCOMMAREA形式に合わせて送信するように作成する必要があります。現在、execute()メソッドでは、レコード・オブジェクトにStreamableが含まれていない場合、例外としてCICSResourceExceptionを発生させます。
戻り値
- true : 正常に実行された場合です。
- false : 実行に失敗した場合です。
スローする例外
- CICSResourceException : 実行に失敗した場合に発生します。エラー状況に応じて、CICSのABENDコードを確認することができます。
- ResourceException : 実行に失敗した場合に発生します。

14. ECIInteractionSpec

ECI接続とCICSサーバーとの対話のプロパティを定義したクラスです。ECIInteractionは、CICSサーバーとの送受信を実行するときに、ECIInteractionSpecに定義されたプロパティを使用します。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public class ECIInteractionSpec
implements java.io.Serializable,
    javax.resource.cci.InteractionSpec

コンストラクター

コンストラクター	説明
public ECIInteractionSpec()	ECIInteractionSpecクラスのオブジェクトを作成します。次の値を設定します。 InteractionVerb : SYNC_SEND_RECEIVE UserID, Password : 使用しません。（setUserID()、setPassword()を使用して変更可能） Commarea Length : 5000バイト（setCommareaLength()を使用して変更可能）
public ECIInteractionSpec(int verb, String prog)	ECIInteractionSpecクラスのオブジェクトを作成します。デフォルト値については、public ECIInteractionSpec()コンストラクターを参照してください。パラメータ verb : InteractionVerbを指定します。 SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを指定します。（現在は、SYNC_SEND_RECEIVEのみサポートしています） prog : 実行するプログラム名を指定します。setFunctionName()メソッドを使用して変更できます。
public ECIInteractionSpec(int verb, String prog, int timeout, int commLen, int repLen)	ECIInteractionSpecクラスのオブジェクトを作成します。デフォルト値については、public ECIInteractionSpec()コンストラクターを参照してください。パラメータ verb : InteractionVerbを指定します。 SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを指定します（現在は、SYNC_SEND_RECEIVEのみサポートしています）。 prog : 実行するプログラム名を指定します。setFunctionName()メソッドを使用して変更できます。 timeout : 応答タイムアウトを指定します。（現在はサポートしていません） commLen : COMMAREAの長さを指定します。 repLen : 応答データの長さを指定します。現在は、この設定値と関係なく、すべての応答データを受信します。

説明

public ECIInteractionSpec()

ECIInteractionSpecクラスのオブジェクトを作成します。

次の値を設定します。

InteractionVerb : SYNC_SEND_RECEIVE
UserID, Password : 使用しません。（setUserID()、setPassword()を使用して変更可能）
Commarea Length : 5000バイト（setCommareaLength()を使用して変更可能）

public ECIInteractionSpec(int verb, String prog)

ECIInteractionSpecクラスのオブジェクトを作成します。デフォルト値については、public ECIInteractionSpec()コンストラクターを参照してください。

パラメータ
- verb : InteractionVerbを指定します。
  
  SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを指定します。（現在は、SYNC_SEND_RECEIVEのみサポートしています）
- prog : 実行するプログラム名を指定します。setFunctionName()メソッドを使用して変更できます。

public ECIInteractionSpec(int verb, String prog, int timeout, int commLen, int repLen)

ECIInteractionSpecクラスのオブジェクトを作成します。デフォルト値については、public ECIInteractionSpec()コンストラクターを参照してください。

パラメータ
- verb : InteractionVerbを指定します。
  
  SYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを指定します（現在は、SYNC_SEND_RECEIVEのみサポートしています）。
- prog : 実行するプログラム名を指定します。setFunctionName()メソッドを使用して変更できます。
- timeout : 応答タイムアウトを指定します。（現在はサポートしていません）
- commLen : COMMAREAの長さを指定します。
- repLen : 応答データの長さを指定します。現在は、この設定値と関係なく、すべての応答データを受信します。

メソッド

以下は、ECIInteractionSpecクラスのメソッドです。

メソッド	説明
public int getCommareaLength()	COMMAREAの長さを返します。
public int getExecuteTimeout()	ECIInteractionクラスのexecute()メソッドを実行時のタイムアウトを取得します。
public int getInteractionVerb()	InteractionVerbを返します。 InteractionSpecクラスに定義されているSYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを返します。
public String getFunctionName()	プログラム名を返します。
public String getPassword()	プログラムの実行時にTACF認証に使用されるパスワードを返します。
public int getReplyLength()	応答データの長さを返します。現在は、この設定値と関係なく、すべての応答データを受信します。
public String getTPNName()	TP名を返します。
public String getTranName()	Tran名を返します。
public String getUserID()	プログラムの実行時にTACF認証に使用されるIDを返します。
public void setCommareaLength(int length)	COMMAREAの長さを指定します。
public void setExecuteTimeout(int time)	ECIInteractionクラスのexecute()メソッドを実行時のタイムアウトを指定します。このメソッドを呼び出さない場合は、デフォルト値としてリソース・アダプターの設定値を使用します。
public void setFunctionName(String name)	呼び出すプログラム名を指定します。
public void setInteractionVerb(int verb)	InteractionVerbを指定します（現在は、SYNC_SEND_RECEIVEのみサポートしています）。
public void setUserID(String password)	プログラムの実行時にTACF認証に使用されるIDを指定します。この値が設定された場合は、ECIConnectionSpecクラスのsetUserName()メソッドより優先して適用されます。
public void setPassword(String password)	プログラムの実行時にTACF認証に使用されるパスワードを指定します。この値が設定された場合は、ECIConnectionSpecクラスのsetPassword()メソッドより優先して適用されます。
public void setReplyLength(int length)	応答データの長さを指定します。現在は、この設定値と関係なく、すべての応答データを受信します。
public void setTPNName(String newTPNName)	ECI呼び出しによって実行されるミラー・トランザクション名を指定します。 TPNNameとTranNameがいずれも指定されていない場合は、デフォルト値のCPMIがミラー・トランザクション名として使用されます。ただし、TPNNameとTranNameの両方を指定した場合は、TPNNameが優先して適用されます。
public void setTranName(java.lang.String newTranName)	ECI呼び出しによって実行されるミラー・トランザクション名を指定します。 TPNNameとTranNameがいずれも指定されていない場合は、デフォルト値のCPMIがミラー・トランザクション名として使用されます。ただし、TPNNameを指定せずにTranNameのみ指定した場合は、ミラー・トランザクションにはデフォルト値のCPMIが適用され、OSCのEIBTRNIDにはTranNameが適用されます。

メソッド

説明

public int getCommareaLength()

COMMAREAの長さを返します。

public int getExecuteTimeout()

ECIInteractionクラスのexecute()メソッドを実行時のタイムアウトを取得します。

public int getInteractionVerb()

InteractionVerbを返します。

InteractionSpecクラスに定義されているSYNC_SEND、SYNC_RECEIVE、SYNC_SEND_RECEIVEのいずれかを返します。

public String getFunctionName()

プログラム名を返します。

public String getPassword()

プログラムの実行時にTACF認証に使用されるパスワードを返します。

public int getReplyLength()

応答データの長さを返します。現在は、この設定値と関係なく、すべての応答データを受信します。

public String getTPNName()

TP名を返します。

public String getTranName()

Tran名を返します。

public String getUserID()

プログラムの実行時にTACF認証に使用されるIDを返します。

public void setCommareaLength(int length)

COMMAREAの長さを指定します。

public void setExecuteTimeout(int time)

ECIInteractionクラスのexecute()メソッドを実行時のタイムアウトを指定します。このメソッドを呼び出さない場合は、デフォルト値としてリソース・アダプターの設定値を使用します。

public void setFunctionName(String name)

呼び出すプログラム名を指定します。

public void setInteractionVerb(int verb)

InteractionVerbを指定します（現在は、SYNC_SEND_RECEIVEのみサポートしています）。

public void setUserID(String password)

プログラムの実行時にTACF認証に使用されるIDを指定します。

この値が設定された場合は、ECIConnectionSpecクラスのsetUserName()メソッドより優先して適用されます。

public void setPassword(String password)

プログラムの実行時にTACF認証に使用されるパスワードを指定します。

この値が設定された場合は、ECIConnectionSpecクラスのsetPassword()メソッドより優先して適用されます。

public void setReplyLength(int length)

応答データの長さを指定します。現在は、この設定値と関係なく、すべての応答データを受信します。

public void setTPNName(String newTPNName)

ECI呼び出しによって実行されるミラー・トランザクション名を指定します。

TPNNameとTranNameがいずれも指定されていない場合は、デフォルト値のCPMIがミラー・トランザクション名として使用されます。ただし、TPNNameとTranNameの両方を指定した場合は、TPNNameが優先して適用されます。

public void setTranName(java.lang.String newTranName)

ECI呼び出しによって実行されるミラー・トランザクション名を指定します。

TPNNameとTranNameがいずれも指定されていない場合は、デフォルト値のCPMIがミラー・トランザクション名として使用されます。ただし、TPNNameを指定せずにTranNameのみ指定した場合は、ミラー・トランザクションにはデフォルト値のCPMIが適用され、OSCのEIBTRNIDにはTranNameが適用されます。

15. ECIManagedConnectionFactory

ECIManagedConnectionFactoryは、ECI接続を作成するために使用される上位クラスです。このクラスには、CICSサーバーに接続するためのすべての情報が含まれています。該当の情報は、リソース・アダプターのra.xmlに設定します。ra.xmlの設定例については、[sect_resource_adapter]を参照してください。

ユーザーはこのクラスを直接使用するのではなく、リソース・アダプターに設定された名前でルックアップを実行すると、createConnectionFactoryによって作成されたECIConnectionFactoryを取得して使用することになります。リソース・アダプターに設定できる名前とタイプについては、CICSManagedConnectionFactoryを参照してください。

パッケージ
```
com.tmax.ofctg.connector.cics
```

クラスの定義

public final class ECIManagedConnectionFactory
extends com.tmax.ofctg.connector.cics.CICSManagedConnectionFactory
implements javax.resource.spi.ManagedConnectionFactory,
    javax.resource.spi.TransactionSupport

16. ECIResourceAdapterRc

OSCアプリケーション・サーバーの実行中に発生したエラーの定数を定義したクラスです。

パッケージ
```
com.tmax.ofctg.connector.cics
```
クラスの定義
```
public class ECIResourceAdapterRc
```

メソッド

以下は、ECIResourceAdapterRcクラスのメソッドです。

メソッド	説明
public static String getErrorMessage(int cicsRespCode)	エラー定数の文字列を返します。応答コード ECI_NO_ERROR ECI_ERR_INVALID_DATA_LENGTH ECI_ERR_INVALID_EXTEND_MODE ECI_ERR_NO_CICS ECI_ERR_CICS_DIED ECI_ERR_RESPONSE_TIMEOUT ECI_ERR_TRANSACTION_ABEND ECI_ERR_LUW_TOKEN ECI_ERR_SYSTEM_ERROR ECI_ERR_THREAD_CREATE_ERROR ECI_ERR_INVALID_DATA_AREA ECI_ERR_UNKNOWN_SERVER ECI_ERR_INVALID_TRANSID ECI_ERR_SECURITY_ERROR サーバーの状態 : サーバーの状態を返します。 ECI_SERVERSTATE_DOWN ECI_SERVERSTATE_UNKNOWN ECI_SERVERSTATE_UP 各コードについての詳細は、「ECIResourceAdapterRcクラスの定数」を参照してください。

メソッド

説明

public static String getErrorMessage(int cicsRespCode)

エラー定数の文字列を返します。

応答コード
- ECI_NO_ERROR
- ECI_ERR_INVALID_DATA_LENGTH
- ECI_ERR_INVALID_EXTEND_MODE
- ECI_ERR_NO_CICS
- ECI_ERR_CICS_DIED
- ECI_ERR_RESPONSE_TIMEOUT
- ECI_ERR_TRANSACTION_ABEND
- ECI_ERR_LUW_TOKEN
- ECI_ERR_SYSTEM_ERROR
- ECI_ERR_THREAD_CREATE_ERROR
- ECI_ERR_INVALID_DATA_AREA
- ECI_ERR_UNKNOWN_SERVER
- ECI_ERR_INVALID_TRANSID
- ECI_ERR_SECURITY_ERROR
サーバーの状態 : サーバーの状態を返します。
- ECI_SERVERSTATE_DOWN
- ECI_SERVERSTATE_UNKNOWN
- ECI_SERVERSTATE_UP

各コードについての詳細は、「ECIResourceAdapterRcクラスの定数」を参照してください。

ECI_ERR_NO_REPLY、ECI_ERR_REQUEST_TIMEOUT、ECI_ERR_EXEC_NOT_RESIDENT、ECI_ERR_NULL_WIN_HANDLE、ECI_ERR_NULL_MESSAGE_ID、ECI_ERR_ALREADY_ACTIVE、ECI_ERR_RESOURCE_SHORTAGE、ECI_ERR_NO_SESSIONS、ECI_ERR_NULL_SEM_HANDLE、ECI_ERR_INVALID_VERSION、ECI_ERR_MORE_SYSTEMS、ECI_ERR_CALL_FROM_CALLBACK、ECI_ERR_NO_SYSTEMS、ECI_ERR_MAX_SYSTEMS、ECI_ERR_MAX_SESSIONS、ECI_ERR_ROLLEDBACK、ECI_ERR_XID_INVALIDなどの応答コードはサポートされません。

ECIResourceAdapterRcクラスの定数

以下は、ECIResourceAdapterRcクラスの定数です。

定数名	値	説明
public static final short ECI_CLIENTSTATE_UNKNOWN	0	クライアントの状態が不明です。
public static final short ECI_CLIENTSTATE_UP	1	クライアントが使用可能です。
public static final int ECI_ERR_CICS_DIED	-4	通信中にリージョン・サーバーが終了されました。
public static final int ECI_ERR_INVALID_CALL_TYPE	-14	ECI_SYNC、ECI_SYNC_TPN以外の値が指定されました。
public static final int ECI_ERR_INVALID_DATA_AREA	-19	COMMAREAの長さと実際に受信したデータの長さが一致しません。
public static final int ECI_ERR_INVALID_DATA_LENGTH	-1	COMMAREAの長さが無効です。
public static final int ECI_ERR_INVALID_EXTEND_MODE	-2	拡張モードがECI_NO_EXTENDではありません。
public static final int ECI_ERR_INVALID_TRANSID	-24	定義されていないトランザクションが呼び出されました。
public static final int ECI_ERR_LUW_TOKEN	-8	不明なLUWトークンです。
public static final int ECI_ERR_NO_CICS	-3	該当のリージョン・サーバーが起動されていません。
public static final int ECI_ERR_RESPONSE_TIMEOUT	-6	応答待ち中にタイムアウトになりました。
public static final int ECI_ERR_SECURITY_ERROR	-27	ユーザーIDとパスワードが無効です。
public static final int ECI_ERR_SYSTEM_ERROR	-9	不明な内部エラーです。
public static final int ECI_ERR_TRANSACTION_ABEND	-7	トランザクションの異常終了が発生しました。
public static final int ECI_ERR_UNKNOWN_SERVER	-22	不明なリージョン・サーバーです。
public static final int ECI_EXTENDED	2	拡張モードがEXTENDEDです。
public static final int ECI_NO_ERROR	0	正常に終了されました。
public static final int ECI_NO_EXTEND	1	拡張モードがNO_EXTENDです。
public static final short ECI_SERVERSTATE_DOWN	2	サーバーが起動されていません。
public static final short ECI_SERVERSTATE_UNKNOWN	0	サーバーの状態が不明です。
public static final short ECI_SERVERSTATE_UP	1	サーバーの状態が正常です。
public static final int ECI_SYNC	1	呼び出しタイプがSYNCに指定されています。
public static final int ECI_SYNC_TPN	2	呼び出しタイプがSYNC_TPNに指定されています。

定数名

値

説明

public static final short ECI_CLIENTSTATE_UNKNOWN

クライアントの状態が不明です。

public static final short ECI_CLIENTSTATE_UP

クライアントが使用可能です。

public static final int ECI_ERR_CICS_DIED

-4

通信中にリージョン・サーバーが終了されました。

public static final int ECI_ERR_INVALID_CALL_TYPE

-14

ECI_SYNC、ECI_SYNC_TPN以外の値が指定されました。

public static final int ECI_ERR_INVALID_DATA_AREA

-19

COMMAREAの長さと実際に受信したデータの長さが一致しません。

public static final int ECI_ERR_INVALID_DATA_LENGTH

-1

COMMAREAの長さが無効です。

public static final int ECI_ERR_INVALID_EXTEND_MODE

-2

拡張モードがECI_NO_EXTENDではありません。

public static final int ECI_ERR_INVALID_TRANSID

-24

定義されていないトランザクションが呼び出されました。

public static final int ECI_ERR_LUW_TOKEN

-8

不明なLUWトークンです。

public static final int ECI_ERR_NO_CICS

-3

該当のリージョン・サーバーが起動されていません。

public static final int ECI_ERR_RESPONSE_TIMEOUT

-6

応答待ち中にタイムアウトになりました。

public static final int ECI_ERR_SECURITY_ERROR

-27

ユーザーIDとパスワードが無効です。

public static final int ECI_ERR_SYSTEM_ERROR

-9

不明な内部エラーです。

public static final int ECI_ERR_TRANSACTION_ABEND

-7

トランザクションの異常終了が発生しました。

public static final int ECI_ERR_UNKNOWN_SERVER

-22

不明なリージョン・サーバーです。

public static final int ECI_EXTENDED

拡張モードがEXTENDEDです。

public static final int ECI_NO_ERROR

正常に終了されました。

public static final int ECI_NO_EXTEND

拡張モードがNO_EXTENDです。

public static final short ECI_SERVERSTATE_DOWN

サーバーが起動されていません。

public static final short ECI_SERVERSTATE_UNKNOWN

サーバーの状態が不明です。

public static final short ECI_SERVERSTATE_UP

サーバーの状態が正常です。

public static final int ECI_SYNC

呼び出しタイプがSYNCに指定されています。

public static final int ECI_SYNC_TPN

呼び出しタイプがSYNC_TPNに指定されています。