org.opengion.hayabusa.taglib

## クラス QueueSendTag

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

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

      public class QueueSendTag
      extends CommonTagSupport

  キュー送信 キュー送信用のタグです。
  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:queueSend queueType="mq" mqQueueName="queue01" message="テキスト" />
         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
            <og:queueSend
                jmsServer                      【TAG】JMSサーバの接続先を指定します。JNDI名で指定します。(初期値:jms/Default)
                                                                  ※別途コンテキストファイルに接続情報が記載されている必要があります。
                queueType                    【TAG】タイプ(MQ,SQS)を指定します。
                mqTransacted               【TAG】トランザクション確認応答フラグを指定します。(MQ用)(初期値:false)
                                                                  true:トランザクション確認応答 false: 確認応答タイプに指定した確認応答
                mqAcknowledgeMode  【TAG】確認応答タイプを指定します。(MQ用)(初期値:1)
                                                                  1:AUTO_ACKNOWLEDTE(自動応答:１回の配信を保障)
                                                                  2:CLIENT_ACKNOWLEDE(クライアント応答)
                                                                  3:DUPS_OK_ACKNOWLEDTE(自動応答：複数回の配信可能性あり)
                mqQueueName            【TAG】キュー名を指定します。(MQ用)
                message                       【TAG】送信するメッセージを指定します。
                sqsFifoGroupId              【TAG】グループIDを指定します。(SQSのFIFOキュータイプ用)
                sqsFifoDedupliId           【TAG】重複排除IDを指定します。(SQSのFIFOキュータイプ用)

         ● 使用例
                ・<og:queueSend queueType="mq" mqQueueName="queue01" message="送信テキスト" />
                ・<og:queueSend queueType="mq" mqQueueName="queue01" />
                       送信テキスト
                   </og:queueSend>
                ・<og:queueSend queueType="sqs" sqsGroupId="group01" message="送信テキスト" />

  変更履歴:

    5.10.14.0 (2019/08/01) 新規作成

  機能分類
    画面部品
  バージョン
    5
  作成者
    oota

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

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

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

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

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

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() をオーバーライドします。
    `int` | `doEndTag()` Taglibの終了タグが見つかった時に処理する doEndTag() をオーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかった時に処理する doStartTag() をオーバライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setJmsServer(java.lang.String server)` 【TAG】メッセージサーバのURLを指定します。
    `void` | `setMessage(java.lang.String mess)` 【TAG】メッセージを指定します。
    `void` | `setMqAcknowledgeMode(java.lang.String mode)` 【TAG】MQ確認応答タイプを指定します。
    `void` | `setMqQueueName(java.lang.String qName)` 【TAG】MQキュー名を指定します。
    `void` | `setMqTransacted(java.lang.String flg)` 【TAG】MQトランザクション処理判定を指定します。
    `void` | `setQueueType(java.lang.String qType)` 【TAG】キューのタイプを指定します。
    `void` | `setSqsFifoDedupliId(java.lang.String sqsFifoDid)` 【TAG】 SQSのFIFOタイプキューの重複排除IDを指定します。
    `void` | `setSqsFifoGroupId(java.lang.String sqsGid)` 【TAG】SQSのFIFOタイプキューのグループIDを指定します。
    `java.lang.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, getTagName, 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`

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

    - #### QueueSendTag

          public QueueSendTag()

  - ### メソッドの詳細

    - #### release2

          protected void release2()

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

    - #### doStartTag

          public int doStartTag()

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

    - #### doAfterBody

          public int doAfterBody()

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

    - #### doEndTag

          public int doEndTag()

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

        5.10.15.0 (2019/08/30)アクセスキー修正

    - #### setJmsServer

          public void setJmsServer(java.lang.String server)

      【TAG】メッセージサーバのURLを指定します。
      パラメータ:
        `server` - JMSサーバの接続先
      説明:

             送信先のメッセージサーバのURLを指定します。

    - #### setMqTransacted

          public void setMqTransacted(java.lang.String flg)

      【TAG】MQトランザクション処理判定を指定します。
      パラメータ:
        `flg` - トランザクション処理フラグ
      説明:

             MQトランザクションの処理判定を指定します。
             true：受信側でコミット、ロールバックのトランザクション応答を行います。
             ※trueの場合は、MQ確認応答タイプは無効になります。
             false：受信側はMQ確認応答タイプに指定した値によって、確認応答を行います。

    - #### setMqAcknowledgeMode

          public void setMqAcknowledgeMode(java.lang.String mode)

      【TAG】MQ確認応答タイプを指定します。
      パラメータ:
        `mode` - 確認応答モード
      説明:

             MQ確認応答タイプを指定します。
             ※MQトランザクション処理判定にはfalseを指定して下さい。

             1：AUTO_ACKNOWLEDGE
             メッセージの配信の通知をjmsサーバーが自動的に処理するモードです。
             １回だけの配信を保障します。
             2：CLIENT_ACKNOWLEDGE
             確認応答を受信側が行うモードです。
             受信側に確認応答の実行が必要です。
             3：DUPS_OK_ACKNOWLEDGE
             AUTO_AKNOWLEDGEと同様にjmsサーバーが自動的に処理を行います。
             複数回配信される可能性があります。(処理が軽い事がメリットです。
             基本的にはAUTO_ACKNOWLEDGEを推奨します。)

    - #### setMqQueueName

          public void setMqQueueName(java.lang.String qName)

      【TAG】MQキュー名を指定します。
      パラメータ:
        `qName` - MQキュー名
      説明:

             MQタイプのキューを利用時、
             メッセージを格納するキュー名を指定します。

    - #### setMessage

          public void setMessage(java.lang.String mess)

      【TAG】メッセージを指定します。
      パラメータ:
        `mess` - メッセージ
      説明:

             送信するメッセージを指定します。

    - #### setQueueType

          public void setQueueType(java.lang.String qType)

      【TAG】キューのタイプを指定します。
      パラメータ:
        `qType` - キュータイプ
      説明:

             利用するメッセージサーバのタイプを指定します。
             下記のタイプが利用可能です。

             mq : ActiveQueue or AmazonMQ
             sqs：AmazonSQS

    - #### setSqsFifoGroupId

          public void setSqsFifoGroupId(java.lang.String sqsGid)

      【TAG】SQSのFIFOタイプキューのグループIDを指定します。
      パラメータ:
        `sqsGid` - SQSFIFOタイプキューのグループID
      説明:

             awsのSQSのFIFOタイプキューを利用時、
             グループIDを指定します。
             同一の値内で、FIFOの配信順序が保障されます。

    - #### setSqsFifoDedupliId

          public void setSqsFifoDedupliId(java.lang.String sqsFifoDid)

      【TAG】 SQSのFIFOタイプキューの重複排除IDを指定します。
      パラメータ:
        `sqsFifoDid` - SQSFIFOタイプキューの重複禁止ID
      説明:

             awsのSQSのFIFOタイプキューを利用時、
             重複排除IDを指定します。
             5分間同一の値が送信された場合、キューに格納しない機能です。
             aws側の設定で、メッセージを暗号化した値を、自動設定することも可能です。

    - #### toString

          public java.lang.String toString()

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

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