WebApi (iplass-web 3.1.0 API)

@Repeatable(value=WebApis.class)
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface WebApi

WebAPIの定義。

必須要素のサマリー

必須要素
修飾子とタイプ必須要素と説明

java.lang.String name

必須要素
修飾子とタイプ	必須要素と説明
`java.lang.String`	`name`

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`RequestType[]`	`accepts`
`boolean`	`accessControlAllowCredentials`
`java.lang.String`	`accessControlAllowOrign`
`java.lang.String[]`	`allowRequestContentTypes` 許可するリクエストボディのContentType。
`long`	`cacheControlMaxAge` cacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age（秒）を指定します。
`CacheControlType`	`cacheControlType` WebAPIのキャッシュ種別（Cache-Controlヘッダの制御）を設定します。
`boolean`	`checkXRequestedWithHeader`
`CommandConfig`	`command`
`java.lang.String`	`description`
`java.lang.String`	`displayName`
`java.lang.String`	`id`
`long`	`maxFileSize` multipart/form-dataの際のファイルの最大サイズ（バイト）。
`long`	`maxRequestBodySize` リクエストボディの最大サイズ（バイト）。
`MethodType[]`	`methods`
`boolean`	`needTrustedAuthenticate`
`java.lang.String[]`	`oauthScopes`
`boolean`	`overwritable`
`WebApiParamMapping[]`	`paramMapping`
`boolean`	`permissionSharable`
`boolean`	`privilaged`
`boolean`	`publicWebApi`
`java.lang.String`	`responseType`
`RestJson`	`restJson`
`RestXml`	`restXml`
`java.lang.String[]`	`results`
`StateType`	`state`
`boolean`	`supportBearerToken`
`boolean`	`synchronizeOnSession` このAction処理をSessionにて同期化するか否か。
`WebApiTokenCheck`	`tokenCheck` TokenCheck設定デフォルトではTokenチェックは実行されません。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
- - id
```
public abstract java.lang.String id
```
    デフォルト:
    
    "##default"
- - displayName
```
public abstract java.lang.String displayName
```
    デフォルト:
    
    "##default"
- - description
```
public abstract java.lang.String description
```
    デフォルト:
    
    "##default"
- - cacheControlType
```
public abstract CacheControlType cacheControlType
```
    WebAPIのキャッシュ種別（Cache-Controlヘッダの制御）を設定します。デフォルトは、UNSPECIFIED（未指定）です。
    
    戻り値:
    
    WebAPIのキャッシュ種別
    
    デフォルト:
    
    org.iplass.mtp.webapi.definition.CacheControlType.UNSPECIFIED
- - cacheControlMaxAge
```
public abstract long cacheControlMaxAge
```
    cacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age（秒）を指定します。デフォルト値は-1でこの場合はmax-ageは未指定となります。
    注意：max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されません
    
    パラメータ:
    
    cacheControlMaxAge -
    
    デフォルト:
    
    -1L
- - checkXRequestedWithHeader
```
public abstract boolean checkXRequestedWithHeader
```
    デフォルト:
    
    true
- - privilaged
```
public abstract boolean privilaged
```
    デフォルト:
    
    false
- - publicWebApi
```
public abstract boolean publicWebApi
```
    デフォルト:
    
    false
- - overwritable
```
public abstract boolean overwritable
```
    デフォルト:
    
    true
- - permissionSharable
```
public abstract boolean permissionSharable
```
    デフォルト:
    
    false
- - accessControlAllowOrign
```
public abstract java.lang.String accessControlAllowOrign
```
    デフォルト:
    
    ""
- - accessControlAllowCredentials
```
public abstract boolean accessControlAllowCredentials
```
    デフォルト:
    
    false
- - needTrustedAuthenticate
```
public abstract boolean needTrustedAuthenticate
```
    デフォルト:
    
    false
- - paramMapping
```
public abstract WebApiParamMapping[] paramMapping
```
    デフォルト:
    
    {}
- - command
```
public abstract CommandConfig command
```
    デフォルト:
    
    <error>
- - accepts
```
public abstract RequestType[] accepts
```
    デフォルト:
    
    {}
- - methods
```
public abstract MethodType[] methods
```
    デフォルト:
    
    {}
- - allowRequestContentTypes
```
public abstract java.lang.String[] allowRequestContentTypes
```
    許可するリクエストボディのContentType。デフォルト未指定（＝すべて許可）。
    accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
    例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。
    
    デフォルト:
    
    {}
- - maxRequestBodySize
```
public abstract long maxRequestBodySize
```
    リクエストボディの最大サイズ（バイト）。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。
    
    戻り値:
    
    デフォルト:
    
    -9223372036854775808L
- - maxFileSize
```
public abstract long maxFileSize
```
    multipart/form-dataの際のファイルの最大サイズ（バイト）。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。１つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。
    
    戻り値:
    
    デフォルト:
    
    -9223372036854775808L
- - state
```
public abstract StateType state
```
    デフォルト:
    
    org.iplass.mtp.webapi.definition.StateType.STATEFUL
- - supportBearerToken
```
public abstract boolean supportBearerToken
```
    デフォルト:
    
    false
- - oauthScopes
```
public abstract java.lang.String[] oauthScopes
```
    デフォルト:
    
    {}
- - results
```
public abstract java.lang.String[] results
```
    デフォルト:
    
    "result"
- - restJson
```
public abstract RestJson restJson
```
    デフォルト:
    
    @org.iplass.mtp.command.annotation.webapi.RestJson(parameterName="")
- - restXml
```
public abstract RestXml restXml
```
    デフォルト:
    
    @org.iplass.mtp.command.annotation.webapi.RestXml(parameterName="")
- - tokenCheck
```
public abstract WebApiTokenCheck tokenCheck
```
    TokenCheck設定
    デフォルトではTokenチェックは実行されません。
    
    デフォルト:
    
    @org.iplass.mtp.command.annotation.webapi.WebApiTokenCheck(executeCheck=false)
- - synchronizeOnSession
```
public abstract boolean synchronizeOnSession
```
    このAction処理をSessionにて同期化するか否か。デフォルトfalse。
    
    戻り値:
    
    デフォルト:
    
    false
- - responseType
```
public abstract java.lang.String responseType
```
    デフォルト:
    
    ""

注釈型 WebApi

必須要素のサマリー

任意要素のサマリー

要素の詳細

name

id

displayName

description

cacheControlType

cacheControlMaxAge

checkXRequestedWithHeader

privilaged

publicWebApi

overwritable

permissionSharable

accessControlAllowOrign

accessControlAllowCredentials

needTrustedAuthenticate

paramMapping

command

accepts

methods

allowRequestContentTypes

maxRequestBodySize

maxFileSize

state

supportBearerToken

oauthScopes

results

restJson

restXml

tokenCheck

synchronizeOnSession

responseType