Task (logicaldoc 6.8.3 API)

java.lang.Object
- com.logicaldoc.core.task.Task

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DigestProcessor, IndexerTask, IndexOptimizer, ProductNews, StatsCollector, TagCloudGenerator
```
public abstract class Task
extends Object
implements Runnable
```
A task is a long running sequence of operations

Since:

3.5.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContextProperties`	`config`
`protected boolean`	`interruptRequested`
`protected Throwable`	`lastRunError`
`protected LockManager`	`lockManager`
`protected org.slf4j.Logger`	`log`
`protected boolean`	`sendActivityReport`
`protected EMailSender`	`sender`
`protected long`	`size`
`static int`	`STATUS_IDLE`
`static int`	`STATUS_RUNNING`
`static int`	`STATUS_STOPPING`
`protected SystemLoadMonitor`	`systemLoadMonitor`
`protected String`	`transactionId`
`protected UserDAO`	`userDao`

Constructor Summary

Constructors
Constructor and Description

Task(String name)

Constructors
Constructor and Description
`Task(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTaskListener(TaskListener listener)`
`int`	`getCompletionPercentage()` The percentage of completion(1-100)
`ContextProperties`	`getConfig()`
`String`	`getName()`
`long`	`getProgress()` The current processing step
`String`	`getReportRecipients()`
`TaskScheduling`	`getScheduling()` Scheduling policies
`long`	`getSize()` The the total size of the processing(number of units of work)
`int`	`getStatus()` The task status(one of STATUS_IDLE or STATUS_RUNNING)
`void`	`interrupt()`
`abstract boolean`	`isConcurrent()` Concrete implementations must override this method declaring if the task supports multiple instances running concurrently.
`abstract boolean`	`isIndeterminate()` Concrete implementations must override this method declaring if the task is indeterminate.
`boolean`	`isInterrupted()`
`boolean`	`isRunning()` Check if the task is currently running
`boolean`	`isSendActivityReport()`
`protected void`	`next()` Increments the progress by one and detects system overload.
`void`	`notifyReport()`
`protected String`	`prepareReport(Locale locale)` Implementations may compose a locale specific report.
`void`	`removeTaskListener(TaskListener listener)`
`void`	`run()`
`protected abstract void`	`runTask()` Concrete implementations must override this method implementing their own processing logic.
`void`	`save()` Saves the task configuration
`void`	`saveWork()` Concrete implementations must insert here the code needed to save the elaboration state in a persistent storage
`void`	`setConfig(ContextProperties config)`
`void`	`setLockManager(LockManager lockManager)`
`protected void`	`setName(String name)`
`protected void`	`setProgress(long progress)`
`void`	`setReportRecipients(String reportRecipients)`
`void`	`setSendActivityReport(boolean sendActivityReport)`
`void`	`setSender(EMailSender sender)`
`void`	`setSize(long size)`
`void`	`setSystemLoadMonitor(SystemLoadMonitor systemLoadMonitor)`
`void`	`setUserDao(UserDAO userDao)`

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

Field Detail

log
```
protected org.slf4j.Logger log
```

STATUS_IDLE
```
public static final int STATUS_IDLE
```
See Also:
Constant Field Values

STATUS_RUNNING
```
public static final int STATUS_RUNNING
```
See Also:
Constant Field Values

STATUS_STOPPING
```
public static final int STATUS_STOPPING
```
See Also:
Constant Field Values

size
```
protected long size
```

interruptRequested
```
protected boolean interruptRequested
```

lastRunError
```
protected Throwable lastRunError
```

config
```
protected ContextProperties config
```

sender
```
protected EMailSender sender
```

userDao
```
protected UserDAO userDao
```

sendActivityReport
```
protected boolean sendActivityReport
```

transactionId
```
protected String transactionId
```

lockManager
```
protected LockManager lockManager
```

systemLoadMonitor

protected SystemLoadMonitor systemLoadMonitor

Constructor Detail
- Task
```
public Task(String name)
```

Method Detail

getName
```
public String getName()
```

setName
```
protected void setName(String name)
```

next
```
protected void next()
```
Increments the progress by one and detects system overload.

setProgress

protected void setProgress(long progress)

run
```
public void run()
```
Specified by:

run in interface Runnable

interrupt
```
public void interrupt()
```

isInterrupted
```
public boolean isInterrupted()
```

getSize
```
public long getSize()
```
The the total size of the processing(number of units of work)

setSize
```
public void setSize(long size)
```

getStatus
```
public int getStatus()
```
The task status(one of STATUS_IDLE or STATUS_RUNNING)

getProgress
```
public long getProgress()
```
The current processing step

getCompletionPercentage
```
public int getCompletionPercentage()
```
The percentage of completion(1-100)

isRunning
```
public boolean isRunning()
```
Check if the task is currently running

saveWork
```
public void saveWork()
```
Concrete implementations must insert here the code needed to save the elaboration state in a persistent storage

getScheduling
```
public TaskScheduling getScheduling()
```
Scheduling policies

addTaskListener

public void addTaskListener(TaskListener listener)

removeTaskListener

public void removeTaskListener(TaskListener listener)

notifyReport
```
public void notifyReport()
```

prepareReport
```
protected String prepareReport(Locale locale)
```
Implementations may compose a locale specific report.

runTask
```
protected abstract void runTask()
                         throws Exception
```
Concrete implementations must override this method implementing their own processing logic.

Throws:

Exception - If something goes wrong this exception is raised

isIndeterminate
```
public abstract boolean isIndeterminate()
```
Concrete implementations must override this method declaring if the task is indeterminate. An indeterminate task is not able to compute it's time length

isConcurrent
```
public abstract boolean isConcurrent()
```
Concrete implementations must override this method declaring if the task supports multiple instances running concurrently.

getReportRecipients
```
public String getReportRecipients()
```

getConfig
```
public ContextProperties getConfig()
```

setConfig

public void setConfig(ContextProperties config)

setSender

public void setSender(EMailSender sender)

setUserDao

public void setUserDao(UserDAO userDao)

save

public void save()
          throws IOException,
                 ParseException

Saves the task configuration

Throws:: ParseException; IOException

isSendActivityReport
```
public boolean isSendActivityReport()
```

setSendActivityReport

public void setSendActivityReport(boolean sendActivityReport)

setReportRecipients

public void setReportRecipients(String reportRecipients)

setLockManager

public void setLockManager(LockManager lockManager)

setSystemLoadMonitor

public void setSystemLoadMonitor(SystemLoadMonitor systemLoadMonitor)

Class Task

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

STATUS_IDLE

STATUS_RUNNING

STATUS_STOPPING

size

interruptRequested

lastRunError

config

sender

userDao

sendActivityReport

transactionId

lockManager

systemLoadMonitor

Constructor Detail

Task

Method Detail

getName

setName

next

setProgress

run

interrupt

isInterrupted

getSize

setSize

getStatus

getProgress

getCompletionPercentage

isRunning

saveWork

getScheduling

addTaskListener

removeTaskListener

notifyReport

prepareReport

runTask

isIndeterminate

isConcurrent

getReportRecipients

getConfig

setConfig

setSender

setUserDao

save

isSendActivityReport

setSendActivityReport

setReportRecipients

setLockManager

setSystemLoadMonitor