OracleLobHandler (Spring Framework 4.3.24.RELEASE API)

java.lang.ObjectSE
- org.springframework.jdbc.support.lob.AbstractLobHandler
- - org.springframework.jdbc.support.lob.OracleLobHandler

実装されているすべてのインターフェース:
LobHandler
使用すべきではありません。
Oracle 10g ドライバ以上では、DefaultLobHandler を推奨します。Oracle 9i データベースに対しても、10g/11g ドライバの使用を検討してください。DefaultLobHandler.setCreateTemporaryLob(boolean) は、この OracleLobHandler の実装戦略と直接同等であり、標準の JDBC 4.0 API を使用するだけです。ただし、ほとんどの場合、通常の DefaultLobHandler セットアップでも問題なく動作します。
```
@DeprecatedSE
public class OracleLobHandler
extends AbstractLobHandler
```
Oracle データベース用の LobHandler 実装。Oracle の JDBC ドライバーを使用する場合、必要に応じて独自の API を使用して oracle.sql.BLOB および oracle.sql.CLOB インスタンスを作成します。この LobHandler には、Oracle JDBC ドライバー 9i 以上が必要であることに注意してください。
ほとんどのデータベースは DefaultLobHandler で動作できますが、Oracle 9i (より具体的には、Oracle 9i JDBC ドライバー) は、独自の BLOB/CLOB API を介して作成された Blob/Clob インスタンスのみを受け入れ、さらに、PreparedStatement の対応する setter メソッドの大きなストリームを受け入れません。したがって、この LobHandler 実装のような戦略を使用するか、Oracle 10g/11g ドライバー (引き続き Oracle 9i データベースへのアクセスをサポート) にアップグレードする必要があります。
注意: Oracle 10.2 では、DefaultLobHandler はそのままでも同様に動作するはずです。Oracle 11g では、DefaultLobHandler.setStreamAsLob(boolean) や DefaultLobHandler.setCreateTemporaryLob(boolean) などの JDBC 4.0 ベースのオプションも利用できるため、この独自の OracleLobHandler は廃止されています。また、古いデータベースにアクセスする場合でも、新しいドライバーへのアップグレードを検討してください。推奨事項の概要については、LobHandler インターフェースの javadoc を参照してください。
ネイティブ JDBC 接続で動作し、それを oracle.jdbc.OracleConnection にキャストできるようにする必要があります。接続プールから接続を渡す場合 (Java EE 環境では通常の場合)、適切な NativeJdbcExtractor を設定して、基礎となるネイティブ JDBC 接続を自動的に取得できるようにする必要があります。LobHandler と NativeJdbcExtractor は別の問題であるため、別の戦略インターフェースで表されます。
Oracle クラスへの依存を避けるために、リフレクションを介してコード化されています。異なる Oracle ドライバー (classes12、ojdbc14、ojdbc5、ojdbc6) が異なる定数値を持つため、リフレクションを介して Oracle 定数も読み込まれます。この LobHandler はインスタンス化時に Oracle クラスを初期化するため、クラスパスにある Oracle JAR に依存したくない場合は、これを積極的な初期化シングルトンとして定義しないでください。この課題を回避するには、"lazy-init=true" を使用します。
導入:
04.12.2003
作成者:
Juergen Hoeller, Thomas Risberg
関連事項:
DefaultLobHandler, setNativeJdbcExtractor(org.springframework.jdbc.support.nativejdbc.NativeJdbcExtractor)

ネストされたクラスの要約

ネストされたクラス
修飾子と型	クラスと説明
`protected static interface`	`OracleLobHandler.LobCallback` 使用すべきではありません。 createLob で使用するための内部コールバックインターフェース。
`protected class`	`OracleLobHandler.OracleLobCreator` 使用すべきではありません。 Oracle データベース用の LobCreator 実装。

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger
使用すべきではありません。

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger` 使用すべきではありません。

コンストラクターの概要
コンストラクター
コンストラクターと説明
OracleLobHandler()
使用すべきではありません。

コンストラクター
コンストラクターと説明
`OracleLobHandler()` 使用すべきではありません。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`InputStreamSE`	`getBlobAsBinaryStream(ResultSetSE rs, int columnIndex)` 使用すべきではありません。指定された ResultSet から、指定された列をバイナリストリームとして取得します。
`byte[]`	`getBlobAsBytes(ResultSetSE rs, int columnIndex)` 使用すべきではありません。指定された ResultSet から指定された列をバイトとして取得します。
`InputStreamSE`	`getClobAsAsciiStream(ResultSetSE rs, int columnIndex)` 使用すべきではありません。指定された ResultSet から指定された列を ASCII ストリームとして取得します。
`ReaderSE`	`getClobAsCharacterStream(ResultSetSE rs, int columnIndex)` 使用すべきではありません。指定された ResultSet から、指定された列を文字ストリームとして取得します。
`StringSE`	`getClobAsString(ResultSetSE rs, int columnIndex)` 使用すべきではありません。指定された ResultSet から指定された列を文字列として取得します。
`LobCreator`	`getLobCreator()` 使用すべきではありません。新しい `LobCreator` インスタンスを作成します。
`protected void`	`initializeResourcesBeforeRead(ConnectionSE con, ObjectSE lob)` 使用すべきではありません。読み取りが完了する前に、LOB リソースを初期化します。
`protected void`	`initOracleDriverClasses(ConnectionSE con)` 使用すべきではありません。リフレクションを介して `oracle.sql.BLOB` クラスと `oracle.sql.CLOB` クラスを取得し、そこで定義されている DURATION_SESSION、MODE_READWRITE、MODE_READONLY 定数の値を初期化します。
`protected void`	`releaseResourcesAfterRead(ConnectionSE con, ObjectSE lob)` 使用すべきではありません。読み取りが完了したら、LOB リソースを解放します。
`void`	`setCache(boolean cache)` 使用すべきではありません。一時 LOB をバッファキャッシュにキャッシュするかどうかを設定します。
`void`	`setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor)` 使用すべきではありません。基礎となるネイティブ `oracle.jdbc.OracleConnection` を取得できるように、適切な NativeJdbcExtractor を設定します。
`void`	`setReleaseResourcesAfterRead(boolean releaseResources)` 使用すべきではありません。 LOB によって使用されるリソースを積極的に解放するかどうかを設定します。

クラス org.springframework.jdbc.support.lob.AbstractLobHandler から継承されたメソッド
getBlobAsBinaryStream, getBlobAsBytes, getClobAsAsciiStream, getClobAsCharacterStream, getClobAsString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - logger
```
protected final Log logger
```
    使用すべきではありません。
- コンストラクターの詳細
  - OracleLobHandler
```
public OracleLobHandler()
```
    使用すべきではありません。
- メソッドの詳細
  - setNativeJdbcExtractor
```
public void setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor)
```
    使用すべきではありません。
    適切な NativeJdbcExtractor を設定して、基礎となるネイティブ oracle.jdbc.OracleConnection を取得できるようにします。これは、ネイティブの Connection 実装にキャストできないラップされた JDBC Connection ハンドルを返す必要がある DataSource ベースの接続プールに必要です。
    実際には、この LobHandler は単一の NativeJdbcExtractor メソッド、つまり PreparedStatement 引数を持つ getNativeConnectionFromStatement を呼び出すだけです (抽出子が設定されていない場合は、PreparedStatement.getConnection() 呼び出しにフォールバックします)。
    一般的な選択肢は SimpleNativeJdbcExtractor です。その Connection アンラップ (OracleLobHandler に必要な機能) は、多くの接続プールで機能します。詳細については、SimpleNativeJdbcExtractor および oracle.jdbc.OracleConnection の javadoc を参照してください。
    関連事項:
    NativeJdbcExtractor.getNativeConnectionFromStatement(java.sql.Statement), SimpleNativeJdbcExtractor, OracleJdbc4NativeJdbcExtractor
  - setCache
```
public void setCache(boolean cache)
```
    使用すべきではありません。
    一時 LOB をバッファキャッシュにキャッシュするかどうかを設定します。この値は BLOB/CLOB.createTemporary に渡されます。
    デフォルトは true です。
    関連事項:
    - oracle.sql.BLOB.createTemporary
    - oracle.sql.CLOB.createTemporary
  - setReleaseResourcesAfterRead
```
public void setReleaseResourcesAfterRead(boolean releaseResources)
```
    使用すべきではありません。
    LOB によって使用されるリソースを積極的に解放するかどうかを設定します。true に設定すると、LOB 値を 1 回だけ読み取ることができます。リソースが閉じられているため、それ以降の読み取りは失敗します。
    このプロパティを true に設定すると、クエリによって TEMPORARY 表領域の領域を占有する大きな一時 LOB が生成される場合や、LOB 読み取り用にドライバーによって割り当てられたメモリを解放する場合に役立ちます。
    デフォルトは false です。
    関連事項:
  - initOracleDriverClasses
```
protected void initOracleDriverClasses(ConnectionSE con)
```
    使用すべきではありません。
    リフレクションを介して oracle.sql.BLOB クラスと oracle.sql.CLOB クラスを取得し、そこで定義されている DURATION_SESSION、MODE_READWRITE、MODE_READONLY 定数の値を初期化します。
    関連事項:
    パラメーター:
    con - Oracle 接続は、Oracle ドライバがロードされたのと全く同じクラスローダーを使用するため
  - getBlobAsBytes
```
public byte[] getBlobAsBytes(ResultSetSE rs,
                             int columnIndex)
                      throws SQLExceptionSE
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    指定された ResultSet から指定された列をバイトとして取得します。データベースとドライバーに応じて、単に ResultSet.getBytes を呼び出すか、ResultSet.getBlob を操作する場合があります。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    バイト配列としてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getBytes(int)SE
  - getBlobAsBinaryStream
```
public InputStreamSE getBlobAsBinaryStream(ResultSetSE rs,
                                         int columnIndex)
                                  throws SQLExceptionSE
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    指定された ResultSet から、指定された列をバイナリストリームとして取得します。データベースとドライバーに応じて、単に ResultSet.getBinaryStream を呼び出すか、ResultSet.getBlob を操作します。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    バイナリストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getBinaryStream(int)SE
  - getClobAsString
```
public StringSE getClobAsString(ResultSetSE rs,
                              int columnIndex)
                       throws SQLExceptionSE
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    指定された ResultSet から指定された列を文字列として取得します。データベースとドライバーに応じて、単に ResultSet.getString を呼び出すか、ResultSet.getClob を操作します。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    文字列としてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getString(int)SE
  - getClobAsAsciiStream
```
public InputStreamSE getClobAsAsciiStream(ResultSetSE rs,
                                        int columnIndex)
                                 throws SQLExceptionSE
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    指定された ResultSet から指定された列を ASCII ストリームとして取得します。データベースとドライバーに応じて、単に ResultSet.getAsciiStream を呼び出すか、ResultSet.getClob を操作します。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    ASCII ストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getAsciiStream(int)SE
  - getClobAsCharacterStream
```
public ReaderSE getClobAsCharacterStream(ResultSetSE rs,
                                       int columnIndex)
                                throws SQLExceptionSE
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    指定された ResultSet から、指定された列を文字ストリームとして取得します。データベースとドライバーに応じて、単に ResultSet.getCharacterStream を呼び出すか、ResultSet.getClob を操作します。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    文字ストリームとしてのコンテンツ
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getCharacterStream(int)SE
  - getLobCreator
```
public LobCreator getLobCreator()
```
    使用すべきではありません。
    インターフェースからコピーされた説明: LobHandler
    新しい LobCreator インスタンス、つまり BLOB と CLOB を作成するためのセッションを作成します。作成された LOB が不要になった後、通常はステートメントの実行後またはトランザクションの完了後に閉じる必要があります。
    戻り値:
    新しい LobCreator インスタンス
    関連事項:
    LobCreator.close()
  - initializeResourcesBeforeRead
```
protected void initializeResourcesBeforeRead(ConnectionSE con,
                                             ObjectSE lob)
```
    使用すべきではありません。
    読み取りが完了する前に、LOB リソースを初期化します。
    この実装では、releaseResourcesAfterRead プロパティが true に設定されている場合、非一時 LOB に対して BLOB.open(BLOB.MODE_READONLY) または CLOB.open(CLOB.MODE_READONLY) を呼び出します。
    異なる動作が必要な場合、このメソッドはサブクラスによってオーバーライドできます。
    パラメーター:
    con - 初期化に使用する接続
    lob - 初期化する LOB
  - releaseResourcesAfterRead
```
protected void releaseResourcesAfterRead(ConnectionSE con,
                                         ObjectSE lob)
```
    使用すべきではありません。
    読み取りが完了したら、LOB リソースを解放します。
    releaseResourcesAfterRead プロパティが true に設定されている場合、この実装は、開いている非一時 LOB に対して BLOB.close() または CLOB.close() を呼び出し、一時 LOB に対して BLOB.freeTemporary() または CLOB.freeTemporary() を呼び出します。
    異なる動作が必要な場合、このメソッドはサブクラスによってオーバーライドできます。
    パラメーター:
    con - 初期化に使用する接続
    lob - 初期化する LOB

クラス OracleLobHandler

ネストされたクラスの要約

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.jdbc.support.lob.AbstractLobHandler から継承されたメソッド

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

フィールドの詳細

logger

コンストラクターの詳細

OracleLobHandler

メソッドの詳細

setNativeJdbcExtractor

setCache

setReleaseResourcesAfterRead

initOracleDriverClasses

getBlobAsBytes

getBlobAsBinaryStream

getClobAsString

getClobAsAsciiStream

getClobAsCharacterStream

getLobCreator

initializeResourcesBeforeRead

releaseResourcesAfterRead