クラス AsyncRequestContext

  • すべての実装されたインタフェース:
    java.io.Serializable, RequestContext

    public class AsyncRequestContext
    extends java.lang.Object
    implements RequestContext, java.io.Serializable
    非同期Commandを呼び出し時に利用するRequestContext。
    AsyncRequestContextは実行する際Serializeされ、DBに格納される。 そのため、非同期呼び出し時に渡す属性(attribute)は、Serializable実装されている必要がある。 また、極力小さなオブジェクトとなるようにする。 大きなオブジェクトを渡す場合は、別途Entityなどの形でDBに格納し、 AsyncRequestContextへは、そのキーであるoidを渡すようにする。
    getParam,getParamsメソッドは、以下のようなロジックで動作する。
     Map param = getAttribute(AsyncRequestConstants.PARAM);
     if (param == null) {
            return  null;
     }
     return param.get(name)
     
    また、非同期実行の際のtaskId、queueはそれぞれ、 AsyncRequestConstants.TASK_ID、AsyncRequestConstants.QUEUEをキーにattributeより取得できる。
    関連項目:
    直列化された形式
    • コンストラクタの概要

      コンストラクタ 
      コンストラクタ 説明
      AsyncRequestContext()
      コンストラクタ。
      AsyncRequestContext​(java.util.Map<java.lang.String,​java.lang.Object> attributeMap)
      コンストラクタ。
    • メソッドの概要

      修飾子とタイプ メソッド 説明
      java.lang.Object getAttribute​(java.lang.String name)
      サーバサイドでリクエストスコープで保持している属性を取得します。
      java.util.Iterator<java.lang.String> getAttributeNames()
      属性の名前の一覧をIteratorで取得します。
      java.lang.String getParam​(java.lang.String name)
      クライアントからの呼び出しパラメータを取得。
      <T> T getParam​(java.lang.String name, java.lang.Class<T> type)
      クライアントからの呼び出しパラメータを指定の型として取得します。
      java.math.BigDecimal getParamAsBigDecimal​(java.lang.String name)
      クライアントからの呼び出しパラメータをBigDecimal型として取得します。
      java.lang.Boolean getParamAsBoolean​(java.lang.String name)
      クライアントからの呼び出しパラメータをBoolean型として取得します。
      java.sql.Date getParamAsDate​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをjava.sql.Date型として取得します。
      java.lang.Double getParamAsDouble​(java.lang.String name)
      クライアントからの呼び出しパラメータをDouble型として取得します。
      UploadFileHandle getParamAsFile​(java.lang.String name)
      AysncRequestContextでは利用できない。
      java.lang.Integer getParamAsInt​(java.lang.String name)
      クライアントからの呼び出しパラメータをInteger型として取得します。
      java.lang.Long getParamAsLong​(java.lang.String name)
      クライアントからの呼び出しパラメータをLong型として取得します。
      java.sql.Time getParamAsTime​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTime型として取得します。
      java.sql.Timestamp getParamAsTimestamp​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTimestamp型として取得します。
      java.util.Map<java.lang.String,​java.lang.Object> getParamMap()
      パラメータをMap形式で取得します。
      java.util.Iterator<java.lang.String> getParamNames()
      パラメータ名の一覧のIteratorを取得します。
      java.lang.String[] getParams​(java.lang.String name)
      クライアントからの呼び出しパラメータ(複数) を取得します。
      <T> T[] getParams​(java.lang.String name, java.lang.Class<T> type)
      クライアントからの呼び出しパラメータを指定の型の配列として取得します。
      java.math.BigDecimal[] getParamsAsBigDecimal​(java.lang.String name)
      クライアントからの呼び出しパラメータをBigDecimal型配列として取得します。
      java.lang.Boolean[] getParamsAsBoolean​(java.lang.String name)
      クライアントからの呼び出しパラメータをBoolean型配列として取得します。
      java.sql.Date[] getParamsAsDate​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをjava.sql.Date型配列として取得します。
      java.lang.Double[] getParamsAsDouble​(java.lang.String name)
      クライアントからの呼び出しパラメータをDouble型配列として取得します。
      UploadFileHandle[] getParamsAsFile​(java.lang.String name)
      AysncRequestContextでは利用できない。
      java.lang.Integer[] getParamsAsInt​(java.lang.String name)
      クライアントからの呼び出しパラメータをInteger型配列として取得します。
      java.lang.Long[] getParamsAsLong​(java.lang.String name)
      クライアントからの呼び出しパラメータをLong型配列として取得します。
      java.sql.Time[] getParamsAsTime​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTime型配列として取得します。
      java.sql.Timestamp[] getParamsAsTimestamp​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTimestamp型配列として取得します。
      SessionContext getSession()
      AysncRequestContextでは利用できない。
      SessionContext getSession​(boolean create)
      AysncRequestContextでは利用できない。
      void removeAttribute​(java.lang.String name)
      指定のnameの属性を削除します。
      void setAttribute​(java.lang.String name, java.lang.Object value)
      サーバサイドでリクエストスコープで属性を保持します。
      • クラスから継承されたメソッド java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • コンストラクタの詳細

      • AsyncRequestContext

        public AsyncRequestContext()
        コンストラクタ。
      • AsyncRequestContext

        public AsyncRequestContext​(java.util.Map<java.lang.String,​java.lang.Object> attributeMap)
        コンストラクタ。 引数のattributeMapをattributeの属性として構築する。
        パラメータ:
        attributeMap -
    • メソッドの詳細

      • getParam

        public java.lang.String getParam​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータを取得。 (HttpServletRequestのgetParameter相当)
        定義:
        getParam インタフェース内 RequestContext
        戻り値:
      • getParams

        public java.lang.String[] getParams​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータ(複数) を取得します。 (HttpServletRequestのgetParameterValues相当)
        定義:
        getParams インタフェース内 RequestContext
        戻り値:
      • getParam

        public <T> T getParam​(java.lang.String name,
                              java.lang.Class<T> type)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータを指定の型として取得します。 typeにはプリミティブ側のラッパークラス、String、BigDecimal、SelectValue、 java.sql.Date、Timestamp、Timeを指定可能です。
        定義:
        getParam インタフェース内 RequestContext
        戻り値:
      • getParams

        public <T> T[] getParams​(java.lang.String name,
                                 java.lang.Class<T> type)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータを指定の型の配列として取得します。 typeにはプリミティブ側のラッパークラス、String、BigDecimal、SelectValue、 java.sql.Date、Timestamp、Timeを指定可能です。
        定義:
        getParams インタフェース内 RequestContext
        戻り値:
      • getParamAsBoolean

        public java.lang.Boolean getParamAsBoolean​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをBoolean型として取得します。 Boolean.valueOf(String)で変換します。
        定義:
        getParamAsBoolean インタフェース内 RequestContext
        戻り値:
      • getParamsAsBoolean

        public java.lang.Boolean[] getParamsAsBoolean​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをBoolean型配列として取得します。 Boolean.valueOf(String)で変換します。
        定義:
        getParamsAsBoolean インタフェース内 RequestContext
        戻り値:
      • getParamAsLong

        public java.lang.Long getParamAsLong​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをLong型として取得します。 Long.valueOf(String)で変換します。
        定義:
        getParamAsLong インタフェース内 RequestContext
        戻り値:
      • getParamsAsLong

        public java.lang.Long[] getParamsAsLong​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをLong型配列として取得します。 Long.valueOf(String)で変換します。
        定義:
        getParamsAsLong インタフェース内 RequestContext
        戻り値:
      • getParamAsInt

        public java.lang.Integer getParamAsInt​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをInteger型として取得します。 Integer.valueOf(String)で変換します。
        定義:
        getParamAsInt インタフェース内 RequestContext
        戻り値:
      • getParamsAsInt

        public java.lang.Integer[] getParamsAsInt​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをInteger型配列として取得します。 Integer.valueOf(String)で変換します。
        定義:
        getParamsAsInt インタフェース内 RequestContext
        戻り値:
      • getParamAsDouble

        public java.lang.Double getParamAsDouble​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをDouble型として取得します。 Double.valueOf(String)で変換します。
        定義:
        getParamAsDouble インタフェース内 RequestContext
        戻り値:
      • getParamsAsDouble

        public java.lang.Double[] getParamsAsDouble​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをDouble型配列として取得します。 Double.valueOf(String)で変換します。
        定義:
        getParamsAsDouble インタフェース内 RequestContext
        戻り値:
      • getParamAsDate

        public java.sql.Date getParamAsDate​(java.lang.String name,
                                            java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをjava.sql.Date型として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamAsDate インタフェース内 RequestContext
        戻り値:
      • getParamsAsDate

        public java.sql.Date[] getParamsAsDate​(java.lang.String name,
                                               java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをjava.sql.Date型配列として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamsAsDate インタフェース内 RequestContext
        戻り値:
      • getParamAsTimestamp

        public java.sql.Timestamp getParamAsTimestamp​(java.lang.String name,
                                                      java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをTimestamp型として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamAsTimestamp インタフェース内 RequestContext
        戻り値:
      • getParamsAsTimestamp

        public java.sql.Timestamp[] getParamsAsTimestamp​(java.lang.String name,
                                                         java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをTimestamp型配列として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamsAsTimestamp インタフェース内 RequestContext
        戻り値:
      • getParamAsTime

        public java.sql.Time getParamAsTime​(java.lang.String name,
                                            java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをTime型として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamAsTime インタフェース内 RequestContext
        戻り値:
      • getParamsAsTime

        public java.sql.Time[] getParamsAsTime​(java.lang.String name,
                                               java.lang.String format)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをTime型配列として取得します。 値の文字列のフォーマットはformatで指定します。
        定義:
        getParamsAsTime インタフェース内 RequestContext
        戻り値:
      • getParamAsBigDecimal

        public java.math.BigDecimal getParamAsBigDecimal​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをBigDecimal型として取得します。 new BigDecimal(String)で変換します。
        定義:
        getParamAsBigDecimal インタフェース内 RequestContext
        戻り値:
      • getParamsAsBigDecimal

        public java.math.BigDecimal[] getParamsAsBigDecimal​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        クライアントからの呼び出しパラメータをBigDecimal型配列として取得します。 new BigDecimal(String)で変換します。
        定義:
        getParamsAsBigDecimal インタフェース内 RequestContext
        戻り値:
      • getParamAsFile

        public UploadFileHandle getParamAsFile​(java.lang.String name)
        AysncRequestContextでは利用できない。
        定義:
        getParamAsFile インタフェース内 RequestContext
        戻り値:
        例外:
        java.lang.UnsupportedOperationException
      • getParamsAsFile

        public UploadFileHandle[] getParamsAsFile​(java.lang.String name)
        AysncRequestContextでは利用できない。
        定義:
        getParamsAsFile インタフェース内 RequestContext
        戻り値:
        例外:
        java.lang.UnsupportedOperationException
      • getParamMap

        public java.util.Map<java.lang.String,​java.lang.Object> getParamMap()
        インタフェースからコピーされた説明: RequestContext
        パラメータをMap形式で取得します。
        定義:
        getParamMap インタフェース内 RequestContext
        戻り値:
      • getParamNames

        public java.util.Iterator<java.lang.String> getParamNames()
        インタフェースからコピーされた説明: RequestContext
        パラメータ名の一覧のIteratorを取得します。
        定義:
        getParamNames インタフェース内 RequestContext
        戻り値:
      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        サーバサイドでリクエストスコープで保持している属性を取得します。 (HttpServletRequestのgetAttribute相当)
        定義:
        getAttribute インタフェース内 RequestContext
        戻り値:
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.Object value)
        インタフェースからコピーされた説明: RequestContext
        サーバサイドでリクエストスコープで属性を保持します。 (HttpServletRequestのsetAttribute相当)
        定義:
        setAttribute インタフェース内 RequestContext
      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        インタフェースからコピーされた説明: RequestContext
        指定のnameの属性を削除します。 setAttribute(name, null)と同義
        定義:
        removeAttribute インタフェース内 RequestContext
      • getAttributeNames

        public java.util.Iterator<java.lang.String> getAttributeNames()
        インタフェースからコピーされた説明: RequestContext
        属性の名前の一覧をIteratorで取得します。
        定義:
        getAttributeNames インタフェース内 RequestContext
        戻り値:
      • getSession

        public SessionContext getSession()
        AysncRequestContextでは利用できない。
        定義:
        getSession インタフェース内 RequestContext
        戻り値:
        例外:
        java.lang.UnsupportedOperationException
      • getSession

        public SessionContext getSession​(boolean create)
        AysncRequestContextでは利用できない。
        定義:
        getSession インタフェース内 RequestContext
        パラメータ:
        create - trueの場合、セッションオブジェクトが存在しなかったら新規に作成して返す
        戻り値:
        例外:
        java.lang.UnsupportedOperationException