org.alfresco.linkvalidation
Class LinkValidationReport

java.lang.Object
  extended by org.alfresco.linkvalidation.LinkValidationReport
All Implemented Interfaces:
java.io.Serializable

public class LinkValidationReport
extends java.lang.Object
implements java.io.Serializable

Object representing the result of a link validation action being executed. This object combines the results of the multiple service calls required to detect broken links and retrieve them.

This object is then typically added to the store being checked as a store property.

See Also:
Serialized Form

Constructor Summary
LinkValidationReport(java.lang.String store, java.lang.String webapp, HrefManifest manifest, int noFilesChecked, int noLinksChecked, int maxNumberLinksInReport)
          Constructs a link validation report from the results of a check of the staging area.
LinkValidationReport(java.lang.String store, java.lang.String webapp, java.lang.Throwable error)
          Constructs a link validation report from an error that occurred
 
Method Summary
 int getBaseSnapshotVersion()
           
 java.util.List getBrokenLinksForFile(java.lang.String file)
           
 java.util.Date getCheckCompletedAt()
           
 java.lang.Throwable getError()
           
 java.util.List getFilesWithBrokenLinks()
           
 int getLatestSnapshotVersion()
           
 int getMaxNumberLinksInReport()
           
 int getNumberBrokenFiles()
           
 int getNumberBrokenLinks()
           
 int getNumberFilesChecked()
           
 int getNumberLinksChecked()
           
 java.lang.String getStore()
           
 java.lang.String getWebapp()
           
 boolean hasMaxNumberLinksExceeded()
           
 void setError(java.lang.Throwable error)
           
protected  void storeBrokenFiles(java.util.List manifests)
          Stores the given list of manifest entries in the internal lists and maps
 java.lang.String toString()
           
 boolean wasSuccessful()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LinkValidationReport

public LinkValidationReport(java.lang.String store,
                            java.lang.String webapp,
                            HrefManifest manifest,
                            int noFilesChecked,
                            int noLinksChecked,
                            int maxNumberLinksInReport)
Constructs a link validation report from the results of a check of the staging area.

Parameters:
store - The store the link check was run against
webapp - The webapp within the store the check was run against
manifest - The manifest of broken links and snapshot info
noFilesChecked - The number of files checked
noLinksChecked - The number of links checked
maxNumberLinksInReport - The maximum number of links to store in the report, -1 will store all links passed in the manifest object

LinkValidationReport

public LinkValidationReport(java.lang.String store,
                            java.lang.String webapp,
                            java.lang.Throwable error)
Constructs a link validation report from an error that occurred

Parameters:
store - The store the link check was run against
webapp - The webapp within the store the check was run against
error - The error that caused the link check to fail
Method Detail

getStore

public java.lang.String getStore()

getWebapp

public java.lang.String getWebapp()

getCheckCompletedAt

public java.util.Date getCheckCompletedAt()

getNumberFilesChecked

public int getNumberFilesChecked()

getNumberLinksChecked

public int getNumberLinksChecked()

getNumberBrokenFiles

public int getNumberBrokenFiles()

getNumberBrokenLinks

public int getNumberBrokenLinks()

getMaxNumberLinksInReport

public int getMaxNumberLinksInReport()

hasMaxNumberLinksExceeded

public boolean hasMaxNumberLinksExceeded()

getFilesWithBrokenLinks

public java.util.List getFilesWithBrokenLinks()

getBrokenLinksForFile

public java.util.List getBrokenLinksForFile(java.lang.String file)

getBaseSnapshotVersion

public int getBaseSnapshotVersion()

getLatestSnapshotVersion

public int getLatestSnapshotVersion()

wasSuccessful

public boolean wasSuccessful()

setError

public void setError(java.lang.Throwable error)

getError

public java.lang.Throwable getError()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

storeBrokenFiles

protected void storeBrokenFiles(java.util.List manifests)
Stores the given list of manifest entries in the internal lists and maps

Parameters:
manifests - Manifest entries to store


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.