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