    All Resources  All filters

# CacheProp

This resource class provides editable access to the cache configuration. It's use is to allow easy customization of Jigsaw when used as a proxy or as a mirror.

## Inherits

The CacheProp class inherits from the following classes:

- PropertySet

## Attributes description

The HTTPResource defines the following attributes:

- w3c.www.protocol.http.cache.size
- w3c.www.protocol.http.cache.debug
- w3c.www.protocol.http.cache.shared
- w3c.www.protocol.http.cache.directory
- w3c.www.protocol.http.cache.connected
- w3c.www.protocol.http.cache.garbageCollectionEnabled
- w3c.www.protocol.http.cache.fileSizeRatio

`w3c.www.protocol.http.cache.size`

semantics
  The size of the cache, given as the number of bytes that the cache is allowed to use on the disk.
type
  This attribute is a editable IntegerAttribute
default value
  This attribute defaults to 5000000.

`w3c.www.protocol.http.cache.debug`

semantics
  Turn the cache filter debug mode on or off.
type
  This attribute is a computed BooleanAttribute
default value
  This attribute defaults to false.

`w3c.www.protocol.http.cache.shared`

semantics
  Is this cache shared among multiple users ?
type
  This attribute is a computed BooleanAttribute
default value
  This attribute defaults to true. For better caching efficiency, you should turn that flag to false if you are the only user of the cache.

`w3c.www.protocol.http.cache.directory`

semantics
  The directory that the cache can use to store cached entries.
type
  This attribute is a computed FileAttribute
default value
  This attribute defaults to the current directory.

`w3c.www.protocol.http.cache.connected`

semantics
  Tell the cache wether it is allowed to use the net to answer to any request. This has the same effect as if all requests served by the cache had the `only-if-cache` cache control directive set.
type
  This attribute is a computed BooleanAttribute
default value
  This attribute defaults to the false.

`w3c.www.protocol.http.cache.garbageCollectionEnabled`

semantics
  Enables or disables the garbage collector of the cache. This is most usefull when you are planning to use the proxy in disconnected mode: turn off this flag while filling in the cache, then disconnect it by using the `w3c.www.protocol.http.cache.connected` property.
type
  This attribute is a computed BooleanAttribute
default value
  This attribute defaults to the true.

`w3c.www.protocol.http.cache.fileSizeRatio`

semantics
  Indicates the ratio - relative to the cache size - of the number of bytes a single entry in the cache is allowed to occupy. For example, if set to 0.1 and the cache size is set to 5000000, then any document whose length is greater then 500000 will not be cached.
  This ratio is given as a floating point value between 0 and 1.
type
  This attribute is a computed DoubleAttribute
default value
  This attribute defaults to the 0.1.

Anselm Baird-Smith
$Id: w3c.jigsaw.proxy.CacheProp.html,v 1.1 1996/09/25 14:23:11 abaird Exp $