注釈型 WebApi


@Repeatable(WebApis.class)
@Retention(RUNTIME)
@Target(TYPE)
public @interface WebApi
WebAPIの定義。
  • 要素の詳細

    • name

      java.lang.String name
    • id

      java.lang.String id
      デフォルト:
      "##default"
    • displayName

      java.lang.String displayName
      デフォルト:
      "##default"
    • description

      java.lang.String description
      デフォルト:
      "##default"
    • cacheControlType

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

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

      boolean checkXRequestedWithHeader
      デフォルト:
      true
    • privilaged

      boolean privilaged
      デフォルト:
      false
    • publicWebApi

      boolean publicWebApi
      デフォルト:
      false
    • overwritable

      boolean overwritable
      デフォルト:
      true
    • permissionSharable

      boolean permissionSharable
      デフォルト:
      false
    • accessControlAllowOrign

      java.lang.String accessControlAllowOrign
      デフォルト:
      ""
    • accessControlAllowCredentials

      boolean accessControlAllowCredentials
      デフォルト:
      false
    • needTrustedAuthenticate

      boolean needTrustedAuthenticate
      デフォルト:
      false
    • paramMapping

      WebApiParamMapping[] paramMapping
      デフォルト:
      {}
    • command

      CommandConfig command
      デフォルト:
      @org.iplass.mtp.command.annotation.CommandConfig
    • accepts

      RequestType[] accepts
      デフォルト:
      {}
    • methods

      MethodType[] methods
      デフォルト:
      {}
    • allowRequestContentTypes

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

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

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

      StateType state
      デフォルト:
      org.iplass.mtp.webapi.definition.StateType.STATEFUL
    • supportBearerToken

      boolean supportBearerToken
      デフォルト:
      false
    • oauthScopes

      java.lang.String[] oauthScopes
      デフォルト:
      {}
    • results

      java.lang.String[] results
      デフォルト:
      {"result"}
    • 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)
    • synchronizeOnSession

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

      java.lang.String responseType
      デフォルト:
      ""