001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.db;
017
018import java.io.File;
019import java.net.URL;
020import java.util.ArrayList;
021import java.util.LinkedHashMap;
022import java.util.List;
023import java.util.Locale;
024import java.util.Map;
025import java.util.Collections;
026
027import org.opengion.fukurou.util.StringUtil;
028import org.opengion.fukurou.util.FileUtil;
029import org.opengion.fukurou.util.HybsDateUtil;                          // 6.9.2.1 (2018/03/12)
030import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
031import org.opengion.fukurou.system.LogWriter;
032import org.opengion.fukurou.xml.DomParser;
033import org.w3c.dom.Document;
034import org.w3c.dom.Element;
035import org.w3c.dom.Node;
036import org.w3c.dom.NodeList;
037import org.w3c.dom.NamedNodeMap;                                                        // 6.9.2.0 (2018/03/05)
038
039import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
040
041/**
042 * DB設定XMLの内容をJAXBを利用してロードする
043 * Driverをロードする
044 * 上記2つの機能を備えたクラスです
045 *
046 * 外部からはgetDbidメソッドを利用してDB設定(ExpandedDbid型)を取得します。
047 * DB設定情報が無い場合にXMLを読みにいきます。
048 * このDBIDを決めるキーは、内部取り込み字に、大文字変換されますので、大文字・
049 * 小文字の区別はありません。
050 *
051 * @og.rev 4.0.0.0 (2007/10/25) 新規作成
052 * @og.rev 5.1.7.0 (2010/06/01) org.opengion.fukurou.xml.jaxb.dbid 関係 廃止
053 * @og.group 初期化
054 *
055 * @version  4.0
056 * @author 高橋正和
057 * @since   JDK6.0,
058 */
059public class DatabaseConfig {
060
061        // fukurou内で完結させるため、HybsDataからは読み込まずにここに書く
062        private static final String DEFAULT_DRIVER       = "oracle.jdbc.OracleDriver";
063
064        // 6.4.3.3 (2016/03/04) 初期 DBConfig.xml ファイルの設定。
065        public static final String DB_CONFIG_FILE = "../DBConfig.xml" ;
066
067        // XMLファイル関連
068        private final String xmlFilename;                               // 5.7.2.2 (2014/01/24)
069
070        /** 6.4.3.1 (2016/02/12) Collections.synchronizedMap で同期処理を行います。  */
071        private final Map<String, EDbid> dbidMap = Collections.synchronizedMap( new LinkedHashMap<>() );        // 5.6.7.0 (2013/07/27)
072        /** 6.4.3.1 (2016/02/12) Collections.synchronizedList で同期処理を行います。  */
073        private final List<String>    driverList = Collections.synchronizedList( new ArrayList<>() );
074
075        // 5.6.7.0 (2013/07/27) プルダウンメニュー用の情報の、キャッシュ用変数。
076        private String codeKeyVal ;                                             // 初めて要求されたときに、セットします。
077
078        // 5.6.6.0 (2013/07/05) 表題(title)属性を追加
079        private static final String[] DBID_INFO_KEYS
080                                = { "dbidKey", "title", "url", "user", "password", "readonly"
081                                        , "mincount", "maxcount", "pooltime", "applicationInfo","property" };
082
083        /* DBDRIVERのキーのを管理します。5.1.9.0 (2010/08/01) */
084        private static final String DBDRIVER_CLASS_KEY = "class";
085
086        /**
087         * 初期値を使ってXMLを読み込む
088         * xmlFilenameの初期値は../DBConfig.xml
089         *
090         * @og.rev 4.3.1.1 (2008/08/23) 自分のコンストラクターを呼ぶように修正
091         */
092        public DatabaseConfig() {
093                this( DB_CONFIG_FILE );
094        }
095
096        /**
097         * XMLファイルの名前を指定して読み込む
098         *
099         * @og.rev 5.1.9.0 (2010/08/01) クラスローダー外からでもDBConfig.xmlを取得できるようにする
100         * @og.rev 5.6.7.0 (2013/07/27) オブジェクト作成時に初期化も行っておきます。
101         * @og.rev 5.6.8.2 (2013/09/20) Tomcat8で、クラスローダーが変更されているのでその対応
102         * @og.rev 5.7.2.2 (2014/01/24) WEB-INF/classes フォルダがないと、xmlURL がnull になる対応。
103         * @og.rev 5.7.2.3 (2014/01/31) ファイルの存在チェックを追加します。
104         * @og.rev 6.4.3.3 (2016/03/04) 初期 DBConfig.xml ファイルの設定。
105         * @og.rev 6.6.0.0 (2016/12/01) コンテキストパスから、##バージョン番号を取り去った値を返すようにします。
106         * @og.rev 6.8.5.1 (2018/01/15) ClassLoader変数名を、clsl から、loader に変更(他の変数名と整合性を持たす)。
107         *
108         * @param       infile  XMLファイルの名前
109         */
110        public DatabaseConfig( final String infile ) {
111                final String xmlfile = infile == null || infile.isEmpty() ? DB_CONFIG_FILE : infile ;           // 引数が無い場合の初期設定を行います。
112                String fileName = null;
113
114                // 6.3.9.1 (2015/11/27) In J2EE, getClassLoader() might not work as expected.  Use Thread.currentThread().getContextClassLoader() instead.(PMD)
115                final ClassLoader loader        = Thread.currentThread().getContextClassLoader();
116                URL xmlURL                                      = loader.getResource( xmlfile );
117
118                // 5.6.8.2 (2013/09/20) Tomcat8で、xmlURL が取得できなくなっている・・・ようだ。
119                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..;
120                if( xmlURL == null ) {
121                        xmlURL = loader.getResource( "/" );             // クラスパスのベースURL
122                        // 5.7.2.2 (2014/01/24) Tomcat7で、WEB-INF/classes フォルダがないと、xmlURL がnull になる。
123                        if( xmlURL != null ) {
124                                final File temp = new File( xmlURL.getPath() , xmlfile );
125                                if( temp.exists() ) { fileName = temp.getAbsolutePath(); }
126                        }
127                }
128                else {
129                        fileName = xmlURL.getFile().replaceAll( "%23%23","##" );                // 6.6.0.0 (2016/12/01)
130                        // 5.7.2.3 (2014/01/31) ファイルの存在チェックを追加します。
131                        if( ! new File( fileName ).exists() ) { fileName = null; }
132                }
133
134                // 5.1.9.0 (2010/08/01)  クラスローダー外からでもDBConfig.xmlを取得できるようにする
135                if( fileName == null && new File( xmlfile ).exists() ) {
136                        fileName = xmlfile;
137                }
138
139                if( fileName == null ) {
140                        // 5.5.7.2 (2012/10/09) コメント追加
141                        final String errMsg = "DBConfig.xmlが見つかりません。File=[" + xmlfile + "]\n" 
142                                                                + " WEB-INF/classes フォルダがないと、相対パスで見つけることができません。" ;
143                        throw new OgRuntimeException( errMsg );
144                }
145
146                xmlFilename = fileName;
147
148                init();                 // 5.6.7.0 (2013/07/27)
149        }
150
151        /**
152         * dbidKeyをキーにしてExpandedDbid型でマップの内容を返す。
153         * 存在しない場合はNULLを返します。
154         * キーが無い場合に初期化を行う。
155         *
156         * @og.rev 4.0.0.1 (2007/12/04) EDbid#clone() 廃止
157         * @og.rev 5.6.7.0 (2013/07/27) synchronized メソッドにします。
158         * @og.rev 6.0.0.1 (2014/04/25) Collections.synchronizedMap を使用します。
159         *
160         * @param key XMLで登録したdbidKey
161         *
162         * @return EDbid型オブジェクト
163         */
164        public EDbid getDbid( final String key ) {
165                return dbidMap.get( key.toUpperCase( Locale.JAPAN ) ) ;
166        }
167
168        /**
169         * マップをクリアします。
170         * XMLファイルを再読み込みする場合に使用します。
171         *
172         * @og.rev 5.1.9.0 (2010/08/01) ドライバーのリストもクリアする。
173         * @og.rev 5.6.7.0 (2013/07/27) synchronized メソッドにします。
174         * @og.rev 6.0.0.1 (2014/04/25) Collections.synchronizedMap を使用します。
175         */
176        public void reload() {
177                dbidMap.clear();
178                driverList.clear();
179                init();
180        }
181
182        /**
183         * 初期化処理
184         *
185         * DB設定XMLファイル(DBConfig.xml)を読み込みます。
186         * このファイルから、ドライバーリストの取得、DBIDのオブジェクトマップの作成を
187         * 行います。
188         * EDbidオブジェクト は、環境変数で、共通の初期値を定義しておくことが可能です。
189         * 項目として、REALM_URL、REALM_NAME、REALM_PASSWORD が設定可能です。
190         *
191         * ドライバーリストの取得後、Class.forName で、ドライバの登録も行います。
192         *
193         * @og.rev 5.1.7.0 (2010/06/01) org.opengion.fukurou.xml.jaxb.dbid 関係 廃止
194         * @og.rev 5.6.7.0 (2013/07/27) dbidMap,driverList を書き込むのではなく、作成します。
195         */
196        private void init() {
197                final Document doc = DomParser.read( new File(xmlFilename) ) ;
198                final Element firstRoot = doc.getDocumentElement();
199
200                makeDriverList( firstRoot );                            // 5.6.7.0 (2013/07/27)
201
202                // 5.6.7.0 (2013/07/27) を、かけておきます。
203                synchronized ( this ) {
204                        for( final String dr : driverList ) {
205                                try {
206                                        Class.forName( dr );
207//                              } catch( final ClassNotFoundException ex ) {            // 7.0.0.1 (2018/10/09) LinkageErrorが発生したので、いっそすべてをcatchします。
208                                } catch( final Throwable th ) {
209                                        final String errMsg = "ドライバクラスが見つかりません。[" + dr + "]" ;
210                                        LogWriter.log( errMsg );
211                                        LogWriter.log( th );
212                                }
213                        }
214                }
215
216                final EDbid defDdbid = new EDbid();             // 初期値
217                defDdbid.setUrl(                System.getenv( "REALM_URL" ) );
218                defDdbid.setUser(               System.getenv( "REALM_NAME" ) );
219                defDdbid.setPassword(   System.getenv( "REALM_PASSWORD" ) );
220
221                makeDbidMap( firstRoot,defDdbid );                              // 5.6.7.0 (2013/07/27)
222        }
223
224        /**
225         * ドライバーリストを取得します。
226         *
227         * DB設定XMLファイル(DBConfig.xml)の、class タグを取り込みます。
228         * このファイルから、ドライバーリストを取得します。
229         *
230         * 内部的に3段階の処理が実行されます。
231         * 第1Step:DBConfig.xml から、ドライバーリストを取得
232         * 第2Step:ドライバーリストが存在しない場合、環境変数の REALM_DRIVER からドライバーを取得
233         * 第3Step:それでも存在しない場合、このクラスの DEFAULT_DRIVER 定数 からドライバーを取得
234         *
235         * @og.rev 5.1.7.0 (2010/06/01) org.opengion.fukurou.xml.jaxb.dbid 関係 廃止
236         * @og.rev 5.1.9.0 (2010/08/01) ドライバ一覧のListをオブジェクト変数化
237         * @og.rev 5.6.7.0 (2013/07/27) driverList を書き込むのではなく、作成します。
238         * @og.rev 5.6.7.0 (2013/07/27) synchronized メソッドにします。
239         *
240         * @param       element DB設定XMLファイルのElementオブジェクト
241         */
242        private void makeDriverList( final Element element ) {
243
244                final NodeList list = element.getElementsByTagName( "class" ) ;
245                final int num = list.getLength();
246                for( int i=0; i<num; i++ ) {
247                        final Element cls = (Element)list.item(i);
248                        driverList.add( cls.getTextContent() );
249                }
250
251                if( driverList.isEmpty() ) {
252                        final String realmDriver = System.getenv( "REALM_DRIVER" );
253                        if( realmDriver != null && realmDriver.length() > 0 ) {
254                                driverList.add( realmDriver );
255                        }
256                }
257
258                if( driverList.isEmpty() ) { driverList.add( DEFAULT_DRIVER ); }
259        }
260
261        /**
262         * EDbidオブジェクトのマップを取得します。
263         *
264         * DB設定XMLファイル(DBConfig.xml)の、dbid タグを取り込みます。
265         * このファイルから、EDbidオブジェクトの属性情報を取得し、オブジェクトを構築します。
266         *
267         * EDbidオブジェクト は、初期値をコピーして、作成していきます。
268         * EDbidオブジェクトをマップから取り出すキーとなる、dbidKey は、大文字化して設定します。
269         *
270         * 7.0.5.0 (2019/09/09)
271         *  begin,end,step,var,items 属性に対して、stepを年月指定できるように、type属性を追加しました。
272         *  type="month" で、begin,end を、年月として処理します。
273         *
274         * @og.rev 5.1.7.0 (2010/06/01) org.opengion.fukurou.xml.jaxb.dbid 関係 廃止
275         * @og.rev 5.1.9.0 (2010/08/01) Mapを返すように変更
276         * @og.rev 5.5.2.0 (2012/05/01) property追加
277         * @og.rev 5.6.6.0 (2013/07/05) 表題(title)属性の取得
278         * @og.rev 5.6.7.0 (2013/07/27) 内部MapをDBConfig.xmlの読み込み順に変更。
279         * @og.rev 5.6.7.0 (2013/07/27) dbidMap を書き込むのではなく、作成します。
280         * @og.rev 5.6.7.0 (2013/07/27) synchronized メソッドにします。
281         * @og.rev 5.6.7.1 (2013/08/09) DEFAULT と、RESOURCE の DBIDキーがなければ、内部的に作成します。
282         * @og.rev 5.6.8.0 (2013/09/06) RESOURCE の DBIDキーを内部作成時に、title も設定します。
283         * @og.rev 6.4.3.4 (2016/03/11) computeIfAbsent と、新しい clone(String) メソッドを使用する。
284         * @og.rev 6.8.2.4 (2017/11/20) 環境変数( ${env.XXXX} ) を処理できるようにします。
285         * @og.rev 6.9.2.0 (2018/03/05) dbidに、begin,end,step,var,items 属性を追加します(影響は、ForEachObject内)。
286         * @og.rev 7.0.5.0 (2019/09/09) dbidに、type 属性を追加します(影響は、ForEachObject内)。
287         *
288         * @param  element DB設定XMLファイルのElementオブジェクト
289         * @param  defDdbid 初期情報の設定された、EDbidオブジェクト
290         */
291        private void makeDbidMap( final Element element , final EDbid defDdbid ) {
292                final NodeList list = element.getElementsByTagName( "dbid" ) ;
293                final int num = list.getLength();
294                for( int i=0; i<num; i++ ) {
295                        final Element ele = (Element)list.item(i);
296                        final ForEachObject forEach = new ForEachObject( ele );
297
298                        while( forEach.hasNext() ) {
299                                final NodeList childs   = ele.getChildNodes();
300                                final int      numChild = childs.getLength();
301                                final EDbid    dbid     = defDdbid.clone();                             // 初期値をコピーして、作成
302                                for( int j=0; j<numChild; j++ ) {
303                                        final Node nd = childs.item(j);
304                                        if( nd.getNodeType() == Node.ELEMENT_NODE ) {
305                                                final Element el = (Element)nd;
306                                                final String tag = el.getTagName();
307//                                              // 6.8.2.4 (2017/11/20) 環境変数( ${env.XXXX} ) を処理できるようにします。
308//                                              final String txt = envText( el.getTextContent() );
309                                                // 6.9.2.0 (2018/03/05) 変数の置き換え( ${var} )と、環境変数( ${env.XXXX} ) を処理します。
310                                                final String txt = forEach.getText( el.getTextContent() );
311
312                                                // dbidKey は、toUpperCase して、大文字のみとする。
313                                                // 6.8.2.4 (2017/11/20) 環境変数( ${env.XXXX} ) を処理できるようにします。
314                                                if( "dbidKey".equals( tag ) )   {
315                                                        if( txt != null && txt.length() > 0 ) {
316                                                                dbid.setDbidKey( txt.toUpperCase( Locale.JAPAN ) );
317                                                        }
318                                                }
319                                                else if( "title".equals( tag ) )        { dbid.setTitle(        txt ); }                // 5.6.6.0 (2013/07/05) 表題(title)属性の取得
320                                                else if( "url".equals( tag ) )          { dbid.setUrl(          txt ); }
321                                                else if( "user".equals( tag ) )         { dbid.setUser(         txt ); }
322                                                else if( "password".equals( tag ) ) { dbid.setPassword( txt ); }
323                                                else if( "readonly".equals( tag ) ) { dbid.setReadonly( txt ); }
324                                                else if( "mincount".equals( tag ) ) { dbid.setMincount( txt ); }
325                                                else if( "maxcount".equals( tag ) ) { dbid.setMaxcount( txt ); }
326                                                else if( "pooltime".equals( tag ) ) { dbid.setPooltime( txt ); }
327                                                else if( "applicationInfo".equals( tag ) ) { dbid.setApplicationInfo( txt ); }
328                                                else if( "property".equals( tag ) ) { dbid.addProp(             txt ); } // 5.5.2.0 (2012/05/01)
329                                                else {
330                                                        System.err.println( "警告:dbid に新しい属性が、追加されています。" );
331                                                }
332                                        }
333                                }
334                                dbidMap.put( dbid.getDbidKey(), dbid );         // 5.6.7.0 (2013/07/27) 復活
335                        }
336                }
337
338                // 5.6.7.1 (2013/08/09) DEFAULT と、RESOURCE の DBIDキーがなければ、内部的に作成します。
339                // 6.4.3.4 (2016/03/11) computeIfAbsent と、新しい clone(String) メソッドを使用する。
340                // Map#computeIfAbsent : 戻り値は、既存の、または計算された値。追加有り、置換なし、削除なし
341                dbidMap.computeIfAbsent( "DEFAULT", k -> defDdbid.clone( "DEFAULT" ) ); // DEFAULT が存在するか確認する。
342
343                // 6.4.3.4 (2016/03/11) computeIfAbsent と、新しい clone(String) メソッドを使用する。
344                // Map#computeIfAbsent : 戻り値は、既存の、または計算された値。追加有り、置換なし、削除なし
345                dbidMap.computeIfAbsent( "RESOURCE", k -> defDdbid.clone( "RESOURCE" ) );       // RESOURCE が存在するか確認する。
346        }
347
348//      /**
349//       * 環境変数( ${env.XXX} )を含むテキストを処理します。
350//       *
351//       * 環境変数を含まない場合は、引数の orgTxt を返します。
352//       *
353//       * @og.rev 6.8.2.4 (2017/11/20) 環境変数( ${env.XXXX} ) を処理できるようにします。
354//       *
355//       * @param  orgTxt 環境変数( ${env.XXX} )を含む可能性のあるテキスト
356//       * @return  環境変数を処理したテキスト
357//       */
358//      private String envText( final String orgTxt ) {
359//              final int st = orgTxt.indexOf( "${env." );
360//              if( st >= 0 ) {
361//                      final int ed = orgTxt.indexOf( '}' , st );
362//                      if( ed >= 0 ) {
363//                              final String envKey = orgTxt.substring( st + "${env.".length() , ed );
364//                              final String envTxt = orgTxt.substring( 0,st ) + System.getenv( envKey ) + orgTxt.substring( ed+1 );
365//                              return envText( envTxt );                       // ループすべきだが、再帰処理で対応します。
366//                      }
367//                      else {
368//                              final String errMsg = xmlFilename + " の環境変数( ${env.XXX} )の整合性が取れていません。" + orgTxt ;
369//                              throw new OgRuntimeException( errMsg );
370//                      }
371//              }
372//
373//              return orgTxt;
374//      }
375
376        /**
377         * dbidの属性処理が、煩雑になってきたので、内部クラスにまとめます。
378         *
379         * begin,end,step,var,items 属性で、ループ処理を行うための設定を取得します。
380         * items が未指定の場合は、begin,end,step による、数字(文字列)の配列を返します。
381         * itemsが、定義されている場合は、カンマで分割後、文字列の配列を返します。
382         * それぞれ、初期値があり、begin=0 , end=0 or items要素数,step=1,
383         *
384         * @og.rev 7.0.5.0 (2019/09/09) type属性を追加。
385         *  begin,end,step,var,items 属性に対して、stepを年月指定できるように、type属性を追加しました。
386         *  type="month" で、begin,end を、年月として処理します。
387         *
388         * @og.rev 6.9.2.1 (2018/03/12) dbidに、begin,end,step,var,items 属性を追加します。
389         * @og.rev 7.0.5.0 (2019/09/09) dbidに、type 属性を追加します。
390         */
391        private static final class ForEachObject {
392                private final String   attVar ;                         // var 属性の値を、${xxxx} に置き換えた文字列。未定義は、null
393                private final String[] items ;                          // items 属性のCSV分割か、begin,end,step の数字文字列の配列
394
395                private int   idx      = -1;                            // hasNext() で、先にアップするので、一つ引いておきます。
396
397                /**
398                 * Elementオブジェクトを指定して、インスタンスを生成するコンストラクタです。
399                 *
400                 * @og.rev 6.9.2.1 (2018/03/12) dbidに、begin,end,step,var,items 属性を追加します。
401                 * @og.rev 7.0.5.0 (2019/09/09) dbidに、type 属性を追加します。
402                 *
403                 * @param  element DB設定XMLファイルのElementオブジェクト
404                 */
405                public ForEachObject( final Element ele ) {
406                        // 6.9.2.0 (2018/03/05) dbidに、begin,end,step,var 属性を追加します。
407                        if( ele.hasAttributes() ) {
408                                final NamedNodeMap attNode = ele.getAttributes();
409//                              final int attBgn = StringUtil.nval( getAttri( attNode,"begin" ),0 );    // 7.0.5.0 (2019/09/09) 削除
410//                              final int attStp = StringUtil.nval( getAttri( attNode,"step"  ),1 );    // 7.0.5.0 (2019/09/09) (ifの中へ)移動
411                                final String tmpVar = getAttri( attNode,"var" );
412                                attVar = StringUtil.isNull( tmpVar ) ? null : "${" + tmpVar + "}" ;             // 置換元定数を作成します。
413
414//                              final String endStr = getAttri( attNode,"end" );                                                // 7.0.5.0 (2019/09/09) (ifの中へ)移動
415                                final String itms   = getAttri( attNode,"items" );
416                                if( StringUtil.isNull( itms ) ) {
417                                        final String bgiStr = getAttri( attNode,"begin" );                                      // 7.0.5.0 (2019/09/09) 追加
418                                        final String endStr = getAttri( attNode,"end" );                                        // 7.0.5.0 (2019/09/09) (ifの中へ)移動
419                                        final int attStp = StringUtil.nval( getAttri( attNode,"step"  ),1 );
420
421                                        final String typStr = getAttri( attNode,"type" );                                       // 7.0.5.0 (2019/09/09) 新規追加
422                                        if( "month".equalsIgnoreCase( typStr ) ) {                                                      // 7.0.5.0 (2019/09/09) 新規追加
423                                                items = HybsDateUtil.stepYM( bgiStr,endStr,attStp );
424                                        }
425                                        else {
426                                                final int attBgn = StringUtil.nval( bgiStr,0 );                                 // 7.0.5.0 (2019/09/09) 文字列化をint化
427
428                                                final int attEnd = StringUtil.nval( endStr,attBgn+1 );                  // とりあえず 1回は回すため。
429                                                final List<String> list = new ArrayList<>();
430                                                for( int i=attBgn; i<attEnd; i+=attStp ) {
431                                                        list.add( String.valueOf( i ) );
432                                                }
433
434                                                items = list.toArray( new String[list.size()] ) ;
435                                        }
436                                }
437                                else {
438                                        items = itms.split( "," );
439                                }
440                        }
441                        else {
442                                attVar = null;
443                                items  = new String[] { "0" };                  // 最低1回は回せるように。
444                        }
445                }
446
447                /**
448                 * 反復処理でさらに要素がある場合にtrueを返します。
449                 *
450                 * この判定で、内部カウンタを、プラスしていますので、
451                 * ループ判定時にのみ、呼び出してください。
452                 *
453                 * @og.rev 6.9.2.1 (2018/03/12) 新規追加
454                 *
455                 * @return 反復処理でさらに要素がある場合はtrue
456                 */
457                public boolean hasNext() { return ++idx < items.length; }
458
459                /**
460                 * 引数の文字列に対して、var 属性と item要素の置換を行います。
461                 *
462                 * さらに、${env.XXXX} 環境変数の置換と、日付文字列{&#064;DATE.XXXX}の置換も
463                 * 行います。
464                 * この処理では、内部カウンタはアップしませんので、inTxt を替えて、何度でも
465                 * 呼び出すことが可能です。
466                 *
467                 * @og.rev 6.9.2.1 (2018/03/12) 新規追加
468                 *
469                 * @param  inTxt 置換元の文字列
470                 * @return items属性に対応して置換された、文字列
471                 */
472                public String getText( final String inTxt ) {
473                        String rtnTxt = StringUtil.replace( inTxt , attVar , items[idx] );              // attVar が null の場合、inTxt が戻される。
474                        rtnTxt = StringUtil.replaceText( rtnTxt , "${env."  , "}" , System::getenv );                           // 環境変数置換
475                        rtnTxt = StringUtil.replaceText( rtnTxt , "{@DATE." , "}" , HybsDateUtil::getDateFormat );      // 日付文字列置換
476
477                        return rtnTxt;
478                }
479
480                /**
481                 * 属性を取得する簡易メソッドです。
482                 *
483                 * 引数に、ノードのコレクションと、属性のキーワードを指定することで、属性値を返します。
484                 *
485                 * @og.rev 6.9.2.0 (2018/03/05) 新規追加
486                 *
487                 * @param  nodeMap 名前を指定してアクセスできるノードのコレクション
488                 * @param  key    属性のキーワード
489                 * @return 属性値(キーに対応する属性が無い場合は、null)
490                 */
491                private String getAttri( final NamedNodeMap nodeMap,final String key ) {
492                        final Node attNode = nodeMap.getNamedItem( key );
493
494//                      return attNode == null ? null : attNode.getNodeValue() ;
495
496                        String rtnTxt = attNode == null ? null : attNode.getNodeValue() ;
497
498                        rtnTxt = StringUtil.replaceText( rtnTxt , "${env."  , "}" , System::getenv );                           // 環境変数置換
499                        rtnTxt = StringUtil.replaceText( rtnTxt , "{@DATE." , "}" , HybsDateUtil::getDateFormat );      // 日付文字列置換
500
501                        return rtnTxt;
502                }
503        }
504
505        /* ------------------------------------------------------------------------------------
506         *
507         * 以下は、DBConfig.xml編集用のメソッドです。
508         * 編集用のメソッドでは、オブジェクト化されたDBID及びDBDRIVERの情報は使用せずに、
509         * DBConfig.xmlからその情報を再度読み出して、SET/GETしています。
510         * (オブジェクトとして依存しているのは、DBConfig.xmlのファイル名のみです)
511         *
512         * -------------------------------------------------------------------------------------
513         */
514        /**
515         * DBIDとして管理している項目のキーの一覧を配列形式で返します。
516         *
517         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
518         *
519         * @return 項目のキー一覧
520         * @og.rtnNotNull
521         */
522        public static String[] getDbidInfoKeys() {
523                return DBID_INFO_KEYS.clone();
524        }
525
526        /**
527         * 全てのDBIDの属性情報のリスト(配列)で返します。
528         *
529         * 値の順番については、{@link #getDbidInfoKeys()}で返されるキーの一覧と同じです。
530         *
531         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
532         * @og.rev 5.5.2.1 (2012/05/07) propertiesを出力
533         * @og.rev 5.6.6.0 (2013/07/05) 表題(title)属性を追加
534         * @og.rev 5.6.7.0 (2013/07/27) 内部MapをDBConfig.xmlの読み込み順に変更。
535         * @og.rev 6.3.9.0 (2015/11/06) Use block level rather than method level synchronization.(PMD)
536         *
537         * @return 全てのDBIDの属性情報のリスト(配列)
538         * @og.rtnNotNull
539         * @see #getDbidInfoKeys()
540         */
541        public String[][] getDbidInfo() {
542                // 6.3.9.0 (2015/11/06) 色々やりたいが、今はsynchronizedブロックにするだけにします。
543                synchronized( dbidMap ) {
544                        String[][] dbidInfo = new String[dbidMap.size()][DBID_INFO_KEYS.length];
545                        int idx = 0;
546                        for( final EDbid dbid : dbidMap.values() ) {
547                                dbidInfo[idx][0] = dbid.getDbidKey();
548                                dbidInfo[idx][1] = dbid.getTitle();                             // 5.6.6.0 (2013/07/05) 表題(title)属性を追加
549                                dbidInfo[idx][2] = dbid.getUrl();
550                                dbidInfo[idx][3] = dbid.getUser();
551                                dbidInfo[idx][4] = dbid.getPassword();
552                                dbidInfo[idx][5] = String.valueOf( dbid.isReadonly() );
553                                dbidInfo[idx][6] = String.valueOf( dbid.getMincount() );
554                                dbidInfo[idx][7] = String.valueOf( dbid.getMaxcount() );
555                                dbidInfo[idx][8] = String.valueOf( dbid.getPooltime() );
556                                dbidInfo[idx][9] = String.valueOf( dbid.isApplicationInfo() );
557                                dbidInfo[idx][10]= String.valueOf( dbid.getProps().toString() ); // 5.5.2.1 (2012/05/07)
558                                idx++;
559                        }
560
561                        return dbidInfo;
562                }
563        }
564
565        /**
566         * 全てのDBIDの属性情報のリスト(配列)をセットします。
567         *
568         * このメソッドを呼び出すと、DBConfig.xmlで定義されているDBID情報一覧を"一旦削除し"、
569         * その上で、引数のDBID情報一覧をDBConfig.xmlに書き込みます。
570         *
571         * 値の順番については、{@link #getDbidInfoKeys()}で返されるキーの一覧と同じです。
572         *
573         * 書き込みの直前に、同じフォルダにタイムスタンプを付加したバックアップファイルを作成します。
574         *
575         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
576         * @og.rev 5.6.7.0 (2013/07/27) 内部MapをDBConfig.xmlの読み込み順に変更。
577         *
578         * @param dbidVals 全てのDBIDの属性情報の配列の配列
579         * @see #getDbidInfoKeys()
580         */
581        public void setDbidInfo( final String[][] dbidVals ) {
582                FileUtil.copy( xmlFilename, xmlFilename + "_" + System.currentTimeMillis() );
583
584                final Document doc = DomParser.read( new File(xmlFilename) ) ;
585                final Element firstRoot = doc.getDocumentElement();
586                deleteChildElements( firstRoot, "dbid" );
587
588                if( dbidVals != null && dbidVals.length > 0 ) {
589                        // 5.6.7.0 (2013/07/27) 内部MapをDBConfig.xmlの読み込み順に変更(なので、廃止)。
590                        for( int i=0; i<dbidVals.length; i++ ) {
591                                final Element newEle = doc.createElement( "dbid" );
592                                for( int j=0; j<dbidVals[i].length; j++ ) {
593                                        final Element newChEle = doc.createElement( DBID_INFO_KEYS[j] );
594                                        newChEle.setTextContent( dbidVals[i][j] );
595                                        newEle.appendChild( newChEle );
596                                }
597                                firstRoot.appendChild( newEle );
598                                firstRoot.appendChild( doc.createTextNode( "\n\n" ) );
599                        }
600                }
601
602                DomParser.write( new File(xmlFilename), doc );
603
604                reload();               // 5.6.7.0 (2013/07/27) DBIDの属性情報のリストを更新後、初期化します。
605        }
606
607        /**
608         * DBドライバーの属性キーを返します。
609         *
610         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
611         *
612         * @return      DBドライバーの属性キー
613         * @og.rtnNotNull
614         */
615        public static String getDriverKey() {
616                return DBDRIVER_CLASS_KEY;
617        }
618
619        /**
620         * DBドライバーのリスト(配列)を返します。
621         *
622         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
623         * @og.rev 5.6.7.0 (2013/07/27) driverList を書き込むのではなく、作成します。
624         *
625         * @return      DBドライバーリスト(配列)
626         * @og.rtnNotNull
627         */
628        public String[] getDriverList() {
629                return driverList.toArray( new String[driverList.size()] );
630        }
631
632        /**
633         * DBドライバーのリスト(配列)をセットします。
634         *
635         * このメソッドを呼び出すと、DBConfig.xmlで定義されているclass一覧を"一旦削除し"、
636         * その上で、引数のDBドライバー一覧をDBConfig.xmlに書き込みます。
637         *
638         * 書き込みの直前に、同じフォルダにタイムスタンプを付加したバックアップファイルを作成します。
639         *
640         * @og.rev 5.1.9.0 (2010/08/01) 新規作成
641         * @og.rev 5.6.7.0 (2013/07/27) DBドライバーのリストを更新後、初期化します。
642         *
643         * @param drivers DBドライバーの配列(可変長引数)
644         */
645        public void setDriverList( final String... drivers ) {
646                FileUtil.copy( xmlFilename, xmlFilename + "_" + System.currentTimeMillis() );
647
648                final Document doc = DomParser.read( new File(xmlFilename) );
649                final Element firstRoot = doc.getDocumentElement();
650
651                final Element parent = (Element)firstRoot.getElementsByTagName( "dbDriver" ).item( 0 );
652                deleteChildElements( parent, "class" );
653
654                // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。
655                if( drivers != null && drivers.length > 0 ) {
656                        for( int i=0; i<drivers.length; i++ ) {
657                                final Element newEle = doc.createElement( "class" );
658                                newEle.setTextContent( drivers[i] );
659                                parent.appendChild( newEle );
660                        }
661                }
662
663                DomParser.write( new File(xmlFilename), doc );
664
665                reload();               // 5.6.7.0 (2013/07/27) DBドライバーのリストを更新後、初期化します。
666        }
667
668        /**
669         * DBID情報のキーとタイトルから、プルダウンメニューを作成するための情報を取得します。
670         *
671         * このメソッドを呼び出すと、DBConfig.xmlで定義されている dbidKey と、 title 属性から、
672         * 「key1:val1 key2:val2 ・・・」という文字列を作成します。
673         * これを利用すれば、プルダウンメニューが簡単に作成できます。
674         *
675         * @og.rev 5.6.7.0 (2013/07/27) プルダウンメニュー用の情報を作成します。
676         * @og.rev 5.6.7.1 (2013/08/09) 表題(title)属性のスペース対策
677         * @og.rev 6.2.6.0 (2015/06/19) 表題(title)属性のスペース対策(KEY:LBL をダブルクオートで囲う)
678         * @og.rev 6.3.9.0 (2015/11/06) Use block level rather than method level synchronization.(PMD)
679         * @og.rev 7.1.0.0 (2020/01/20) DB接続できないDBIDはプルダウンメニューに含めない。
680         *
681         * @return プルダウンメニューを作成するための情報
682         */
683        public String getCodeKeyVal() {
684                if( codeKeyVal == null ) {
685                        final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
686                        // 6.3.9.0 (2015/11/06) 色々やりたいが、今はsynchronizedブロックにするだけにします。
687                        synchronized( dbidMap ) {
688                                for( final EDbid dbid : dbidMap.values() ) {
689                                        final String key = dbid.getDbidKey();
690                                        try {                                                                                           // 7.1.0.0 (2020/01/20)
691                                                if( dbid.getDbProductName() == null ) {
692                                                        ConnectionFactory.getDBName( key );                     // 7.1.0.0 (2020/01/20) DB接続テスト
693                                                }
694
695                                                final String lbl = StringUtil.nval( dbid.getTitle() , key );
696                                                // 6.0.2.5 (2014/10/31) char を append する。
697                                                if( lbl.indexOf( ' ' ) >= 0 ) {                                 // 5.6.7.1 (2013/08/09) スペース対策
698                                                        buf.append( '"' ).append( key ).append( ':' ).append( lbl ).append( '"' );
699                                                }
700                                                else {
701                                                        buf.append( key ).append( ':' ).append( lbl );
702                                                }
703                                                buf.append( ' ' );
704                                        }
705        //                              catch( final OgRuntimeException ex ) {                          // 7.1.0.0 (2020/01/20) エラー時
706                                        catch( final RuntimeException ex ) {                            // 7.1.0.0 (2020/01/20) エラー時
707                        //                      System.err.println( "警告:" + ex.getMessage() );
708                                                final String errMsg = "DBID=[" + key + "] 接続できません" ;            // エラーメッセージの簡素化
709                                                System.err.println( errMsg );
710                                        }
711                                }
712                        }
713
714                        buf.setLength( buf.length()-1 );                // 最後のスペースを削除
715                        codeKeyVal = buf.toString();
716                }
717
718                return codeKeyVal;
719        }
720
721        /**
722         * 親要素を基点として、引数で指定されたタグ名を持つ子要素を削除します。
723         *
724         * @og.rev 5.6.7.0 (2013/07/27) staticメソッド を イスタンスメソッドに変更
725         *
726         * @param parent 親要素
727         * @param childTagName 削除する子要素のタグ名
728         */
729        private void deleteChildElements( final Element parent, final String childTagName ) {
730                Node child = parent.getFirstChild();
731                boolean isDel = false;
732                while( child != null ) {
733                        // エレメント間の改行Cも削除するため、次の異なる要素が来るまでは削除し続けます。
734                        if( child.getNodeType() == Node.ELEMENT_NODE ) {
735                                // 6.4.4.1 (2016/03/18) 
736                                isDel = ((Element)child).getTagName().equalsIgnoreCase( childTagName );
737                        }
738
739                        final Node next = child.getNextSibling();
740                        if( isDel ) {
741                                parent.removeChild( child );
742                        }
743                        child = next;
744                }
745        }
746}