Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-linkcheck-plugin:1.1:linkcheck
Description:
Linkcheck
report.Attributes:
1.0
.Name | Type | Since | Description |
---|---|---|---|
httpMethod | String |
1.0 |
The HTTP method to use. Currently supported are "GET" and "HEAD".
Default value is: head . |
linkcheckCache | File |
1.0 |
The location of the Linkcheck cache file. Default value is: ${project.build.directory}/linkcheck/linkcheck.cache . |
linkcheckOutput | File |
1.0 |
The location of the Linkcheck report file. Default value is: ${project.build.directory}/linkcheck/linkcheck.xml . |
offline | boolean |
1.0 |
Whether we are offline or not. Default value is: ${settings.offline} . |
outputDirectory | File |
1.0 |
Report output directory. |
Name | Type | Since | Description |
---|---|---|---|
baseURL | String |
1.0 |
The base URL to use for absolute links (eg
/index.html ) in the site.Default value is: ${project.url} . |
encoding | String |
1.0 |
The file encoding to use when Linkcheck reads the source files. If
the property project.build.sourceEncoding is not set,
the platform default encoding is used.Default value is: ${project.build.sourceEncoding} . |
excludedHttpStatusErrors | Integer[] |
1.0 |
The list of HTTP errors to ignored, like 404 . |
excludedHttpStatusWarnings | Integer[] |
1.0 |
The list of HTTP warnings to ignored, like 301 . |
excludedLinks | String[] |
1.0 |
The list of links to exclude. Note: Patterns like **/dummy/* are allowed for
excludedLink. |
excludedPages | String[] |
1.0 |
A list of pages to exclude. Note:
|
forceSite | boolean |
1.0 |
true to force the site generation, false
otherwise. Using this parameter ensures that all documents have
been correctly generated.Default value is: true . |
httpClientParameters | Properties |
1.0 |
The extra HttpClient parameters to be used when fetching links. For
instance:
<httpClientParameters> <property> <name>http.protocol.max-redirects</name> <value>10</value> </property> </httpClientParameters>See HttpClient preference page |
httpFollowRedirect | boolean |
1.0 |
If online, the HTTP method should automatically follow HTTP
redirects, false otherwise. Default value is: true . |
skip | boolean |
1.0 |
true to skip the report execution, false
otherwise. The purpose is to prevent infinite call when
forceSite is enable.Default value is: false . |
timeout | int |
1.0 |
Set the timeout to be used when fetching links. A value of zero
means the timeout is not used. Default value is: 2000 . |
/index.html
) in the site.java.lang.String
1.0
No
${linkcheck.baseURL}
${project.url}
project.build.sourceEncoding
is not set,
the platform default encoding is used.java.lang.String
1.0
No
${encoding}
${project.build.sourceEncoding}
404
.java.lang.Integer[]
1.0
No
301
.java.lang.Integer[]
1.0
No
**/dummy/*
are allowed for
excludedLink.java.lang.String[]
1.0
No
linkcheck.html
, is always
excluded.apidocs/**
, etc.java.lang.String[]
1.0
No
true
to force the site generation, false
otherwise. Using this parameter ensures that all documents have
been correctly generated.boolean
1.0
No
${linkcheck.forceSite}
true
<httpClientParameters> <property> <name>http.protocol.max-redirects</name> <value>10</value> </property> </httpClientParameters>See HttpClient preference page
java.util.Properties
1.0
No
${httpClientParameters}
boolean
1.0
No
true
java.lang.String
1.0
Yes
head
java.io.File
1.0
Yes
${project.build.directory}/linkcheck/linkcheck.cache
java.io.File
1.0
Yes
${project.build.directory}/linkcheck/linkcheck.xml
boolean
1.0
Yes
${linkcheck.offline}
${settings.offline}
java.io.File
1.0
Yes
${project.reporting.outputDirectory}
skip:
true
to skip the report execution, false
otherwise. The purpose is to prevent infinite call when
forceSite
is enable.boolean
1.0
No
${linkcheck.skip}
false
int
1.0
No
${timeout}
2000