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.String name  
    • Element Detail

      • name

        java.lang.String name
      • id

        java.lang.String id
        Default:
        "##default"
      • displayName

        java.lang.String displayName
        Default:
        "##default"
      • description

        java.lang.String description
        Default:
        "##default"
      • cacheControlType

        CacheControlType cacheControlType
        WebAPIのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。
        Returns:
        WebAPIのキャッシュ種別
        Default:
        org.iplass.mtp.webapi.definition.CacheControlType.UNSPECIFIED
      • cacheControlMaxAge

        long cacheControlMaxAge
        cacheControlType=CACHEを指定した場合の WebAPIキャッシュのmax-age(秒)を指定します。 デフォルト値は-1でこの場合はmax-ageは未指定となります。
        注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されません
        Parameters:
        cacheControlMaxAge -
        Default:
        -1L
      • checkXRequestedWithHeader

        boolean checkXRequestedWithHeader
        Default:
        true
      • privilaged

        boolean privilaged
        Default:
        false
      • publicWebApi

        boolean publicWebApi
        Default:
        false
      • overwritable

        boolean overwritable
        Default:
        true
      • permissionSharable

        boolean permissionSharable
        Default:
        false
      • accessControlAllowOrign

        java.lang.String accessControlAllowOrign
        Default:
        ""
      • accessControlAllowCredentials

        boolean accessControlAllowCredentials
        Default:
        false
      • needTrustedAuthenticate

        boolean needTrustedAuthenticate
        Default:
        false
      • command

        CommandConfig command
        Default:
        @org.iplass.mtp.command.annotation.CommandConfig
      • allowRequestContentTypes

        java.lang.String[] allowRequestContentTypes
        許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)。
        accepts指定より、allowRequestContentTypesの指定による制限が優先されます。
        例えば、 accepts指定によりJSON形式の処理が有効化されている場合において、 allowRequestContentTypesに"application/json"が含まれない場合は、 JSON形式によるリクエストは処理されません。
        Default:
        {}
      • maxRequestBodySize

        long maxRequestBodySize
        リクエストボディの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。
        Returns:
        Default:
        -9223372036854775808L
      • maxFileSize

        long maxFileSize
        multipart/form-dataの際のファイルの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。
        Returns:
        Default:
        -9223372036854775808L
      • state

        StateType state
        Default:
        org.iplass.mtp.webapi.definition.StateType.STATEFUL
      • supportBearerToken

        boolean supportBearerToken
        Default:
        false
      • oauthScopes

        java.lang.String[] oauthScopes
        Default:
        {}
      • results

        java.lang.String[] results
        Default:
        {"result"}
      • 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)
      • synchronizeOnSession

        boolean synchronizeOnSession
        このAction処理をSessionにて同期化するか否か。デフォルトfalse。
        Returns:
        Default:
        false
      • responseType

        java.lang.String responseType
        Default:
        ""