注釈型 WebApi
-
@Repeatable(WebApis.class) @Retention(RUNTIME) @Target(TYPE) public @interface WebApi
WebAPIの定義。
-
-
必須要素の概要
必須要素 修飾子とタイプ 必須要素 説明 java.lang.Stringname
-
任意要素の概要
任意要素 修飾子とタイプ 任意要素 説明 RequestType[]acceptsbooleanaccessControlAllowCredentialsjava.lang.StringaccessControlAllowOrignjava.lang.String[]allowRequestContentTypes許可するリクエストボディのContentType。longcacheControlMaxAgecacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定します。CacheControlTypecacheControlTypeWebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。booleancheckXRequestedWithHeaderCommandConfigcommandjava.lang.Stringdescriptionjava.lang.StringdisplayNamejava.lang.StringidlongmaxFileSizemultipart/form-dataの際のファイルの最大サイズ(バイト)。longmaxRequestBodySizeリクエストボディの最大サイズ(バイト)。MethodType[]methodsbooleanneedTrustedAuthenticatejava.lang.String[]oauthScopesbooleanoverwritableWebApiParamMapping[]paramMappingbooleanpermissionSharablebooleanprivilagedbooleanpublicWebApijava.lang.StringresponseTypeRestJsonrestJsonRestXmlrestXmljava.lang.String[]resultsStateTypestatebooleansupportBearerTokenbooleansynchronizeOnSessionこのAction処理をSessionにて同期化するか否か。WebApiTokenChecktokenCheckTokenCheck設定
-
-
-
-
cacheControlType
CacheControlType cacheControlType
WebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。- 戻り値:
- WebAPIのキャッシュ種別
- デフォルト:
- org.iplass.mtp.webapi.definition.CacheControlType.UNSPECIFIED
-
-
-
paramMapping
WebApiParamMapping[] paramMapping
- デフォルト:
- {}
-
-
-
command
CommandConfig command
- デフォルト:
- @org.iplass.mtp.command.annotation.CommandConfig
-
-
-
accepts
RequestType[] accepts
- デフォルト:
- {}
-
-
-
methods
MethodType[] methods
- デフォルト:
- {}
-
-
-
state
StateType state
- デフォルト:
- org.iplass.mtp.webapi.definition.StateType.STATEFUL
-
-
-
restJson
RestJson restJson
- デフォルト:
- @org.iplass.mtp.command.annotation.webapi.RestJson(parameterName="")
-
-
-
restXml
RestXml restXml
- デフォルト:
- @org.iplass.mtp.command.annotation.webapi.RestXml(parameterName="")
-
-
-
tokenCheck
WebApiTokenCheck tokenCheck
TokenCheck設定
デフォルトではTokenチェックは実行されません。- デフォルト:
- @org.iplass.mtp.command.annotation.webapi.WebApiTokenCheck(executeCheck=false)
-
-