パッケージ jakarta.resource.cci
インターフェース ConnectionFactory
- すべてのスーパーインターフェース:
Referenceable、ReferenceableSE、SerializableSE
public interface ConnectionFactory extends SerializableSE, Referenceable
ConnectionFactoryは、EIS インスタンスへの接続を取得するためのインターフェースを提供します。ConnectionFactory インターフェースの実装は、リソースアダプターによって提供されます。アプリケーションコードは、JNDI 名前空間から ConnectionFactory インスタンスを検索し、それを使用して EIS 接続を取得します。
JNDI 登録をサポートするために
java.io.Serializableおよびjakarta.resource.Referenceableインターフェースを実装するには、ConnectionFactory の実装クラスが必要です。- バージョン:
- 0.8
- 作成者:
- Rahul Sharma
- 関連事項:
Connection,Referenceable
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ConnectiongetConnection()EIS インスタンスへの接続を取得します。ConnectiongetConnection(ConnectionSpec properties)EIS インスタンスへの接続を取得します。ResourceAdapterMetaDatagetMetaData()リソースアダプターのメタデータを取得します。RecordFactorygetRecordFactory()RecordFactory インスタンスを取得します。インターフェース jakarta.resource.Referenceable から継承されたメソッド
setReference
インターフェース javax.naming.ReferenceableSE から継承されたメソッド
getReference
メソッドの詳細
getConnection
Connection getConnection() throws ResourceException
EIS インスタンスへの接続を取得します。この getConnection バリアントは、コンポーネントがコンテナーに EIS サインオンを管理させたい場合に使用します。このケースは、コンテナー管理サインオンと呼ばれます。コンポーネントはセキュリティ情報を渡しません。- 戻り値:
- 接続インスタンス
- 例外:
ResourceException- EIS インスタンスへの接続を取得できませんでした。エラーケースの例は次のとおりです。- ManagedConnectionFactory の構成が無効です - 例: サーバー名が無効です
- アプリケーションサーバー - 内部エラー - 例: 接続プール関連のエラー
- 通信エラー
- EIS 固有のエラー - 例: EIS がアクティブではありません
- リソースアダプター - 内部エラー
- セキュリティ関連のエラー。例: 無効なユーザー
- システムリソースの割り当ての失敗
getConnection
Connection getConnection(ConnectionSpec properties) throws ResourceException
EIS インスタンスへの接続を取得します。コンポーネントは、リソースアダプター固有のセキュリティ情報と接続パラメーターを渡す必要がある場合、jakarta.resource.cci.ConnectionSpec パラメーターを指定した getConnection バリアントを使用する必要があります。コンポーネント管理サインオンの場合、アプリケーションコンポーネントは、セキュリティ情報 (例: ユーザー名、パスワード) を ConnectionSpec インスタンスを介して渡します。getConnection メソッドを通じて渡されるプロパティはクライアント固有 (例: ユーザー名、パスワード、言語) であり、ターゲット EIS インスタンスの構成 (例: ポート番号、サーバー名) とは関連がないことに注意してください。ManagedConnectionFactory インスタンスは、EIS インスタンスへの接続の作成に必要なプロパティの完全なセットで構成されます。
- パラメーター:
properties- ConnectionSpec インスタンスとして指定された接続パラメーターとセキュリティ情報- 戻り値:
- 接続インスタンス
- 例外:
ResourceException- EIS インスタンスへの接続を取得できませんでした。エラーケースの例は次のとおりです。- 入力パラメーターの指定が無効です
- ManagedConnectionFactory の構成が無効です - 例: サーバー名が無効です
- アプリケーションサーバー - 内部エラー - 例: 接続プール関連のエラー
- 通信エラー
- EIS 固有のエラー - 例: EIS がアクティブではありません
- リソースアダプター - 内部エラー
- セキュリティ関連のエラー。例: 無効なユーザー
- システムリソースの割り当ての失敗
- 関連事項:
ConnectionSpec
getRecordFactory
RecordFactory getRecordFactory() throws ResourceException
RecordFactory インスタンスを取得します。RecordFactory は、汎用レコードインスタンスの作成に使用されます。- 戻り値:
- RecordFactory RecordFactory インスタンス
- 例外:
ResourceException- RecordFactory の作成に失敗しましたNotSupportedException- 操作がサポートされていません
getMetaData
ResourceAdapterMetaData getMetaData() throws ResourceException
リソースアダプターのメタデータを取得します。メタデータ情報は ResourceAdapter に関するものであり、EIS インスタンスに関するものではないことに注意してください。このメソッドの呼び出しでは、EIS インスタンスへのアクティブな接続が確立されている必要はありません。- 戻り値:
- ResourceAdapterMetaData インスタンス
- 例外:
ResourceException- リソースアダプターに関するメタデータ情報の取得に失敗しました