org.opengion.hayabusa.taglib

## クラス ResponseHeaderTag

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

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

      public class ResponseHeaderTag
      extends CommonTagSupport

       レスポンスヘッダー情報をセットするタグです。

       レスポンスヘッダーには、キャッシュコントロールやリフレッシュ(ページ自動転送)などを行う
       ヘッダー情報をセットすることで、HTML の振る舞いを制御することができます。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:responseHeader cacheKey="[･･･]" />
         ●body：なし

         ●Tag定義：
           <og:responseHeader
               cacheControl       【TAG】レスポンスヘッダ に、Cache-Control の値を設定します(初期値:"max-age=0")
               contentType        【TAG】レスポンスヘッダ に、content-Type の値を設定します
               refresh            【TAG】レスポンスヘッダ に、refresh の値を設定します
               refreshURL         【TAG】レスポンスヘッダ に、refresh の値を設定するときに、指定のURLをロードします
               redirect           【TAG】指定されたURLへ一時的なリダイレクトレスポンスを送信します
               status             【TAG】ステータスコードを設定します
               location           【TAG】レスポンスヘッダ に、location の値を設定します
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例

  変更履歴:

    3.1.3.0 (2003/04/10) ResponseHeaderTag を 新規作成しました。

  機能分類
    画面制御
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド 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`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `ResponseHeaderTag()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setCacheControl(String cc)` 【TAG】レスポンスヘッダ に、Cache-Control の値を設定します(初期値:"max-age=0")。
    `void` | `setContentType(String ct)` 【TAG】レスポンスヘッダ に、content-Type の値を設定します。
    `void` | `setLocation(String lo)` 【TAG】レスポンスヘッダ に、location の値を設定します。
    `void` | `setRedirect(String rd)` 【TAG】指定されたURLへ一時的なリダイレクトレスポンスを送信します。
    `void` | `setRefresh(String ref)` 【TAG】レスポンスヘッダ に、refresh の値を設定します。
    `void` | `setRefreshURL(String refurl)` 【TAG】レスポンスヘッダ に、refresh の値を設定するときに、指定のURLをロードします。
    `void` | `setStatus(String st)` 【TAG】ステータスコードを設定します。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, 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`

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

    - #### ResponseHeaderTag

          public ResponseHeaderTag()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doEndTag

          public int doEndTag()

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

        3.1.9.0 (2003/05/16) refresh 属性を設定した場合は、ページの残りを処理しないように変更。

    - #### release2

          protected void release2()

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

    - #### setCacheControl

          public void setCacheControl(String cc)

      【TAG】レスポンスヘッダ に、Cache-Control の値を設定します(初期値:"max-age=0")。
      パラメータ:
        `cc` - Cache-Control
      説明:

             このヘッダは、クライアントに対してドキュメントをキャッシュする場合の
             条件を伝えます。初期値は、max-age=0 に設定しています。
             指定する値は、以下のどれかです。

             public        : ドキュメントをキャッシュして良い
             private       : ドキュメントが共有されないプライベートの中なら、キャッシュして良い。
             no-cache      : ドキュメントをキャッシュしてはいけない。
             no-store      : ドキュメントのキャッシュや、ディスク上の一時ファイルも禁止する。
             must-revalidate
                           : クライアントは、ドキュメントをプロキシではなく、本来の
                             サーバーに確認する必要がある。
             proxy-revalidate
                           : must-revalidate と同じであるが、共有キャッシュに対してのみ
                             適用される。
             max-age=xxx   : ドキュメントが、xxx秒後に陳腐化する。Expires より優先される。
             s-max-age=xxx : 共有キャッシュは、ドキュメントが、xxx秒後に陳腐化する。

      変更履歴:

        3.1.5.1 (2003/04/24) 初期値を、"max-age=0" に変更。

    - #### setContentType

          public void setContentType(String ct)

      【TAG】レスポンスヘッダ に、content-Type の値を設定します。
      パラメータ:
        `ct` - content-Type
      説明:

             このヘッダは、これから返すドキュメントのMIMEタイプを与えます。
             MIMEタイプの詳しい規格は、RFC1521 と、RFC1522 です。
             最新リスト
             未登録タイプ(x-タイプ)

    - #### setRefresh

          public void setRefresh(String ref)

      【TAG】レスポンスヘッダ に、refresh の値を設定します。
      パラメータ:
        `ref` - 画面更新(秒)
      説明:

             レスポンスヘッダのrefresh の値は、更新されたページをブラウザが
             今から何秒後にリクエストすればよいかということを伝えます。
             つまり、指定した秒数後に、再リクエストさせる事が可能になります。

    - #### setRefreshURL

          public void setRefreshURL(String refurl)

      【TAG】レスポンスヘッダ に、refresh の値を設定するときに、指定のURLをロードします。
      パラメータ:
        `refurl` - 再リクエストさせるURL
      説明:

             このヘッダは、refresh と共に使用され、リクエストする場合のURLを指定します。

      変更履歴:

        3.1.4.0 (2003/04/18) 属性名変更。(refreshUrl ⇒ refreshURL)

    - #### setRedirect

          public void setRedirect(String rd)

      【TAG】指定されたURLへ一時的なリダイレクトレスポンスを送信します。
      パラメータ:
        `rd` - リダイレクするURL
      説明:

             指定されたリダイレクト先のURLを用いて、 クライアントに一時的な
             リダイレクトレスポンスを送信します。
             URLとしては相対URLを指定することができます。

      変更履歴:

        3.6.0.0 (2004/09/17) \\\\hn51d4 などのネットワーク名への対応

    - #### setStatus

          public void setStatus(String st)

      【TAG】ステータスコードを設定します。
      パラメータ:
        `st` - ステータスコード
      説明:

             ステータスコードを設定します。
             100 ～ 199  １００番台はおしらせ的な情報です。
             200 ～ 299  ２００番台はリクエストが成功したことを表します。
             300 ～ 399  ３００番台はファイルが移動したことを表します。
             400 ～ 499  ４００番台はクライアント側のエラーを表します。
             500 ～ 599  ５００番台はサーバー側のエラーを表します。

    - #### setLocation

          public void setLocation(String lo)

      【TAG】レスポンスヘッダ に、location の値を設定します。
      パラメータ:
        `lo` - ドキュメントのアドレス(ロケーション)
      説明:

             このヘッダは、ドキュメントのアドレスを通知します。
             ３００番台のステータスコードには、このヘッダが必ず付随する必要があります。

    - #### toString

          public String toString()

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

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