BulkAdminServiceImpl (Nuxeo ECM Projects 10.10 API)

java.lang.Object
- org.nuxeo.ecm.core.bulk.BulkAdminServiceImpl

All Implemented Interfaces:: BulkAdminService

public class BulkAdminServiceImpl
extends Object
implements BulkAdminService

Since:: 10.3

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`actions`
`protected Map<String,BulkActionValidation>`	`actionValidations`
`static String`	`BULK_SCROLL_CONTINUE_ON_FAILURE_PROPERTY`
`static String`	`BULK_SCROLL_KEEP_ALIVE_PROPERTY`
`static String`	`BULK_SCROLL_PRODUCE_IMMEDIATE_PROPERTY`
`static String`	`BULK_SCROLL_SIZE_PROPERTY`
`static String`	`BULK_SCROLLER_CONCURRENCY_PROPERTY`
`static String`	`BULK_STATUS_CONCURRENCY_PROPERTY`
`static String`	`BULK_STATUS_CONTINUE_ON_FAILURE_PROPERTY`
`static String`	`BULK_STATUS_DELAY_PROPERTY`
`static String`	`BULK_STATUS_MAX_DELAY_PROPERTY`
`static String`	`BULK_STATUS_MAX_RETRIES_PROPERTY`
`static String`	`DEFAULT_SCROLL_KEEP_ALIVE`
`static String`	`DEFAULT_SCROLL_PRODUCE_IMMEDIATE`
`static String`	`DEFAULT_SCROLL_SIZE`
`static String`	`DEFAULT_SCROLLER_CONCURRENCY`
`static String`	`DEFAULT_STATUS_CONCURRENCY`
`static String`	`DEFAULT_STATUS_DELAY_MILLIS`
`static String`	`DEFAULT_STATUS_MAX_DELAY_MILLIS`
`static String`	`DEFAULT_STATUS_MAX_RETRIES`
`protected Map<String,BulkActionDescriptor>`	`descriptors`
`static String`	`SCROLLER_NAME`
`static String`	`STATUS_NAME`
`static Duration`	`STOP_DURATION`
`protected StreamProcessor`	`streamProcessor`

Constructor Summary

Constructors
Constructor and Description

BulkAdminServiceImpl(List<BulkActionDescriptor> descriptorsList)

Constructors
Constructor and Description
`BulkAdminServiceImpl(List<BulkActionDescriptor> descriptorsList)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterStart()`
`void`	`beforeStop()`
`List<String>`	`getActions()` Returns a list of declared bulk actions.
`BulkActionValidation`	`getActionValidation(String action)` Gets the validation class of an action.
`int`	`getBatchSize(String action)`
`int`	`getBucketSize(String action)`
`protected Topology`	`getTopology(int scrollBatchSize, int scrollKeepAlive, boolean scrollProduceImmediate)`
`protected void`	`initProcessor()`
`boolean`	`isHttpEnabled(String actionId)` Returns true if the action id is to be accessible through http API.
`boolean`	`isSequentialCommands(String actionId)` Returns true if commands about this action need to be executed sequentially instead of being run concurrently.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCROLLER_NAME
```
public static final String SCROLLER_NAME
```
    See Also:
    
    Constant Field Values
  - STATUS_NAME
```
public static final String STATUS_NAME
```
    See Also:
    
    Constant Field Values
  - BULK_SCROLLER_CONCURRENCY_PROPERTY
```
public static final String BULK_SCROLLER_CONCURRENCY_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_STATUS_CONCURRENCY_PROPERTY
```
public static final String BULK_STATUS_CONCURRENCY_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_STATUS_CONTINUE_ON_FAILURE_PROPERTY
```
public static final String BULK_STATUS_CONTINUE_ON_FAILURE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_STATUS_MAX_RETRIES_PROPERTY
```
public static final String BULK_STATUS_MAX_RETRIES_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_STATUS_DELAY_PROPERTY
```
public static final String BULK_STATUS_DELAY_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_STATUS_MAX_DELAY_PROPERTY
```
public static final String BULK_STATUS_MAX_DELAY_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_SCROLL_SIZE_PROPERTY
```
public static final String BULK_SCROLL_SIZE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_SCROLL_KEEP_ALIVE_PROPERTY
```
public static final String BULK_SCROLL_KEEP_ALIVE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_SCROLL_PRODUCE_IMMEDIATE_PROPERTY
```
public static final String BULK_SCROLL_PRODUCE_IMMEDIATE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BULK_SCROLL_CONTINUE_ON_FAILURE_PROPERTY
```
public static final String BULK_SCROLL_CONTINUE_ON_FAILURE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_CONCURRENCY
```
public static final String DEFAULT_STATUS_CONCURRENCY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_MAX_RETRIES
```
public static final String DEFAULT_STATUS_MAX_RETRIES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_DELAY_MILLIS
```
public static final String DEFAULT_STATUS_DELAY_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STATUS_MAX_DELAY_MILLIS
```
public static final String DEFAULT_STATUS_MAX_DELAY_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCROLLER_CONCURRENCY
```
public static final String DEFAULT_SCROLLER_CONCURRENCY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCROLL_SIZE
```
public static final String DEFAULT_SCROLL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCROLL_KEEP_ALIVE
```
public static final String DEFAULT_SCROLL_KEEP_ALIVE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCROLL_PRODUCE_IMMEDIATE
```
public static final String DEFAULT_SCROLL_PRODUCE_IMMEDIATE
```
    See Also:
    
    Constant Field Values
  - STOP_DURATION
```
public static final Duration STOP_DURATION
```
  - descriptors
```
protected final Map<String,BulkActionDescriptor> descriptors
```
  - actions
```
protected final List<String> actions
```
  - streamProcessor
```
protected StreamProcessor streamProcessor
```
  - actionValidations
```
protected Map<String,BulkActionValidation> actionValidations
```
- Constructor Detail
  - BulkAdminServiceImpl
```
public BulkAdminServiceImpl(List<BulkActionDescriptor> descriptorsList)
```
- Method Detail
  - initProcessor
```
protected void initProcessor()
```
  - getTopology
```
protected Topology getTopology(int scrollBatchSize,
                               int scrollKeepAlive,
                               boolean scrollProduceImmediate)
```
  - getActions
```
public List<String> getActions()
```
    Description copied from interface: BulkAdminService
    
    Returns a list of declared bulk actions. By design a bulk action listen the stream of its own name.
    
    Specified by:
    
    getActions in interface BulkAdminService
    
    Returns:
    
    a list of declared bulk actions
  - getBucketSize
```
public int getBucketSize(String action)
```
    Specified by:
    
    getBucketSize in interface BulkAdminService
  - getBatchSize
```
public int getBatchSize(String action)
```
    Specified by:
    
    getBatchSize in interface BulkAdminService
  - isHttpEnabled
```
public boolean isHttpEnabled(String actionId)
```
    Description copied from interface: BulkAdminService
    
    Returns true if the action id is to be accessible through http API.
    
    Specified by:
    
    isHttpEnabled in interface BulkAdminService
  - isSequentialCommands
```
public boolean isSequentialCommands(String actionId)
```
    Description copied from interface: BulkAdminService
    
    Returns true if commands about this action need to be executed sequentially instead of being run concurrently.
    
    Specified by:
    
    isSequentialCommands in interface BulkAdminService
  - getActionValidation
```
public BulkActionValidation getActionValidation(String action)
```
    Description copied from interface: BulkAdminService
    
    Gets the validation class of an action.
    
    Specified by:
    
    getActionValidation in interface BulkAdminService
  - afterStart
```
public void afterStart()
```
  - beforeStop
```
public void beforeStop()
```

Class BulkAdminServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCROLLER_NAME

STATUS_NAME

BULK_SCROLLER_CONCURRENCY_PROPERTY

BULK_STATUS_CONCURRENCY_PROPERTY

BULK_STATUS_CONTINUE_ON_FAILURE_PROPERTY

BULK_STATUS_MAX_RETRIES_PROPERTY

BULK_STATUS_DELAY_PROPERTY

BULK_STATUS_MAX_DELAY_PROPERTY

BULK_SCROLL_SIZE_PROPERTY

BULK_SCROLL_KEEP_ALIVE_PROPERTY

BULK_SCROLL_PRODUCE_IMMEDIATE_PROPERTY

BULK_SCROLL_CONTINUE_ON_FAILURE_PROPERTY

DEFAULT_STATUS_CONCURRENCY

DEFAULT_STATUS_MAX_RETRIES

DEFAULT_STATUS_DELAY_MILLIS

DEFAULT_STATUS_MAX_DELAY_MILLIS

DEFAULT_SCROLLER_CONCURRENCY

DEFAULT_SCROLL_SIZE

DEFAULT_SCROLL_KEEP_ALIVE

DEFAULT_SCROLL_PRODUCE_IMMEDIATE

STOP_DURATION

descriptors

actions

streamProcessor

actionValidations

Constructor Detail

BulkAdminServiceImpl

Method Detail

initProcessor

getTopology

getActions

getBucketSize

getBatchSize

isHttpEnabled

isSequentialCommands

getActionValidation

afterStart

beforeStop