org.opencms.workplace.threads
Class CmsXmlDocumentLinkValidatorThread

java.lang.Object
  java.lang.Thread
      org.opencms.report.A_CmsReportThread
          org.opencms.workplace.threads.CmsXmlDocumentLinkValidatorThread

All Implemented Interfaces:

Runnable, I_CmsReportThread

public class CmsXmlDocumentLinkValidatorThread
extends A_CmsReportThread

A report thread for the HTML link validator.

Since:

6.0.0

Version:

$Revision: 1.6 $

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

CmsXmlDocumentLinkValidatorThread(CmsObject cms)
Creates a thread that validates the HTML links (hrefs and images) in all unpublished Cms files of the current (offline) project, if the files resource types implement the interface I_CmsXmlDocumentLinkValidatable.

CmsXmlDocumentLinkValidatorThread(CmsObject cms, CmsPublishList publishList, CmsWorkplaceSettings settings)
Creates a thread that validates the HTML links (hrefs and images) in the list of unpublished Cms file(s) of the current (offline) project, if the file's resource type implements the interface I_CmsXmlDocumentLinkValidatable.

Method Summary

String	getReportUpdate() Returns the part of the report that is ready for output.
void	run()

Methods inherited from class org.opencms.report.A_CmsReportThread

addError, getCms, getError, getErrors, getReport, getRuntime, getUUID, hasError, initHtmlReport, initOldHtmlReport, isDoomed

Methods inherited from class java.lang.Thread

activeCount, checkAccess, 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, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.report.I_CmsReportThread

start

Constructor Detail

CmsXmlDocumentLinkValidatorThread

public CmsXmlDocumentLinkValidatorThread(CmsObject cms)

Creates a thread that validates the HTML links (hrefs and images) in all unpublished Cms files of the current (offline) project, if the files resource types implement the interface I_CmsXmlDocumentLinkValidatable.

Please refer to the Javadoc of the I_CmsHtmlLinkValidatable interface to see which classes implement this interface (and so, which file types get validated by the HTML link validator).

The generated Cms publish list is *NOT* saved in the current user's workplace settings.

Parameters:

cms - the current OpenCms context object

See Also:

CmsObject.getPublishList()

CmsXmlDocumentLinkValidatorThread

public CmsXmlDocumentLinkValidatorThread(CmsObject cms,
                                         CmsPublishList publishList,
                                         CmsWorkplaceSettings settings)

Creates a thread that validates the HTML links (hrefs and images) in the list of unpublished Cms file(s) of the current (offline) project, if the file's resource type implements the interface I_CmsXmlDocumentLinkValidatable.

Please refer to the Javadoc of the I_CmsHtmlLinkValidatable interface to see which classes implement this interface (and so, which file types get validated by the HTML link validator).

The Cms publish list *IS* saved in the current user's workplace settings for further processing by other threads. The last thread processing this publish list *MUST* ensure that the publish list gets removed from the current user's workplace settings!

Parameters:

cms - the current OpenCms context object

publishList - the list of resources which will be directly published

settings - the current user's workplace settings

Method Detail

getReportUpdate

public String getReportUpdate()

Description copied from class: A_CmsReportThread

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

Specified by:

getReportUpdate in class A_CmsReportThread

Returns:

the part of the report that is ready for output

See Also:

A_CmsReportThread.getReportUpdate()

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

See Also:

Runnable.run()