jp.livewell.baby.pool.jdbc
クラス ConnectionPoolInfo

java.lang.Object
  |
  +--jp.livewell.baby.pool.PoolInfo
        |
        +--jp.livewell.baby.pool.jdbc.ConnectionPoolInfo
すべての実装インタフェース:
java.lang.Cloneable

public class ConnectionPoolInfo
extends PoolInfo

JDBC ConnectionPool構築の設定情報を格納するclassです。

作成者:
mitsuhito

フィールドの概要
static java.lang.String KEY_PASSWORD
          JDBC Driver内部で使用するdatabase user's passwordのプロパティ名
static java.lang.String KEY_USER
          JDBC Driver内部で使用するdatabase userのプロパティ名
 
コンストラクタの概要
  ConnectionPoolInfo()
          ConnectionPoolInfoを構築します。
protected ConnectionPoolInfo(ConnectionPoolInfo master)
          指定されたConnectionPoolInfoと同じ値を持つConnectionPoolInfoを作成し ます。
 
メソッドの概要
 java.lang.Object clone()
          このobjectの複製を作成します。
 boolean equals(java.lang.Object o)
          指定されたobjectがこのobjectと等しいか比較します。
 java.lang.String getDriverName()
          JDBC Driverの名前を取得します。
 java.lang.String getExtention(java.lang.String key)
          JDBC Driver固有の拡張属性を取得します。
 java.lang.String getPassword()
          database user's passwordを取得します。
 java.lang.String getPingCommand()
          データベースへの接続確認に使用するSQL文を取得します。
 long getPingInterval()
          データベースへの接続を確認する最終アクセスからの時間間隔(ms)を取得し ます。
 java.lang.String getUrl()
          database URLを取得します。
 java.lang.String getUser()
          database userを取得します。
 void setDriverName(java.lang.String className)
          JDBC Driverの名前を設定します。
 void setExtention(java.lang.String key, java.lang.String val)
          JDBC Driver固有の拡張属性を設定します。
 void setPassword(java.lang.String password)
          database user's passwordを設定します。
 void setPingCommand(java.lang.String command)
          データベースへの接続確認に使用するSQL文を設定します。
 void setPingInterval(long interval)
          データベースへの接続を確認する最終アクセスからの時間間隔(ms)を設定し ます。
 void setUrl(java.lang.String url)
          database URLを設定します。
 void setUser(java.lang.String userName)
          database userを設定します。
 java.util.Properties toProperties()
          JDBC Driverへ渡すPropertiesを作成して返します。
 java.lang.String toString()
          このインスタンスの文字列表現を取得します。
 
クラス jp.livewell.baby.pool.PoolInfo から継承したメソッド
getGrowPoint, getIdleCheckInterval, getMaxSize, getMinCheckInterval, getMinSize, getName, getShrinkPoint, getTimeout, setGrowPoint, setIdleCheckInterval, setMaxSize, setMinCheckInterval, setMinSize, setName, setShrinkPoint, setTimeout
 
クラス java.lang.Object から継承したメソッド
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

KEY_USER

public static final java.lang.String KEY_USER
JDBC Driver内部で使用するdatabase userのプロパティ名

KEY_PASSWORD

public static final java.lang.String KEY_PASSWORD
JDBC Driver内部で使用するdatabase user's passwordのプロパティ名
コンストラクタの詳細

ConnectionPoolInfo

public ConnectionPoolInfo()
ConnectionPoolInfoを構築します。

ConnectionPoolInfo

protected ConnectionPoolInfo(ConnectionPoolInfo master)
指定されたConnectionPoolInfoと同じ値を持つConnectionPoolInfoを作成し ます。
パラメータ:
master - コピー元のConnectionPoolInfo
メソッドの詳細

clone

public java.lang.Object clone()
このobjectの複製を作成します。deep copyは作成しません。
オーバーライド:
クラス PoolInfo 内の clone
戻り値:
このobjectの複製。

equals

public boolean equals(java.lang.Object o)
指定されたobjectがこのobjectと等しいか比較します。
オーバーライド:
クラス PoolInfo 内の equals
パラメータ:
o - 比較対象のobject
戻り値:
全ての値が同じConnectionPoolInfoの場合にはtrue。それ以外はfalse

toString

public java.lang.String toString()
このインスタンスの文字列表現を取得します。
オーバーライド:
クラス PoolInfo 内の toString
戻り値:
このインスタンスの文字列表現

getDriverName

public java.lang.String getDriverName()
JDBC Driverの名前を取得します。
戻り値:
JDBC Driverのclass name。設定されていない場合は空文字。

setDriverName

public void setDriverName(java.lang.String className)
                   throws java.lang.IllegalArgumentException
JDBC Driverの名前を設定します。
パラメータ:
className - JDBC Driverのclass name
例外:
java.lang.IllegalArgumentException - 設定されたclassNameのDriverがロード出来ないとき。

getUrl

public java.lang.String getUrl()
database URLを取得します。
戻り値:
databaseのURL。設定されていない場合は空文字。

setUrl

public void setUrl(java.lang.String url)
            throws java.lang.NullPointerException
database URLを設定します。nullを設定するとNullPointerExceptionがthrow されます。
パラメータ:
url - databaseのURL。
例外:
java.lang.NullPointerException - nullを設定しようとした場合

getUser

public java.lang.String getUser()
database userを取得します。
戻り値:
database user名。設定されていない場合は空文字。

setUser

public void setUser(java.lang.String userName)
             throws java.lang.NullPointerException
database userを設定します。nullを設定するとNullPointerExceptionが throwされます。
パラメータ:
userName - database user名
例外:
java.lang.NullPointerException - nullを設定しようとした場合

getPassword

public java.lang.String getPassword()
database user's passwordを取得します。
戻り値:
database user's password。設定されていない場合は空文字。

setPassword

public void setPassword(java.lang.String password)
                 throws java.lang.NullPointerException
database user's passwordを設定します。nullを設定すると NullPointerExceptionがthrowされます。
パラメータ:
password - database user's password
例外:
java.lang.NullPointerException - nullを設定しようとした場合

getExtention

public java.lang.String getExtention(java.lang.String key)
                              throws java.lang.NullPointerException
JDBC Driver固有の拡張属性を取得します。
パラメータ:
key - 拡張属性の名前。
戻り値:
設定されている拡張属性の名前。
例外:
java.lang.NullPointerException - nullのkeyを指定した場合。

setExtention

public void setExtention(java.lang.String key,
                         java.lang.String val)
                  throws java.lang.NullPointerException
JDBC Driver固有の拡張属性を設定します。 key及びvalueはnullを指定できません。指定した場合はNullPointerException をthrowします。
パラメータ:
key - 拡張属性の名前
val - 拡張属性の値
例外:
java.lang.NullPointerException - key又はvalにnullを指定した場合

getPingCommand

public java.lang.String getPingCommand()
データベースへの接続確認に使用するSQL文を取得します。
戻り値:
データベースへの接続確認に使用するSQL文。標準は[ select 1; ]

setPingCommand

public void setPingCommand(java.lang.String command)
                    throws java.lang.NullPointerException
データベースへの接続確認に使用するSQL文を設定します。 nullを設定するとNullPointerExceptionがthrowされます。
パラメータ:
command - データベースへの接続確認に使用するSQL文
例外:
java.lang.NullPointerException - nullを設定しようとした場合

getPingInterval

public long getPingInterval()
データベースへの接続を確認する最終アクセスからの時間間隔(ms)を取得し ます。
戻り値:
データベースへの接続を確認する最終アクセスからの時間間隔(ms)

setPingInterval

public void setPingInterval(long interval)
                     throws java.lang.IllegalArgumentException
データベースへの接続を確認する最終アクセスからの時間間隔(ms)を設定し ます。負の値を設定するとIllegalArgumentExceptionがthrowされます。
パラメータ:
interval - データベースへの接続確認に使用するSQL文
例外:
java.lang.IllegalArgumentException - 負の値を設定しようとした場合

toProperties

public java.util.Properties toProperties()
JDBC Driverへ渡すPropertiesを作成して返します。 返されたPropertiesはコピーなので操作を行っても問題ありません。
戻り値:
JDBC Driverへ渡す接続情報。