Package org.nuxeo.ecm.core.bulk

Class BulkAdminServiceImpl

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	Description
protected final List<String>	actions
protected Map<String,BulkActionValidation>	actionValidations
static final String	BULK_SCROLL_KEEP_ALIVE_PROPERTY
static final String	BULK_SCROLL_PRODUCE_IMMEDIATE_PROPERTY
static final String	BULK_SCROLL_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY
static final String	BULK_SCROLL_SIZE_PROPERTY
static final String	BULK_SCROLL_TRANSACTION_TIMEOUT_PROPERTY
static final String	BULK_SERVICE_PROCESSOR_NAME
static final int	DEFAULT_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY
static final int	DEFAULT_SCROLL_KEEP_ALIVE
static final int	DEFAULT_SCROLL_SIZE
static final Duration	DEFAULT_SCROLL_TRANSACTION_TIMEOUT
protected final Map<String,BulkActionDescriptor>	descriptors
static final String	SCROLLER_NAME
static final String	STATUS_NAME
static final Duration	STOP_DURATION
protected StreamProcessor	streamProcessor

Constructor Summary

Constructors

Constructor	Description
BulkAdminServiceImpl(List<BulkActionDescriptor> descriptorsList)

Method Summary

Modifier and Type	Method	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)
Duration	getBatchTransactionTimeout(String action)	Returns the transaction timeout to use to process a batch.
int	getBucketSize(String action)
String	getDefaultScroller(String action)
String	getInputStream(String action)
Long	getQueryLimit(String action)	Returns the default query limit for the bulk action.
boolean	isExclusive(String actionId)	Returns true if action is exclusive and only one of such command per repository can be scheduled or running.
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 of this action need to be scrolled sequentially.
boolean	isSequentialProcessing(String actionId)	Returns true if command processing for this action should be done sequentially.
boolean	isSequentialScroll(String actionId)	Returns true if commands of this action need to be scrolled sequentially.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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_SERVICE_PROCESSOR_NAME

public static final String BULK_SERVICE_PROCESSOR_NAME

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_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY

public static final String BULK_SCROLL_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY

See Also:

• Constant Field Values

DEFAULT_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY

public static final int DEFAULT_PRODUCE_IMMEDIATE_THRESHOLD_PROPERTY

See Also:

• Constant Field Values

DEFAULT_SCROLL_SIZE

public static final int DEFAULT_SCROLL_SIZE

See Also:

• Constant Field Values

DEFAULT_SCROLL_KEEP_ALIVE

public static final int DEFAULT_SCROLL_KEEP_ALIVE

See Also:

• Constant Field Values

BULK_SCROLL_TRANSACTION_TIMEOUT_PROPERTY

public static final String BULK_SCROLL_TRANSACTION_TIMEOUT_PROPERTY

See Also:

• Constant Field Values

DEFAULT_SCROLL_TRANSACTION_TIMEOUT

public static final Duration DEFAULT_SCROLL_TRANSACTION_TIMEOUT

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 Details

BulkAdminServiceImpl

public BulkAdminServiceImpl(List<BulkActionDescriptor> descriptorsList)

Method Details

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

getBatchTransactionTimeout

public Duration getBatchTransactionTimeout(String action)

Description copied from interface: BulkAdminService

Returns the transaction timeout to use to process a batch.

Specified by:

getBatchTransactionTimeout in interface BulkAdminService

getQueryLimit

public Long getQueryLimit(String action)

Description copied from interface: BulkAdminService

Returns the default query limit for the bulk action.

Specified by:

getQueryLimit in interface BulkAdminService

getDefaultScroller

public String getDefaultScroller(String action)

Specified by:

getDefaultScroller in interface BulkAdminService

getInputStream

public String getInputStream(String action)

Specified by:

getInputStream 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 of this action need to be scrolled sequentially.

Specified by:

isSequentialCommands in interface BulkAdminService

isSequentialScroll

public boolean isSequentialScroll(String actionId)

Description copied from interface: BulkAdminService

Returns true if commands of this action need to be scrolled sequentially.

Specified by:

isSequentialScroll in interface BulkAdminService

isSequentialProcessing

public boolean isSequentialProcessing(String actionId)

Description copied from interface: BulkAdminService

Returns true if command processing for this action should be done sequentially.

Specified by:

isSequentialProcessing in interface BulkAdminService

isExclusive

public boolean isExclusive(String actionId)

Description copied from interface: BulkAdminService

Returns true if action is exclusive and only one of such command per repository can be scheduled or running.

Specified by:

isExclusive 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()