Java Doc for BrokenLinkCheckerRun.java in  » Content-Management-System » hippo-cms » nl » hippo » cms » brokenlinkchecker » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Content Management System » hippo cms » nl.hippo.cms.brokenlinkchecker 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   nl.hippo.cms.brokenlinkchecker.BrokenLinkCheckerRun

BrokenLinkCheckerRun
public class BrokenLinkCheckerRun (Code)

This class searches a tree in a WebDAV repository for broken links. It does so by executing a DASL that finds documents that have property links in namespace http://hippo.nl/cms/1.0 defined. The result of the check is stored in a document in the repository with the following structure:

 <broken-links date="...">
 <page url="...">
 <link url="...">[error message]</link>
 </page>
 </broken-links>
 

The error message can be a simple text, or an element with namespace http://apache.org/cocoon/i18n/2.1 and name text which contains a localization key.

If a link exists in multiple documents it is checked only once.

Checking links is a time-consuming task. It does not require a lot of resources though. That is why the checking of links is performed using multiple threads.

NOTE: this class assumes that the result document will be written to the WebDAV repository that is checked for broken links. Therefore only one set of credentials have to be given.



Field Summary
final public static  intMAXIMUM_DOCUMENT_BATCH_SIZE
    

The maximum number of documents to retrieve in one request.

final public static  intMAXIMUM_LINK_CHECK_TIMEOUT_SECONDS
    

The HTTP client timeout is specified in milliseconds as an integer.

final public static  intMINIMUM_DOCUMENT_BATCH_SIZE
    

The minimum number of documents to retrieve in one request.

final public static  intMINIMUM_LINK_CHECK_TIMEOUT_SECONDS
    

The minimum timeout for requests used to check for broken links.

final public static  intMINIMUM_NUMBER_OF_LINK_CHECKING_THREADS
    

The minimum number of thread to use for checking for broken links.


Constructor Summary
public  BrokenLinkCheckerRun(BrokenLinkCheckerRunConfiguration configuration)
    

Create an instance of this class passing it the information and resources it needs.

The broken link checking is not started by this constructor.


Method Summary
synchronized  voidaddBrokenLink(String link, BrokenLinkErrorMessage errorMessage)
    

Add a link to the set of broken links.

public static  voidassertConfigurationIsValid(BrokenLinkCheckerRunConfiguration configuration)
    

Check that the configuration is valid.

public  voidexecute()
    

Start the broken link checking process.

synchronized  StringgetLinkToCheck()
    

Get the URL of a link to check.

synchronized  voidhandleBrokenLinksCheckingTaskFinished(BrokenLinkCheckerTask task)
    

Handle the event that a broken links checking task has finished.

synchronized  booleanhaveLinksToCheckBeenExhausted()
    

Determine whether or not the links to check have been exhausted.


Field Detail
MAXIMUM_DOCUMENT_BATCH_SIZE
final public static int MAXIMUM_DOCUMENT_BATCH_SIZE(Code)

The maximum number of documents to retrieve in one request.




MAXIMUM_LINK_CHECK_TIMEOUT_SECONDS
final public static int MAXIMUM_LINK_CHECK_TIMEOUT_SECONDS(Code)

The HTTP client timeout is specified in milliseconds as an integer. This limits the maximum value for the number of seconds for the timeout that can be specified in the configuration to this value.




MINIMUM_DOCUMENT_BATCH_SIZE
final public static int MINIMUM_DOCUMENT_BATCH_SIZE(Code)

The minimum number of documents to retrieve in one request.




MINIMUM_LINK_CHECK_TIMEOUT_SECONDS
final public static int MINIMUM_LINK_CHECK_TIMEOUT_SECONDS(Code)

The minimum timeout for requests used to check for broken links.




MINIMUM_NUMBER_OF_LINK_CHECKING_THREADS
final public static int MINIMUM_NUMBER_OF_LINK_CHECKING_THREADS(Code)

The minimum number of thread to use for checking for broken links.





Constructor Detail
BrokenLinkCheckerRun
public BrokenLinkCheckerRun(BrokenLinkCheckerRunConfiguration configuration)(Code)

Create an instance of this class passing it the information and resources it needs.

The broken link checking is not started by this constructor. Invoke BrokenLinkCheckerRun.execute() to start the process.


Parameters:
  configuration - the object holding the information and resources.




Method Detail
addBrokenLink
synchronized void addBrokenLink(String link, BrokenLinkErrorMessage errorMessage)(Code)

Add a link to the set of broken links.


Parameters:
  link - the link that is broken.
Parameters:
  errorMessage - the message of the error causing the brokenness.



assertConfigurationIsValid
public static void assertConfigurationIsValid(BrokenLinkCheckerRunConfiguration configuration)(Code)

Check that the configuration is valid. If it is not an IllegalArgumentException is thrown.

A configuration is valid if the following rules are followed:

Attribute Rules
documentTreeToCheckRootUrl Cannot be null.
documentsBaseUrl Cannot be null.
internalLinksBaseUrl Cannot be null.
repositoryUsername Cannot be null.
repositoryPassword Cannot be null.
resultDocumentUrl Cannot be null.
documentBatchSize Greater than or equal to 1 and less than or equal to 1000.
numberOfLinkCheckingThreads Greater than or equal to 1.
linkCheckTimeoutSeconds Greater than or equal to 1 and less than or equal to 2147483.
log Cannot be null.

Parameters:
  configuration - the configuration to check.



execute
public void execute()(Code)

Start the broken link checking process. This method can only be invoked once.




getLinkToCheck
synchronized String getLinkToCheck()(Code)

Get the URL of a link to check.

a link to check, or null if there are no morelinks to check.



handleBrokenLinksCheckingTaskFinished
synchronized void handleBrokenLinksCheckingTaskFinished(BrokenLinkCheckerTask task)(Code)

Handle the event that a broken links checking task has finished. If all tasks have finished, notify this object that it can stop waiting for the tasks to finish.




haveLinksToCheckBeenExhausted
synchronized boolean haveLinksToCheckBeenExhausted()(Code)

Determine whether or not the links to check have been exhausted. If the links to check have been exhausted the task checking the links can stop.

true if the links to check have beenexhausted, false otherwise.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.