[Index]

web:resource


Provides a Handler to Serve file content from the file system or class path.

Property Summary

base The base directory or resource from where to serve content.
directoriesListed List directories or not.
minMemoryMappedContentLength Control memory mapped size.
resourceType The type of resource, FILE or CLASSPATH.
welcomeFiles List of welcome files to serve.

Example Summary

Example 1 Serve files from the same directory the configuration file is in.
Example 2 Serves files but also provides a list of welcome files.

Property Detail

base

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo, but pointless without one.

The base directory or resource from where to serve content.

directoriesListed

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo, defaults to false.

List directories or not.

minMemoryMappedContentLength

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo.

Control memory mapped size. Set to -1 on windows because of This issue

resourceType

Configured ByELEMENT
AccessREAD_WRITE
RequiredNo, defaults to FILE.

The type of resource, FILE or CLASSPATH.

welcomeFiles

Configured ByELEMENT
AccessREAD_WRITE
RequiredNo.

List of welcome files to serve.


Examples

Example 1

Serve files from the same directory the configuration file is in.

<oddjob id="this">
  <job>
    <web:server id="server" xmlns:web="oddjob:web">
      <handlers>
        <web:resource directoriesListed="true" base="${this.dir}"/>
      </handlers>
    </web:server>
  </job>
</oddjob>

Example 2

Serves files but also provides a list of welcome files.

<oddjob id="this">
  <job>
    <web:server id="server" xmlns:web="oddjob:web">
      <handlers>
        <web:resource base="${this.dir}">
          <welcomeFiles>
            <value value="TestFile.txt"/>
          </welcomeFiles>
        </web:resource>
      </handlers>
    </web:server>
  </job>
</oddjob>


(c) R Gordon Ltd 2005 - Present