Package org.nuxeo.ecm.core.bulk

Interface BulkAdminService

All Known Implementing Classes:
BulkAdminServiceImpl
public interface BulkAdminService
The Bulk admin service, it's an internal service in order to access configuration from Bulk Action Framework.
Since:
10.2

  • Method Details

    • getActions

      List<String> getActions()
      Returns a list of declared bulk actions. By design a bulk action listen the stream of its own name.
      Returns:
      a list of declared bulk actions

    • getBucketSize

      int getBucketSize(String action)

    • getBatchSize

      int getBatchSize(String action)

    • getBatchTransactionTimeout

      Duration getBatchTransactionTimeout(String action)
      Returns the transaction timeout to use to process a batch.
      Since:
      11.5

    • getQueryLimit

      Long getQueryLimit(String action)
      Returns the default query limit for the bulk action.
      Since:
      11.4

    • getDefaultScroller

      String getDefaultScroller(String action)
      Since:
      11.1

    • getInputStream

      String getInputStream(String action)
      Since:
      11.1

    • isHttpEnabled

      boolean isHttpEnabled(String actionId)
      Returns true if the action id is to be accessible through http API.
      Since:
      10.3

    • isSequentialCommands

      @Deprecated boolean isSequentialCommands(String actionId)
      Deprecated.
      since 2021.45, use isSequentialScroll(String) instead.
      Returns true if commands of this action need to be scrolled sequentially.
      Since:
      10.3

    • isSequentialScroll

      boolean isSequentialScroll(String actionId)
      Returns true if commands of this action need to be scrolled sequentially.
      Since:
      2021.45

    • isSequentialProcessing

      boolean isSequentialProcessing(String actionId)
      Returns true if command processing for this action should be done sequentially.
      Since:
      2021.45

    • isExclusive

      boolean isExclusive(String actionId)
      Returns true if action is exclusive and only one of such command per repository can be scheduled or running.
      Since:
      2021.45

    • getActionValidation

      BulkActionValidation getActionValidation(String action)
      Gets the validation class of an action.
      Since:
      10.10