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

注釈型 ActionMapping

@Repeatable(ActionMappings.class)
@Retention(RUNTIME)
@Target(TYPE)
public @interface ActionMapping
ActionMappingを定義するアノテーションです。
関連項目:
ActionMappingDefinition

  • 要素の詳細

    • name

      java.lang.String name

    • id

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

    • displayName

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

    • localizedDisplayName

      LocalizedString[] localizedDisplayName
      デフォルト:
      {}

    • description

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

    • clientCacheType

      ActionMapping.ClientCacheType clientCacheType
      クライアントのキャッシュ種別（Cache-Controlヘッダの制御）を設定します。 デフォルトは、UNSPECIFIED（未指定）です。
      戻り値:
      デフォルト:
      org.iplass.mtp.command.annotation.action.ActionMapping.ClientCacheType.UNSPECIFIED

    • clientCacheMaxAge

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

    • allowMethod

      HttpMethodType[] allowMethod
      許可するHTTP Methodの設定です。 未指定の場合は、すべて許可となります。 デフォルト未指定（＝すべて許可）です。
      デフォルト:
      {}

    • allowRequestContentTypes

      java.lang.String[] allowRequestContentTypes
      許可するリクエストボディのContentType。デフォルト未指定（＝すべて許可）
      デフォルト:
      {}

    • maxRequestBodySize

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

    • maxFileSize

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

    • needTrustedAuthenticate

      boolean needTrustedAuthenticate
      デフォルト:
      false

    • parts

      boolean parts
      このActionMappingで指定される表示処理が部品かどうかを設定します。 trueをセットした場合、クライアントからの直接呼出しが不可となります。 デフォルトfalseです。
      戻り値:
      デフォルト:
      false

    • privilaged

      @Deprecated boolean privilaged
      推奨されていません。
      privileged() を使用してください。
      このActionMappingで処理されるCommand,Templateを特権（セキュリティ制約を受けない）にて処理するかどうかを設定します。 デフォルトはfalseです。 publicActionとの違いは、Entity権限など、すべての権限が許可された状態で実行されます。
      戻り値:
      デフォルト:
      false

    • privileged

      boolean privileged
      このActionMappingで処理されるCommand,Templateを特権（セキュリティ制約を受けない）にて処理するかどうかを設定します。 デフォルトはfalseです。 publicActionとの違いは、Entity権限など、すべての権限が許可された状態で実行されます。
      戻り値:
      デフォルト:
      false

    • publicAction

      boolean publicAction
      このActionの呼び出しをAction権限設定によらず呼び出し可能にする場合は、trueを設定します。 isPrivilegedとの違いは、Entityの操作などAction権限以外の権限がチェックされる状況においては、 セキュリティ制約を受けます。 デフォルトはfalseです。
      戻り値:
      デフォルト:
      false

    • overwritable

      boolean overwritable
      デフォルト:
      true

    • permissionSharable

      boolean permissionSharable
      デフォルト:
      false

    • paramMapping

      ParamMapping[] paramMapping
      デフォルト:
      {}

    • command

      CommandConfig[] command
      実行するCommandを設定します。 compositeCommandが設定されている場合は、compositeCommandの設定が優先されます。 複数のCommandConnfigが設定された場合は、単純に順番に実行します。 また、Command実行結果は最後のCommandの結果が返却されます。
      戻り値:
      デフォルト:
      {@org.iplass.mtp.command.annotation.CommandConfig}

    • compositeCommand

      CompositeCommandConfig compositeCommand
      複合Commandを利用する場合の設定です。
      戻り値:
      デフォルト:
      @org.iplass.mtp.command.annotation.CompositeCommandConfig

    • result

      Result[] result
      Command実行後の表示処理の定義です。
      戻り値:
      デフォルト:
      {}

    • tokenCheck

      TokenCheck tokenCheck

      TokenCheck設定

      デフォルトではTokenチェックは実行されません。
      デフォルト:
      @org.iplass.mtp.command.annotation.action.TokenCheck(executeCheck=false)

    • cacheCriteria

      CacheCriteria cacheCriteria
      サーバサイドのキャッシュ設定です。
      戻り値:
      デフォルト:
      @org.iplass.mtp.command.annotation.action.cache.CacheCriteria

    • synchronizeOnSession

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