Package org.iplass.mtp.webapi
Interface WebApiRequestConstants
-
public interface WebApiRequestConstants
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringAPI_NAMEWebApi名を取得する際のattribute名です。static java.lang.StringDEFAULT_PARAM_NAMEREST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。static java.lang.StringDEFAULT_RESULTWebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。 実際の値は、"result"です。static java.lang.StringHTTP_HEADERHTTPヘッダ(リクエストの)が格納されているMapのインスタンス。static java.lang.StringHTTP_METHODWebAPIのHTTPメソッドを取得する際のattribute名です。MethodTypeのいずれかの値が取得されます。static java.lang.StringPARAMattribute経由でパラメータMapを取得する際のattribute名。取得できるインスタンスは、RequestContext#getParamMap()と同じ。static java.lang.StringREQUEST_TYPEWebAPIのリクエスト種別を取得する際のattribute名です。RequestTypeのいずれかの値が取得されます。static java.lang.StringRESPONSE_HEADERResponseHeaderのインスタンス。Command内でレスポンスにCokkie、Headerをセットしたい場合利用。static java.lang.StringSERVLET_REQUESTこのリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。取得されるインスタンスは、implementsHttpServletRequest,RequestInfoの形。情報参照系のメソッドのみ利用可能。利用可能なメソッドは、RequestInfoに定義されているメソッド。static java.lang.StringSUB_PATHWebApi名以降のサブパス文字列を取得する際のattribute名static java.lang.StringWEB_APIこのリクエストがwebApi経由の呼び出しか否かを判断するフラグ(Boolean)を取得する際のattribute名
-
-
-
Field Detail
-
REQUEST_TYPE
static final java.lang.String REQUEST_TYPE
WebAPIのリクエスト種別を取得する際のattribute名です。RequestTypeのいずれかの値が取得されます。- See Also:
- Constant Field Values
-
HTTP_METHOD
static final java.lang.String HTTP_METHOD
WebAPIのHTTPメソッドを取得する際のattribute名です。MethodTypeのいずれかの値が取得されます。- See Also:
- Constant Field Values
-
API_NAME
static final java.lang.String API_NAME
WebApi名を取得する際のattribute名です。- See Also:
- Constant Field Values
-
DEFAULT_RESULT
static final java.lang.String DEFAULT_RESULT
WebApi呼び出しの実行結果として、クライアントへ返却するオブジェクトをrequestContextへ格納する際の名前で、 定義にて未設定の場合のデフォルトの名前です。 実際の値は、"result"です。- See Also:
- Constant Field Values
-
RESPONSE_HEADER
static final java.lang.String RESPONSE_HEADER
ResponseHeaderのインスタンス。Command内でレスポンスにCokkie、Headerをセットしたい場合利用。- See Also:
- Constant Field Values
-
HTTP_HEADER
static final java.lang.String HTTP_HEADER
HTTPヘッダ(リクエストの)が格納されているMapのインスタンス。- See Also:
- Constant Field Values
-
PARAM
static final java.lang.String PARAM
attribute経由でパラメータMapを取得する際のattribute名。取得できるインスタンスは、RequestContext#getParamMap()と同じ。- See Also:
- Constant Field Values
-
SERVLET_REQUEST
static final java.lang.String SERVLET_REQUEST
このリクエストが呼び出された際のHttpServletReqeustを取得する際のattribute名。取得されるインスタンスは、implementsHttpServletRequest,RequestInfoの形。情報参照系のメソッドのみ利用可能。利用可能なメソッドは、RequestInfoに定義されているメソッド。- See Also:
- Constant Field Values
-
DEFAULT_PARAM_NAME
static final java.lang.String DEFAULT_PARAM_NAME
REST FORM, SOAP WSDLで利用するデフォルトのパラメータ名です。- See Also:
- Constant Field Values
-
WEB_API
static final java.lang.String WEB_API
このリクエストがwebApi経由の呼び出しか否かを判断するフラグ(Boolean)を取得する際のattribute名- See Also:
- Constant Field Values
-
SUB_PATH
static final java.lang.String SUB_PATH
WebApi名以降のサブパス文字列を取得する際のattribute名- See Also:
- Constant Field Values
-
-