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.hayabusa.taglib; 017 018import static org.opengion.fukurou.util.StringUtil.nval; 019 020import java.io.File; 021import java.io.IOException; 022import java.io.ObjectInputStream; 023import java.io.ObjectOutputStream; 024import java.util.Locale; 025import java.util.Map; 026import java.util.Map.Entry; 027import java.util.Arrays; 028 029import org.opengion.fukurou.business.ArrayTableModel; 030import org.opengion.fukurou.business.BizLogicHelper; 031import org.opengion.fukurou.db.Transaction; 032import org.opengion.fukurou.db.TransactionReal; 033import org.opengion.fukurou.util.ErrMsg; 034import org.opengion.fukurou.util.ErrorMessage; 035import org.opengion.fukurou.util.HybsLoader; 036import org.opengion.fukurou.util.HybsLoaderConfig; 037import org.opengion.fukurou.util.HybsLoaderFactory; 038import org.opengion.fukurou.util.StringUtil; 039import org.opengion.hayabusa.common.HybsSystem; 040import org.opengion.hayabusa.common.HybsSystemException; 041import org.opengion.hayabusa.db.DBTableModel; 042 043/** 044 * 業務ロジックを呼び出すためのタグです。 045 * 046 * logics属性に呼び出す業務ロジックのクラス名を記述します。 047 * このタグでは、複数の業務ロジックを1度に呼び出すことができ、 048 * DB接続のcommit,rollbackは一番最後に、1度のみ実行されます。 049 * 各業務ロジックは、記述した順番に呼び出されます。 050 * 051 * 業務ロジックは、{@link org.opengion.fukurou.business.BizLogicHelper}の 052 * 実装クラス、または、この実装クラスを継承したサブクラスである必要があります。 053 * 054 * 業務ロジッククラスについては、ホットデプロイ機能により、動的コンパイル、クラスロードが 055 * 行われます。 056 * 057 * 業務ロジックのソースディレクトリは、システムリソースの BIZLOGIC_SRC_PATH で定義されます。 058 * また、同様にクラスディレクトリは、システムリソースの BIZLOGIC_CLASS_PATH で定義されます。 059 * さらに、システムリソースの BIZLOGIC_HOTDEPLOY を false に設定することで、動的コンパイル 060 * 、クラスロードを行わなくすることもできます。 061 * この場合、予めコンパイルされたクラスを、初回呼び出し時に1回のみロードされます。 062 * 063 * SystemData の USE_SQL_INJECTION_CHECK が true か、quotCheck 属性が true の場合は、 064 * SQLインジェクション対策用のクォーティションチェックを行います。リクエスト引数に 065 * クォーティション(')が含まれると、エラーになります。 066 * 同様にUSE_XSS_CHECKがtrueか、xssCheck属性がtrueの場合は、 067 * クロスサイトススクリプティング(XSS)対策のためless/greater than signのチェックを行います。 068 * 069 * ※ このタグは、Transaction タグの対象です。 070 * 071 * @og.formSample 072 * ●形式: 073 * ・<og:bizLog 074 * logics = "業務ロジックのクラス名" 075 * command = "ENTRY" 076 * scope = "session" 077 * dbid = "DEFAULT" 078 * tableId = "DEFAULT" 079 * selectedAll = "false" 080 * modifyType = "A" 081 * keys = "SYSTEM_ID" 082 * vals = "{@SYSTEM_ID}" 083 * stopError = "true" 084 * quotCheck = "true" 085 * xssCheck = "true" 086 * debug = "false" 087 * /> 088 * ●body:なし 089 * 090 * ●Tag定義: 091 * <og:bizLogic 092 * logics ○【TAG】実行する業務ロジック名を指定します(必須)。 093 * command 【TAG】コマンドをセットします(初期値:ENTRY) 094 * scope 【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session) 095 * dbid 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します 096 * tableId 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 097 * selectedAll 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false) 098 * modifyType 【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除] 099 * keys 【TAG】リンク先に渡すキーをCSV形式で複数指定します 100 * vals 【TAG】リンク先に渡す値をCSV形式で複数指定します 101 * stopError 【TAG】処理エラーの時に処理を中止するかどうか[true/false]を設定します(初期値:true) 102 * quotCheck 【TAG】リクエスト情報の クォーティション(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=true]) 103 * xssCheck 【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true]) 104 * multi 【TAG】vals属性でパラメーターを取得する際、複数件存在する場合に、値を連結するかどうかを指定します(初期値:false) 105 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 106 * /> 107 * 108 * ●使用例 109 * <!-- 業務ロジックの呼び出しを行います --> 110 * <og:bizLogic logics="org.opengion.logic.gf9110.BizLogic_0001" keys="SYSTEM_ID" vals="{@MEM.SYSTEM_ID}" /> 111 * 112 * @og.rev 5.1.1.0 (2009/12/01) 新規作成 113 * @og.group 業務ロジック 114 * 115 * @version 5.0 116 * @author Hiroki Nakamura 117 * @since JDK1.6, 118 */ 119public class BizLogicTag extends CommonTagSupport { 120 //* このプログラムのVERSION文字列を設定します。 {@value} */ 121 private static final String VERSION = "567020130727" ; 122 private static final long serialVersionUID = 567020130727L ; 123 124 /** command 引数に渡す事の出来る コマンド エントリー {@value} */ 125// private static final String CMD_ENTRY = "ENTRY" ; 126 public static final String CMD_ENTRY = "ENTRY" ; // 5.1.9.0 (2010/08/01) 127// private static final String COMMAND_LIST = CMD_ENTRY; 128 private static final String ERR_MSG_ID = HybsSystem.ERR_MSG_KEY; 129 130 private String command = CMD_ENTRY; 131 private String[] logics = null; 132 private String dbid = null ; 133 private transient DBTableModel table = null; 134 private String tableId = HybsSystem.TBL_MDL_KEY; 135 private boolean selectedAll = false; 136 private String modifyType = null; 137 private String[] keys = null; 138 private String[] vals = null; 139 140 private boolean stopError = true; 141 private boolean quotCheck = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" ); // 4.0.0 (2005/08/31) 142 private boolean xssCheck = HybsSystem.sysBool( "USE_XSS_CHECK" ); // 5.0.0.2 (2009/09/15) 143 144 private transient ErrorMessage errMessage = null; 145 private int errCode = ErrorMessage.OK; 146 private int executeCount = -1; 147// private Connection conn = null; // 5.1.9.0 (2010/08/01) Transaction 対応 148 private ArrayTableModel arrTable= null; 149 private HybsLoader loader = null; 150 151 private String srcDir = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_SRC_PATH" ); 152 private String classDir = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" ); 153 private boolean isAutoCompile = HybsSystem.sysBool( "BIZLOGIC_AUTO_COMPILE" ); 154 private boolean isHotDeploy = HybsSystem.sysBool( "BIZLOGIC_HOT_DEPLOY" ); 155 private boolean isMulti = false; // 5.1.8.0 (2010/07/01) 追加 156 157 // 5.9.26.1 (2017/11/10) 実行エラーの際に、エラーを画面に出力するかどうか。。 158 private boolean dispError = true; 159 160 private static final String CLASS_PATH; 161 162 // HotDeploy機能を使用する場合に、Javaクラスをコンパイルするためのクラスパスを設定します。 163 // 対象となるクラスパスは、WEB-INF/classes 及び WEB-INF/lib/*.jar です。 164 165 static { 166 StringBuilder sb = new StringBuilder(); 167 sb.append( '.' ).append( File.pathSeparatorChar ); 168 File lib = new File( HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "lib" ); 169 File[] libFiles = lib.listFiles(); 170 for( int i=0; i<libFiles.length; i++ ) { 171 // 5.1.1.2 (2009/12/10) File.pathSeparatorCharを使用 172 // 5.1.8.0 (2010/07/01) libの検索パスの不具合対応 173// sb.append( libFiles[i] ).append( ';' ); 174 sb.append( libFiles[i].getAbsolutePath() ).append( File.pathSeparatorChar ); 175 } 176 sb.append( HybsSystem.sys( "REAL_PATH" ) + "WEB-INF" + File.separator + "classes" ).append( File.pathSeparatorChar ); 177 // 5.1.8.0 (2010/07/01) bizの下も検索パスに追加 178 sb.append( HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" ) ).append( File.pathSeparatorChar ); 179 180 CLASS_PATH = sb.toString(); 181 } 182 183 /** 184 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。 185 * 186 * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。 187 * 188 * @return 後続処理の指示(SKIP_BODY) 189 */ 190 @Override 191 public int doStartTag() { 192 // 5.3.4.0 (2011/04/01) 193// if( !check( command, COMMAND_LIST ) ) { 194// return(SKIP_BODY); 195// } 196 197 if( CMD_ENTRY.equals( command ) ) { 198 startQueryTransaction( tableId ); 199 } 200 201 return( SKIP_BODY ); 202 } 203 204 /** 205 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 206 * 207 * @og.rev 5.1.8.0 (2010/07/01) isMulti対応 208 * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。 209 * @og.rev 5.9.26.1 (2017/11/10) dispErrorの処理追加 210 * 211 * @return 後続処理の指示 212 */ 213 @Override 214 public int doEndTag() { 215 debugPrint(); 216 217 // 5.3.4.0 (2011/04/01) 218// if( check( command, COMMAND_LIST ) ) { 219 useQuotCheck( quotCheck ); 220 useXssCheck( xssCheck ); 221 222 makeVals(); 223 execute(); 224 225 String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() ); 226 if( err != null && err.length() > 0 ) { 227 setSessionAttribute( ERR_MSG_ID,errMessage ); 228 } 229 230 if( table != null && ! commitTableObject( tableId, table ) ) { 231 jspPrint( "BizLoicTag 処理が割り込まれました。DBTableModel は登録しません。" ); 232 return (SKIP_PAGE); 233 } 234 235 // 5.9.26.1 (2017/11/10) エラーメッセージをリクエスト変数で持つようにしておく 236 setRequestAttribute( "DB.ERR_MSG", err ); 237 // 5.9.26.1 (2017/11/10) dispErrorで表示をコントロール 238 if( dispError ) { 239 jspPrint( err ); 240 } 241// } 242 243 if( errCode >= ErrorMessage.NG && stopError ) { 244 return SKIP_PAGE; 245 } 246 else { 247 return EVAL_PAGE; 248 } 249 } 250 251 /** 252 * タグリブオブジェクトをリリースします。 253 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 254 * 255 * @og.rev 5.1.8.0 (2010/07/01) isMultiを追加 256 * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応 257 * @og.rev 5.9.26.1 (2017/11/10) dispError追加 258 */ 259 @Override 260 protected void release2() { 261 super.release2(); 262 command = CMD_ENTRY; 263 logics = null; 264 dbid = null; 265 table = null; 266 tableId = HybsSystem.TBL_MDL_KEY; 267 selectedAll = false; 268 modifyType = null; 269 keys = null; 270 vals = null; 271 stopError = true; 272 quotCheck = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" ); 273 xssCheck = HybsSystem.sysBool( "USE_XSS_CHECK" ); 274 errMessage = null; 275 errCode = ErrorMessage.OK; 276 executeCount = -1; 277// conn = null; // 5.1.9.0 (2010/08/01) Transaction 対応 278 arrTable = null; 279 loader = null; 280 srcDir = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_SRC_PATH" ); 281 classDir = HybsSystem.sys( "REAL_PATH" ) + HybsSystem.sys( "BIZLOGIC_CLASS_PATH" ); 282 isAutoCompile = HybsSystem.sysBool( "BIZLOGIC_AUTO_COMPILE" ); 283 isHotDeploy = HybsSystem.sysBool( "BIZLOGIC_HOT_DEPLOY" ); 284 isMulti = false; // 5.1.8.0 (2010/07/01) 追加 285 dispError = true; // 5.9.26.1 (2017/11/10) 追加 286 } 287 288 /** 289 * 業務ロジックを実行します。 290 * 291 * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応 292 * @og.rev 5.3.4.0 (2011/04/01) command=ENTRY以外ではDBTableModelの処理を行わない。 293 * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更 、Transaction対応で、close処理を入れる。 294 * @og.rev 5.6.0.3 (2012/01/24) arrTable に変更された値を、table に書き戻す処理を追加 295 */ 296 private void execute() { 297 int[] rowNos = new int[0]; 298 299 // 5.3.4.0 (2011/04/01) 300 if( CMD_ENTRY.equals( command ) ) { 301 table = (DBTableModel)getObject( tableId ); 302 } 303 304 if( table != null ) { 305 rowNos = getParameterRows(); 306 String[][] tblVals = new String[rowNos.length][table.getColumnCount()]; 307 String[] modTypes = new String[rowNos.length]; 308 for( int i=0; i<rowNos.length; i++ ) { 309 tblVals[i] = table.getValues( rowNos[i] ); 310 modTypes[i] = table.getModifyType( rowNos[i] ); 311 } 312 arrTable = new ArrayTableModel( table.getNames(), tblVals, modTypes ); 313 } 314 315 // 5.1.9.0 (2010/08/01) Transaction 対応 316// final Transaction tran ; 317 Transaction tran = null; 318 // 5.3.7.0 (2011/07/01) Transaction対応で、close処理を入れる。 319 try { 320 TransactionTag tranTag = (TransactionTag)findAncestorWithClass( this,TransactionTag.class ); 321 if( tranTag == null ) { 322 // tran = new TransactionReal( dbid,getApplicationInfo() ); 323 tran = new TransactionReal( getApplicationInfo() ); // 5.3.7.0 (2011/07/01) 引数変更 324 } 325 else { 326 tran = tranTag.getTransaction(); 327 } 328 // conn = ConnectionFactory.connection( dbid, null ); 329 errMessage = new ErrorMessage(); 330 loader = HybsLoaderFactory.getLoader( 331 new HybsLoaderConfig( srcDir, classDir, isAutoCompile, isHotDeploy, CLASS_PATH ) 332 ); 333 334 boolean rtn = false; 335 for( int i=0; i<logics.length; i++ ) { 336 // BizLogic logic = (BizLogic)loader.newInstance( logics[i] ); 337 // rtn = call( logic ); 338 // rtn = call( logics[i] ); 339 rtn = call( logics[i] , tran ); // 5.1.9.0 (2010/08/01) Transaction 対応 340 if( !rtn ) { break; } 341 } 342 343 // 5.6.0.3 (2012/01/24) arrTable に変更された値を、table に書き戻す処理 344 if( arrTable != null ) { 345 Map<Integer,String[]> valMap = arrTable.getModifyVals(); 346 if( valMap != null ) { 347 for( Map.Entry<Integer, String[]> entr : valMap.entrySet()) { 348 int seq = entr.getKey(); // intValue() は省略できる。 349 String[] vals = entr.getValue(); 350 table.setValues( vals , rowNos[seq] ); // DBTableModel へ書き戻し。元の行番号に変換が必要。 351 } 352 } 353 } 354 355 executeCount = rowNos.length; 356 errCode = errMessage.getKekka(); 357 setRequestAttribute( "DB.COUNT" , String.valueOf( executeCount ) ); 358 setRequestAttribute( "DB.ERR_CODE", String.valueOf( errCode ) ); 359 360 if( errCode < ErrorMessage.NG ) { 361 // Closer.commit( conn ); 362 tran.commit(); // 5.1.9.0 (2010/08/01) Transaction 対応 363 364 if( table != null && rowNos.length > 0 ) { 365 for( int j=rowNos.length-1; j>=0; j-- ) { 366 int row = rowNos[j]; 367 if( DBTableModel.DELETE_TYPE.equals( table.getModifyType( row ) ) ) { 368 table.removeValue( row ); 369 } 370 else { 371 table.resetModify( row ); 372 } 373 } 374 } 375 } 376 else { 377 // Closer.rollback( conn ); 378 tran.rollback(); // 5.1.9.0 (2010/08/01) Transaction 対応 379 } 380 // ConnectionFactory.close( conn, dbid ); 381// tran.close(); // 5.1.9.0 (2010/08/01) Transaction 対応 382 } 383 finally { 384 if( tran != null ) { tran.close(); } 385 } 386 387 // エラーメッセージの行番号を元の選択行に戻します。 388 ErrMsg[] errs = errMessage.toArray(); 389 ErrorMessage errMsgTmp = new ErrorMessage(); 390 for( int i=0; i<errs.length; i++ ) { 391 if( table != null && rowNos.length > 0 ) { 392 errMsgTmp.addMessage( errs[i].copy( rowNos[errs[i].getNo()] + 1 ) ); 393 } 394 else { 395 errMsgTmp.addMessage( errs[i].copy( errs[i].getNo() + 1 ) ); 396 } 397 } 398 errMessage = errMsgTmp; 399 } 400 401 /** 402 * 業務ロジックをCallします。 403 * 404 * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応 405 * @og.rev 5.1.9.0 (2010/08/01) DBIDをセット、ConnectonではなくTransactionを渡すように変更 406 * @og.rev 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。 407 * 408 * @param logicName 業務ロジック名 409 * @param tran Transactionトランザクションオブジェクト 410 * 411 * @return 業務ロジックの呼び出しが成功したかどうか 412 */ 413// private boolean call( final BizLogic logic ) { 414// private boolean call( final String logicName ) { 415 private boolean call( final String logicName , final Transaction tran ) { 416 BizLogicHelper logicHp = new BizLogicHelper( logicName, loader ); 417 418 if( logicHp.isRequireTable() ) { 419 if( arrTable == null ) { 420 // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。 421// throw new HybsSystemException( "TableModelが存在しません。logic=[" + logicName + "]" ); 422 String errMsg = "TableModelが存在しません。logic=[" + logicName + "]" ; 423 throw new HybsSystemException( errMsg ); 424 } 425 else if( arrTable.getRowCount() == 0 ) { return true; } // 0件のときは呼び出ししない 426 else { logicHp.setTable( arrTable ); } 427 } 428// logicHp.setConnection( conn ); 429// logicHp.setConnection( tran.getConnection( dbid ) ); // 5.1.9.0 (2010/08/01) Transaction 対応 430 logicHp.setTransaction( tran ); 431 logicHp.setDbid( dbid ); // 5.1.9.0 (2010/08/01) DBIDをセット 432 logicHp.setKeys( keys ); 433 logicHp.setVals( vals ); 434 logicHp.setUserId( getUser().getUserID() ); 435 logicHp.setParentPgId( getGUIInfoAttri( "KEY" ) ); 436 logicHp.setLoader( loader ); 437 if( isDebug() ) { logicHp.setDebug(); } 438 439 boolean rtn = false; 440 try { 441 rtn = logicHp.exec(); 442 } 443 catch ( Throwable th ) { 444// Closer.rollback( conn ); 445// ConnectionFactory.remove( conn, dbid ); 446 tran.rollback(); // 5.1.9.0 (2010/08/01) Transaction 対応 447 // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。 448// throw new HybsSystemException( "業務ロジックの処理中にエラーが発生しました。", th ); 449 String errMsg = "業務ロジックの処理中にエラーが発生しました。" + th.getMessage() ; 450 throw new HybsSystemException( errMsg,th ); 451 } 452 errMessage.append( logicHp.getErrMsg() ); 453 454 setRequestAttribute( logicHp.getClass().getSimpleName() + ".RETURN" , logicHp.getReturn() ); 455 setRequestAttribute( "RETURN", logicHp.getReturn() ); 456 457 if( isDebug() ) { jspPrint( logicHp.getDebugMsg() ); } 458 459 return rtn; 460 } 461 462 /** 463 * Valsの配列を生成します。 464 * 465 * @og.rev 5.1.8.0 (2010/07/01) 新規作成- 466 * @og.rev 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。 467 */ 468 private void makeVals() { 469 if( keys != null && keys.length > 0 ) { 470 boolean isSetVal = ( vals == null || vals.length == 0 ) ? false : true; 471 if( isSetVal ) { 472 if( keys.length != vals.length ) { 473 // 5.6.7.0 (2013/07/27) Exception を throw するとき、一旦、errMsg 変数にセットします。 474// throw new HybsSystemException( "keysとValsの個数が異なります。" ); 475 String errMsg = "keysとValsの個数が異なります。" + HybsSystem.CR 476 + " keys=" + Arrays.toString( keys ) + HybsSystem.CR 477 + " vals=" + Arrays.toString( vals ) ; 478 throw new HybsSystemException( errMsg ); 479 } 480 } 481 else { 482 vals = new String[keys.length]; 483 } 484 for( int i=0; i<keys.length; i++ ) { 485 if( isSetVal ) { 486 if( isMulti ) { vals[i] = StringUtil.array2csv( getRequestParameterValues( vals[i] ) );} 487 else { vals[i] = getRequestParameter( vals[i] ); } 488 } 489 else { 490 if( isMulti ) { vals[i] = StringUtil.array2csv( getRequestValues( keys[i] ) );} 491 else { vals[i] = getRequestValue( keys[i] ); } 492 } 493 } 494 } 495 } 496 497 /** 498 * 【TAG】コマンドをセットします(初期値:ENTRY)。 499 * 500 * @og.tag 501 * command=ENTRY以外ではDBTableModelの処理を行いません。 502 * コマンドは,HTMLから[get/post]指定されますので,CMD_xxx で設定される 503 * フィールド定数値のいづれかを、指定できます。 504 * 505 * @param cmd コマンド(public static final 宣言されている文字列) 506 * @see <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.BizLogicTag.CMD_ENTRY">コマンド定数</a> 507 */ 508 public void setCommand( final String cmd ) { 509 String cmd2 = getRequestParameter( cmd ); 510 if( cmd2 != null && cmd2.length() >= 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); } 511 } 512 513 /** 514 * 【TAG】実行する業務ロジック名を指定します。 515 * 516 * @og.tag 517 * 実行する業務ロジック名を指定します。業務ロジック名は、クラス名を指定します。 518 * クラス名については、クラス自身の名称のみを指定することができます。 519 * (パッケージ名を含めた完全な形のクラス名を指定することもできます) 520 * また、カンマ区切りで、複数指定することもできます。 521 * この場合、指定した順番に処理されます。 522 * 523 * @param lgs 業務ロジック名 524 */ 525 public void setLogics( final String lgs ) { 526 logics = getCSVParameter( lgs ); 527 } 528 529 /** 530 * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。 531 * 532 * @og.tag 533 * Queryオブジェクトを作成する時のDB接続IDを指定します。 534 * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先 535 * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して 536 * データベースにアクセスできます。 537 * 538 * @param id データベース接続ID 539 */ 540 public void setDbid( final String id ) { 541 dbid = nval( getRequestParameter( id ),dbid ); 542 } 543 544 /** 545 * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 546 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 547 * 548 * @og.tag 549 * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 550 * 渡す場合に、通常は、session を利用します。その場合の登録キーです。 551 * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 552 * この tableId 属性を利用して、メモリ空間を分けます。 553 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 554 * 555 * @param id sessionに登録する時の ID 556 */ 557 public void setTableId( final String id ) { 558 tableId = nval( getRequestParameter( id ),tableId ); 559 } 560 561 /** 562 * 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。 563 * 564 * @og.tag 565 * 全てのデータを選択済みデータとして扱って処理します。 566 * 全件処理する場合に、(true/false)を指定します。 567 * 初期値は false です。 568 * 569 * @param all データを全件選択済み [true:全件選択済み/false:通常] 570 */ 571 public void setSelectedAll( final String all ) { 572 selectedAll = nval( getRequestParameter( all ),selectedAll ); 573 } 574 575 /** 576 * 【TAG】DB検索時の モディファイタイプを指定します[A:追加/C:更新/D:削除]。 577 * 578 * @og.tag 579 * DB検索時に、そのデータをA(追加)、C(更新)、D(削除)のモディファイタイプを 580 * つけた状態にします。 581 * その状態で、そのまま、update する事が可能になります。 582 * 583 * @param type DB検索時のモディファイタイプ [A:追加/C:更新/D:削除] 584 */ 585 public void setModifyType( final String type ) { 586 modifyType = nval( getRequestParameter( type ),modifyType ); 587 } 588 589 /** 590 * 【TAG】リンク先に渡すキーをCSV形式で複数指定します。 591 * 592 * @og.tag リンク先に渡すキーを指定します。 593 * Keysだけを指定して、Valsを指定しない場合、Keysで指定された項目名に対応するパラメーターを取得し、 594 * Valsとして使用します。 595 * 596 * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用 597 * 598 * @param key リンク先に渡すキー(CSV形式) 599 */ 600 public void setKeys( final String key ) { 601// keys = getCSVParameter( key ); 602 keys = getCSVParameter( getRequestParameter( key ) ); 603 } 604 605 /** 606 * 【TAG】リンク先に渡す値をCSV形式で複数指定します。 607 * 608 * @og.tag リンク先に渡す値を指定します。 609 * Keysだけを指定して、Valsを指定しない場合、Keysで指定された項目名に対応するパラメーターを取得し、 610 * Valsとして使用します。 611 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 612 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 613 * 614 * @og.rev 3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用 615 * @og.rev 5.1.8.0 (2010/07/01) isMuitl対応 616 * 617 * @param val リンク先に渡す値(CSV形式) 618 */ 619 public void setVals( final String val ) { 620// vals = getCSVParameter( val ); 621 vals = StringUtil.csv2Array( val ); 622 } 623 624 /** 625 * 【TAG】処理エラーの時に処理を中止するかどうか[true/false]を設定します(初期値:true)。 626 * 627 * @og.tag 628 * false(中止しない)に設定する場合、後続処理では、{@DB.ERR_CODE}の値により、 629 * PLSQL/SQLの異常/正常終了によって分岐処理は可能となります。 630 * 初期値は、true(中止する)です。 631 * 632 * @param flag [true:中止する/false:中止しない] 633 */ 634 public void setStopError( final String flag ) { 635 stopError = nval( getRequestParameter( flag ),stopError ); 636 } 637 638 /** 639 * 【TAG】エラー時に内容を画面表示するか[true/false]を設定します(初期値:true)。 640 * 641 * @og.tag 642 * false(表示しない)に設定する場合、後続処理では、{@DB.ERR_MSG}の値により、 643 * 本来表示されるはずだったメッセージを取得可能です。 644 * stopErrorと併用して、JSON形式でエラーを返す場合等に利用します。 645 * 初期値は、true(中止する)です。 646 * 647 * @og.rev 5.9.27.1 (2017/12/08) 新規追加 648 * 649 * @param flag [true:表示する/false:表示しない] 650 */ 651 public void setDispError( final String flag ) { 652 dispError = nval( getRequestParameter( flag ),dispError ); 653 } 654 655 /** 656 * 【TAG】リクエスト情報の クォーティション(') 存在チェックを実施するかどうか[true/false]を設定します 657 * (初期値:USE_SQL_INJECTION_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK}])。 658 * 659 * @og.tag 660 * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに 661 * 渡す文字列にクォーティション(') を許さない設定にすれば、ある程度は防止できます。 662 * 数字タイプの引数には、 or 5=5 などのクォーティションを使用しないコードを埋めても、 663 * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、 664 * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。 665 * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。 666 * (初期値:システム定数のUSE_SQL_INJECTION_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK}])。 667 * 668 * @param flag クォーティションチェック [true:する/それ以外:しない] 669 * @see org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK 670 */ 671 public void setQuotCheck( final String flag ) { 672 quotCheck = nval( getRequestParameter( flag ),quotCheck ); 673 } 674 675 /** 676 * 【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します 677 * (初期値:USE_XSS_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK}])。 678 * 679 * @og.tag 680 * クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。 681 * (><) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。 682 * (初期値:システム定数のUSE_XSS_CHECK[={@og.value org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK}])。 683 * 684 * @param flag XSSチェックする [true:チェックする/false:しない] 685 * @see org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK 686 */ 687 public void setXssCheck( final String flag ) { 688 xssCheck = nval( getRequestParameter( flag ),xssCheck ); 689 } 690 691 /** 692 * 【TAG】vals属性でパラメーターを取得する際、複数件存在する場合に、値を連結するかどうかを指定します(初期値:false)。 693 * 694 * @og.tag 695 * この属性がtrueに指定された場合、パラメーターが複数存在する場合に、カンマで連結します。 696 * 初期値は、false(連結しない)です。 697 * 698 * @og.rev 5.1.8.0 (2010/07/01) 新規作成 699 * 700 * @param flag パラメーター連結するかどうか 701 */ 702 public void setMulti( final String flag ) { 703 isMulti = nval( getRequestParameter( flag ),isMulti ); 704 } 705 706 /** 707 * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。 708 * 709 * @return 選択行の配列 710 */ 711 @Override 712 protected int[] getParameterRows() { 713 final int[] rowNo ; 714 if( selectedAll ) { 715 int rowCnt = table.getRowCount(); 716 rowNo = new int[ rowCnt ]; 717 for( int i=0; i<rowCnt; i++ ) { 718 rowNo[i] = i; 719 } 720 } else { 721 rowNo = super.getParameterRows(); 722 } 723 return rowNo ; 724 } 725 726 /** 727 * シリアライズ用のカスタムシリアライズ書き込みメソッド 728 * 729 * @serialData 一部のオブジェクト(DBTableModel,ErrorMessage)は、シリアライズされません。 730 * 731 * @param strm ObjectOutputStreamオブジェクト 732 * @throws IOException 入出力エラーが発生した場合 733 */ 734 private void writeObject( final ObjectOutputStream strm ) throws IOException { 735 strm.defaultWriteObject(); 736 } 737 738 /** 739 * シリアライズ用のカスタムシリアライズ読み込みメソッド 740 * 741 * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。 742 * 743 * @serialData 一部のオブジェクト(DBTableModel,ErrorMessage)は、読み込まれません。 744 * 745 * @param strm ObjectInputStreamオブジェクト 746 * @see #release2() 747 * @throws IOException シリアライズに関する入出力エラーが発生した場合 748 * @throws ClassNotFoundException クラスを見つけることができなかった場合 749 */ 750 private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException { 751 strm.defaultReadObject(); 752 } 753 754 /** 755 * このオブジェクトの文字列表現を返します。 756 * 基本的にデバッグ目的に使用します。 757 * 758 * @return このクラスの文字列表現 759 */ 760 @Override 761 public String toString() { 762 return org.opengion.fukurou.util.ToString.title( this.getClass().getName() ) 763 .println( "VERSION" ,VERSION ) 764 .println( "command" ,command ) 765 .println( "logics" ,logics ) 766 .println( "dbid" ,dbid ) 767 .println( "tableId" ,tableId ) 768 .println( "selectedAll" ,selectedAll ) 769 .println( "modifyType" ,modifyType ) 770 .println( "keys" ,keys ) 771 .println( "vals" ,vals ) 772 .println( "stopError" ,stopError ) 773 .println( "quotCheck" ,quotCheck ) 774 .println( "xssCheck" ,xssCheck ) 775 .println( "executeCount" ,executeCount ) 776 .println( "errCode" ,errCode ) 777 .println( "Other..." ,getAttributes().getAttribute() ) 778 .fixForm().toString() ; 779 } 780}