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 org.opengion.hayabusa.common.HybsSystem; 019import org.opengion.hayabusa.common.HybsSystemException; 020import org.opengion.hayabusa.resource.GUIInfo; 021import org.opengion.fukurou.util.ToString; // 6.1.1.0 (2015/01/17) 022import org.opengion.fukurou.util.ArraySet; // 6.4.3.4 (2016/03/11) 023 024import static org.opengion.fukurou.util.StringUtil.nval ; 025 026import javax.servlet.ServletRequest ; 027import javax.servlet.http.HttpSession ; 028 029import java.util.Set; // 6.4.3.4 (2016/03/11) 030import java.util.Map; 031import java.util.HashMap; 032 033/** 034 * 戻るリンクで戻る場合に使用する、検索時の request 情報をキャッシュするタグです(通常はquery.jsp に組込み)。 035 * 036 * requestタグをキャッシュすることにより、 再検索時や、各画面遷移時の項目の持ち回りを行います。 037 * command = "NEW" で、キャッシュし、"RENEW" で、取り出します。 038 * 暫定的にこのタグは、共通JSPファイルに設定し、HTMLそのもののキャッシュ制御も 039 * 行うように設定しています。 040 * 041 * @og.formSample 042 * ●形式:<og:requestCache cacheKey="[・・・]" /> 043 * ●body:なし 044 * 045 * ●Tag定義: 046 * <og:requestCache 047 * cacheKey 【TAG】キャッシュするサブキーを指定します(初期値:"") 048 * action 【TAG】アクション(SET,DELETE)をセットします 049 * keys 【TAG】リンク先に渡すキーを指定します 050 * vals 【TAG】keys属性に対応する値をCSV形式で複数指定します 051 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 052 * /> 053 * 054 * ●使用例 055 * <og:requestCache 056 * cacheKey="{@GUI.KEY}" キャッシュするサブキーを指定します。 057 * /> 058 * 059 * @og.group 画面制御 060 * 061 * @version 4.0 062 * @author Kazuhiko Hasegawa 063 * @since JDK5.0, 064 */ 065public class RequestCacheTag extends CommonTagSupport { 066 /** このプログラムのVERSION文字列を設定します。 {@value} */ 067 private static final String VERSION = "6.4.3.4 (2016/03/11)" ; 068 private static final long serialVersionUID = 643420160311L ; 069 070 private static final String CACHE_KEY = HybsSystem.REQ_CACHE_KEY; 071 072 /** command 引数に渡す事の出来る アクションコマンド ニュー {@value} */ 073 public static final String CMD_NEW = "NEW" ; 074 /** command 引数に渡す事の出来る アクションコマンド レニュー {@value} */ 075 public static final String CMD_RENEW = "RENEW" ; 076 /** command 引数に渡す事の出来る アクションコマンド イニット {@value} */ 077 public static final String CMD_INIT = "INIT" ; 078 /** command 引数に渡す事の出来る アクションコマンド リセット {@value} */ 079 public static final String CMD_RESET = "RESET" ; // 3.5.5.0 (2004/03/12) 追加 080 081 // 3.8.8.0 (2006/12/22) 082 /** action 引数に渡す事の出来る アクション 設定 {@value} */ 083 public static final String ACT_SET = "SET" ; 084 /** action 引数に渡す事の出来る アクション 削除 {@value} */ 085 public static final String ACT_DELETE = "DELETE" ; 086 087 // 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。 088 private static final Set<String> ACTION_SET = new ArraySet<>( ACT_SET , ACT_DELETE ); 089 090 private String cacheKey = ""; 091 private String action ; 092 private String[] keys ; 093 private String[] vals ; 094 095 /** 096 * デフォルトコンストラクター 097 * 098 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 099 */ 100 public RequestCacheTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 101 102 /** 103 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 104 * 105 * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。 106 * @og.rev 3.1.1.2 (2003/04/04) 継承元を、CommonTagSupport から TagSupport に変更する。 107 * @og.rev 3.1.3.0 (2003/04/10) Cache-Control ヘッダーのセットを削除します。 108 * @og.rev 3.1.6.0 (2003/04/24) キャッシュすべき値を、キー毎に指定できるように、cacheKey 属性を追加。 109 * @og.rev 3.1.7.0 (2003/05/02) command=INIT または、null のときに、キャッシュを削除するように変更する。 110 * @og.rev 3.1.7.0 (2003/05/02) command=INIT または、null のときに、キャッシュを削除するように変更する。 111 * @og.rev 3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの設定先を変更する。 112 * @og.rev 3.5.1.0 (2003/10/03) GAMENID 情報を取得し、backGamenIdSetメソッドに渡すように変更。 113 * @og.rev 3.7.0.3 (2005/03/01) BACK_ROW 情報を取得し、backGamenIdSetメソッドに渡すように変更。 114 * @og.rev 4.0.1.0 (2007/12/17) BackAddress対応 115 * 116 * @return 後続処理の指示 117 */ 118 @Override 119 public int doEndTag() { 120 debugPrint(); // 4.0.0 (2005/02/28) 121 // request をキャッシュするタグなので、直接取り込む。 122 final ServletRequest request = pageContext.getRequest(); 123 final String command = request.getParameter( "command" ); 124 final String backGamenId = request.getParameter( "BACK_GAMENID" ); 125 final String gamenId = request.getParameter( "GAMENID" ); // 3.5.1.0 (2003/10/03) 126 final String backRow = request.getParameter( "BACK_ROW" ); // 3.7.0.3 (2005/03/01) 127 final String backAdrs = request.getParameter( "BACK_ADDRESS" ); // 4.0.1.0 (2007/12/17) 128 129 commandExec( command,request ); 130 backGamenIdSet( command,backGamenId,gamenId,backRow,backAdrs ); // 4.0.1.0 (2007/12/17) 131 132 return EVAL_PAGE ; // ページの残りを評価する。 133 } 134 135 /** 136 * タグリブオブジェクトをリリースします。 137 * 138 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 139 * 140 * @og.rev 3.5.5.3 (2004/04/09) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。 141 * @og.rev 3.8.8.0 (2006/12/22) action,keys,vals 追加 142 * 143 */ 144 @Override 145 protected void release2() { 146 super.release2(); 147 cacheKey = ""; 148 action = null; 149 keys = null; 150 vals = null; 151 } 152 153 /** 154 * アクションを実行します。 155 * アクションは,指定のアクションコマンドに対応する処理を入力データに 156 * 対して行います。 157 * 158 * @og.rev 3.1.1.2 (2003/04/04) 継承元を、CommonTagSupport から TagSupport に変更する。 159 * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。HybsRequestWrapper 廃止。直接 Mapでキャッシュする。 160 * @og.rev 3.1.6.0 (2003/04/24) キャッシュすべき値を、キー毎に指定できるように、cacheKey 属性を追加。 161 * @og.rev 3.1.7.0 (2003/05/02) RENEW のときに、キャッシュを削除しないように変更する。 162 * @og.rev 3.1.7.0 (2003/05/02) command=INIT または、null のときに、キャッシュを削除するように変更する。 163 * @og.rev 3.5.5.0 (2004/03/12) command=RESET時にも、キャッシュを取り出すように変更する。 164 * @og.rev 3.8.6.3 (2006/11/30) debug 処理を追加 165 * @og.rev 3.8.8.0 (2006/12/22) actionCacheData 処理を追加 166 * @og.rev 5.6.8.1 (2013/09/13) UserInfo に、request 情報を渡してキャッシュ対象情報をセットします。 167 * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 168 * @og.rev 6.4.3.3 (2016/03/04) ServletRequest#getParameterMap() が、not null保証は無いので、ConcurrentHashMap に置き換えできない。 169 * 170 * @param command アクションコマンド (public static final 宣言されている文字列) 171 * @param request リクエストオブジェクト 172 */ 173 @SuppressWarnings(value={"unchecked"}) 174 private void commandExec( final String command,final ServletRequest request ) { 175 final String key = CACHE_KEY + cacheKey ; 176 final HttpSession session = pageContext.getSession(); 177 String msg = null; // 3.8.6.3 (2006/11/30) 178 179 if( CMD_NEW.equals( command ) ) { 180 // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 181 final Map<String,String[]> map = actionCacheData( new HashMap<>( request.getParameterMap() ) ); // 6.4.3.3 (2016/03/04) 182 session.setAttribute( key,map ); 183 184 // 5.6.8.1 (2013/09/13) UserInfo に、request 情報を渡してキャッシュ対象情報をセットします。 185 getUser().setLastRequestMap( map ); 186 msg = "command=[NEW] CACHE=[Set]" ; 187 } 188 else if( cacheKey.length() > 0 && 189 ( CMD_RENEW.equals( command ) || CMD_RESET.equals( command ) ) ) { 190 Map<String,String[]> map = (Map<String,String[]>)session.getAttribute( key ); 191 if( map != null ) { 192 map = actionCacheData( map ); 193 session.setAttribute( CACHE_KEY,map ); // 共有キャッシュにセット 194 msg = "command=[" + command + "] CACHE=[Load]" ; 195 } 196 } 197 else if( CMD_INIT.equals( command ) || command == null || command.isEmpty() ) { 198 session.removeAttribute( key ); 199 msg = "command=[" + command + "] CACHE=[remove]" ; 200 } 201 202 // 3.8.6.3 (2006/11/30) 203 if( isDebug() ) { 204 jspPrint( msg + "<br />" ); 205 } 206 } 207 208 /** 209 * キャッシュデータに対して、追記、削除を行います。 210 * 211 * @og.rev 3.8.8.0 (2006/12/22) 新規追加 212 * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMapではないが、not null制限のチェック追加 213 * 214 * @param map キャッシュデータ 215 * 216 * @return 追記、削除のキャッシュデータのマップ(入力のMapと同一) 217 */ 218 private Map<String,String[]> actionCacheData( final Map<String,String[]> map ) { 219 if( action != null && map != null && keys != null && vals != null ) { 220 if( ACT_SET.equalsIgnoreCase( action ) ) { 221 for( int i=0; i<keys.length; i++ ) { 222 final String[] val = new String[] { vals[i] } ; 223 if( keys[i] != null ) { map.put( keys[i],val ); } // 6.4.3.3 (2016/03/04) 224 } 225 } 226 else if( ACT_DELETE.equalsIgnoreCase( action ) ) { 227 for( int i=0; i<keys.length; i++ ) { 228 if( keys[i] != null ) { map.remove( keys[i] ); } // 6.4.3.3 (2016/03/04) 229 } 230 } 231 } 232 233 return map ; 234 } 235 236 /** 237 * BACK_GAMENID のキャッシュの設定先を変更します。 238 * 239 * @og.rev 3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの設定先を変更する。 240 * @og.rev 3.5.1.0 (2003/10/03) BACK_GAMENID のリクエストがNULLのときの処理(バグ)訂正。 241 * @og.rev 3.7.0.3 (2005/03/01) BACK_ROW 情報を取得し、backGamenIdSetメソッドに渡すように変更。 242 * @og.rev 3.8.6.3 (2006/11/30) debug 処理を追加 243 * @og.rev 4.0.1.0 (2007/12/17) BACK_ADDRESSを追加 244 * 245 * @param command アクションコマンド (public static final 宣言されている文字列) 246 * @param backGamenId リクエストから取得したBACK_GAMENID 247 * @param gamenId 画面ID 248 * @param backRow Stringリクエストから取得したBACK_ROW 249 * @param backAdrs Stringリクエストから取得したBACK_ADDRESS 250 */ 251 private void backGamenIdSet( final String command,final String backGamenId,final String gamenId,final String backRow,final String backAdrs) { // 3.5.1.0 (2003/10/03) 252 final HttpSession session = pageContext.getSession(); 253 254 // この画面自身のID 255 final GUIInfo guiInfo = (GUIInfo)session.getAttribute( HybsSystem.GUIINFO_KEY ); 256 final String guiId = guiInfo.getAttribute( "KEY" ); 257 258 final String guikey = HybsSystem.BACK_GAMENID_KEY + guiId ; 259 final String rowkey = HybsSystem.BACK_ROW_KEY + guiId ; // 3.7.0.3 (2005/03/01) 260 String msg = null; // 3.8.6.3 (2006/11/30) 261 final String adrskey = HybsSystem.BACK_ADDRESS_KEY + guiId; // 4.0.1.0 (2007/12/17) 262 if( CMD_NEW.equals( command ) && backGamenId != null && ! backGamenId.equals( guiId ) ) { 263 session.setAttribute( guikey,backGamenId ); 264 session.setAttribute( rowkey,backRow ); // 3.7.0.3 (2005/03/01) 265 session.setAttribute( adrskey,backAdrs ); // 4.0.1.0 (2007/12/17) 266 msg = "command=[" + command + "] backGamenId=[Set]" ; 267 } 268 else if( CMD_INIT.equals( command ) || command == null || command.isEmpty() ) { 269 session.removeAttribute( guikey ); 270 session.removeAttribute( rowkey ); // 3.7.0.3 (2005/03/01) 271 msg = "command=[" + command + "] backGamenId=[command Remove]" ; 272 session.removeAttribute( adrskey ); // 4.0.1.0 (2007/12/17) 273 } 274 // 以下 追加 3.5.1.0 (2003/10/03) 275 // 変更 4.0.1.0 (2007/12/17) 276 else if( ( gamenId == null || gamenId.isEmpty() ) && 277 ( backGamenId == null || backGamenId.isEmpty() ) && 278 ( backAdrs == null || backAdrs.isEmpty() )) { 279 session.removeAttribute(guikey ); 280 session.removeAttribute( rowkey ); // 3.7.0.3 (2005/03/01) 281 msg = "command=[" + command + "] backGamenId=[null Remove] " ; 282 session.removeAttribute( adrskey ); // 4.0.1.0 (2007/12/17) 283 } 284 285 // 3.8.6.3 (2006/11/30) 286 if( isDebug() ) { 287 jspPrint( msg + "<br />" ); 288 } 289 } 290 291 /** 292 * 【TAG】キャッシュするサブキーを指定します(初期値:"")。 293 * 294 * @og.tag 295 * キャッシュすべき値を、キー毎に指定できるようにします。 296 * 例えば、これに、画面IDを追加しておけば、画面ごとに、自分のリクエスト情報を 297 * キャッシュしておき、自分の画面が呼ばれたら、再度使用することができる様になります。 298 * NEW でキャッシュ登録を行い、RENEW で、通常のキャッシュキーに値を取り出します。 299 * 300 * @og.rev 3.1.6.0 (2003/04/24) キャッシュすべき値を、キー毎に指定できるように、cacheKey 属性を追加。 301 * 302 * @param ck キャッシュするサブキー 303 */ 304 public void setCacheKey( final String ck ) { 305 cacheKey = nval( getRequestParameter( ck ),cacheKey ); 306 } 307 308 /** 309 * 【TAG】アクション(SET,DELETE)をセットします。 310 * 311 * @og.tag 312 * アクションは,HTMLから(get/post)指定されますので,ACT_xxx で設定される 313 * フィールド定数値のいづれかを、指定できます。 314 * 無指定の場合は、なにもしません。 315 * 316 * <table border="1" frame="box" rules="all" > 317 * <caption>アクションの説明</caption> 318 * <tr><th>action </th><th>名称</th><th>機能</th></tr> 319 * <tr><td>SET </td><td>登録</td><td>指定の keys のキーに vals のキャッシュをセットします。</td></tr> 320 * <tr><td>DELETE </td><td>削除</td><td>指定の keys のキャッシュを削除します。 </td></tr> 321 * </table> 322 * 323 * @og.rev 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。 324 * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。 325 * 326 * @param act アクション (public static final 宣言されている文字列) 327 * @see <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.RequestCacheTag.ACT_DELETE">アクション定数</a> 328 */ 329 public void setAction( final String act ) { 330 action = nval( getRequestParameter( act ),action ); 331 332 if( action != null && !check( action, ACTION_SET ) ) { 333 final String errMsg = "指定のアクションは実行できません。アクションエラー" + CR 334 + "action=[" + action + "] " + CR 335 + "actionList=" + String.join( ", " , ACTION_SET ) ; 336 throw new HybsSystemException( errMsg ); 337 } 338 } 339 340 /** 341 * 【TAG】リンク先に渡すキーを指定します。 342 * 343 * @og.tag 344 * 戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり 345 * する場合のキーを設定できます。CSV形式で複数指定できます。 346 * vals 属性には、キーに対応する値を、設定してください。 347 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 348 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 349 * 350 * @og.rev 3.8.8.0 (2006/12/22) 新規追加 351 * 352 * @param key リンク先に渡すキー 353 */ 354 public void setKeys( final String key ) { 355 keys = getCSVParameter( key ); 356 } 357 358 /** 359 * 【TAG】keys属性に対応する値をCSV形式で複数指定します。 360 * 361 * @og.tag 362 * キーに設定した値を、CSV形式で複数して出来ます。 363 * 指定順序は、キーと同じにしておいて下さい。 364 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 365 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 366 * 367 * @og.rev 3.8.8.0 (2006/12/22) 新規追加 368 * 369 * @param val keys属性に対応する値 370 */ 371 public void setVals( final String val ) { 372 vals = getCSVParameter( val ); 373 } 374 375 /** 376 * このオブジェクトの文字列表現を返します。 377 * 基本的にデバッグ目的に使用します。 378 * 379 * @return このクラスの文字列表現 380 * @og.rtnNotNull 381 */ 382 @Override 383 public String toString() { 384 return ToString.title( this.getClass().getName() ) 385 .println( "VERSION" ,VERSION ) 386 .println( "cacheKey" ,cacheKey ) 387 .println( "Other..." ,getAttributes().getAttribute() ) 388 .fixForm().toString() ; 389 } 390}