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