Annotation Type WebApi
-
@Repeatable(WebApis.class) @Retention(RUNTIME) @Target(TYPE) public @interface WebApi
WebAPIの定義。
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.Stringname
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description RequestType[]acceptsbooleanaccessControlAllowCredentialsjava.lang.StringaccessControlAllowOrignjava.lang.String[]allowRequestContentTypes許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)。
accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。longcacheControlMaxAgecacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定します。 デフォルト値は-1でこの場合はmax-ageは未指定となります。
注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されませんCacheControlTypecacheControlTypeWebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。booleancheckXRequestedWithHeaderCommandConfigcommandjava.lang.Stringdescriptionjava.lang.StringdisplayNamejava.lang.StringidlongmaxFileSizemultipart/form-dataの際のファイルの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。longmaxRequestBodySizeリクエストボディの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。MethodType[]methodsbooleanneedTrustedAuthenticatejava.lang.String[]oauthScopesbooleanoverwritableWebApiParamMapping[]paramMappingbooleanpermissionSharablebooleanprivilagedbooleanpublicWebApijava.lang.StringresponseTypeRestJsonrestJsonRestXmlrestXmljava.lang.String[]resultsStateTypestatebooleansupportBearerTokenbooleansynchronizeOnSessionこのAction処理をSessionにて同期化するか否か。デフォルトfalse。WebApiTokenChecktokenCheckTokenCheck設定
-
-
-
-
cacheControlType
CacheControlType cacheControlType
WebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。- Returns:
- WebAPIのキャッシュ種別
- Default:
- org.iplass.mtp.webapi.definition.CacheControlType.UNSPECIFIED
-
-
-
paramMapping
WebApiParamMapping[] paramMapping
- Default:
- {}
-
-
-
command
CommandConfig command
- Default:
- @org.iplass.mtp.command.annotation.CommandConfig
-
-
-
accepts
RequestType[] accepts
- Default:
- {}
-
-
-
methods
MethodType[] methods
- Default:
- {}
-
-
-
state
StateType state
- Default:
- org.iplass.mtp.webapi.definition.StateType.STATEFUL
-
-
-
restJson
RestJson restJson
- Default:
- @org.iplass.mtp.command.annotation.webapi.RestJson(parameterName="")
-
-
-
restXml
RestXml restXml
- Default:
- @org.iplass.mtp.command.annotation.webapi.RestXml(parameterName="")
-
-
-
tokenCheck
WebApiTokenCheck tokenCheck
TokenCheck設定
デフォルトではTokenチェックは実行されません。- Default:
- @org.iplass.mtp.command.annotation.webapi.WebApiTokenCheck(executeCheck=false)
-
-