org.opengion.hayabusa.taglib

## クラス URLConnectTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.URLConnectTag

- すべての実装されたインタフェース:
    Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

      public class URLConnectTag
      extends CommonTagSupport

  指定のURLに接続します。 エンジンでは、URL にアクセスすることで、デーモンを起動したり、 コマンドを実行(adminメニュー)することが出来ます。 もちろん、検索条件を指定して、結果を取得することも可能です。 このタグでは、URLにアクセスして、コマンドを実行したり結果を取得できます。 さらに、ファイルを POST で転送したり、処理結果を XSLT変換したり出来ます。
  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：
             <og:urlConnect
                 url           = "http://･･･ "    必須
                 proxyHost     = "proxy.opengion.org"
                 proxyPort     = "8080"
                 timeout       = "1"
                 keys          = "command,SYSTEM_ID"
                 vals          = "NEW,GE"
                 useSystemUser = "true/false"     初期値:true
                 authUserPass  = "admin:******"   初期値:admin:******
                 display       = "false/true"     初期値:false
                 xslFile       = "filter.xsl"
                 saveFile      = "outdata.xml"
                 soapNameSpace = "MyWebService"
                 soapMethodName= "test"
                 tableId       = "DEFAULT"
                 rowKey        = "item"
                 colKeys       = "person_id,person_name"
                 rtnKeys       = "version,summary"
                 encode        = "UTF-8"
             />

         url           : 接続するURLを指定します。必須属性です。
         proxyHost     : proxy が存在する場合は、そのホスト名(例：proxy.opengion.org)
         proxyPort     : proxy が存在する場合は、そのポート番号(例：8080)
         timeout       : 通信リンクのオープン時に、指定された秒単位のタイム・アウト値を使用(例：10)
         keys,vals     : URLの指定時に、パラメータ(引数)を追加します。URLに含めても構いません。
                       : SOAPによる呼び出しの場合の詳細については、keysの属性定義を参照して下さい。
         postKey       : POST を使って、postFile属性のファイル内容を送信する時のキーです。
         postFile      : POST を使って、postFile属性のファイル内容を送信します。
                         postFile を指定せず、postKey のみ指定して、BODY部に何か書き込めば、
                         そのBODY部の文字列を POSTの内容として送信します。
         authUserPass  : Basic認証を使用する場合の接続ユーザー：パスワードを指定します。
                         接続時のユーザーとパスワードを、USER:PASSWD 形式 で指定します。
                         useSystemUser="false" で何も指定しない場合は、Basic認証を使用しません。
         useSystemUser : Basic認証の接続ユーザー：パスワードに、システムユーザーを使用
                         するかどうかを指定します(初期値:true)。
                         true の場合は、SYSTEM:***** を使用します。
         xslFile       : 接続先データを取得し、そのデータを XSLT変換する場合のXSLファイルを指定します。
         display       : 接続した結果のレスポンスを画面に表示するかどうかを指定します(初期値:false)。
                         エンジンの場合、コマンドを投げるだけであれば、結果を取得する必要は
                         ありません。イメージ的には、取得データが、このタグの位置に置き換わります。
                         xslFile が指定されている場合、XSLT変換してセーブします。
         saveFile      : 接続先データを取得した結果を、ファイル出力します。
                         display="true" と、saveFile を併用することはできません。
                         xslFile が指定されている場合、XSLT変換してセーブします。
         soapNameSpace : SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。
                         この名前空間は、通常WSDLファイルのdescriptionsタグのtargetNamespace属性の値により
                         定義されます。
         soapMethodName: SOAPによるWebサービスの呼び出しで、メソッド名を指定します。
                         WSDLファイルで定義されるoperationタグのname属性の値に相当します。
         tableId       : 結果のXMLファイルをDBTableModelに変換した際に、登録するTableIdを指定します。
         rowKey        : XMLをDBTableModelに変換する際の、行を表すタグキーを指定します。
         colKeys       : XMLをDBTableModelに変換する際の、項目を表すタグキーの一覧を指定します。
                         キーにPARENT_TAG、PARENT_FULL_TAGを指定することで、rowKeyで指定されたタグの
                         直近の親タグ、及びフルの親タグ名(親タグの階層を">[タグA]>[タグB]>[タグC]>"で表現)を
                         取得することができます。
         rtnKeys       : XMLのタグキーを指定して値を取り出します。取り出した値は、{@XX}形式で処理することが可能です。
         encode        : データの入出力を行うエンコードを指定します。

         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
                 POSTデータを記述します。

         ●Tag定義：
           <og:urlConnect
               url              ○【TAG】アクセスする ＵＲＬ を指定します(必須)(必須)。
               proxyHost          【TAG】プロキシ経由で接続する場合の、プロキシホスト名を指定します
               proxyPort          【TAG】プロキシ経由で接続する場合の、プロキシポート番号を指定します
               timeout            【TAG】通信リンクのオープン時に、指定された秒単位のタイム・アウト値を使用
                                          (初期値:URL_CONNECT_TIMEOUT[={@og.value org.opengion.hayabusa.common.SystemData#URL_CONNECT_TIMEOUT}])。)
               keys               【TAG】アクセスパラメータキーをCSV形式で複数指定します
               vals               【TAG】keys属性に対応する値をCSV形式で複数指定します
               useSystemUser      【TAG】Basic認証で接続するユーザーにSYSTEMユーザーを使用するかどうか[true/false]を指定します(初期値:true)
               authUserPass       【TAG】Basic認証を使用して接続する場合のユーザー:パスワードを指定します(初期値:null)
               display            【TAG】接続の結果を表示するかどうかを指定します(初期値:false)
               xslFile            【TAG】接続の結果を表示する場合にXSLT変換する場合のファイルを指定します
               saveFile           【TAG】接続の結果をファイルに保存します
               postKey            【TAG】POST を使って、postFile属性のファイル内容を送信する時のキーを指定します
               postFile           【TAG】POST を使って、postFile属性のファイル内容を送信します
               method             【TAG】送信メソッドを指定します(GET/POST/SOAP)
               errNeglect         【TAG】(通常は使いません) 接続エラーを無視する場合にtrueとします(初期値false)
               soapNameSpace      【TAG】SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します
               soapMethodName     【TAG】SOAPによるWebサービスの呼び出しで、メソッド名を指定します
               tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
               scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
               rowKey             【TAG】結果のXMLをDBTableModelに変換する際に、行のキーとなるタグ名を指定します
               colKeys            【TAG】結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します
               rtnKeys            【TAG】結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します
               encode             【TAG】データの入出力のエンコードを指定します
               mainTrans          【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)
               caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
               caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
               caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20)
               caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:true) 5.7.7.2 (2014/06/20)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           >   ... Body ...
           </og:urlConnect>

         ●例：
         アドミン関連
         http://localhost:8823/gf/jsp/admin?COMMAND=infomation     [状況表示]
         http://localhost:8823/gf/jsp/admin?COMMAND=close          [プール削除]
         http://localhost:8823/gf/jsp/admin?COMMAND=loginUser      [ログインユーザー]
         http://localhost:8823/gf/jsp/admin?COMMAND=システムパラメータ [システムパラメータ]

         帳票デーモン
         http://localhost:8823/gf/jsp/REP08/result.jsp?cmd=SET&period=5000&command=NEW&timerTask=org.opengion.hayabusa.report.ReportDaemon&name=ReportDaemon  デーモン起動
         http://localhost:8823/gf/jsp/REP08/result.jsp?cmd=CANCEL&period=5000&command=NEW&timerTask=org.opengion.hayabusa.report.ReportDaemon&name=ReportDaemon  デーモン停止

        Tomcat Manager 画面
         http://localhost:8823/manager/reload?path=/ver4 アプリケーションを再ロード

  変更履歴:

    3.6.0.0 (2004/09/17) 新規作成
    4.1.0.0 (2007/12/22) POSTメソッドで複数キーを登録できるように属性追加
    5.1.5.0 (2010/04/01) SOAP対応

  機能分類
    その他部品
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドの概要

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `URLConnectTag()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected String` | `getTagName()` タグの名称を、返します。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setAuthUserPass(String userPass)` 【TAG】Basic認証を使用して接続する場合のユーザー:パスワードを指定します(初期値:null)。
    `void` | `setColKeys(String keys)` 【TAG】結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します。
    `void` | `setDisplay(String flag)` 【TAG】接続の結果を表示するかどうかを指定します(初期値:false)。
    `void` | `setEncode(String enc)` 【TAG】データの入出力のエンコードを指定します。
    `void` | `setErrNeglect(String flag)` 【TAG】(通常は使いません) 接続エラーを無視する場合にtrueとします(初期値false)。
    `void` | `setKeys(String key)` 【TAG】アクセスパラメータキーをCSV形式で複数指定します。
    `void` | `setMainTrans(String flag)` 【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)。
    `void` | `setMethod(String post_get)` 【TAG】送信メソッドを指定します(GET/POST/SOAP)。
    `void` | `setPostFile(String file)` 【TAG】POST を使って、postFile属性のファイル内容を送信します。
    `void` | `setPostKey(String key)` 【TAG】POST を使って、postFile属性のファイル内容を送信する時のキーを指定します。
    `void` | `setProxyHost(String host)` 【TAG】プロキシ経由で接続する場合の、プロキシホスト名を指定します。
    `void` | `setProxyPort(String port)` 【TAG】プロキシ経由で接続する場合の、プロキシポート番号を指定します。
    `void` | `setRowKey(String key)` 【TAG】結果のXMLをDBTableModelに変換する際に、行のキーとなるタグ名を指定します。
    `void` | `setRtnKeys(String keys)` 【TAG】結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します。
    `void` | `setSaveFile(String file)` 【TAG】接続の結果をファイルに保存します。
    `void` | `setSoapMethodName(String method)` 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名を指定します。
    `void` | `setSoapNameSpace(String ns)` 【TAG】SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。
    `void` | `setTableId(String id)` 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=h_tblmdl])。
    `void` | `setTimeout(String tout)` 【TAG】接続タイムアウト時間を(秒)で指定します (初期値:URL_CONNECT_TIMEOUT[=1])。
    `void` | `setUrl(String url)` 【TAG】アクセスする ＵＲＬ を指定します(必須)。
    `void` | `setUseSystemUser(String flag)` 【TAG】Basic認証で接続するユーザーにSYSTEMユーザーを使用するかどうか[true/false]を指定します(初期値:true)。
    `void` | `setVals(String val)` 【TAG】keys属性に対応する値をCSV形式で複数指定します。
    `void` | `setXslFile(String file)` 【TAG】接続の結果を表示する場合にXSLT変換する場合のファイルを指定します。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

      `add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.BodyTagSupport

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### インタフェースから継承されたメソッド javax.servlet.jsp.tagext.Tag

      `getParent, setPageContext, setParent`

- - ### コンストラクタの詳細

    - #### URLConnectTag

          public URLConnectTag()

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        5.1.5.0 (2010/04/01) SOAP・DBTableModel出力対応
        5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
        5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加

    - #### doAfterBody

          public int doAfterBody()

      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
        `doAfterBody` インタフェース内 `IterationTag`
      オーバーライド:
        `doAfterBody` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示(SKIP_BODY)

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        4.0.1.0 (2007/12/12) PostKeys,PostVals処理を追加
        5.1.5.0 (2010/04/01) SOAP・DBTableModel出力対応
        5.2.0.0 (2010/09/01) エラー処理でNullPointerExceptionが発生するバグを修正
        5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`
      変更履歴:

        5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
        5.8.1.1 (2015/06/12) timeout追加

    - #### setUrl

          public void setUrl(String url)

      【TAG】アクセスする ＵＲＬ を指定します(必須)。
      パラメータ:
        `url` - アクセスする ＵＲＬ
      説明:

             接続するＵＲＬを指定します。(例：http:// ･･････)
             ?以降のパラメータが含まれていても構いません。
             このURL に、keys,vals で指定されたパラメータも追加されます。

    - #### setProxyHost

          public void setProxyHost(String host)

      【TAG】プロキシ経由で接続する場合の、プロキシホスト名を指定します。
      パラメータ:
        `host` - プロキシホスト名
      説明:

             接続先が、プロキシ経由の場合、プロキシのホスト名を指定します。
             例：proxy.opengion.org

    - #### setProxyPort

          public void setProxyPort(String port)

      【TAG】プロキシ経由で接続する場合の、プロキシポート番号を指定します。
      パラメータ:
        `port` - プロキシポート番号
      説明:

             接続先が、プロキシ経由の場合、プロキシのポート番号を指定します。
             例：8080

    - #### setKeys

          public void setKeys(String key)

      【TAG】アクセスパラメータキーをCSV形式で複数指定します。
      パラメータ:
        `key` - リンク先に渡すキー
      関連項目:
        `setVals( String )`
      説明:

             アクセスする ＵＲＬに追加するパラメータのキーを指定します。
             カンマ区切りで複数指定できます。
             vals 属性には、キーに対応する値を、設定してください。
             例:keys="command,SYSTEM_ID" vals="NEW,GE"
             分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
             こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

             [SOAP対応]
             SOAPによるWebサービスの呼び出しの場合、keys,valsに指定された値より、env:Envelopタグを
             rootタグとするXMLデータを生成します。
             (BODY部分に直接XMLデータを出力することも可能です。)
             この際、項目名に'>'を含めることで、階層的なXMLデータを表現することができます。
             例)
               [属性定義]
               keys="param0>AAA,param0>BBB,param1>CCC,DDD"
               vals="v1,v2,v3,v4"
               [XMLデータ(※データ部のみ)]
               <param0>
                 <AAA>v1</AAA>
                 <BBB>v2</BBB>
               </param0>
               <param1>
                 <CCC>v3</CCC>
               </param1>
               <DDD>v4</DDD>
             項目の値を"null"とすることで、XMLで言うところの「xsi:nil=\"true\"」のデータを表現すること
             もできます。
             また、キー名の先頭を'@'にすることで、項目名に名前空間のPREFIXを付加することができます。
             一般的には、JavaやRubyで実装されたWebサービスを呼び出しする場合は、必要ありませんが、
             .NETで実装されたWebサービスを呼び出しする場合は、各項目にPREFIXを付与しないと、正しく
             パラメーターを渡すことができません。
             ※現時点では、keysの階層定義は、2階層まで対応しています。
               3階層以上のXML構造を定義する場合は、postFile属性によるファイル指定又は、Body部分で直接
               XMLデータを記述して下さい。

    - #### setVals

          public void setVals(String val)

      【TAG】keys属性に対応する値をCSV形式で複数指定します。
      パラメータ:
        `val` - names属性に対応する値
      関連項目:
        `setKeys( String )`
      説明:

             キーに設定した値を、カンマ区切り文字で複数して出来ます。
             指定順序は、キーと同じにしておいて下さい。
             例:keys="command,SYSTEM_ID" vals="NEW,GE"
             分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
             こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

    - #### setMethod

          public void setMethod(String post_get)

      【TAG】送信メソッドを指定します(GET/POST/SOAP)。
      パラメータ:
        `post_get` - 送信メソッド(GET/POST/SOAP)
      説明:

             URLConnectTagのメソッドの初期設定はGETです。
             ここで"POST"(大文字)を指定するとkyes,valsの値セットをPOSTで送信します。
             (postKeyが設定されている場合はこの値に関係なくPOSTです)

      変更履歴:

        4.1.0.0 (2007/12/22) 新規作成

    - #### setUseSystemUser

          public void setUseSystemUser(String flag)

      【TAG】Basic認証で接続するユーザーにSYSTEMユーザーを使用するかどうか[true/false]を指定します(初期値:true)。
      パラメータ:
        `flag` - [true:SYSTEMユーザー認証する/false:この接続のユーザーで認証する]
      関連項目:
        `setAuthUserPass( String )`
      説明:

             useSystemUser="true"(初期値) の場合、URL接続時のコネクションに、Basic認証を
             使用しますが、その時のユーザーにシステムユーザー(SYSTEM)を使用します。
             useSystemUser="false"の場合は、authUserPass で指定したユーザー：パスワードを
             使用します。authUserPass で、何も指定されなかった場合は、Basic認証を使用しません。
             初期値は、true(SYSTEMユーザー認証する) です。

    - #### setAuthUserPass

          public void setAuthUserPass(String userPass)

      【TAG】Basic認証を使用して接続する場合のユーザー:パスワードを指定します(初期値:null)。
      パラメータ:
        `userPass` - 接続のユーザーとパスワード(USER:PASSWD 形式)
      関連項目:
        `setUseSystemUser( String )`
      説明:

             接続時のユーザーとパスワードを、USER:PASSWD 形式で指定します。
             useSystemUser="false"の場合は、ここで指定したユーザーとパスワードを使用します。
             その場合に、何も指定しない場合は、Basic認証を使用しません。

    - #### setXslFile

          public void setXslFile(String file)

      【TAG】接続の結果を表示する場合にXSLT変換する場合のファイルを指定します。
      パラメータ:
        `file` - 接続の結果を表示する場合にXSLT変換する場合のファイル
      関連項目:
        `setSaveFile( String )`, `setDisplay( String )`
      説明:

             接続先のデータが、XML形式の場合、そのままでは、画面出力できない場合が
             あります。通常は、HTML形式に変換しますが、その変換に、 XSL ファイルを
             指定することが可能です。
             display="true" の場合や、saveFile を指定した場合に、適用されます。

    - #### setDisplay

          public void setDisplay(String flag)

      【TAG】接続の結果を表示するかどうかを指定します(初期値:false)。
      パラメータ:
        `flag` - 接続の結果を表示するかどうか(初期値:false)
      関連項目:
        `setSaveFile( String )`, `setXslFile( String )`
      説明:

             true で、接続結果を表示します。 false では、何も表示しません(初期値:false)
             接続結果を表示する使い方より、admin 画面に接続して、キャッシュクリアするような
             使い方が多いと考え、初期値は、false になっています。
             xslFile が指定されている場合、XSLT変換して画面表示します。
             display="true" と、saveFile を併用することはできません。

    - #### setSaveFile

          public void setSaveFile(String file)

      【TAG】接続の結果をファイルに保存します。
      パラメータ:
        `file` - 接続の結果を表示する場合にXSLT変換する場合のファイル
      関連項目:
        `setXslFile( String )`, `setDisplay( String )`
      説明:

             接続先のデータを受け取って、ファイルに保存します。その場合、
             xslFile が指定されている場合、XSLT変換してセーブします。
             display="true" と、saveFile を併用することはできません。

    - #### setPostKey

          public void setPostKey(String key)

      【TAG】POST を使って、postFile属性のファイル内容を送信する時のキーを指定します。
      パラメータ:
        `key` - POST を使って、postFile属性のファイル内容を送信する時のキー
      関連項目:
        `setPostFile( String )`
      説明:

             接続先にパラメータ(引数)を投げる場合に、POST を使用できます。
             そのときの キーをここで指定します。
             POSTするデータは、postFileで指定されたファイルか、BODY部に記述された文字列です。

    - #### setPostFile

          public void setPostFile(String file)

      【TAG】POST を使って、postFile属性のファイル内容を送信します。
      パラメータ:
        `file` - 接続の結果を表示する場合にXSLT変換する場合のファイル
      関連項目:
        `setPostKey( String )`
      説明:

             接続先にパラメータ(引数)を投げる場合に、POST を使用できます。
             そのときの 送信データのファイルをここで指定します。
             postKey のみ指定されて、postFile が指定されない場合は、BODY部を送信します。
             SOAPによる呼び出しの場合は、ここ(BODY部での定義を含む)で、送信するXMLデータを
             定義することができます。

    - #### setTimeout

          public void setTimeout(String tout)

      【TAG】接続タイムアウト時間を(秒)で指定します (初期値:URL_CONNECT_TIMEOUT[=1])。
      パラメータ:
        `tout` - タイムアウト時間(秒) (ゼロは、無制限)
      関連項目:
        `URLConnect.setTimeout(int)`, `URLConnection.setConnectTimeout(int)`
      説明:

             実際には、java.net.URLConnection#setConnectTimeout(int) に 1000倍して設定されます。
             0 は、無限のタイムアウト、マイナスは、設定しません。(つまりJavaの初期値のまま)
             (初期値:システム定数のURL_CONNECT_TIMEOUT[={@og.value org.opengion.hayabusa.common.SystemData#URL_CONNECT_TIMEOUT}])。

      変更履歴:

        5.8.1.1 (2015/06/12) timeout属性追加

    - #### setErrNeglect

          public void setErrNeglect(String flag)

      【TAG】(通常は使いません) 接続エラーを無視する場合にtrueとします(初期値false)。
      パラメータ:
        `flag` - エラーを無視する場合にtrue
      説明:

             trueにするとConnectで発生したエラーを投げずに処理を続行します。
             (標準エラー出力にエラー内容は出力されます)
             接続エラーが発生しても処理を中断したくない場合に設定します。

      変更履歴:

        4.1.1.0 (2008/01/22) 新規追加

    - #### setSoapNameSpace

          public void setSoapNameSpace(String ns)

      【TAG】SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。
      パラメータ:
        `ns` - 名前空間
      説明:

             SOAPによるWebサービスの呼び出しで、メソッド名及びパラメーターの名前空間を指定します。
             この名前空間は、通常WSDLファイルのdescriptionsタグのtargetNamespace属性の値により
             定義されます。

      変更履歴:

        5.1.5.0 (2010/04/01) 新規追加

    - #### setSoapMethodName

          public void setSoapMethodName(String method)

      【TAG】SOAPによるWebサービスの呼び出しで、メソッド名を指定します。
      パラメータ:
        `method` - メソッド名
      説明:

             SOAPによるWebサービスの呼び出しで、メソッド名を指定します。
             WSDLファイルで定義されるoperationタグのname属性の値に相当します。

      変更履歴:

        5.1.5.0 (2010/04/01) 新規追加

    - #### setTableId

          public void setTableId(String id)

      【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=h_tblmdl])。
      パラメータ:
        `id` - sessionに登録する時の ID
      説明:

             検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
             渡す場合に、通常は、session を利用します。その場合の登録キーです。
             query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
             この tableId 属性を利用して、メモリ空間を分けます。
            		(初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。

    - #### setRowKey

          public void setRowKey(String key)

      【TAG】結果のXMLをDBTableModelに変換する際に、行のキーとなるタグ名を指定します。
      パラメータ:
        `key` - 行のキーとなるタグ名
      関連項目:
        `setColKeys( String )`
      説明:

             結果のXMLを表形式に変換する際に、行のキーとなるタグ名を指定します。
             このキーのタグを基点として、colKeysで指定されたタグの値を各項目の値として取り込みます。
             (詳細は、colKeysのタグリブ属性マニュアルを参照して下さい。)

    - #### setColKeys

          public void setColKeys(String keys)

      【TAG】結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します。
      パラメータ:
        `keys` - 項目のキーとなるタグ名の一覧
      説明:

             結果のXMLをDBTableModelに変換する際に、項目のキーとなるタグ名の一覧を指定します。
             rowKeyで行を、colKeysで項目を表現し、rowKeyのタグで囲われた固まりを1つの行とみなします。
             このため、colKeysに指定されたキーのタグでも、rowKeyの外にある場合は、取り込み対象となりません。

             また、キーにPARENT_TAG、PARENT_FULL_TAGを指定することで、rowKeyで指定されたタグの
             直近の親タグ、及びフルの親タグ名(親タグの階層を">[タグA]>[タグB]>[タグC]>"で表現)を
             取得することができます。

    - #### setRtnKeys

          public void setRtnKeys(String keys)

      【TAG】結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します。
      パラメータ:
        `keys` - パラメーター(Attributes)のキーとなるタグ名の一覧
      説明:

             結果のXMLを変換する際に、パラメータ(Attributes)として取り込むキーの一覧を指定します。
             ここで指定されたキーのタグの値を取り出し、{@XX}形式(Attributes)として処理できるようにします。

    - #### setEncode

          public void setEncode(String enc)

      【TAG】データの入出力のエンコードを指定します。
      パラメータ:
        `enc` - エンコード
      説明:

             データの入出力のエンコードを指定します。
             初期値は、"UTF-8"です。

      変更履歴:

        5.1.6.0 (2010/05/01) 新規作成

    - #### getTagName

          protected String getTagName()

      タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
      オーバーライド:
        `getTagName` クラス内 `CommonTagSupport`
      戻り値:
        タグの名称
      関連項目:
        `CommonTagSupport.getDocumentLink()`
      変更履歴:

        4.0.0.0 (2005/01/31) 新規追加

    - #### setMainTrans

          public void setMainTrans(String flag)

      【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)。
      パラメータ:
        `flag` - メイントランザクションかどうか
      説明:

             (通常使いません)タグで処理される処理が、メインとなるトランザクション処理かどうかを指定します。(初期値:false)
             この値は、ファイルダウンロード処理に影響します。この値がtrueに指定された時にcommitされたDBTableModelが
             ファイルダウンロードの対象の表になります。

             このパラメーターは、通常、各タグにより実装され、ユーザーが指定する必要はありません。
             但し、1つのJSP内でDBTableModelが複数生成される場合に、前に処理したDBTableModelについてファイルダウンロードをさせたい
             場合は、後ろでDBTableModelを生成するタグで、明示的にこの値をfalseに指定することで、ファイルダウンロード処理の対象から
             除外することができます。

      変更履歴:

        5.1.6.0 (2010/05/01) 新規作成

    - #### toString

          public String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.