You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2007/09/02 09:38:32 UTC
svn commit: r571926 - in
/maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck:
FileToCheck.java LinkCheck.java LinkCheckResult.java
validation/OnlineHTTPLinkValidator.java
Author: ltheussl
Date: Sun Sep 2 00:38:30 2007
New Revision: 571926
URL: http://svn.apache.org/viewvc?rev=571926&view=rev
Log:
Make report level configurable to reduce size of report file
Modified:
maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/FileToCheck.java
maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheck.java
maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheckResult.java
maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/validation/OnlineHTTPLinkValidator.java
Modified: maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/FileToCheck.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/FileToCheck.java?rev=571926&r1=571925&r2=571926&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/FileToCheck.java (original)
+++ maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/FileToCheck.java Sun Sep 2 00:38:30 2007
@@ -243,6 +243,19 @@
*/
public String toXML()
{
+ return toXML( LinkCheckResult.UNKNOWN );
+ }
+
+
+ /**
+ * Returns an XML representation of the linkcheck results for this file.
+ * This is only available after {@link #check(LinkValidatorManager)} has been called.
+ *
+ * @param level The minimum status level to report. Should be one of the constants defined in LinkCheckResult.
+ * @return the XML linkcheck result as a string.
+ */
+ public String toXML( int level)
+ {
StringBuffer buf = new StringBuffer();
buf.append( " <file>" + LinkCheck.EOL );
@@ -261,7 +274,10 @@
{
result = (LinkCheckResult) iter.next();
- buf.append( result.toXML() );
+ if ( level >= result.getStatusLevel() )
+ {
+ buf.append( result.toXML() );
+ }
}
buf.append( " </file>" + LinkCheck.EOL );
Modified: maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheck.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheck.java?rev=571926&r1=571925&r2=571926&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheck.java (original)
+++ maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheck.java Sun Sep 2 00:38:30 2007
@@ -88,6 +88,29 @@
/** Output encoding for the xml document. */
private String outputEncoding;
+ /** The level to report, used in toXML(). */
+ private int reportLevel = LinkCheckResult.WARNING;
+
+ /**
+ * The current report level. Defaults to LinkCheckResult.WARNING.
+ *
+ * @return int
+ */
+ public int getReportLevel()
+ {
+ return this.reportLevel;
+ }
+
+ /**
+ * Set the report level.
+ *
+ * @param level the level to set.
+ */
+ public void setReportLevel( int level )
+ {
+ this.reportLevel = level;
+ }
+
/**
* Whether links are checked in online mode.
*
@@ -440,7 +463,7 @@
for ( Iterator iter = getFiles().iterator(); iter.hasNext(); )
{
ftc = (FileToCheck) iter.next();
- buf.append( ftc.toXML() );
+ buf.append( ftc.toXML( getReportLevel() ) );
}
ftc = null;
Modified: maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheckResult.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheckResult.java?rev=571926&r1=571925&r2=571926&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheckResult.java (original)
+++ maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/LinkCheckResult.java Sun Sep 2 00:38:30 2007
@@ -30,6 +30,21 @@
*/
public final class LinkCheckResult
{
+
+ /** Validation result: error. */
+ public static final int ERROR = 1;
+
+ /** Validation result: warning. */
+ public static final int WARNING = 2;
+
+ /** Validation result: valid. */
+ public static final int VALID = 3;
+
+ /** Validation result: unknown. */
+ public static final int UNKNOWN = 4;
+
+
+
/** status. */
private String status;
@@ -38,6 +53,32 @@
/** errorMessage. */
private String errorMessage;
+
+
+ /**
+ * Returns the status as an integer.
+ *
+ * @return One of ERROR, WARNING, VALID or UNKNOWN.
+ */
+ public int getStatusLevel()
+ {
+ int level = UNKNOWN;
+
+ if ( "valid".equals( getStatus() ) )
+ {
+ level = VALID;
+ }
+ else if ( "warning".equals( getStatus() ) )
+ {
+ level = WARNING;
+ }
+ else if ( "error".equals( getStatus() ) )
+ {
+ level = ERROR ;
+ }
+
+ return level;
+ }
/**
* Returns the status.
Modified: maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/validation/OnlineHTTPLinkValidator.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/validation/OnlineHTTPLinkValidator.java?rev=571926&r1=571925&r2=571926&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/validation/OnlineHTTPLinkValidator.java (original)
+++ maven/sandbox/trunk/doxia/doxia-linkcheck/src/main/java/org/apache/maven/doxia/linkcheck/validation/OnlineHTTPLinkValidator.java Sun Sep 2 00:38:30 2007
@@ -389,7 +389,10 @@
HttpMethod oldHm = hm;
- LOG.info( "[" + link + "] is redirected to [" + newLink + "]" );
+ if ( LOG.isDebugEnabled() )
+ {
+ LOG.debug( "[" + link + "] is redirected to [" + newLink + "]" );
+ }
oldHm.releaseConnection();