LinkStatus Generator
http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Main
User Documentation

Generators
Overview

Default
File Generator

Core
HTML Generator
Directory Generator
Image Directory Generator
Fragment Extractor Generator
JSP Generator
Script Generator
Server Pages Generator
Velocity Generator
Request Generator
Status Generator
Stream Generator
Profile Generator
Error Generator
Search Generator
LinkStatus Generator
Web Service Proxy Generator
Text Parser Generator

Optional
Php Generator
XML:DB Generator
XML:DB Collection Generator

LinkStatus Generator

The LinkStatus Generator emits a list of links that are reachable. Please note that it is available only in Cocoon 2.1.

The LinkStatusGenerator has serveral configuration options.

include-name -
RE pattern for including links
By default include-name is empty.
exclude-name -
RE pattern for excluding links.
By default exclude-name is defined as .*\.gif(\?.*)?$, .*\.png(\?.*)?$, .*\.jpe?g(\?.*)?$, .*\.js(\?.*)?$, .*\.css(\?.*)?$ .
link-content-type -
expected MIME type of xml document requested on view link-query-view
By default link-content-type is set to application/x-cocoon-links.
link-view-query -
A query-string appended to the crawling URL
By default link-view-query is set to cocoon-view=links.
user-agent -
HTTP user-agent for requesting links, By default user-agent is set to value of org.apache.cocoon.Constants.COMPLETE_NAME, ie. Apache Cocoon 2.1-dev
accept -
Not currently used
  • Name : linkStatus
  • Class: org.apache.cocoon.generation.LinkStatusGenerator
  • Cacheable: no.

A simple example might help to use the LinkStatusGenerator effectivly:

Add the LinkStatusGenerator to the components in your sitemap.xmap

...
<map:components>
...
  <map:generators default="file">
  ...
    <map:generator name="linkStatus"
      src="org.apache.cocoon.generation.LinkStatusGenerator"/>
  </map:generators>
  <map:serialize default="html">
    <map:serializer name="links"
      src="org.apache.cocoon.serialization.LinkSerializer"/>
  </map:serialize>
</map:components>
<map:views>
  <map:view>
    <map:view from-position="last" name="links">
      <map:serialize type="links"/>
    </map:view>
    ...
</map:view>

Next define in your pipeline to use the LinkStatusGenerator

<map:match pattern="/linkStatus">
  <map:generate type="linkStatus" name="my-root"/>
  ...
  <map:serialize/>
</map:match>
Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.