Annotation Type ActionMapping

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      HttpMethodType[] allowMethod
      許可するHTTP Methodの設定です。 未指定の場合は、すべて許可となります。 デフォルト未指定(=すべて許可)です。
      java.lang.String[] allowRequestContentTypes
      許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)
      CacheCriteria cacheCriteria
      サーバサイドのキャッシュ設定です。
      long clientCacheMaxAge
      clientCacheType=CACHEを指定した場合の クライアントキャッシュのmax-age(秒)を指定します。 デフォルト値は-1でこの場合はmax-ageは未指定となります。
      注意:max-age未指定の場合、FF、Chromeでは実際はキャッシュが利用されません
      ActionMapping.ClientCacheType clientCacheType
      クライアントのキャッシュ種別(Cache-Controlヘッダの制御)を設定します。 デフォルトは、UNSPECIFIED(未指定)です。
      CommandConfig[] command
      実行するCommandを設定します。 compositeCommandが設定されている場合は、compositeCommandの設定が優先されます。 複数のCommandConnfigが設定された場合は、単純に順番に実行します。 また、Command実行結果は最後のCommandの結果が返却されます。
      CompositeCommandConfig compositeCommand
      複合Commandを利用する場合の設定です。
      java.lang.String description  
      java.lang.String displayName  
      java.lang.String id  
      LocalizedString[] localizedDisplayName  
      long maxFileSize
      multipart/form-dataの際のファイルの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。 1つのファイルに対する最大サイズなので、複数のファイルの合計サイズを制限したい場合は、 maxRequestBodySizeを設定します。
      long maxRequestBodySize
      リクエストボディの最大サイズ(バイト)。-1の場合は無制限を表す。 annotation上ではデフォルト値はLong.MIN_VALUEだが、これは未指定を表す。
      boolean needTrustedAuthenticate  
      boolean overwritable  
      ParamMapping[] paramMapping  
      boolean parts
      このActionMappingで指定される表示処理が部品かどうかを設定します。 trueをセットした場合、クライアントからの直接呼出しが不可となります。 デフォルトfalseです。
      boolean permissionSharable  
      boolean privilaged
      このActionMappingで処理されるCommand,Templateを特権(セキュリティ制約を受けない)にて処理するかどうかを設定します。 デフォルトはfalseです。 publicActionとの違いは、Entity権限など、すべての権限が許可された状態で実行されます。
      boolean publicAction
      このActionの呼び出しをAction権限設定によらず呼び出し可能にする場合は、trueを設定します。 isPrivilagedとの違いは、Entityの操作などAction権限以外の権限がチェックされる状況においては、 セキュリティ制約を受けます。 デフォルトはfalseです。
      Result[] result
      Command実行後の表示処理の定義です。
      boolean synchronizeOnSession
      このAction処理をSessionにて同期化するか否かを設定します。 デフォルトfalseです。
      TokenCheck tokenCheck
      TokenCheck設定
    • 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"
      • clientCacheType

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

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

        HttpMethodType[] allowMethod
        許可するHTTP Methodの設定です。 未指定の場合は、すべて許可となります。 デフォルト未指定(=すべて許可)です。
        Default:
        {}
      • allowRequestContentTypes

        java.lang.String[] allowRequestContentTypes
        許可するリクエストボディのContentType。デフォルト未指定(=すべて許可)
        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
      • needTrustedAuthenticate

        boolean needTrustedAuthenticate
        Default:
        false
      • parts

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

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

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

        boolean overwritable
        Default:
        true
      • permissionSharable

        boolean permissionSharable
        Default:
        false
      • command

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

        CompositeCommandConfig compositeCommand
        複合Commandを利用する場合の設定です。
        Returns:
        Default:
        @org.iplass.mtp.command.annotation.CompositeCommandConfig
      • result

        Result[] result
        Command実行後の表示処理の定義です。
        Returns:
        Default:
        {}
      • tokenCheck

        TokenCheck tokenCheck

        TokenCheck設定

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

        CacheCriteria cacheCriteria
        サーバサイドのキャッシュ設定です。
        Returns:
        Default:
        @org.iplass.mtp.command.annotation.action.cache.CacheCriteria
      • synchronizeOnSession

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