io.jmix.ui.executor.impl

Class WebBackgroundWorker

java.lang.Object

io.jmix.ui.executor.impl.WebBackgroundWorker

All Implemented Interfaces:

BackgroundWorker

@Component(value="ui_BackgroundWorker")
public class WebBackgroundWorker
extends java.lang.Object
implements BackgroundWorker

Web implementation of BackgroundWorker

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationEventPublisher	applicationEventPublisher
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected java.util.concurrent.ExecutorService	executorService
protected UiBackgroundTaskProperties	properties
protected io.jmix.core.TimeSource	timeSource
protected WatchDog	watchDog

Constructor Summary

Constructors

Constructor and Description
WebBackgroundWorker()

Method Summary

Modifier and Type	Method and Description
void	checkUIAccess()
protected void	createThreadPoolExecutor()
void	destroy()
UIAccessor	getUIAccessor() Obtain UI access for later use from background thread.
<T,V> BackgroundTaskHandler<V>	handle(BackgroundTask<T,V> task) Create handler for a background task.
void	setProperties(UiBackgroundTaskProperties properties)

Methods inherited from class java.lang.Object

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

Field Detail

watchDog

@Autowired
protected WatchDog watchDog

currentAuthentication

@Autowired
protected io.jmix.core.security.CurrentAuthentication currentAuthentication

applicationEventPublisher

@Autowired
protected org.springframework.context.ApplicationEventPublisher applicationEventPublisher

timeSource

@Autowired
protected io.jmix.core.TimeSource timeSource

properties

protected UiBackgroundTaskProperties properties

executorService

protected java.util.concurrent.ExecutorService executorService

Constructor Detail

WebBackgroundWorker

public WebBackgroundWorker()

Method Detail

setProperties

@Autowired
public void setProperties(UiBackgroundTaskProperties properties)

createThreadPoolExecutor

protected void createThreadPoolExecutor()

destroy

@PreDestroy
public void destroy()

handle

public <T,V> BackgroundTaskHandler<V> handle(BackgroundTask<T,V> task)

Description copied from interface: BackgroundWorker

Create handler for a background task. The handler is used to control the task execution.

Specified by:

handle in interface BackgroundWorker

Type Parameters:

T - progress measure unit

V - task result type

Parameters:

task - background task instance

Returns:

task handler

getUIAccessor

public UIAccessor getUIAccessor()

Description copied from interface: BackgroundWorker

Obtain UI access for later use from background thread. Can be invoked only from UI thread.

Specified by:

getUIAccessor in interface BackgroundWorker

Returns:

ui accessor object that allows to read/write state of UI

checkUIAccess

public void checkUIAccess()

Specified by:

checkUIAccess in interface BackgroundWorker