Package org.iplass.mtp.webapi

Interface WebApiRequestConstants

public interface WebApiRequestConstants

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    API_NAME
    WebApi名を取得する際のattribute名です。
    static final String
    DEFAULT_PARAM_NAME
    REST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。
    static final String
    DEFAULT_RESULT
    WebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。 実際の値は、"result"です。
    static final String
    HTTP_HEADER
    HTTPヘッダ（リクエストの）が格納されているMapのインスタンス。
    static final String
    HTTP_METHOD
    WebAPIのHTTPメソッドを取得する際のattribute名です。MethodTypeのいずれかの値が取得されます。
    static final String
    PARAM
    attribute経由でパラメータMapを取得する際のattribute名。取得できるインスタンスは、RequestContext#getParamMap()と同じ。
    static final String
    REQUEST_BODY
    WebApi 呼び出しを行った際、REST_OTHERS で処理を受け付けた際、 リクエストボディを取得する為のattribute名です。 取得するインスタンスは java.io.InputStream です。
    static final String
    REQUEST_CHARACTER_ENCODING
    WebApi 呼び出しを行った際、REST_OTHERS で処理を受け付けた際、 リクエストボディの文字コードを取得する為のattribute名です。 取得するインスタンスは String です。
    static final String
    REQUEST_TYPE
    WebAPIのリクエスト種別を取得する際のattribute名です。RequestTypeのいずれかの値が取得されます。
    static final String
    RESPONSE_HEADER
    ResponseHeaderのインスタンス。Command内でレスポンスにCokkie、Headerをセットしたい場合利用。
    static final String
    SERVLET_REQUEST
    このリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。取得されるインスタンスは、implements HttpServletRequest, RequestInfoの形。情報参照系のメソッドのみ利用可能。利用可能なメソッドは、RequestInfoに定義されているメソッド。
    static final String
    SUB_PATH
    WebApi名以降のサブパス文字列を取得する際のattribute名
    static final String
    WEB_API
    このリクエストがwebApi経由の呼び出しか否かを判断するフラグ（Boolean）を取得する際のattribute名

  • Field Details

    • REQUEST_TYPE

      static final String REQUEST_TYPE
      WebAPIのリクエスト種別を取得する際のattribute名です。RequestTypeのいずれかの値が取得されます。
      See Also:

    • HTTP_METHOD

      static final String HTTP_METHOD
      WebAPIのHTTPメソッドを取得する際のattribute名です。MethodTypeのいずれかの値が取得されます。
      See Also:

    • API_NAME

      static final String API_NAME
      WebApi名を取得する際のattribute名です。
      See Also:

    • DEFAULT_RESULT

      static final String DEFAULT_RESULT
      WebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。 実際の値は、"result"です。
      See Also:

    • RESPONSE_HEADER

      static final String RESPONSE_HEADER
      ResponseHeaderのインスタンス。Command内でレスポンスにCokkie、Headerをセットしたい場合利用。
      See Also:

    • HTTP_HEADER

      static final String HTTP_HEADER
      HTTPヘッダ（リクエストの）が格納されているMapのインスタンス。
      See Also:

    • PARAM

      static final String PARAM
      attribute経由でパラメータMapを取得する際のattribute名。取得できるインスタンスは、RequestContext#getParamMap()と同じ。
      See Also:

    • SERVLET_REQUEST

      static final String SERVLET_REQUEST
      このリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。取得されるインスタンスは、implements HttpServletRequest, RequestInfoの形。情報参照系のメソッドのみ利用可能。利用可能なメソッドは、RequestInfoに定義されているメソッド。
      See Also:

    • DEFAULT_PARAM_NAME

      static final String DEFAULT_PARAM_NAME
      REST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。
      See Also:

    • WEB_API

      static final String WEB_API
      このリクエストがwebApi経由の呼び出しか否かを判断するフラグ（Boolean）を取得する際のattribute名
      See Also:

    • SUB_PATH

      static final String SUB_PATH
      WebApi名以降のサブパス文字列を取得する際のattribute名
      See Also:

    • REQUEST_BODY

      static final String REQUEST_BODY
      WebApi 呼び出しを行った際、REST_OTHERS で処理を受け付けた際、 リクエストボディを取得する為のattribute名です。 取得するインスタンスは java.io.InputStream です。
      See Also:

    • REQUEST_CHARACTER_ENCODING

      static final String REQUEST_CHARACTER_ENCODING
      WebApi 呼び出しを行った際、REST_OTHERS で処理を受け付けた際、 リクエストボディの文字コードを取得する為のattribute名です。 取得するインスタンスは String です。

      HttpServletRequest#getCharacterEncoding() で取得される文字コードを格納します。

      See Also: