org.opencms.report

类 A_CmsReportThread

java.lang.Object

java.lang.Thread

org.opencms.report.A_CmsReportThread

所有已实现的接口:

java.lang.Runnable, I_CmsReportThread

直接已知子类:

CmsChangeElementLocaleThread, CmsCloneModuleThread, CmsContentCheckThread, CmsConvertXmlThread, CmsDatabaseImportThread, CmsElementRenameThread, CmsExportThread, CmsExternalLinksValidatorThread, CmsHistoryClearThread, CmsHtmlImportThread, CmsIndexingReportThread, CmsLanguageCopyThread, CmsMergePagesThread, CmsModuleAddResourceTypeThread, CmsModuleDeleteThread, CmsModuleReplaceThread, CmsProjectDeleteThread, CmsRelationsValidatorThread, CmsRemovePubLocksThread, CmsSearchReplaceThread, CmsSitesWebserverThread, CmsStaticExportThread, CmsSynchronizeThread, CmsTagReplaceThread, CmsUpdateXmlThread, CmsXmlContentRepairThread

public abstract class A_CmsReportThread
extends java.lang.Thread
implements I_CmsReportThread

Provides a common Thread class for the reports.

从以下版本开始:

6.0.0

嵌套类概要

从类继承的嵌套类/接口 java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

字段概要

从类继承的字段 java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

构造器概要

构造器

限定符	构造器和说明
protected	A_CmsReportThread(CmsObject cms, java.lang.String name) Constructs a new report Thread with the given name.

方法概要

方法

限定符和类型	方法和说明
void	addError(java.lang.Object obj) Adds an error object to the list of errors that occurred during the report.
protected CmsObject	getCms() Returns the OpenCms context object this Thread is initialized with.
java.lang.Throwable	getError() Returns the error exception in case there was an error during the execution of this Thread, null otherwise.
java.util.List<java.lang.Object>	getErrors() Returns a list of all errors that occurred during the report.
long	getLastEntryTime() Returns the time of last report entry.
protected I_CmsReport	getReport() Returns the report where the output of this Thread is written to.
abstract java.lang.String	getReportUpdate() Returns the part of the report that is ready for output.
long	getRuntime() Returns the time this report has been running.
CmsUUID	getUUID() Returns the OpenCms UUID of this report thread.
boolean	hasError() Returns if the report generated an error output.
protected void	initHtmlReport(java.util.Locale locale) Initialize a HTML report for this Thread.
protected void	initOldHtmlReport(java.util.Locale locale) Initialize a HTML report for this Thread.
boolean	isDoomed() Returns true if this thread is already "doomed" to be deleted.

从类继承的方法 java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.report.I_CmsReportThread

start

构造器详细资料

A_CmsReportThread

protected A_CmsReportThread(CmsObject cms,
                 java.lang.String name)

Constructs a new report Thread with the given name.

参数:

cms - the current OpenCms context object

name - the name of the Thread

方法详细资料

addError

public void addError(java.lang.Object obj)

Adds an error object to the list of errors that occurred during the report.

参数:

obj - the error object

getLastEntryTime

public long getLastEntryTime()

Returns the time of last report entry.

Will return zero if no entry has been written.

返回:

time of last report entry

getError

public java.lang.Throwable getError()

Returns the error exception in case there was an error during the execution of this Thread, null otherwise.

返回:

the error exception in case there was an error, null otherwise

getErrors

public java.util.List<java.lang.Object> getErrors()

Returns a list of all errors that occurred during the report.

返回:

an error list that occurred during the report

getReportUpdate

public abstract java.lang.String getReportUpdate()

Returns the part of the report that is ready for output.

返回:

the part of the report that is ready for output

getRuntime

public long getRuntime()

Returns the time this report has been running.

返回:

the time this report has been running

getUUID

public CmsUUID getUUID()

Returns the OpenCms UUID of this report thread.

指定者:

getUUID 在接口中 I_CmsReportThread

返回:

the OpenCms UUID of this report thread

hasError

public boolean hasError()

Returns if the report generated an error output.

返回:

true if the report generated an error, otherwise false

isDoomed

public boolean isDoomed()

Returns true if this thread is already "doomed" to be deleted.

A OpenCms deamon Thread (the "Grim Reaper") will collect all doomed Threads, i.e. threads that are not longer active for some time.

返回:

true if this thread is already "doomed" to be deleted

getCms

protected CmsObject getCms()

Returns the OpenCms context object this Thread is initialized with.

返回:

the OpenCms context object this Thread is initialized with

getReport

protected I_CmsReport getReport()

Returns the report where the output of this Thread is written to.

返回:

the report where the output of this Thread is written to

initHtmlReport

protected void initHtmlReport(java.util.Locale locale)

Initialize a HTML report for this Thread.

参数:

locale - the locale for the report output messages

initOldHtmlReport

protected void initOldHtmlReport(java.util.Locale locale)

Initialize a HTML report for this Thread.

This method is reserved for older report threads that still use XML templates to generate their output.

参数:

locale - the locale for the report output messages