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.BufferedInputStream; 021import java.io.BufferedWriter; 022import java.io.ByteArrayInputStream; 023import java.io.ByteArrayOutputStream; 024import java.io.File; 025import java.io.IOException; 026import java.io.InputStream; 027import java.io.OutputStreamWriter; 028import java.io.UnsupportedEncodingException; 029import java.io.Writer; 030import java.util.Map; 031 032import org.opengion.fukurou.model.FileOperation; 033import org.opengion.fukurou.util.Closer; 034import org.opengion.fukurou.util.FileString; 035import org.opengion.fukurou.util.FileUtil; 036import org.opengion.fukurou.util.LogWriter; 037import org.opengion.fukurou.util.SOAPConnect; 038import org.opengion.fukurou.util.StringUtil; 039import org.opengion.fukurou.util.URLConnect; 040import org.opengion.fukurou.util.XHTMLTag; 041import org.opengion.fukurou.xml.XML2TableParser; 042import org.opengion.fukurou.xml.XSLT; 043import org.opengion.hayabusa.common.HybsSystem; 044import org.opengion.hayabusa.common.HybsSystemException; 045import org.opengion.hayabusa.db.DBTableModel; 046import org.opengion.hayabusa.db.DBTableModelUtil; 047import org.opengion.hayabusa.io.HybsFileOperationFactory; 048 049/** 050 * 指定のURLに接続します。 051 * 052 * エンジンでは、URL にアクセスすることで、デーモンを起動したり、 053 * コマンドを実行(adminメニュー)することが出来ます。 054 * もちろん、検索条件を指定して、結果を取得することも可能です。 055 * このタグでは、URLにアクセスして、コマンドを実行したり結果を取得できます。 056 * さらに、ファイルを POST で転送したり、処理結果を XSLT変換したり出来ます。 057 * 058 * @og.formSample 059 * ●形式: 060 * <og:urlConnect 061 * url = "http://・・・ " 必須 062 * proxyHost = "proxy.opengion.org" 063 * proxyPort = "8080" 064 * timeout = "1" 065 * keys = "command,SYSTEM_ID" 066 * vals = "NEW,GE" 067 * useSystemUser = "true/false" 初期値:true 068 * authUserPass = "admin:******" 初期値:admin:****** 069 * display = "false/true" 初期値:false 070 * xslFile = "filter.xsl" 071 * saveFile = "outdata.xml" 072 * soapNameSpace = "MyWebService" 073 * soapMethodName= "test" 074 * tableId = "DEFAULT" 075 * rowKey = "item" 076 * colKeys = "person_id,person_name" 077 * rtnKeys = "version,summary" 078 * encode = "UTF-8" 079 * /> 080 * 081 * url : 接続するURLを指定します。必須属性です。 082 * proxyHost : proxy が存在する場合は、そのホスト名(例:proxy.opengion.org) 083 * proxyPort : proxy が存在する場合は、そのポート番号(例:8080) 084 * timeout : 通信リンクのオープン時に、指定された秒単位のタイム・アウト値を使用(例:10) 085 * keys,vals : URLの指定時に、パラメータ(引数)を追加します。URLに含めても構いません。 086 * : SOAPによる呼び出しの場合の詳細については、keysの属性定義を参照して下さい。 087 * postKey : POST を使って、postFile属性のファイル内容を送信する時のキーです。 088 * postFile : POST を使って、postFile属性のファイル内容を送信します。 089 * postFile を指定せず、postKey のみ指定して、BODY部に何か書き込めば、 090 * そのBODY部の文字列を POSTの内容として送信します。 091 * authUserPass : Basic認証を使用する場合の接続ユーザー:パスワードを指定します。 092 * 接続時のユーザーとパスワードを、USER:PASSWD 形式 で指定します。 093 * useSystemUser="false" で何も指定しない場合は、Basic認証を使用しません。 094 * useSystemUser : Basic認証の接続ユーザー:パスワードに、システムユーザーを使用 095 * するかどうかを指定します(初期値:true)。 096 * true の場合は、SYSTEM:***** を使用します。 097 * xslFile : 接続先データを取得し、そのデータを XSLT変換する場合のXSLファイルを指定します。 098 * display : 接続した結果のレスポンスを画面に表示するかどうかを指定します(初期値:false)。 099 * エンジンの場合、コマンドを投げるだけであれば、結果を取得する必要は 100 * ありません。イメージ的には、取得データが、このタグの位置に置き換わります。 101 * xslFile が指定されている場合、XSLT変換してセーブします。 102 * saveFile : 接続先データを取得した結果を、ファイル出力します。 103 * display="true" と、saveFile を併用することはできません。 104 * xslFile が指定されている場合、XSLT変換してセーブします。 105 * soapNameSpace : SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。 106 * この名前空間は、通常WSDLファイルのdescriptionsタグのtargetNamespace属性の値により 107 * 定義されます。 108 * soapMethodName: SOAPによるWebサービスの呼び出しで、メソッド名を指定します。 109 * WSDLファイルで定義されるoperationタグのname属性の値に相当します。 110 * tableId : 結果のXMLファイルをDBTableModelに変換した際に、登録するTableIdを指定します。 111 * rowKey : XMLをDBTableModelに変換する際の、行を表すタグキーを指定します。 112 * colKeys : XMLをDBTableModelに変換する際の、項目を表すタグキーの一覧を指定します。 113 * キーにPARENT_TAG、PARENT_FULL_TAGを指定することで、rowKeyで指定されたタグの 114 * 直近の親タグ、及びフルの親タグ名(親タグの階層を">[タグA]>[タグB]>[タグC]>"で表現)を 115 * 取得することができます。 116 * rtnKeys : XMLのタグキーを指定して値を取り出します。取り出した値は、{@XX}形式で処理することが可能です。 117 * encode : データの入出力を行うエンコードを指定します。 118 * 119 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) 120 * POSTデータを記述します。 121 * 122 * ●Tag定義: 123 * <og:urlConnect 124 * url ○【TAG】アクセスする URL を指定します(必須)(必須)。 125 * proxyHost 【TAG】プロキシ経由で接続する場合の、プロキシホスト名を指定します 126 * proxyPort 【TAG】プロキシ経由で接続する場合の、プロキシポート番号を指定します 127 * timeout 【TAG】通信リンクのオープン時に、指定された秒単位のタイム・アウト値を使用 128 * (初期値:URL_CONNECT_TIMEOUT[={@og.value org.opengion.hayabusa.common.SystemData#URL_CONNECT_TIMEOUT}])。) 129 * keys 【TAG】アクセスパラメータキーをCSV形式で複数指定します 130 * vals 【TAG】keys属性に対応する値をCSV形式で複数指定します 131 * useSystemUser 【TAG】Basic認証で接続するユーザーにSYSTEMユーザーを使用するかどうか[true/false]を指定します(初期値:true) 132 * authUserPass 【TAG】Basic認証を使用して接続する場合のユーザー:パスワードを指定します(初期値:null) 133 * display 【TAG】接続の結果を表示するかどうかを指定します(初期値:false) 134 * xslFile 【TAG】接続の結果を表示する場合にXSLT変換する場合のファイルを指定します 135 * saveFile 【TAG】接続の結果をファイルに保存します 136 * postKey 【TAG】POST を使って、postFile属性のファイル内容を送信する時のキーを指定します 137 * postFile 【TAG】POST を使って、postFile属性のファイル内容を送信します 138 * method 【TAG】送信メソッドを指定します(GET/POST/SOAP) 139 * errNeglect 【TAG】(通常は使いません) 接続エラーを無視する場合にtrueとします(初期値false) 140 * soapNameSpace 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します 141 * soapMethodName 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名を指定します 142 * tableId 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 143 * scope 【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session) 144 * rowKey 【TAG】結果のXMLをDBTableModelに変換する際に、行のキーとなるタグ名を指定します 145 * colKeys 【TAG】結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します 146 * rtnKeys 【TAG】結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します 147 * encode 【TAG】データの入出力のエンコードを指定します 148 * mainTrans 【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false) 149 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20) 150 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20) 151 * caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20) 152 * caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20) 153 * storageType 【TAG】保存先ストレージタイプを指定します 154 * bucketName 【TAG】保存先バケット名を指定します 155 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 156 * > ... Body ... 157 * </og:urlConnect> 158 * 159 * ●例: 160 * アドミン関連 161 * http://localhost:8823/gf/jsp/admin?COMMAND=infomation [状況表示] 162 * http://localhost:8823/gf/jsp/admin?COMMAND=close [プール削除] 163 * http://localhost:8823/gf/jsp/admin?COMMAND=loginUser [ログインユーザー] 164 * http://localhost:8823/gf/jsp/admin?COMMAND=システムパラメータ [システムパラメータ] 165 * 166 * 帳票デーモン 167 * http://localhost:8823/gf/jsp/REP08/result.jsp?cmd=SET&period=5000&command=NEW&timerTask=org.opengion.hayabusa.report.ReportDaemon&name=ReportDaemon デーモン起動 168 * http://localhost:8823/gf/jsp/REP08/result.jsp?cmd=CANCEL&period=5000&command=NEW&timerTask=org.opengion.hayabusa.report.ReportDaemon&name=ReportDaemon デーモン停止 169 * 170 *Tomcat Manager 画面 171 * http://localhost:8823/manager/reload?path=/ver4 アプリケーションを再ロード 172 * 173 * @og.rev 3.6.0.0 (2004/09/17) 新規作成 174 * @og.rev 4.1.0.0 (2007/12/22) POSTメソッドで複数キーを登録できるように属性追加 175 * @og.rev 5.1.5.0 (2010/04/01) SOAP対応 176 * @og.rev 5.10.9.0 (2019/03/01) oota クラウドストレージ対応を追加。(Fileクラスを拡張) 177 * 178 * @og.group その他部品 179 * 180 * @version 4.0 181 * @author Kazuhiko Hasegawa 182 * @since JDK5.0, 183 */ 184public class URLConnectTag extends CommonTagSupport { 185 //* このプログラムのVERSION文字列を設定します。 {@value} */ 186 private static final String VERSION = "5.7.7.2 (2014/06/20)" ; 187 188 private static final long serialVersionUID = 577220140620L ; 189 190 private static final String DEFAULT_USER = "SYSTEM:MANAGER" ; 191 192 private String urlStr = null; 193 private String[] keys = null; 194 private String[] vals = null; 195 private String xslFile = null; 196 private String saveFile = null; 197 private String postKey = null; 198 private String postData = null; // postFile ファイルか、BODY部 199 private int timeout = HybsSystem.sysInt( "URL_CONNECT_TIMEOUT" ); // 5.8.8.1 (2015/06/05) 新規追加 200 private boolean useSystemUser = true; 201 private String authUserPass = null; 202 private boolean display = false; 203 private String proxyHost = null; // 4.0.0 (2007/07/25) 204 private int proxyPort = -1; // 4.0.0 (2007/07/25) 205 private String method = "GET"; // 4.1.0.0 (2007/12/22) POSTorGETorSOAP 206 private boolean errNglctFlag = false; // 4.1.1.0 (2008/01/22) エラー無視フラグ 207 private String soapNameSpace = null; // 5.1.5.0 (2010/04/01) SOAP対応 208 private String soapMethodName = null; // 5.1.5.0 (2010/04/01) SOAP対応 209 private transient DBTableModel table = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 210 private String tableId = HybsSystem.TBL_MDL_KEY; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 211 private String rowKey = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 212 private String[] colKeys = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 213 private String[] rtnKeys = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 214 private String encode = "UTF-8"; // 5.1.6.0 (2010/05/01) エンコード指定対応 215 216 private boolean isTableOut = false; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 217 private boolean isOutParse = false; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 218 private boolean isMainTrans = true; // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し 219 private String storageType = null; // 5.10.9.0 (2019/03/01) ADD 220 private String bucketName = null; // 5.10.9.0 (2019/03/01) ADD 221 222 /** 223 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。 224 * 225 * @og.rev 5.1.5.0 (2010/04/01) SOAP・DBTableModel出力対応 226 * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。 227 * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加 228 * 229 * @return 後続処理の指示 230 */ 231 @Override 232 public int doStartTag() { 233 // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加 234 if( !useTag() ) { return SKIP_BODY ; } 235 236 // 5.1.5.0 (2010/04/01) DBTableModel出力対応 237 if( rowKey != null || colKeys != null || rtnKeys != null ) { 238 isOutParse = true; 239 if( rowKey != null || colKeys != null ) { 240 isTableOut = true; 241 useMainTrans( isMainTrans ); // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し 242 startQueryTransaction( tableId ); 243 } 244 } 245 246 // 5.1.5.0 (2010/04/01) SOAPの場合は、postKeyが指定されない。 247 if( postData != null ) { 248 return SKIP_BODY ; // Body を評価しない 249 } 250 else { 251 return EVAL_BODY_BUFFERED ; // Body を評価する。( extends BodyTagSupport 時) 252 } 253 } 254 255 /** 256 * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。 257 * 258 * @return 後続処理の指示(SKIP_BODY) 259 */ 260 @Override 261 public int doAfterBody() { 262 postData = getBodyString(); 263 264 return SKIP_BODY ; 265 } 266 267 /** 268 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 269 * 270 * @og.rev 4.0.1.0 (2007/12/12) PostKeys,PostVals処理を追加 271 * @og.rev 5.1.5.0 (2010/04/01) SOAP・DBTableModel出力対応 272 * @og.rev 5.2.0.0 (2010/09/01) エラー処理でNullPointerExceptionが発生するバグを修正 273 * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加 274 * 275 * @return 後続処理の指示 276 */ 277 @Override 278 public int doEndTag() { 279 debugPrint(); // 4.0.0 (2005/02/28) 280 281 // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加 282 if( !useTag() ) { return EVAL_PAGE ; } 283 284 URLConnect conn = null; 285 ByteArrayOutputStream pipeOut = null; 286 try { 287 conn = connect(); 288 289 // 出力先が、画面かファイルかを判断します。 290 Writer outWriter = null; 291 // 5.1.5.0 (2010/04/01) DBTableModel出力対応 292 if( isOutParse ) { 293 pipeOut = new ByteArrayOutputStream(); 294 try { 295 outWriter = new BufferedWriter( new OutputStreamWriter( pipeOut, "UTF-8" ) ); 296 } 297 catch( UnsupportedEncodingException ex ) { 298 throw new HybsSystemException( "不正なエンコードが指定されました。[UTF-8]",ex ); 299 } 300 } 301 else if( display ) { 302 outWriter = FileUtil.getNonFlushPrintWriter( pageContext.getOut() ) ; // JspWriter の取得 303 } 304 else if( saveFile != null ) { 305 outWriter = FileUtil.getPrintWriter( new File( saveFile ),"UTF-8" ); 306 } 307 308 // 出力先が存在する場合。 309 if( outWriter != null ) { 310 if( xslFile != null ) { 311 XSLT xslt = new XSLT(); 312 xslt.setXslFile( xslFile ); 313 xslt.setOutFile( outWriter ); 314 xslt.transform( conn.getReader() ); 315 xslt.close(); 316 } 317 else { 318 outWriter.write( conn.readData() ); 319 } 320 Closer.ioClose( outWriter ); 321 322 // 5.10.9.0 (2019/03/01) クラウドストレージ指定の場合は、アップロードする。 323 FileOperation cloudFile = HybsFileOperationFactory.create(storageType, bucketName, saveFile); 324 if(!cloudFile.isLocal()) { 325 File localFile = new File(saveFile); 326 FileUtil.copy(localFile, cloudFile); 327 localFile.delete(); 328 } 329 } 330 } 331 catch( IOException ex ) { 332 String errMsg = "データ取得中にエラーが発生しました。" + HybsSystem.CR 333 + " url=[" + urlStr + "]" 334 // 5.2.0.0 (2010/09/01) エラー処理でNullPointerExceptionが発生するバグを修正 335 + " message=[" + ( conn == null ? "NO_CONNECTION" : conn.getMessage() ) + "]"; 336 if( errNglctFlag ) { // 4.1.1.0 (2008/01/22) エラーを無視(標準エラー出力のみ) 337 LogWriter.log( errMsg ); 338 } 339 else { // 通常は無視しない 340 throw new HybsSystemException( errMsg,ex ); 341 } 342 } 343 finally { 344 if( conn != null ) { conn.disconnect(); } 345 } 346 347 // 5.1.5.0 (2010/04/01) DBTableModel出力対応 348 if( isOutParse ) { 349 parse( new BufferedInputStream( new ByteArrayInputStream( pipeOut.toByteArray() ) ) ); 350 if( isTableOut && table != null && !commitTableObject( tableId, table ) ) { 351 jspPrint( "URLConnectTag Query処理が割り込まれました。DBTableModel は登録しません。" ); 352 return SKIP_PAGE ; 353 } 354 } 355 356 return EVAL_PAGE ; 357 } 358 359 /** 360 * URLに対して接続を行います。 361 * 362 * @og.rev 5.1.6.0 (2010/05/01) エンコード指定対応 363 * @og.rev 5.8.8.1 (2015/06/12) timeout追加 364 * 365 * @return 接続オブジェクト 366 * @throws IOException 入出力エラーが発生したとき 367 */ 368 private URLConnect connect() throws IOException { 369 if( useSystemUser ) { authUserPass = DEFAULT_USER; } 370 371 // 5.1.5.0 (2010/04/01) SOAP対応 372 // SOAPの場合、PostDataは、SOAPConnectタグの中で生成します。 373 URLConnect conn = null; 374 if( "SOAP".equalsIgnoreCase( method ) ) { 375 if( soapNameSpace == null || soapNameSpace.length() == 0 376 || soapMethodName == null || soapMethodName.length() == 0 ) { 377 String errMsg = "SOAP接続の場合、soapNameSpace及びsoapMethodNameは必ず指定して下さい。"; 378 throw new HybsSystemException( errMsg ); 379 } 380 381 if( postData != null && postData.length() > 0 ) { 382 conn = new SOAPConnect( urlStr,authUserPass, soapNameSpace, soapMethodName, postData ); 383 } 384 else { 385 conn = new SOAPConnect( urlStr,authUserPass, soapNameSpace, soapMethodName, keys, vals ); 386 } 387 } 388 else { 389 String urlEnc = XHTMLTag.urlEncode( keys,vals ); 390 if( postKey != null ) { // 4.1.0.0 (2007/12/22) 391 method = "POST"; 392 String addEnc = postKey + "=" + postData; 393 urlEnc = urlEnc + "&" + addEnc; // &連結 394 } 395 396 if( ! "POST".equals( method ) ) { // 4.1.0.0 (2007/12/22) 397 // String urlEnc = XHTMLTag.urlEncode( keys,vals ); 398 urlStr = XHTMLTag.addUrlEncode( urlStr,urlEnc ); 399 } 400 conn = new URLConnect( urlStr,authUserPass ); 401 402 // if( postKey != null ) { 403 // conn.setPostData( postKey,postData ); 404 // } 405 if( "POST".equals( method ) && keys != null && vals != null ) { // 4.1.0.0 (2007/12/22) 406 conn.setPostData( urlEnc ); 407 } 408 } 409 410 // 4.0.0 (2007/07/25) プロキシの設定追加 411 if( proxyHost != null ) { 412 conn.setProxy( proxyHost,proxyPort ); 413 } 414 415 // 5.1.6.0 (2010/05/01) エンコード指定対応 416 if( encode != null && encode.length() > 0 ) { 417 conn.setCharset( encode ); 418 } 419 420 // 5.8.8.1 (2015/06/12) timeout属性追加 421 if( timeout >= 0 ) { 422 conn.setTimeout( timeout ); 423 } 424 conn.connect(); 425 426 return conn; 427 } 428 429 /** 430 * 出力データをパースし、DBTableModel及び属性パラメーターに分解します。 431 * 現時点では、XMLデータのみパースすることが可能です。 432 * 433 * @param input インプットストリーム 434 */ 435 private void parse( final InputStream input ) { 436 XML2TableParser parser = new XML2TableParser( input ); 437 parser.setTableCols( rowKey, colKeys ); 438 parser.setReturnCols( rtnKeys ); 439 parser.parse(); 440 441 // DBTableModelを生成します。 442 if( isTableOut ) { 443 table = DBTableModelUtil.makeDBTable( parser.getCols(), parser.getData(), getResource() ); 444 } 445 446 // 戻り値を取得し、Attributeに登録します。 447 if( rtnKeys != null ) { 448 Map<String,String> rtn = parser.getRtn(); 449 for( Map.Entry<String, String> entry : rtn.entrySet() ) { 450 setRequestAttribute( entry.getKey(), entry.getValue() ); 451 } 452 } 453 } 454 455 /** 456 * タグリブオブジェクトをリリースします。 457 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 458 * 459 * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。 460 * @og.rev 5.8.1.1 (2015/06/12) timeout追加 461 * @og.rev 5.10.9.0 (2019/03/01) storageType,bucketNameの初期を追加 462 * 463 */ 464 @Override 465 protected void release2() { 466 super.release2(); 467 urlStr = null; 468 proxyHost = null; // 4.0.0 (2007/07/25) 469 proxyPort = -1; // 4.0.0 (2007/07/25) 470 keys = null; 471 vals = null; 472 xslFile = null; 473 saveFile = null; 474 postKey = null; 475 postData = null; 476 timeout = HybsSystem.sysInt( "URL_CONNECT_TIMEOUT" ); // 5.8.1.1 (2015/06/05) 新規追加 477 useSystemUser = true; 478 authUserPass = null; 479 display = false; 480 method = "GET"; // 4.1.0.0 (2007/12/22) 481 errNglctFlag = false; // 4.1.1.0 (2008/01/22) 482 soapNameSpace = null; // 5.1.5.0 (2010/04/01) SOAP対応 483 soapMethodName = null; // 5.1.5.0 (2010/04/01) SOAP対応 484 table = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 485 tableId = HybsSystem.TBL_MDL_KEY; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 486 rowKey = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 487 colKeys = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 488 rtnKeys = null; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 489 isTableOut = false; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 490 isOutParse = false; // 5.1.5.0 (2010/04/01) DBTableModel出力対応 491 encode = "UTF-8"; // 5.1.6.0 (2010/05/01) エンコード指定対応 492 isMainTrans = true; // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し 493 storageType = null; // 5.10.9.0 (2019/03/01) ADD 494 bucketName = null; // 5.10.9.0 (2019/03/01) ADD 495 } 496 497 /** 498 * 【TAG】アクセスする URL を指定します(必須)。 499 * 500 * @og.tag 501 * 接続するURLを指定します。(例:http:// ・・・・・・) 502 * ?以降のパラメータが含まれていても構いません。 503 * このURL に、keys,vals で指定されたパラメータも追加されます。 504 * 505 * @param url アクセスする URL 506 */ 507 public void setUrl( final String url ) { 508 urlStr = nval( getRequestParameter( url ),urlStr ); 509 } 510 511 /** 512 * 【TAG】プロキシ経由で接続する場合の、プロキシホスト名を指定します。 513 * 514 * @og.tag 515 * 接続先が、プロキシ経由の場合、プロキシのホスト名を指定します。 516 * 例:proxy.opengion.org 517 * 518 * @param host プロキシホスト名 519 */ 520 public void setProxyHost( final String host ) { 521 proxyHost = nval( getRequestParameter( host ),proxyHost ); 522 useSystemUser = false; // プロキシ接続時は、システムユーザーは使えません。 523 } 524 525 /** 526 * 【TAG】プロキシ経由で接続する場合の、プロキシポート番号を指定します。 527 * 528 * @og.tag 529 * 接続先が、プロキシ経由の場合、プロキシのポート番号を指定します。 530 * 例:8080 531 * 532 * @param port プロキシポート番号 533 */ 534 public void setProxyPort( final String port ) { 535 proxyPort = nval( getRequestParameter( port ),proxyPort ); 536 } 537 538 /** 539 * 【TAG】アクセスパラメータキーをCSV形式で複数指定します。 540 * 541 * @og.tag 542 * アクセスする URLに追加するパラメータのキーを指定します。 543 * カンマ区切りで複数指定できます。 544 * vals 属性には、キーに対応する値を、設定してください。 545 * 例:<b>keys="command,SYSTEM_ID"</b> vals="NEW,GE" 546 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 547 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 548 * 549 * [SOAP対応] 550 * SOAPによるWebサービスの呼び出しの場合、keys,valsに指定された値より、env:Envelopタグを 551 * rootタグとするXMLデータを生成します。 552 * (BODY部分に直接XMLデータを出力することも可能です。) 553 * この際、項目名に'>'を含めることで、階層的なXMLデータを表現することができます。 554 * 例) 555 * [属性定義] 556 * keys="param0>AAA,param0>BBB,param1>CCC,DDD" 557 * vals="v1,v2,v3,v4" 558 * [XMLデータ(※データ部のみ)] 559 * <param0> 560 * <AAA>v1</AAA> 561 * <BBB>v2</BBB> 562 * </param0> 563 * <param1> 564 * <CCC>v3</CCC> 565 * </param1> 566 * <DDD>v4</DDD> 567 * 項目の値を"null"とすることで、XMLで言うところの「xsi:nil=\"true\"」のデータを表現すること 568 * もできます。 569 * また、キー名の先頭を'@'にすることで、項目名に名前空間のPREFIXを付加することができます。 570 * 一般的には、JavaやRubyで実装されたWebサービスを呼び出しする場合は、必要ありませんが、 571 * .NETで実装されたWebサービスを呼び出しする場合は、各項目にPREFIXを付与しないと、正しく 572 * パラメーターを渡すことができません。 573 * ※現時点では、keysの階層定義は、2階層まで対応しています。 574 * 3階層以上のXML構造を定義する場合は、postFile属性によるファイル指定又は、Body部分で直接 575 * XMLデータを記述して下さい。 576 * 577 * @param key リンク先に渡すキー 578 * @see #setVals( String ) 579 */ 580 public void setKeys( final String key ) { 581 keys = getCSVParameter( key ); 582 } 583 584 /** 585 * 【TAG】keys属性に対応する値をCSV形式で複数指定します。 586 * 587 * @og.tag 588 * キーに設定した値を、カンマ区切り文字で複数して出来ます。 589 * 指定順序は、キーと同じにしておいて下さい。 590 * 例:<b>keys="command,SYSTEM_ID"</b> vals="NEW,GE" 591 * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 592 * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 593 * 594 * @param val names属性に対応する値 595 * @see #setKeys( String ) 596 */ 597 public void setVals( final String val ) { 598 vals = getCSVParameter( val ); 599 } 600 601 /** 602 * 【TAG】送信メソッドを指定します(GET/POST/SOAP)。 603 * 604 * @og.tag 605 * URLConnectTagのメソッドの初期設定はGETです。 606 * ここで"POST"(大文字)を指定するとkyes,valsの値セットをPOSTで送信します。 607 * (postKeyが設定されている場合はこの値に関係なくPOSTです) 608 * 609 * @og.rev 4.1.0.0 (2007/12/22) 新規作成 610 * 611 * @param post_get 送信メソッド(GET/POST/SOAP) 612 */ 613 public void setMethod ( final String post_get ) { 614 method = nval( getRequestParameter( post_get ), method ); 615 } 616 617 /** 618 * 【TAG】Basic認証で接続するユーザーにSYSTEMユーザーを使用するかどうか[true/false]を指定します(初期値:true)。 619 * 620 * @og.tag 621 * useSystemUser="true"(初期値) の場合、URL接続時のコネクションに、Basic認証を 622 * 使用しますが、その時のユーザーにシステムユーザー(SYSTEM)を使用します。 623 * useSystemUser="false"の場合は、authUserPass で指定したユーザー:パスワードを 624 * 使用します。authUserPass で、何も指定されなかった場合は、Basic認証を使用しません。 625 * 初期値は、true(SYSTEMユーザー認証する) です。 626 * 627 * @param flag [true:SYSTEMユーザー認証する/false:この接続のユーザーで認証する] 628 * @see #setAuthUserPass( String ) 629 */ 630 public void setUseSystemUser( final String flag ) { 631 useSystemUser = nval( getRequestParameter( flag ),useSystemUser ); 632 } 633 634 /** 635 * 【TAG】Basic認証を使用して接続する場合のユーザー:パスワードを指定します(初期値:null)。 636 * 637 * @og.tag 638 * 接続時のユーザーとパスワードを、USER:PASSWD 形式で指定します。 639 * useSystemUser="false"の場合は、ここで指定したユーザーとパスワードを使用します。 640 * その場合に、何も指定しない場合は、Basic認証を使用しません。 641 * 642 * @param userPass 接続のユーザーとパスワード(USER:PASSWD 形式) 643 * @see #setUseSystemUser( String ) 644 */ 645 public void setAuthUserPass( final String userPass ) { 646 authUserPass = nval( getRequestParameter( userPass ),authUserPass ); 647 } 648 649 /** 650 * 【TAG】接続の結果を表示する場合にXSLT変換する場合のファイルを指定します。 651 * 652 * @og.tag 653 * 654 * 接続先のデータが、XML形式の場合、そのままでは、画面出力できない場合が 655 * あります。通常は、HTML形式に変換しますが、その変換に、 XSL ファイルを 656 * 指定することが可能です。 657 * display="true" の場合や、saveFile を指定した場合に、適用されます。 658 * 659 * @param file 接続の結果を表示する場合にXSLT変換する場合のファイル 660 * @see #setSaveFile( String ) 661 * @see #setDisplay( String ) 662 */ 663 public void setXslFile( final String file ) { 664 xslFile = HybsSystem.url2dir( nval( getRequestParameter( file ),xslFile ) ); 665 } 666 667 /** 668 * 【TAG】接続の結果を表示するかどうかを指定します(初期値:false)。 669 * 670 * @og.tag 671 * true で、接続結果を表示します。 false では、何も表示しません(初期値:false) 672 * 接続結果を表示する使い方より、admin 画面に接続して、キャッシュクリアするような 673 * 使い方が多いと考え、初期値は、false になっています。 674 * xslFile が指定されている場合、XSLT変換して画面表示します。 675 * display="true" と、saveFile を併用することはできません。 676 * 677 * @param flag 接続の結果を表示するかどうか(初期値:false) 678 * @see #setSaveFile( String ) 679 * @see #setXslFile( String ) 680 */ 681 public void setDisplay( final String flag ) { 682 display = nval( getRequestParameter( flag ),display ); 683 684 if( display && saveFile != null ) { 685 String errMsg = "display=\"true\" と、saveFile を併用することはできません。"; 686 throw new HybsSystemException( errMsg ); 687 } 688 } 689 690 /** 691 * 【TAG】接続の結果をファイルに保存します。 692 * 693 * @og.tag 694 * 接続先のデータを受け取って、ファイルに保存します。その場合、 695 * xslFile が指定されている場合、XSLT変換してセーブします。 696 * display="true" と、saveFile を併用することはできません。 697 * 698 * @param file 接続の結果を表示する場合にXSLT変換する場合のファイル 699 * @see #setXslFile( String ) 700 * @see #setDisplay( String ) 701 */ 702 public void setSaveFile( final String file ) { 703 saveFile = HybsSystem.url2dir( nval( getRequestParameter( file ),saveFile ) ); 704 705 if( display ) { 706 String errMsg = "display=\"true\" と、saveFile を併用することはできません。"; 707 throw new HybsSystemException( errMsg ); 708 } 709 } 710 711 /** 712 * 【TAG】POST を使って、postFile属性のファイル内容を送信する時のキーを指定します。 713 * 714 * @og.tag 715 * 接続先にパラメータ(引数)を投げる場合に、POST を使用できます。 716 * そのときの キーをここで指定します。 717 * POSTするデータは、postFileで指定されたファイルか、BODY部に記述された文字列です。 718 * 719 * @param key POST を使って、postFile属性のファイル内容を送信する時のキー 720 * @see #setPostFile( String ) 721 */ 722 public void setPostKey( final String key ) { 723 postKey = nval( getRequestParameter( key ),postKey ); 724 } 725 726 /** 727 * 【TAG】POST を使って、postFile属性のファイル内容を送信します。 728 * 729 * @og.tag 730 * 接続先にパラメータ(引数)を投げる場合に、POST を使用できます。 731 * そのときの 送信データのファイルをここで指定します。 732 * postKey のみ指定されて、postFile が指定されない場合は、BODY部を送信します。 733 * SOAPによる呼び出しの場合は、ここ(BODY部での定義を含む)で、送信するXMLデータを 734 * 定義することができます。 735 * 736 * @param file 接続の結果を表示する場合にXSLT変換する場合のファイル 737 * @see #setPostKey( String ) 738 */ 739 public void setPostFile( final String file ) { 740 String postFile = nval( getRequestParameter( file ),null ); 741 742 if( postFile != null ) { 743 FileString fileStr = new FileString(); 744 fileStr.setFilename( HybsSystem.url2dir( postFile ) ); 745 postData = fileStr.getValue(); 746 } 747 } 748 749 /** 750 * 【TAG】接続タイムアウト時間を(秒)で指定します 751 * (初期値:URL_CONNECT_TIMEOUT[={@og.value org.opengion.hayabusa.common.SystemData#URL_CONNECT_TIMEOUT}])。 752 * 753 * @og.tag 754 * 実際には、java.net.URLConnection#setConnectTimeout(int) に 1000倍して設定されます。 755 * 0 は、無限のタイムアウト、マイナスは、設定しません。(つまりJavaの初期値のまま) 756 * (初期値:システム定数のURL_CONNECT_TIMEOUT[={@og.value org.opengion.hayabusa.common.SystemData#URL_CONNECT_TIMEOUT}])。 757 * 758 * @og.rev 5.8.1.1 (2015/06/12) timeout属性追加 759 * 760 * @param tout タイムアウト時間(秒) (ゼロは、無制限) 761 * @see org.opengion.fukurou.util.URLConnect#setTimeout(int) 762 * @see java.net.URLConnection#setConnectTimeout(int) 763 */ 764 public void setTimeout( final String tout ) { 765 timeout = nval( getRequestParameter( tout ),timeout ); 766 } 767 768 /** 769 * 【TAG】(通常は使いません) 接続エラーを無視する場合にtrueとします(初期値false)。 770 * 771 * @og.tag 772 * trueにするとConnectで発生したエラーを投げずに処理を続行します。 773 * (標準エラー出力にエラー内容は出力されます) 774 * 接続エラーが発生しても処理を中断したくない場合に設定します。 775 * 776 * @og.rev 4.1.1.0 (2008/01/22) 新規追加 777 * 778 * @param flag エラーを無視する場合にtrue 779 */ 780 public void setErrNeglect( final String flag ) { 781 errNglctFlag = nval( getRequestParameter( flag ), errNglctFlag ); 782 } 783 784 /** 785 * 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。 786 * 787 * @og.tag 788 * SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。 789 * この名前空間は、通常WSDLファイルのdescriptionsタグのtargetNamespace属性の値により 790 * 定義されます。 791 * 792 * @og.rev 5.1.5.0 (2010/04/01) 新規追加 793 * 794 * @param ns 名前空間 795 */ 796 public void setSoapNameSpace( final String ns ) { 797 soapNameSpace = nval( getRequestParameter( ns ), soapNameSpace ); 798 } 799 800 /** 801 * 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名を指定します。 802 * 803 * @og.tag 804 * SOAPによるWebサービスの呼び出しで、メソッド名を指定します。 805 * WSDLファイルで定義されるoperationタグのname属性の値に相当します。 806 * 807 * @og.rev 5.1.5.0 (2010/04/01) 新規追加 808 * 809 * @param method メソッド名 810 */ 811 public void setSoapMethodName( final String method ) { 812 soapMethodName = nval( getRequestParameter( method ), soapMethodName ); 813 } 814 815 /** 816 * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 817 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 818 * 819 * @og.tag 820 * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 821 * 渡す場合に、通常は、session を利用します。その場合の登録キーです。 822 * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 823 * この tableId 属性を利用して、メモリ空間を分けます。 824 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 825 * 826 * @param id sessionに登録する時の ID 827 */ 828 public void setTableId( final String id ) { 829 tableId = nval( getRequestParameter( id ),tableId ); 830 } 831 832 /** 833 * 【TAG】結果のXMLをDBTableModelに変換する際に、行のキーとなるタグ名を指定します。 834 * 835 * @og.tag 836 * 結果のXMLを表形式に変換する際に、行のキーとなるタグ名を指定します。 837 * このキーのタグを基点として、colKeysで指定されたタグの値を各項目の値として取り込みます。 838 * (詳細は、colKeysのタグリブ属性マニュアルを参照して下さい。) 839 * 840 * @param key 行のキーとなるタグ名 841 * @see #setColKeys( String ) 842 */ 843 public void setRowKey( final String key ) { 844 rowKey = nval( getRequestParameter( key ),rowKey ); 845 } 846 847 /** 848 * 【TAG】結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します。 849 * 850 * @og.tag 851 * 結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します。 852 * rowKeyで行を、colKeysで項目を表現し、rowKeyのタグで囲われた固まりを1つの行とみなします。 853 * このため、colKeysに指定されたキーのタグでも、rowKeyの外にある場合は、取り込み対象となりません。 854 * 855 * また、キーにPARENT_TAG、PARENT_FULL_TAGを指定することで、rowKeyで指定されたタグの 856 * 直近の親タグ、及びフルの親タグ名(親タグの階層を">[タグA]>[タグB]>[タグC]>"で表現)を 857 * 取得することができます。 858 * 859 * @param keys 項目のキーとなるタグ名の一覧 860 */ 861 public void setColKeys( final String keys ) { 862 colKeys = StringUtil.csv2Array( getRequestParameter( keys ) ); 863 } 864 865 /** 866 * 【TAG】結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します。 867 * 868 * @og.tag 869 * 結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します。 870 * ここで指定されたキーのタグの値を取り出し、{@XX}形式(Attributes)として処理できるようにします。 871 * 872 * @param keys パラメーター(Attributes)のキーとなるタグ名の一覧 873 */ 874 public void setRtnKeys( final String keys ) { 875 rtnKeys = StringUtil.csv2Array( getRequestParameter( keys ) ); 876 } 877 878 /** 879 * 【TAG】データの入出力のエンコードを指定します。 880 * 881 * @og.tag 882 * データの入出力のエンコードを指定します。 883 * 初期値は、"UTF-8"です。 884 * 885 * @og.rev 5.1.6.0 (2010/05/01) 新規作成 886 * @param enc エンコード 887 */ 888 public void setEncode( final String enc ) { 889 encode = nval( getRequestParameter( enc ), encode ); 890 } 891 892 /** 893 * タグの名称を、返します。 894 * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。 895 * 896 * @og.rev 4.0.0.0 (2005/01/31) 新規追加 897 * 898 * @return タグの名称 899 */ 900 @Override 901 protected String getTagName() { 902 return "urlConnect" ; 903 } 904 905 /** 906 * 【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)。 907 * 908 * @og.tag 909 * (通常使いません)タグで処理される処理が、メインとなるトランザクション処理かどうかを指定します。(初期値:false) 910 * この値は、ファイルダウンロード処理に影響します。この値がtrueに指定された時にcommitされたDBTableModelが 911 * ファイルダウンロードの対象の表になります。 912 * 913 * このパラメーターは、通常、各タグにより実装され、ユーザーが指定する必要はありません。 914 * 但し、1つのJSP内でDBTableModelが複数生成される場合に、前に処理したDBTableModelについてファイルダウンロードをさせたい 915 * 場合は、後ろでDBTableModelを生成するタグで、明示的にこの値をfalseに指定することで、ファイルダウンロード処理の対象から 916 * 除外することができます。 917 * 918 * @og.rev 5.1.6.0 (2010/05/01) 新規作成 919 * 920 * @param flag メイントランザクションかどうか 921 */ 922 public void setMainTrans( final String flag ) { 923 isMainTrans = nval( getRequestParameter( flag ),isMainTrans ); 924 } 925 926 /** 927 * 【TAG】保存先ストレージタイプを設定します。 928 * 929 * @og.tag 930 * ファイルを読み取り元の、ストレージタイプを設定します。 931 * 未設定の場合は、システムリソースの「CLOUD_TARGET」が参照されます。 932 * 自身のサーバを指定する場合は、「default」を設定してください。 933 * 934 * @og.rev 5.10.9.0 (2019/03/01) 新規追加 935 * 936 * @param storage 保存先ストレージタイプ 937 */ 938 public void setStorageType( final String storage ) { 939 storageType = nval( getRequestParameter( storage ), storageType ); 940 } 941 942 /** 943 * 【TAG】保存先バケット名を設定します。 944 * 945 * @og.tag 946 * ファイルを読み取り元の、バケット名を指定します。 947 * クラウドストレージ利用時のみ有効です。 948 * 未設定の場合は、システムリソースの「CLOUD_BUKET」が参照されます。 949 * 950 * @og.rev 5.10.9.0 (2019/03/01) 新規追加 951 * 952 * @param bucket 保存先バケット名 953 */ 954 public void setBucketName( final String bucket ) { 955 bucketName = nval( getRequestParameter( bucket ), bucketName ); 956 } 957 958 /** 959 * このオブジェクトの文字列表現を返します。 960 * 基本的にデバッグ目的に使用します。 961 * 962 * @og.rev 5.10.9.0 (2019/03/01) storageType,bucketNameを出力対象に追加。 963 * 964 * @return このクラスの文字列表現 965 */ 966 @Override 967 public String toString() { 968 return org.opengion.fukurou.util.ToString.title( this.getClass().getName() ) 969 .println( "VERSION" ,VERSION ) 970 .println( "method" ,method ) 971 .println( "urlStr" ,urlStr ) 972 .println( "keys" ,StringUtil.array2csv( keys ) ) 973 .println( "vals" ,StringUtil.array2csv( vals ) ) 974 .println( "proxyHost" ,proxyHost ) 975 .println( "proxyPort" ,proxyPort ) 976 .println( "timeout" ,timeout ) // 5.8.1.1 (2015/06/12) 新規追加 977 .println( "useSystemUser" ,useSystemUser ) 978 .println( "authUserPass" ,authUserPass ) 979 .println( "display" ,display ) 980 .println( "postData" ,postData ) 981 .println( "xslFile" ,xslFile ) 982 .println( "saveFile" ,saveFile ) 983 .println( "errNglctFlag" ,errNglctFlag ) 984 .println( "soapNameSpace" ,soapNameSpace ) 985 .println( "soapMethodName" ,soapMethodName ) 986 .println( "tableId" ,tableId ) 987 .println( "rowKey" ,rowKey ) 988 .println( "colKeys" ,StringUtil.array2csv( colKeys ) ) 989 .println( "rtnKeys" ,StringUtil.array2csv( rtnKeys ) ) 990 .println( "storageType" ,storageType ) 991 .println( "bucketName" ,bucketName ) 992 .println( "Other..." ,getAttributes().getAttribute() ) 993 .fixForm().toString() ; 994 } 995}