パッケージ org.iplass.mtp.command.annotation.webapi

注釈インタフェース WebApi

@Repeatable(WebApis.class) @Retention(RUNTIME) @Target(TYPE) public @interface WebApi
WebAPIの定義。

  • 要素の詳細

    • id

      String id
      デフォルト:
      "##default"

    • name

      String name

    • displayName

      String displayName
      デフォルト:
      "##default"

    • description

      String description
      デフォルト:
      "##default"

    • cacheControlType

      CacheControlType cacheControlType
      WebAPIのキャッシュ種別（Cache-Controlヘッダの制御）を設定します。 デフォルトは、UNSPECIFIED（未指定）です。
      戻り値:
      WebAPIのキャッシュ種別
      デフォルト:
      UNSPECIFIED

    • cacheControlMaxAge

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

    • checkXRequestedWithHeader

      boolean checkXRequestedWithHeader
      デフォルト:
      true

    • privilaged

      @Deprecated boolean privilaged
      推奨されていません。
      privileged() を使用してください。
      デフォルト:
      false

    • privileged

      boolean privileged
      デフォルト:
      false

    • publicWebApi

      boolean publicWebApi
      デフォルト:
      false

    • overwritable

      boolean overwritable
      デフォルト:
      true

    • permissionSharable

      boolean permissionSharable
      デフォルト:
      false

    • accessControlAllowOrign

      @Deprecated String accessControlAllowOrign
      推奨されていません。
      accessControlAllowOrigin() を使用してください。
      デフォルト:
      ""

    • accessControlAllowOrigin

      String accessControlAllowOrigin
      デフォルト:
      ""

    • 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

      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だが、これは未指定を表す。 １つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。
      戻り値:
      デフォルト:
      -9223372036854775808L

    • state

      StateType state
      デフォルト:
      STATEFUL

    • supportBearerToken

      boolean supportBearerToken
      デフォルト:
      false

    • oauthScopes

      String[] oauthScopes
      デフォルト:
      {}

    • results

      @Deprecated(since="4.0.11", forRemoval=true) String[] results
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      responseResults() を利用してください。本メソッドは大きなバージョンアップの際に削除する予定です。
      デフォルト:
      {"result"}

    • responseResults

      WebApiResultAttribute[] responseResults
      WebAPIの結果に関する属性を設定します。
      戻り値:
      WebAPIの結果に関する属性
      デフォルト:
      {@org.iplass.mtp.command.annotation.webapi.WebApiResultAttribute(name="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

      String responseType
      デフォルト:
      ""

    • returnStubResponse

      boolean returnStubResponse
      スタブレスポンスを返却するかどうか。

      true を設定するとスタブレスポンスを返却します。デフォルトの設定値は false です。
      スタブレスポンスを返却する場合は、stubDefaultContent() / stubContents() を設定してください。

      注意事項

      プロパティに true を設定すると、常にスタブレスポンスを返却することになります。
      スタブレスポンスは、WebAPIの実装を行わずに、WebAPIの仕様を確認するために利用されます。
      そのため、本プロパティは通常は false に設定されていることを想定しています。

      戻り値:
      スタブレスポンスを返却するか。
      デフォルト:
      false

    • stubDefaultContent

      String stubDefaultContent
      スタブデフォルトコンテンツ。

      スタブレスポンスのデフォルト値を設定します。レスポンスには本設定値がそのまま指定されます。
      ここに設定する値は、responseType() で指定された content-type に対応する値を設定してください。

      stubContents() でコンテンツタイプに対応する値を取得できない場合のデフォルト値として動作します。

      戻り値:
      スタブデフォルトコンテンツ
      デフォルト:
      ""

    • stubContents

      WebApiStubContent[] stubContents
      スタブコンテンツ。

      スタブレスポンスを返却する場合に、コンテンツタイプに応じたスタブレスポンスを設定します。

      戻り値:
      スタブコンテンツ
      デフォルト:
      {}

    • openApiVersion

      String openApiVersion
      OpenAPI バージョン

      設定可能な値は OpenApiVersion で定義されている seriesVersion の値です（3.0, 3.1 など）。

      戻り値:
      OpenAPI バージョン
      デフォルト:
      ""

    • openApiFileType

      String openApiFileType
      OpenAPI ファイルタイプ

      設定可能な値は OpenApiFileType で定義されている列挙値の文字列です（JSON, YAML など）。

      戻り値:
      OpenAPI バージョン
      デフォルト:
      ""

    • openApi

      String openApi
      OpenAPI 定義
      戻り値:
      OpenAPI 定義
      デフォルト:
      ""