Package com._1c.g5.v8.internal.derived.pipeline

Class AsyncProcessingPipeline

java.lang.Object

com._1c.g5.v8.internal.derived.pipeline.AsyncProcessingPipeline

All Implemented Interfaces:

IAsyncProcessingPipeline

public final class AsyncProcessingPipeline
extends Object
implements IAsyncProcessingPipeline

Standard implementation of the DD async pipeline.

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<DerivedDataSegmentBucket,String>	OPERATION_SEGMENTS

Method Summary

Modifier and Type	Method	Description
boolean	areAllSegmentsComputed()	Checks if all segments are computed.
void	bindTaskToAnActiveOperationIfApplicable(Object bmOperationHandle)	Binds the BM task to the manually created operation
void	blockPipeline()	Blocks pipeline computations due to external reasons.
OperationContext	completeAutoWrappingOperationIfApplicable(Object bmOperationHandle)	Finishes the auto-wrapping operation if any for the given BM operation handle
void	confirm(String segmentId, Object objectId)	Confirms processing of the specified context collection.
static AsyncProcessingPipeline	create(Collection<DerivedDataSegmentDefinition> segmentDefinitions, Collection<DerivedDataSegmentDefinitionV2> segmentDefinitionsV2, IDerivedDataServiceLockController lockController, String modelId, AsyncPipelineModalModeAccessor modalModeAccessor)	Creates an instance of the async derived data processing pipeline
void	deactivateContexts(String segmentId)	Deactivates contexts of a specified pipeline segment.
void	disableAutoWrapping()	Disables auto-wrapping of BM tasks with operations for the current thread.
void	dumpPipelineState(IDerivedDataContextManager contextManager)
void	enableAutoWrapping()	Enables an auto-wrapping of BM tasks with orchestrator operations for the current thread.
AsyncProcessingTask	gather()	Gather next derived data processing task.
DerivedDataSegmentBucket	getActiveNonPriorityTasksResetRequiredStage()	Checks if a supplier requests a reset of currently computed non-priority tasks (e.g. due to more prioritable operation is appeared)
DerivedDataSegmentBucket	getActivePipelineStage()	Gets the current stage of the DD async. pipeline.
PipelineStatus	getActivePipelineStatus()	Gets the current status of the DD async. pipeline.
DerivedDataSegmentBucket	getActiveStageLock()	Gets active stage lock (if any)
MultithreadingComputationPolicy	getCurrentMultiThreadingComputePolicy()	Gets the multithreading computation policy for the current state of the pipeline.
List<String>	getCurrentSegmentIds()	Gets the set of segments the pipeline works on at the moment.
Set<String>	getReadySegments()	Gets ready (computed) DD segments.
int	getRemainingUnitsOfWork(String segmentId)	Gets the number of remaining work units for the given segment.
String	getSegmentName(String segmentId)	Gets the human-readable name (localizable) for the given DD segment,
PipelineStatus	getStatus()	Gets the current status of the DD async. pipeline.
int	getTotalUnitsOfWork(String segmentId)	Gets the total number of work units for the given DD segment.
OperationContext	getWrappingOperation()	Gets the current BM task wrapping operation (if any)
boolean	hasOperation(Object handle)	Checks if the pipeline has a scheduled operation
boolean	hasPriorityTasks()	Checks if the pipeline has priority tasks ready to be computed at the moment
boolean	hasRunningComputations()	Checks if the DD subsystem already scheduled some DD tasks for the computation.
void	increasePriority(String segmentId, long bmObjectId)	Increases the priority of computation for the given BM object in a specified DD segment.
void	increasePriority(Collection<String> segments)	Increase priority of all segments being supplied as a scope
void	increasePriority(Map<Object,Collection<String>> scope)	Increases the priority of computation for the given scope
boolean	inSync()	Checks if the pipeline performs processing of DerivedDataSegmentBucket.SYNC stage
boolean	isBlockedExternally()	Checks if the pipeline is blocked externally
boolean	isLongRunningSegment(String segmentId)	Checks if the requested DD segment is a long-running one (so the progress indication should be comprehensible to the user).
boolean	isOperationActiveInThread()	Checks if there is an orchestrated operation being active in the client thread.
boolean	isSegmentComputed(String segmentId)	Checks if the DD segment is computed completely.
void	markActiveOperationAsAutoWrapping()	Marks the operation as an auto-wrapping one.
void	markAsModalOperationParticipant()	Marks the current thread explicitly as a participant of the modal operation.
void	prepareForClose()	Prepares the pipeline for the closing.
void	registerActiveOperation(OperationContext context)	Registers the active operation context for the current thread
void	remove(Object objectId)	Removes all context from the async. pipeline for the given object (e.g. during removal of the object).
void	removeOperation(Object handle)	Removes a previously scheduled operation from the pipeline.
String	renderStatusText(String currentSegmentId)	Renders status text for the given segment.
void	resetActivePipelineStatus()	Resets the active pipeline status.
void	resetActiveWrappingOperationContext(OperationContext operationContext)	Resets the binding of an operation to the current thread
void	resetPipelineStatus()	Re-sets the pipeline status, pipeline position, etc.
void	resetStageLock(DerivedDataSegmentBucket stage)	Resets the stage lock, if any
void	schedule(Collection<IObjectDerivedDataContext> updatedContexts, Object modalOperationContext)	Schedules the updated derived data contexts into the pipeline.
void	setImplicitWaitingContext(List<IObjectDerivedDataContext> changedContexts)	Sets the implicit waiting context to the current wrapping operation (if any)
StageLockRequestResult	setStageLock(DerivedDataSegmentBucket stage, boolean allowDataComputing)	Sets the stage lock for a specified stage of async pipeline.
void	start(BiConsumer<String,Object> unlockNotifier)	Starts a pipeline with additional callbacks required by the computation process
void	startMassiveComputing()	Enables the massive computing mode for the DD pipeline.
void	stop()	Stops the pipeline, performing all shutdown sequence processing.
void	unblockPipeline()	Unblocks pileline computations due to clearing of external blocking reasons.
void	unlock(String segmentId, Object objectId)	Unlocks segments task for the given object.
void	validateOnClose()	Validates pipeline state on pipeline close.

Methods inherited from class java.lang.Object

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

Field Details

OPERATION_SEGMENTS

public static final Map<DerivedDataSegmentBucket,String> OPERATION_SEGMENTS

Method Details

create

public static AsyncProcessingPipeline create(Collection<DerivedDataSegmentDefinition> segmentDefinitions,
 Collection<DerivedDataSegmentDefinitionV2> segmentDefinitionsV2,
 IDerivedDataServiceLockController lockController,
 String modelId,
 AsyncPipelineModalModeAccessor modalModeAccessor)

Creates an instance of the async derived data processing pipeline

Parameters:

segmentDefinitions - The set of derived data segment definitions. May not be null

segmentDefinitionsV2 - The set of V2 derived data segment definitions. May not be null

lockController - The lock controller. May not be null

modelId - The identifier of the BM model. May not be null

areAllSegmentsComputed

public boolean areAllSegmentsComputed()

Description copied from interface: IAsyncProcessingPipeline

Checks if all segments are computed.

Specified by:

areAllSegmentsComputed in interface IAsyncProcessingPipeline

Returns:

True if all DD segments are computed.

blockPipeline

public void blockPipeline()

Description copied from interface: IAsyncProcessingPipeline

Blocks pipeline computations due to external reasons.

Specified by:

blockPipeline in interface IAsyncProcessingPipeline

deactivateContexts

public void deactivateContexts(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Deactivates contexts of a specified pipeline segment. Deactivated contexts are treated as non-existing(or being removed) unit reactivation

Specified by:

deactivateContexts in interface IAsyncProcessingPipeline

Parameters:

segmentId - The target segment of the pipeline to deactivate contexts for. Cannot be null

prepareForClose

public void prepareForClose()

Description copied from interface: IAsyncProcessingPipeline

Prepares the pipeline for the closing. Blocks data/unimportant operation computation leaving the important operation execution intact

Specified by:

prepareForClose in interface IAsyncProcessingPipeline

validateOnClose

public void validateOnClose()

Description copied from interface: IAsyncProcessingPipeline

Validates pipeline state on pipeline close. Pipeline shoudn't have any unfinished running tasks

Specified by:

validateOnClose in interface IAsyncProcessingPipeline

confirm

public void confirm(String segmentId,
 Object objectId)

Description copied from interface: IAsyncProcessingPipeline

Confirms processing of the specified context collection.

Specified by:

confirm in interface IAsyncProcessingPipeline

Parameters:

segmentId - The segment id, cannot be null

objectId - The object id, cannot be null

dumpPipelineState

public void dumpPipelineState(IDerivedDataContextManager contextManager)

gather

public AsyncProcessingTask gather()

Description copied from interface: IAsyncProcessingPipeline

Gather next derived data processing task. Pipeline takes all considerations (locking, etc) into consideration while gathering next set of tasks.
Gathering of the tasks locks the next gatherings of this task until the lock will be cleared (as a result of computation confirmation, etc).

Specified by:

gather in interface IAsyncProcessingPipeline

Returns:

The DD processing task.

getCurrentMultiThreadingComputePolicy

public MultithreadingComputationPolicy getCurrentMultiThreadingComputePolicy()

Description copied from interface: IAsyncProcessingPipeline

Gets the multithreading computation policy for the current state of the pipeline.

Specified by:

getCurrentMultiThreadingComputePolicy in interface IAsyncProcessingPipeline

Returns:

The active policy; cannot be null.

getCurrentSegmentIds

public List<String> getCurrentSegmentIds()

Description copied from interface: IAsyncProcessingPipeline

Gets the set of segments the pipeline works on at the moment. As the pipeline supports concurrent computations for grouped segments there are could be several active segments.

Specified by:

getCurrentSegmentIds in interface IAsyncProcessingPipeline

Returns:

The list of identifiers for current segments. Could be empty only in case if the pipeline configuration is empty.

getReadySegments

public Set<String> getReadySegments()

Description copied from interface: IAsyncProcessingPipeline

Gets ready (computed) DD segments.

Specified by:

getReadySegments in interface IAsyncProcessingPipeline

getRemainingUnitsOfWork

public int getRemainingUnitsOfWork(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Gets the number of remaining work units for the given segment.

Specified by:

getRemainingUnitsOfWork in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the segment.

Returns:

The number of remaining work units in the pipeline of the segment.

getSegmentName

public String getSegmentName(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Gets the human-readable name (localizable) for the given DD segment,

Specified by:

getSegmentName in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the DD segment.

Returns:

The human-readable name of the segment.

getStatus

public PipelineStatus getStatus()

Description copied from interface: IAsyncProcessingPipeline

Gets the current status of the DD async. pipeline.

Specified by:

getStatus in interface IAsyncProcessingPipeline

Returns:

The status of the pipeline.

getActivePipelineStatus

public PipelineStatus getActivePipelineStatus()

Description copied from interface: IAsyncProcessingPipeline

Gets the current status of the DD async. pipeline. The modal pipeline status is taken into the account

Specified by:

getActivePipelineStatus in interface IAsyncProcessingPipeline

Returns:

The status of the pipeline.

getActivePipelineStage

public DerivedDataSegmentBucket getActivePipelineStage()

Description copied from interface: IAsyncProcessingPipeline

Gets the current stage of the DD async. pipeline. The modal pipeline status is taken into the account

Specified by:

getActivePipelineStage in interface IAsyncProcessingPipeline

Returns:

The current stage of the pipeline. May not be null

getActiveStageLock

public DerivedDataSegmentBucket getActiveStageLock()

Description copied from interface: IAsyncProcessingPipeline

Gets active stage lock (if any)

Specified by:

getActiveStageLock in interface IAsyncProcessingPipeline

Returns:

Active stage lock. Can be null

isBlockedExternally

public boolean isBlockedExternally()

Description copied from interface: IAsyncProcessingPipeline

Checks if the pipeline is blocked externally

Specified by:

isBlockedExternally in interface IAsyncProcessingPipeline

Returns:

True if the pipeline is blocked externally

getTotalUnitsOfWork

public int getTotalUnitsOfWork(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Gets the total number of work units for the given DD segment.

Specified by:

getTotalUnitsOfWork in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the target DD segment.

Returns:

The total number of work units.

hasPriorityTasks

public boolean hasPriorityTasks()

Description copied from interface: IAsyncProcessingPipeline

Checks if the pipeline has priority tasks ready to be computed at the moment

Specified by:

hasPriorityTasks in interface IAsyncProcessingPipeline

Returns:

True if the pipepilne has priority tasks for the computing at the moment

hasRunningComputations

public boolean hasRunningComputations()

Description copied from interface: IAsyncProcessingPipeline

Checks if the DD subsystem already scheduled some DD tasks for the computation. We need to wait until computations are done in cases of system shutdown, etc.

Specified by:

hasRunningComputations in interface IAsyncProcessingPipeline

Returns:

True if there are active computations of DD.

increasePriority

public void increasePriority(Collection<String> segments)

Description copied from interface: IAsyncProcessingPipeline

Increase priority of all segments being supplied as a scope

Specified by:

increasePriority in interface IAsyncProcessingPipeline

increasePriority

public void increasePriority(Map<Object,Collection<String>> scope)

Description copied from interface: IAsyncProcessingPipeline

Increases the priority of computation for the given scope

Specified by:

increasePriority in interface IAsyncProcessingPipeline

Parameters:

scope - Identifiers of objects mapped to corresponding segments

increasePriority

public void increasePriority(String segmentId,
 long bmObjectId)

Description copied from interface: IAsyncProcessingPipeline

Increases the priority of computation for the given BM object in a specified DD segment.

Specified by:

increasePriority in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the target DD segment.

bmObjectId - The identfier of the BM object.

inSync

public boolean inSync()

Description copied from interface: IAsyncProcessingPipeline

Checks if the pipeline performs processing of DerivedDataSegmentBucket.SYNC stage

Specified by:

inSync in interface IAsyncProcessingPipeline

Returns:

True if the pipeline performs DD task dispatching during the resource sycnhronization at the moment

isLongRunningSegment

public boolean isLongRunningSegment(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Checks if the requested DD segment is a long-running one (so the progress indication should be comprehensible to the user).

Specified by:

isLongRunningSegment in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the target DD segment.

Returns:

True if the DD segment is a long running one.

isSegmentComputed

public boolean isSegmentComputed(String segmentId)

Description copied from interface: IAsyncProcessingPipeline

Checks if the DD segment is computed completely.

Specified by:

isSegmentComputed in interface IAsyncProcessingPipeline

Parameters:

segmentId - The identifier of the target DD segment.

Returns:

True if the DD segment data is computed for all applicable (and known) objects.

remove

public void remove(Object objectId)

Description copied from interface: IAsyncProcessingPipeline

Removes all context from the async. pipeline for the given object (e.g. during removal of the object).

Specified by:

remove in interface IAsyncProcessingPipeline

Parameters:

objectId - The identifier of the object.

removeOperation

public void removeOperation(Object handle)

Description copied from interface: IAsyncProcessingPipeline

Removes a previously scheduled operation from the pipeline. Does nothing in case if the operation is already removed/computed

Specified by:

removeOperation in interface IAsyncProcessingPipeline

Parameters:

handle - The handle of the operation. May not be null

renderStatusText

public String renderStatusText(String currentSegmentId)

Description copied from interface: IAsyncProcessingPipeline

Renders status text for the given segment.

Specified by:

renderStatusText in interface IAsyncProcessingPipeline

Parameters:

currentSegmentId - The identifier of the DD segment.

Returns:

The human-readable DD segment status.

resetStageLock

public void resetStageLock(DerivedDataSegmentBucket stage)

Description copied from interface: IAsyncProcessingPipeline

Resets the stage lock, if any

Specified by:

resetStageLock in interface IAsyncProcessingPipeline

Parameters:

stage - The stage of the async pipeline to reset the lock. May not be null

resetPipelineStatus

public void resetPipelineStatus()

Description copied from interface: IAsyncProcessingPipeline

Re-sets the pipeline status, pipeline position, etc. The pipeline will re-position itself after that

Specified by:

resetPipelineStatus in interface IAsyncProcessingPipeline

resetActivePipelineStatus

public void resetActivePipelineStatus()

Description copied from interface: IAsyncProcessingPipeline

Resets the active pipeline status. This method always selects the active pipeline (modal or main) independently of the current thread binding to the modal operation (if any)

Specified by:

resetActivePipelineStatus in interface IAsyncProcessingPipeline

schedule

public void schedule(Collection<IObjectDerivedDataContext> updatedContexts,
 Object modalOperationContext)

Description copied from interface: IAsyncProcessingPipeline

Schedules the updated derived data contexts into the pipeline.

Specified by:

schedule in interface IAsyncProcessingPipeline

Parameters:

updatedContexts - Updated contexts.

setStageLock

public StageLockRequestResult setStageLock(DerivedDataSegmentBucket stage,
 boolean allowDataComputing)

Description copied from interface: IAsyncProcessingPipeline

Sets the stage lock for a specified stage of async pipeline. May be called multiple times to check the current status of the lock via the returned value

Specified by:

setStageLock in interface IAsyncProcessingPipeline

Parameters:

stage - The stage to lock. May not be null

allowDataComputing - Allows parallel computing of data (not operations) in the target stage of the pipeline

Returns:

The result of locking. Indicates the state of the pipeline at the moment of the lock

startMassiveComputing

public void startMassiveComputing()

Description copied from interface: IAsyncProcessingPipeline

Enables the massive computing mode for the DD pipeline. The mode is being desingaged after computing of all registered important tasks

Specified by:

startMassiveComputing in interface IAsyncProcessingPipeline

start

public void start(BiConsumer<String,Object> unlockNotifier)

Description copied from interface: IAsyncProcessingPipeline

Starts a pipeline with additional callbacks required by the computation process

Specified by:

start in interface IAsyncProcessingPipeline

Parameters:

unlockNotifier - IAsyncProcessingPipeline.unlock(String, Object) call notifier. May not be null

stop

public void stop()

Description copied from interface: IAsyncProcessingPipeline

Stops the pipeline, performing all shutdown sequence processing.

Specified by:

stop in interface IAsyncProcessingPipeline

unblockPipeline

public void unblockPipeline()

Description copied from interface: IAsyncProcessingPipeline

Unblocks pileline computations due to clearing of external blocking reasons.

Specified by:

unblockPipeline in interface IAsyncProcessingPipeline

unlock

public void unlock(String segmentId,
 Object objectId)

Description copied from interface: IAsyncProcessingPipeline

Unlocks segments task for the given object.

Specified by:

unlock in interface IAsyncProcessingPipeline

Parameters:

segmentId - The DD segment to lock into.

objectId - The object which DD task should be unlocked.

hasOperation

public boolean hasOperation(Object handle)

Description copied from interface: IAsyncProcessingPipeline

Checks if the pipeline has a scheduled operation

Specified by:

hasOperation in interface IAsyncProcessingPipeline

Parameters:

handle - the operation handle. May not be null

Returns:

True if the pipeline has scheduled operation matching the given handle

markAsModalOperationParticipant

public void markAsModalOperationParticipant()

Description copied from interface: IAsyncProcessingPipeline

Marks the current thread explicitly as a participant of the modal operation. The mark may/will be reset automatically after the reset of the modal operation

Specified by:

markAsModalOperationParticipant in interface IAsyncProcessingPipeline

getActiveNonPriorityTasksResetRequiredStage

public DerivedDataSegmentBucket getActiveNonPriorityTasksResetRequiredStage()

Description copied from interface: IAsyncProcessingPipeline

Checks if a supplier requests a reset of currently computed non-priority tasks (e.g. due to more prioritable operation is appeared)

Specified by:

getActiveNonPriorityTasksResetRequiredStage in interface IAsyncProcessingPipeline

Returns:

Stage to reset non-priority tasks (if any). null if not reset is required

isOperationActiveInThread

public boolean isOperationActiveInThread()

Description copied from interface: IAsyncProcessingPipeline

Checks if there is an orchestrated operation being active in the client thread. Modal operations aren't tracked by this method

Specified by:

isOperationActiveInThread in interface IAsyncProcessingPipeline

Returns:

True if there is an active orchestrated operation wrapping the calling code at the moment

registerActiveOperation

public void registerActiveOperation(OperationContext context)

Description copied from interface: IAsyncProcessingPipeline

Registers the active operation context for the current thread

Specified by:

registerActiveOperation in interface IAsyncProcessingPipeline

Parameters:

context - The operation context to register. May not be null

markActiveOperationAsAutoWrapping

public void markActiveOperationAsAutoWrapping()

Description copied from interface: IAsyncProcessingPipeline

Marks the operation as an auto-wrapping one. This may be done only after scheduling due to requiremend of the DD engine

Specified by:

markActiveOperationAsAutoWrapping in interface IAsyncProcessingPipeline

completeAutoWrappingOperationIfApplicable

public OperationContext completeAutoWrappingOperationIfApplicable(Object bmOperationHandle)

Description copied from interface: IAsyncProcessingPipeline

Finishes the auto-wrapping operation if any for the given BM operation handle

Specified by:

completeAutoWrappingOperationIfApplicable in interface IAsyncProcessingPipeline

Parameters:

bmOperationHandle - The handle of the executed BM operation. May not be null

Returns:

The context of the finished operation, if any. null otherwise

resetActiveWrappingOperationContext

public void resetActiveWrappingOperationContext(OperationContext operationContext)

Description copied from interface: IAsyncProcessingPipeline

Resets the binding of an operation to the current thread

Specified by:

resetActiveWrappingOperationContext in interface IAsyncProcessingPipeline

Parameters:

operationContext - The operation context to reset the binding for. May not be null

bindTaskToAnActiveOperationIfApplicable

public void bindTaskToAnActiveOperationIfApplicable(Object bmOperationHandle)

Description copied from interface: IAsyncProcessingPipeline

Binds the BM task to the manually created operation

Specified by:

bindTaskToAnActiveOperationIfApplicable in interface IAsyncProcessingPipeline

Parameters:

bmOperationHandle - The BM task handle. May not be null

disableAutoWrapping

public void disableAutoWrapping()

Description copied from interface: IAsyncProcessingPipeline

Disables auto-wrapping of BM tasks with operations for the current thread. Used for async data computations being controlled directly by the async pipeline

Specified by:

disableAutoWrapping in interface IAsyncProcessingPipeline

enableAutoWrapping

public void enableAutoWrapping()

Description copied from interface: IAsyncProcessingPipeline

Enables an auto-wrapping of BM tasks with orchestrator operations for the current thread. Used to restore an auto-wrapping being disabled previously

Specified by:

enableAutoWrapping in interface IAsyncProcessingPipeline

getWrappingOperation

public OperationContext getWrappingOperation()

Description copied from interface: IAsyncProcessingPipeline

Gets the current BM task wrapping operation (if any)

Specified by:

getWrappingOperation in interface IAsyncProcessingPipeline

Returns:

The context of the wrapping operation (if any). null otherwise

setImplicitWaitingContext

public void setImplicitWaitingContext(List<IObjectDerivedDataContext> changedContexts)

Description copied from interface: IAsyncProcessingPipeline

Sets the implicit waiting context to the current wrapping operation (if any)

Specified by:

setImplicitWaitingContext in interface IAsyncProcessingPipeline

Parameters:

changedContexts - The set of changed DD context. May not be null