W3C logo

Indexer configuration

Jigsaw Home / Documentation Overview / Tutorials

In this section, the Jigsaw2.0 version of the indexing scheme will be presented. The Jigsaw1.0 scheme is easy to find out as it is much simpler than the 2.0 one (no protocol frames).

Goal of an indexer

The main goal of an indexer is to create and setup some resource automatically. The resources can be created depending on their name or their extension. Once the resource has been created, the indexer is also in charge of attaching the right frames to this resource, like the HTTP frame, the filters and so on.

Description of an indexer

  1. Class and attributes of an indexer.
    Usually, the indexer's class is org.w3c.tools.resources.indexer.SampleResourceIndexer
    The name of the indexer, ex: "icons"
    Unused, but resent as, internally, it is a resource.
    The name of the parent indexer used when the current indexer fails to index. By default, the super indexer is the "default" indexer.
  2. The sons of an indexer
    Used to index files matching exactly a name, mainly used to index directories. You can specify that an "Icons" directory will always be negotiable, for example. The default name (ie: matching all directory names) is "*default*"
    Used to index files with a specific extension. For example, "html" is a FileResource with an HTTPFrame set to give the "text/html" content type to this file. Then all the "foo.html" files will be indexed as "text/html" type object when accessed by HTTP. The default extension (ie: matching all the extension names) is "*default*". To index files with no extensions, you must use the name "*noextension*".

Setting up the indexer

We will use a small example. The indexer will create all directories named "Icons" as a normal DirectoryResource, but using "icons" as its indexers. It means that all the Icons directories and their subdirectories will be indexed with "icons" instead of "default". Along with that, we will define a new extension "mpg" as a "video/mpeg" object.

  1. Open a jigadmin window
  2. Go to the server you want to add the indexer to (usually http-server), double click on the "indexers" node. On the right side, you must see the resource editor popup

  3. screenshot of Jigadm
    jigadm screenshot

    jigadmin screenshot jigadmin screenshot
    jigadmin screenshot jigadmin screenshot
Of course this is an example, if you want to add an extension for the whole server, the best way is to add it directly in the default indexer. Another thing, it is better to use org.w3c.jigsaw.resources.DirectoryResource than org.w3c.tools.resources.DirectoryResource, just to check if you read ALL the documentation ;)

The Content Type Indexer

In some cases the file extension is not the only criteria, for exemple when a PUT request occurs the indexer should use the Content-Type header comming with the request (if there is a content-type header). This is the job of the Content Type Indexer.
ContentTypeIndexer screen shot
The Content Type Indexer (org.w3c.jigsaw.indexer.ContentTypeIndexer), has one more child, the content-types node. The associations between mime types and resources are stored in this new child.

Since 2.0.2 the ContentTypeIndexer accept generic mime types like text:*, *:xml or even *:*. For example, if you define text:* as a FileResource using a HTTPFrame (with a content-type set to *none*) all content types like text/html, text/plain, text/xml will be accepted.

Note: As you can see in the screenshot, the mime types stored in the indexer are not "real" mime types, the '/' has been replaced by a ':'. We decided that because the '/' can create some conflicts with the URLs in Jigsaw.