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

インタフェース WebApiRequestConstants


  • public interface WebApiRequestConstants
    • フィールドの概要

      フィールド 
      修飾子とタイプ フィールド 説明
      static java.lang.String API_NAME
      WebApi名を取得する際のattribute名です。
      static java.lang.String DEFAULT_PARAM_NAME
      REST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。
      static java.lang.String DEFAULT_RESULT
      WebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。
      static java.lang.String HTTP_HEADER
      HTTPヘッダ(リクエストの)が格納されているMapのインスタンス。
      static java.lang.String HTTP_METHOD
      WebAPIのHTTPメソッドを取得する際のattribute名です。
      static java.lang.String PARAM
      attribute経由でパラメータMapを取得する際のattribute名。
      static java.lang.String REQUEST_TYPE
      WebAPIのリクエスト種別を取得する際のattribute名です。
      static java.lang.String RESPONSE_HEADER
      ResponseHeaderのインスタンス。
      static java.lang.String SERVLET_REQUEST
      このリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。
      static java.lang.String SUB_PATH
      WebApi名以降のサブパス文字列を取得する際のattribute名
      static java.lang.String WEB_API
      このリクエストがwebApi経由の呼び出しか否かを判断するフラグ(Boolean)を取得する際のattribute名
    • フィールドの詳細

      • REQUEST_TYPE

        static final java.lang.String REQUEST_TYPE
        WebAPIのリクエスト種別を取得する際のattribute名です。RequestTypeのいずれかの値が取得されます。
        関連項目:
        定数フィールド値
      • HTTP_METHOD

        static final java.lang.String HTTP_METHOD
        WebAPIのHTTPメソッドを取得する際のattribute名です。MethodTypeのいずれかの値が取得されます。
        関連項目:
        定数フィールド値
      • API_NAME

        static final java.lang.String API_NAME
        WebApi名を取得する際のattribute名です。
        関連項目:
        定数フィールド値
      • DEFAULT_RESULT

        static final java.lang.String DEFAULT_RESULT
        WebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。 実際の値は、"result"です。
        関連項目:
        定数フィールド値
      • RESPONSE_HEADER

        static final java.lang.String RESPONSE_HEADER
        ResponseHeaderのインスタンス。Command内でレスポンスにCokkie、Headerをセットしたい場合利用。
        関連項目:
        定数フィールド値
      • HTTP_HEADER

        static final java.lang.String HTTP_HEADER
        HTTPヘッダ(リクエストの)が格納されているMapのインスタンス。
        関連項目:
        定数フィールド値
      • PARAM

        static final java.lang.String PARAM
        attribute経由でパラメータMapを取得する際のattribute名。取得できるインスタンスは、RequestContext#getParamMap()と同じ。
        関連項目:
        定数フィールド値
      • SERVLET_REQUEST

        static final java.lang.String SERVLET_REQUEST
        このリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。取得されるインスタンスは、implements HttpServletRequest, RequestInfoの形。情報参照系のメソッドのみ利用可能。利用可能なメソッドは、RequestInfoに定義されているメソッド。
        関連項目:
        定数フィールド値
      • DEFAULT_PARAM_NAME

        static final java.lang.String DEFAULT_PARAM_NAME
        REST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。
        関連項目:
        定数フィールド値
      • WEB_API

        static final java.lang.String WEB_API
        このリクエストがwebApi経由の呼び出しか否かを判断するフラグ(Boolean)を取得する際のattribute名
        関連項目:
        定数フィールド値
      • SUB_PATH

        static final java.lang.String SUB_PATH
        WebApi名以降のサブパス文字列を取得する際のattribute名
        関連項目:
        定数フィールド値