com.fujitsu.shun
クラス ShunConnection

java.lang.Object
  |
  +--com.fujitsu.shun.ShunConnection

public class ShunConnection

extends java.lang.Object

shunsaku1コネクションを表現するクラスです。
ShunConnectionクラスを生成することで、Shunsakuに接続することができます。

API用動作環境ファイルに指定した接続先の情報を用いて接続
API用動作環境ファイルにホスト名とポート番号を設定しておき、 以下のコンストラクタを使用してShunConnectionクラスを生成します。

ShunConnection con = new ShunConnection();

このとき、API用動作環境ファイルに指定がない場合またはAPI用動作環境ファイルが 存在しない場合は、以下の値を使用してShunsakuに接続します。

ホスト名またはIPアドレス : localhost
ポート番号               : 23101
Shunsaku File名          : 指定しません

Propertiesに指定した接続先の情報を用いて接続
以下のコンストラクタを使用してShunConnectionクラスを生成します。

ShunConnection con = new ShunConnection(properties);

このとき、プロパティリストにキーの指定がない場合は、 API用動作環境ファイルの指定で接続します。 API用動作環境ファイルに指定がない場合またはAPI用動作環境ファイルが 存在しない場合は、以下の値を使用してShunsakuに接続します。

ホスト名またはIPアドレス : localhost
ポート番号               : 23101
Shunsaku File名          : 指定しません

ホスト名とポート番号を指定して接続
以下のコンストラクタを使用してShunConnectionクラスを生成します。

ShunConnection con = new ShunConnection(host,port);

このとき、ホスト名にnullが指定された場合は、API用動作環境ファイルの指定で接続します。 API用動作環境ファイルに指定がない場合またはAPI用動作環境ファイルが 存在しない場合は、localhostに接続します。
API用動作環境ファイルにShunsaku File名が指定された場合は、有効となります。

ホスト名、ポート番号およびShunsaku File名を指定して接続
以下のコンストラクタを使用してShunConnectionクラスを生成します。

ShunConnection con = new ShunConnection(host,port,shunsakuFile);

このとき、ホスト名またはShunsaku File名にnullが指定された場合は、 API用動作環境ファイルの指定で接続します。 API用動作環境ファイルに指定がない場合またはAPI用動作環境ファイルが 存在しない場合は、以下の値を使用してShunsakuに接続します。

ホスト名またはIPアドレス : localhost
Shunsaku File名          : 指定しません

フィールドの概要

static java.lang.String	SHUN_DEFAULT_SHUNSAKU_FILE ShunsakuのDefault Fileを示します。
static java.lang.String	SHUN_NOT_USED_SHUNSAKU_FILE 接続先のShunsakuがShunsaku File機能を使用していないことを示します。

コンストラクタの概要

ShunConnection()
ShunConnectionオブジェクトを作成します。

ShunConnection(java.util.Properties properties)
Propertiesに指定されたホスト名、ポート番号およびShunsaku File名を用いて、 ShunConnectionオブジェクトを作成します。

ShunConnection(java.lang.String host, int port)
ホスト名とポート番号を指定して、ShunConnectionオブジェクトを作成します。

ShunConnection(java.lang.String host, int port, java.lang.String shunsakuFile)
ホスト名、ポート番号、およびShunsaku File名を指定して、ShunConnectionオブジェクトを作成します。

メソッドの概要

void	close() ShunConnectionオブジェクトを解放します。
void	commit() 現在実行中のトランザクションを有効にして、トランザクションを終了します。
boolean	getAutoCommit() 現在のコミットモードを返却します。
java.lang.String	getHostName() 接続先のホスト名またはIPアドレスを返却します。
int	getPort() 接続先のポート番号を返却します。
java.lang.String	getServerEncoding() Shunsakuのデータの文字コードをJavaのエンコーディング名で返却します。
java.lang.String	getShunsakuFileName() 接続先のShunsaku File名を返却します。
ShunPreparedKey	prepareDeleteKey(java.lang.String keyName) ダイレクトアクセスキーを指定してXML文書を削除するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedRecordID	prepareDeleteRecordID() レコードIDを指定してXML文書を削除するためのShunPreparedRecordIDオブジェクトを作成します。
ShunPreparedStatement	prepareInsert() XML文書を追加するためのShunPreparedStatementオブジェクトを作成します。
ShunPreparedStatement	prepareSearch(java.lang.String queryExpression, java.lang.String returnExpression) 検索式を指定してデータを検索するためのShunPreparedStatementオブジェクトを作成します。
ShunPreparedKey	prepareSearchKey(java.lang.String keyName, java.lang.String returnExpression) ダイレクトアクセスキーを指定してXML文書を検索するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedRecordID	prepareSearchRecordID() レコードIDを指定してデータを検索するためのShunPreparedRecordIDオブジェクトを作成します。
ShunPreparedKey	prepareUpdateKey(java.lang.String keyName) ダイレクトアクセスキーを指定してXML文書を更新するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedRecordID	prepareUpdateRecordID() レコードIDを指定してXML文書を更新するためのShunPreparedRecordIDオブジェクトを作成します。
void	rollback() 現在実行中のトランザクションを無効にして、トランザクションを終了します。
void	setAutoCommit(boolean autoCommit) コミットモードを指定します。
void	setShunsakuFileName(java.lang.String shunsakuFile) 接続先のShunsaku Fileを切り替えます。

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

SHUN_DEFAULT_SHUNSAKU_FILE

public static final java.lang.String SHUN_DEFAULT_SHUNSAKU_FILE

ShunsakuのDefault Fileを示します。
setShunsakuFileNameメソッドおよびコンストラクタで、 ShunsakuのDefault Fileを指定したい場合に使用します。

関連項目:

setShunsakuFileName(String), ShunConnection(String,int,String)

SHUN_NOT_USED_SHUNSAKU_FILE

public static final java.lang.String SHUN_NOT_USED_SHUNSAKU_FILE

接続先のShunsakuがShunsaku File機能を使用していないことを示します。
getShunsakuFileNameメソッドで接続先のShunsaku File名を取得する場合に返却されます。

関連項目:

getShunsakuFileName()

コンストラクタの詳細

ShunConnection

public ShunConnection()
               throws ShunException

ShunConnectionオブジェクトを作成します。
ShunConnectionオブジェクトは、使用後に必ずcloseメソッドで解放してください。

例外:

ShunException - Shunsaku Java APIの例外

ShunConnection

public ShunConnection(java.util.Properties properties)
               throws ShunException

Propertiesに指定されたホスト名、ポート番号およびShunsaku File名を用いて、 ShunConnectionオブジェクトを作成します。
ShunConnectionオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

properties - Shunsakuに接続するための以下の情報を持ったプロパティリスト

以下のキー値を設定します。
connection.hostには、接続先のホスト名またはIPアドレスを指定してください。 IPv4マップドアドレス、リンクローカルアドレス、IPv4マップドアドレスまたはリンクローカルアドレスを表すホスト名は指定できません。
connection.portには、接続先のポート番号を指定してください。
connection.shunsakuFileには、接続先のShunsaku File名を指定してください。

例外:

ShunException - Shunsaku Java APIの例外

ShunConnection

public ShunConnection(java.lang.String host,
                      int port)
               throws ShunException

ホスト名とポート番号を指定して、ShunConnectionオブジェクトを作成します。
ShunConnectionオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

host - 接続先のホスト名またはIPアドレス

IPv4マップドアドレス、リンクローカルアドレス、IPv4マップドアドレスまたはリンクローカルアドレスを表すホスト名は指定できません。

port - 接続先のポート番号

例外:

ShunException - Shunsaku Java APIの例外

ShunConnection

public ShunConnection(java.lang.String host,
                      int port,
                      java.lang.String shunsakuFile)
               throws ShunException

ホスト名、ポート番号、およびShunsaku File名を指定して、ShunConnectionオブジェクトを作成します。
ShunsakuのDefault Fileに接続したい場合には、定数SHUN_DEFAULT_SHUNSAKU_FILEを指定してください。
ShunConnectionオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

host - 接続先のホスト名またはIPアドレス

IPv4マップドアドレス、リンクローカルアドレス、IPv4マップドアドレスまたはリンクローカルアドレスを表すホスト名は指定できません。

port - 接続先のポート番号

shunsakuFile - 接続先のShunsaku File名

例外:

ShunException - Shunsaku Java APIの例外

メソッドの詳細

close

public void close()
           throws ShunException

ShunConnectionオブジェクトを解放します。
本メソッドが呼び出されたときに、 対象のShunConnectionオブジェクトが作成したShunPreparedStatementオブジェクト、 ShunPreparedRecordIDオブジェクト、 ShunPreparedKeyオブジェクトおよびShunResultSetオブジェクトも解放されます。
自動コミットを無効に設定した状態で、 かつ本メソッドを実行する前にcommitまたはrollbackメソッドによってトランザクションを終了していない場合は、 コミットされます。

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement, ShunPreparedRecordID, ShunPreparedKey, ShunResultSet

commit

public void commit()
            throws ShunException

現在実行中のトランザクションを有効にして、トランザクションを終了します。
自動コミットが有効の場合、本メソッドを使用すると例外が発生します。

例外:

ShunException - Shunsaku Java APIの例外

getAutoCommit

public boolean getAutoCommit()
                      throws ShunException

現在のコミットモードを返却します。

戻り値:

現在のコミットモード（trueの場合は自動コミットが有効、falseの場合は自動コミットが無効）

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

setAutoCommit(boolean)

getHostName

public java.lang.String getHostName()
                             throws ShunException

接続先のホスト名またはIPアドレスを返却します。

戻り値:

接続先のホスト名またはIPアドレス

例外:

ShunException - Shunsaku Java APIの例外

getPort

public int getPort()
            throws ShunException

接続先のポート番号を返却します。

戻り値:

接続先のポート番号

例外:

ShunException - Shunsaku Java APIの例外

getServerEncoding

public java.lang.String getServerEncoding()
                                   throws ShunException

Shunsakuのデータの文字コードをJavaのエンコーディング名で返却します。 Javaのエンコーディング名については、 “Java 2 SDK, Standard Edition ドキュメント”を参照してください。

戻り値:

文字コード

例外:

ShunException - Shunsaku Java APIの例外

getShunsakuFileName

public java.lang.String getShunsakuFileName()
                                     throws ShunException

接続先のShunsaku File名を返却します。
接続先がShunsaku Fileの機能を使用していない場合は、 定数SHUN_NOT_USED_SHUNSAKU_FILEを返却します。

戻り値:

接続先のShunsaku File名

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

setShunsakuFileName(String)

prepareDeleteKey

public ShunPreparedKey prepareDeleteKey(java.lang.String keyName)
                                 throws ShunException

ダイレクトアクセスキーを指定してXML文書を削除するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedKeyオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

keyName - ダイレクトアクセスキー名

ダイレクトアクセスキー名は、1〜32バイト以内の半角英数字で指定してください。

戻り値:

ダイレクトアクセスキーによりXML文書を削除するためのShunPreparedKeyオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

prepareDeleteRecordID

public ShunPreparedRecordID prepareDeleteRecordID()
                                           throws ShunException

レコードIDを指定してXML文書を削除するためのShunPreparedRecordIDオブジェクトを作成します。
ShunPreparedRecordIDオブジェクトは、使用後に必ずcloseメソッドで解放してください。

戻り値:

レコードIDによりXML文書を削除するためのShunPreparedRecordIDオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedRecordID.close()

prepareInsert

public ShunPreparedStatement prepareInsert()
                                    throws ShunException

XML文書を追加するためのShunPreparedStatementオブジェクトを作成します。
ShunPreparedStatementオブジェクトは、使用後に必ずcloseメソッドで解放してください。

戻り値:

XML文書を追加するためのShunPreparedStatementオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement.close()

prepareSearch

public ShunPreparedStatement prepareSearch(java.lang.String queryExpression,
                                           java.lang.String returnExpression)
                                    throws ShunException

検索式を指定してデータを検索するためのShunPreparedStatementオブジェクトを作成します。
ShunPreparedStatementオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

queryExpression - 検索式

検索式は、1〜1048575バイトの範囲で指定してください。
検索式のサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、getServerEncodingメソッドで取得することができます。
検索式の詳細については、“アプリケーション開発ガイド”を参照してください。

returnExpression - リターン式

リターン式は、0〜1048575バイトの範囲で指定してください。
リターン式のサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、getServerEncodingメソッドで取得することができます。
リターン式の詳細については、“アプリケーション開発ガイド”を参照してください。

戻り値:

データを検索するためのShunPreparedStatementオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedStatement.close()

prepareSearchKey

public ShunPreparedKey prepareSearchKey(java.lang.String keyName,
                                        java.lang.String returnExpression)
                                 throws ShunException

ダイレクトアクセスキーを指定してXML文書を検索するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedKeyオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

keyName - ダイレクトアクセスキー名

ダイレクトアクセスキー名は、1〜32バイト以内の半角英数字で指定してください。

returnExpression - リターン式

リターン式は、0〜1048575バイトの範囲で指定してください。
リターン式のサイズは、Shunsakuのデータの文字コードに変換したあとのバイト数で計算してください。
Shunsakuのデータの文字コードは、getServerEncodingメソッドで取得することができます。
リターン式の詳細については、“アプリケーション開発ガイド”を参照してください。

戻り値:

ダイレクトアクセスキーによりXML文書を検索するためのShunPreparedKeyオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

prepareSearchRecordID

public ShunPreparedRecordID prepareSearchRecordID()
                                           throws ShunException

レコードIDを指定してデータを検索するためのShunPreparedRecordIDオブジェクトを作成します。
ShunPreparedRecordIDオブジェクトは、使用後に必ずcloseメソッドで解放してください。

戻り値:

レコードIDによりデータを検索するためのShunPreparedRecordIDオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedRecordID.close()

prepareUpdateKey

public ShunPreparedKey prepareUpdateKey(java.lang.String keyName)
                                 throws ShunException

ダイレクトアクセスキーを指定してXML文書を更新するためのShunPreparedKeyオブジェクトを作成します。
ShunPreparedKeyオブジェクトは、使用後に必ずcloseメソッドで解放してください。

パラメータ:

keyName - ダイレクトアクセスキー名

ダイレクトアクセスキー名は、1〜32バイト以内の半角英数字で指定してください。

戻り値:

ダイレクトアクセスキーによりXML文書を更新するためのShunPreparedKeyオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

prepareUpdateRecordID

public ShunPreparedRecordID prepareUpdateRecordID()
                                           throws ShunException

レコードIDを指定してXML文書を更新するためのShunPreparedRecordIDオブジェクトを作成します。
ShunPreparedRecordIDオブジェクトは、使用後に必ずcloseメソッドで解放してください。

戻り値:

レコードIDによりXML文書を更新するためのShunPreparedRecordIDオブジェクト

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

ShunPreparedRecordID.close()

rollback

public void rollback()
              throws ShunException

現在実行中のトランザクションを無効にして、トランザクションを終了します。
自動コミットが有効の場合、本メソッドを使用すると例外が発生します。

例外:

ShunException - Shunsaku Java APIの例外

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws ShunException

コミットモードを指定します。
本メソッドの呼出しが省略された場合、自動コミットは有効となります。
自動コミットを無効にした状態で、 commitを実行する前に通信エラーなどでアプリケーションが異常終了したり、 コネクションが切断されたりした場合、 それまでに行った処理は無効になります。
トランザクション実行中にコミットモード属性が変更されると、 トランザクションはその時点でコミットされます。

パラメータ:

autoCommit - trueの場合は自動コミットが有効、falseの場合は自動コミットが無効

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

getAutoCommit()

setShunsakuFileName

public void setShunsakuFileName(java.lang.String shunsakuFile)
                         throws ShunException

接続先のShunsaku Fileを切り替えます。
ShunsakuのDefault Fileに切り替えたい場合は、 定数SHUN_DEFAULT_SHUNSAKU_FILEを指定します。
API用動作環境ファイルに定義したShunsaku Fileに切り替えたい場合は、 nullを指定します。

パラメータ:

shunsakuFile - 切替え後のShunsaku File名

例外:

ShunException - Shunsaku Java APIの例外

関連項目:

getShunsakuFileName()