Genereal properties reference manual

All Resources All filters

# GeneralProp

This resource provides access to Jigsaw's general properties.

## Inherits

The GeneralProp class inherits from the following classes:

- PropertySet (aka abstract class)

## Attributes description

The HTTPResource defines the following attributes:

- w3c.jigsaw.server
- w3c.jigsaw.checkSensitivity
- w3c.jigsaw.root
- w3c.jigsaw.host
- w3c.jigsaw.port
- w3c.jigsaw.root.store
- w3c.jigsaw.root.name
- w3c.jigsaw.publicMethods
- w3c.jigsaw.trace
- w3c.jigsaw.docurl

`w3c.jigsaw.server`

semantics
  The string that Jigsaw will emit as its identification through the `Server` header.
type
  This attribute is a computed StringAttribute
default value
  This attribute defaults to Jigsaw/major.minor, where major is the current major release number, and minor is the minor one. As an example, September 7th, 1996 Jigsaw release will emit Jigsaw/1.0a2.

w3c.jigsaw.checkSensitivity

semantics
  Should Jigsaw double check case sensitivity when accessing files. On non-broken systems, the underlying file system is case-sensitive and the whole world is very happy. However a few, old operating systems have not incorporated that feature yet. For those system, turning this falg to true will ensure that the URLs served by Jigsaw remains case-sensitive.
type
  This attribute is a computed BooleanAttribute
default value
  Because they are security implications related to not having this flag set when running on a case-insensitive file system, this attribute defaults to true. It is highly recommended that you turn it to false when possible.

w3c.jigsaw.root

semantics
  This property should provide the top directory of the server. This property, by itself, is only used to get defaults value for other properties. A typical top directory for a server will contain the following sub directories:
  config
    Which will contain the required configuration files, among which:
    httpd.props
      Will be the file containing the Jigsaw properties,
    jindex.cfg
      Will be the file containing the default settings for the indexer,
  logs
    Which will contain the log files.
  WWW
    Which will contain the actual entities to be exported, along with their description.
  bin
    Will optionally contain some scripts to run the binaries associated with Jigsaw.
type
  This attribute is a computed FileAttribute
default value
  This property defaults to Jigsaw's current directory.

w3c.jigsaw.host

semantics
  This property should provide the full name (including the domain name) of the machine that hosts the server. Don't forget to provide the host's domain-name along with its name, otherwise, all urls dynamically generated by the server will fail when trigered from a machine outside the server's domain.
type
  This attribute is a computed StringAttribute
default value
  This property defaults to the machine on which the server runs.

w3c.jigsaw.port

semantics
  The port on which the server will listen for client connections. Unless you run the server as root, you won't be able to run the server on a port lesser than 1024. This will be fixed in future releases.
type
  This attribute is a computed IntegerAttribute
default value
  This defaults to port 8001.

w3c.jigsaw.root.store

semantics
  The name of the store repository to be used for the space directory.
type
  This attribute is a computed FileAttribute
default value
  This defaults to <w3c.jigsaw.root>/config/stores/ root.idx.

w3c.jigsaw.root.name

semantics
  The name of the resource to be used as the server's root resource. This name should be a valid resource name within the scope of the space directory resource store (see above). This property is used, for example, to turn the server into a proxy (by giving the name of some ProxyDirectory resource, instead of the default name of the DirectoryResource for the space directory).
type
  This attribute is a computed ObjectAttribute
default value
  This attribute defaults to root.

w3c.jigsaw.publicMethods

semantics
  The set of public methods supported by that server. This set of methods is being exported through the HTTP `Public` header.
type
  This attribute is a computed StringArrayAttribute
default value
  This attribute defaults to {GET, HEAD, PUT, POST, LINK, UNLINK, OPTIONS, DELETE}.

w3c.jigsaw.trace

semantics
  Turn the server in trace mode. This flag wil lmake the server emit various traces into the logger trace file, along with some debugging information to the server's standard output stream. This flag has to be turned on for clients trace flag to be effective.
type
  This attribute is a computed BooleanAttribute
default value
  This attribute defaults to false.

w3c.jigsaw.docurl

semantics
  The URL path of the Jigsaw's documentation, as served by that server. This can be either a relative URL (it will be absolutized relative to the server's root URL), or an absolute URL.
type
  This attribute is a computed StringAttribute
default value
  This attribute has no default value.

Jigsaw Team
$Id: w3c.jigsaw.http.GeneralProp.html,v 1.2 1996/09/11 22:21:47 abaird Exp $