パッケージ org.iplass.mtp.command

インタフェース RequestContext

既知の実装クラスのリスト:
AsyncRequestContext, RequestContextWrapper, TestRequestContext
public interface RequestContext
Commandへのリクエストを表すクラスです。 （ServletにおけるServletRequest相当のクラスです）

  • メソッドの概要

    修飾子とタイプ メソッド 説明
    java.lang.Object getAttribute​(java.lang.String name)
    サーバサイドでリクエストスコープで保持している属性を取得します。
    java.util.Iterator<java.lang.String> getAttributeNames()
    属性の名前の一覧をIteratorで取得します。
    java.lang.String getParam​(java.lang.String name)
    クライアントからの呼び出しパラメータを取得。
    default <T> T getParam​(java.lang.String name, java.lang.Class<T> type)
    クライアントからの呼び出しパラメータを指定の型として取得します。
    default <T> T getParam​(java.lang.String name, java.lang.Class<T> type, T defaultValue)
    クライアントからの呼び出しパラメータを指定の型として取得します。
    default java.math.BigDecimal getParamAsBigDecimal​(java.lang.String name)
    クライアントからの呼び出しパラメータをBigDecimal型として取得します。
    default java.lang.Boolean getParamAsBoolean​(java.lang.String name)
    クライアントからの呼び出しパラメータをBoolean型として取得します。
    default java.sql.Date getParamAsDate​(java.lang.String name, java.lang.String format)
    クライアントからの呼び出しパラメータをjava.sql.Date型として取得します。
    default java.lang.Double getParamAsDouble​(java.lang.String name)
    クライアントからの呼び出しパラメータをDouble型として取得します。
    UploadFileHandle getParamAsFile​(java.lang.String name)
    ファイルを添付してPOST（multipart/form-data）された場合、アップロードされたファイルを取得可能です。
    default java.lang.Integer getParamAsInt​(java.lang.String name)
    クライアントからの呼び出しパラメータをInteger型として取得します。
    default java.lang.Long getParamAsLong​(java.lang.String name)
    クライアントからの呼び出しパラメータをLong型として取得します。
    default java.sql.Time getParamAsTime​(java.lang.String name, java.lang.String format)
    クライアントからの呼び出しパラメータをTime型として取得します。
    default 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)
    クライアントからの呼び出しパラメータ（複数） を取得します。
    default <T> T[] getParams​(java.lang.String name, java.lang.Class<T> type)
    クライアントからの呼び出しパラメータを指定の型の配列として取得します。
    default <T> T[] getParams​(java.lang.String name, java.lang.Class<T> type, T[] defaultValues)
    クライアントからの呼び出しパラメータを指定の型の配列として取得します。
    default java.math.BigDecimal[] getParamsAsBigDecimal​(java.lang.String name)
    クライアントからの呼び出しパラメータをBigDecimal型配列として取得します。
    default java.lang.Boolean[] getParamsAsBoolean​(java.lang.String name)
    クライアントからの呼び出しパラメータをBoolean型配列として取得します。
    default java.sql.Date[] getParamsAsDate​(java.lang.String name, java.lang.String format)
    クライアントからの呼び出しパラメータをjava.sql.Date型配列として取得します。
    default java.lang.Double[] getParamsAsDouble​(java.lang.String name)
    クライアントからの呼び出しパラメータをDouble型配列として取得します。
    UploadFileHandle[] getParamsAsFile​(java.lang.String name)
    ファイルを添付してPOST（multipart/form-data）された場合、アップロードされたファイルを取得可能です。
    default java.lang.Integer[] getParamsAsInt​(java.lang.String name)
    クライアントからの呼び出しパラメータをInteger型配列として取得します。
    default java.lang.Long[] getParamsAsLong​(java.lang.String name)
    クライアントからの呼び出しパラメータをLong型配列として取得します。
    default java.sql.Time[] getParamsAsTime​(java.lang.String name, java.lang.String format)
    クライアントからの呼び出しパラメータをTime型配列として取得します。
    default java.sql.Timestamp[] getParamsAsTimestamp​(java.lang.String name, java.lang.String format)
    クライアントからの呼び出しパラメータをTimestamp型配列として取得します。
    SessionContext getSession()
    クライアントのセッションオブジェクトを取得します。
    SessionContext getSession​(boolean create)
    クライアントのセッションオブジェクトを取得します。
    void removeAttribute​(java.lang.String name)
    指定のnameの属性を削除します。
    static java.lang.String resourceString​(java.lang.String key, java.lang.Object... arguments)  
    void setAttribute​(java.lang.String name, java.lang.Object value)
    サーバサイドでリクエストスコープで属性を保持します。

  • メソッドの詳細

    • getParam

      java.lang.String getParam​(java.lang.String name)
      クライアントからの呼び出しパラメータを取得。 （HttpServletRequestのgetParameter相当）
      パラメータ:
      name -
      戻り値:

    • getParams

      java.lang.String[] getParams​(java.lang.String name)
      クライアントからの呼び出しパラメータ（複数） を取得します。 （HttpServletRequestのgetParameterValues相当）
      パラメータ:
      name -
      戻り値:

    • getParam

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

    • getParam

      default <T> T getParam​(java.lang.String name, java.lang.Class<T> type, T defaultValue)
      クライアントからの呼び出しパラメータを指定の型として取得します。 typeにはプリミティブ側のラッパークラス、String、BigDecimal、SelectValue、 java.sql.Date、Timestamp、Timeを指定可能です。 値が指定されていなかった場合は、defaultValueの値が返却されます。
      パラメータ:
      name -
      type -
      defaultValue -
      戻り値:

    • getParams

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

    • getParams

      default <T> T[] getParams​(java.lang.String name, java.lang.Class<T> type, T[] defaultValues)
      クライアントからの呼び出しパラメータを指定の型の配列として取得します。 typeにはプリミティブ側のラッパークラス、String、BigDecimal、SelectValue、 java.sql.Date、Timestamp、Timeを指定可能です。 値が指定されていなかった場合は、defaultValuesの値が返却されます。
      パラメータ:
      name -
      type -
      defaultValues -
      戻り値:

    • getParamAsBoolean

      default java.lang.Boolean getParamAsBoolean​(java.lang.String name)
      クライアントからの呼び出しパラメータをBoolean型として取得します。 Boolean.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamsAsBoolean

      default java.lang.Boolean[] getParamsAsBoolean​(java.lang.String name)
      クライアントからの呼び出しパラメータをBoolean型配列として取得します。 Boolean.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamAsLong

      default java.lang.Long getParamAsLong​(java.lang.String name)
      クライアントからの呼び出しパラメータをLong型として取得します。 Long.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamsAsLong

      default java.lang.Long[] getParamsAsLong​(java.lang.String name)
      クライアントからの呼び出しパラメータをLong型配列として取得します。 Long.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamAsInt

      default java.lang.Integer getParamAsInt​(java.lang.String name)
      クライアントからの呼び出しパラメータをInteger型として取得します。 Integer.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamsAsInt

      default java.lang.Integer[] getParamsAsInt​(java.lang.String name)
      クライアントからの呼び出しパラメータをInteger型配列として取得します。 Integer.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamAsDouble

      default java.lang.Double getParamAsDouble​(java.lang.String name)
      クライアントからの呼び出しパラメータをDouble型として取得します。 Double.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamsAsDouble

      default java.lang.Double[] getParamsAsDouble​(java.lang.String name)
      クライアントからの呼び出しパラメータをDouble型配列として取得します。 Double.valueOf(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamAsDate

      default java.sql.Date getParamAsDate​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをjava.sql.Date型として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamsAsDate

      default java.sql.Date[] getParamsAsDate​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをjava.sql.Date型配列として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamAsTimestamp

      default java.sql.Timestamp getParamAsTimestamp​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTimestamp型として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamsAsTimestamp

      default java.sql.Timestamp[] getParamsAsTimestamp​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTimestamp型配列として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamAsTime

      default java.sql.Time getParamAsTime​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTime型として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamsAsTime

      default java.sql.Time[] getParamsAsTime​(java.lang.String name, java.lang.String format)
      クライアントからの呼び出しパラメータをTime型配列として取得します。 値の文字列のフォーマットはformatで指定します。
      パラメータ:
      name -
      format -
      戻り値:

    • getParamAsBigDecimal

      default java.math.BigDecimal getParamAsBigDecimal​(java.lang.String name)
      クライアントからの呼び出しパラメータをBigDecimal型として取得します。 new BigDecimal(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamsAsBigDecimal

      default java.math.BigDecimal[] getParamsAsBigDecimal​(java.lang.String name)
      クライアントからの呼び出しパラメータをBigDecimal型配列として取得します。 new BigDecimal(String)で変換します。
      パラメータ:
      name -
      戻り値:

    • getParamAsFile

      UploadFileHandle getParamAsFile​(java.lang.String name)
      ファイルを添付してPOST（multipart/form-data）された場合、アップロードされたファイルを取得可能です。
      パラメータ:
      name -
      戻り値:

    • getParamsAsFile

      UploadFileHandle[] getParamsAsFile​(java.lang.String name)
      ファイルを添付してPOST（multipart/form-data）された場合、アップロードされたファイルを取得可能です。 同一名称で複数件のファイルがアップされた場合、こちらを利用可能です。
      パラメータ:
      name -
      戻り値:

    • getParamMap

      java.util.Map<java.lang.String,​java.lang.Object> getParamMap()
      パラメータをMap形式で取得します。
      戻り値:

    • getParamNames

      java.util.Iterator<java.lang.String> getParamNames()
      パラメータ名の一覧のIteratorを取得します。
      戻り値:

    • getAttribute

      java.lang.Object getAttribute​(java.lang.String name)
      サーバサイドでリクエストスコープで保持している属性を取得します。 （HttpServletRequestのgetAttribute相当）
      パラメータ:
      name -
      戻り値:

    • setAttribute

      void setAttribute​(java.lang.String name, java.lang.Object value)
      サーバサイドでリクエストスコープで属性を保持します。 （HttpServletRequestのsetAttribute相当）
      パラメータ:
      name -
      value -

    • removeAttribute

      void removeAttribute​(java.lang.String name)
      指定のnameの属性を削除します。 setAttribute(name, null)と同義
      パラメータ:
      name -

    • getAttributeNames

      java.util.Iterator<java.lang.String> getAttributeNames()
      属性の名前の一覧をIteratorで取得します。
      戻り値:

    • getSession

      SessionContext getSession()
      クライアントのセッションオブジェクトを取得します。 セッションオブジェクトが存在しなかったら新規に作成して返します。 getSession(true)呼び出しと同等。
      戻り値:

    • getSession

      SessionContext getSession​(boolean create)
      クライアントのセッションオブジェクトを取得します。
      パラメータ:
      create - trueの場合、セッションオブジェクトが存在しなかったら新規に作成して返す
      戻り値:

    • resourceString

      static java.lang.String resourceString​(java.lang.String key, java.lang.Object... arguments)