--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
+<html>\r
+<head>\r
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+ <title>The HTTPFrame reference manual</title>\r
+ <link rel="stylesheet" type="text/css" href="../style/doc.css"><style type="text/css">body { margin: 20pt; color: black; background: white; font-family: helvetica;} </style>\r
+ <link href="jigsaw@w3.org" rel="made">\r
+</head>\r
+\r
+<body>\r
+<a href="../../../../WWW" target="_top_"><img\r
+src="../../../Icons//WWW/w3c_home.gif" alt="W3C" border="0" height="48"\r
+width="72">\r
+</a><a href="../../../../WWW" target="_top_"> </a><a href="../../"\r
+target="_top_"><img src="../../../Icons//jigsaw" alt="Jigsaw" border="0">\r
+</a>\r
+ \r
+<hr noshade size="1">\r
+\r
+<a href="resources.html">All resources</a> <a href="frames.html">All\r
+frames </a> \r
+<hr noshade size="1">\r
+\r
+\r
+<h1>HTTPFrame</h1>\r
+The basic frame class of all resources accessible through the HTTP protocol.\r
+\r
+<p></p>\r
+<hr noshade size="1">\r
+\r
+\r
+<h2>Inherits</h2>\r
+The <a\r
+href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/frames/HTTPFrame.html">HTTPFrame</a>\r
+class inerits from the following classes:\r
+<ul>\r
+ <li><a href="org.w3c.tools.resources.Resource.html">Resource</a></li>\r
+ <li><a\r
+ href="org.w3c.tools.resources.FramedResource.html">FramedResource</a></li>\r
+ <li><a\r
+ href="org.w3c.tools.resources.ResourceFrame.html">ResourceFrame</a></li>\r
+ <li><a\r
+ href="org.w3c.tools.resources.ProtocolFrame.html">ProtocolFrame</a></li>\r
+</ul>\r
+<hr noshade size="1">\r
+\r
+\r
+<h2>Attributes description</h2>\r
+The HTTPFrame defines the following attributes:\r
+<ul>\r
+ <li><a href="#quality">quality</a></li>\r
+ <li><a href="#title">title</a></li>\r
+ <li><a href="#content-language">content-language</a></li>\r
+ <li><a href="#content-encoding">content-encoding</a></li>\r
+ <li><a href="#content-type">content-type</a></li>\r
+ <li><a href="#icon">icon</a></li>\r
+ <li><a href="#maxage">maxage</a></li>\r
+ <li><a href="#md5">send-md5</a></li>\r
+ <li><a href="#putable">putable</a></li>\r
+ <li><a href="#relocate">relocate</a></li>\r
+ <li><a href="#index">index</a></li>\r
+ <li><a href="#icondir">icondir</a></li>\r
+ <li><a href="#browsable">browsable</a></li>\r
+ <li><a href="#style-sheet-link">style-sheet-link</a></li>\r
+</ul>\r
+<hr noshade size="1">\r
+\r
+<a name="quality"></a><tt>quality</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>A rating of the quality of this resource's content. The rating is\r
+ provided as a number between 0.0 and 1.0. It is used mainly by the <a\r
+ href="org.w3c.jigsaw.frames.NegotiatedFrame.html">NegotiatedFrame</a> to\r
+ negotiate among its set of variants.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/DoubleAttribute.html">DoubleAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>1.0</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="title"></a><tt>title</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>The title of this resource. This attribute can be either computed from\r
+ the resource content (e.g. if the content is an HTML file which has some\r
+ META tag), or provided for informational purposes (even if the\r
+ resource's content type is not text/html.)</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="content-language"></a><tt>content-language</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>The natural language of the resource content. This is used mainly by\r
+ the NegotiatedFrame to negotiate among its set of variant resources. The\r
+ value of this attribute can be either extracted from the resource\r
+ content (e.g. if it is an HTML file that includes some appropriate META\r
+ tag), or provided for informational purposes.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/frames/LanguageAttribute.html">LanguageAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="content-encoding"></a><tt>content-encoding</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>The encoding in which the resource's content is stored. Right now this\r
+ can only be a single token (as described in the <a\r
+ href="http://www.w3.org/pub/WWW/Protocols">HTTP/1.1\r
+ specification</a>).</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/frames/EncodingAttribute.html">EncodingAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="content-type"></a><tt>content-type</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>The (MIME) type of the resource's content.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/frames/MimeTypeAttribute.html">MimeTypeAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>text/plain</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="icon"></a><tt>icon</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>Any icon to be associated with the resource. This is used, for\r
+ example, to produce nice directory listings.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="maxage"></a><tt>maxage</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>This attribute defines the allowed drift between the real content of a\r
+ resource, and the one that is sent as request replies. The bigger this\r
+ value, the more efficient the server can be, since it will be able to\r
+ reuse cachd request replies for a longer time. This attribute takes\r
+ effect only if it is defined, and if the resource provides a meaningfull\r
+ last-modified attribute value. The unit is milliseconds.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/LongAttribute.html">LongAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="md5"></a><tt>send-md5</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>Should we add a Content-Md5 header in the reply?</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>false</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="putable"></a><tt>putable</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd><ul>\r
+ <li>Attached to a <a\r
+ href="org.w3c.tools.resources.FileResource.html">FileResource</a>:<br>\r
+ Should the file resource support PUT requets ? When this flag is true,\r
+ the file resource object will handle appropriately the HTTP PUT\r
+ method, by overriding the resource's file with the new content. The\r
+ old content will be saved using the emacs convention (the ~ files).\r
+ Care should be taken when turning this feature on: you probably want\r
+ to use some authentication filter to ensure that only authors are\r
+ allowed to change resources. <ul>\r
+ <li>Attached to a <a\r
+ href="org.w3c.jigsaw.resources.DirectoryResource.html">DirectoryResource</a>:</li>\r
+ </ul>\r
+ <br>\r
+ If this flag is setted to true that will allow you to create new\r
+ resources through the HTTP PUT method. When this resource is looked\r
+ up, it uses the normal DirectoryResource alogorithm to find the\r
+ appropriate resource. If this fails, it goes to the resource indexer,\r
+ and asks it to create a resource having the given name. If this\r
+ succeeds, the newly created resource is attached as a child of the\r
+ directory resource, and the PUT method is delegated to its HTTPFrame.\r
+ Notice that the indexer should be configured to create a resource\r
+ (with its appropriate frame) that handles the PUT method, otherwise,\r
+ the resource will be effectively created, but it will fail to save the\r
+ put'ed content (the FileResource, for example, should have a HTTPFrame\r
+ with its putable attribute turned to true).</ul>\r
+ </dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>false</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="relocate"></a><tt>relocate</tt>\r
+<dl>\r
+ <dt><i>semantics</i> (when attached to a DirectoryResource)</dt>\r
+ <dd>Should the directory emit a relocation reply when accessed through an\r
+ invalid URL. A common case of handling invalid directory access is to\r
+ emit a relocation reply so that the browser gets access to the directory\r
+ through a valid URL (e.g. http://www.w3.org/pub is invalid, because pub\r
+ is a directory, the correct URL is http://www.w3.org/pub/). When this\r
+ flag is set to true, the directory resource will emit the appropriate\r
+ relocation reply.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>true</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="index"></a><tt>index</tt>\r
+<dl>\r
+ <dt><i>semantics</i> (when attached to a DirectoryResource)</dt>\r
+ <dd>The optional name of the directory child resource that is to be used\r
+ as the directory index. This attribute should name an existing child\r
+ resource, that will be used as the index resource of the directory (all\r
+ accesses to the directory will be delegated to it).</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="icondir"></a><tt>icondir</tt>\r
+<dl>\r
+ <dt><i>semantics</i> (when attached to a DirectoryResource)</dt>\r
+ <dd>The name of the directory that handles this directory's icons. Each\r
+ HTTPFrame has an optional icon attribute. When a directory resource\r
+ needs to produce a listing it will dereference each icons relative to\r
+ its icon directory.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="browsable"></a><tt>browsable</tt> (when attached to a\r
+DirectoryResource)\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>Should this directory handle the <a href="http://www.gnn.com">GNN</a>\r
+ BROWSE method ? When trun to true the putable directory will reply\r
+ appropriately to the <a href="http://www.gnn.com">GNN</a> BROWSE method\r
+ (which allows it to get the directory content).</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>false</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+<a name="style-sheet-link"></a><tt>style-sheet-link</tt>\r
+<dl>\r
+ <dt><i>semantics</i></dt>\r
+ <dd>This attribute is a relative link to a <a\r
+ href="http://www.w3.org/Style">Style Sheet</a>. This could be use by the\r
+ frame when it generates a HTML document "on the fly", it could add a\r
+ link to this style sheet.</dd>\r
+ <dt><i>type</i></dt>\r
+ <dd>This attribute is an editable <a\r
+ href="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</a></dd>\r
+ <dt><i>default value</i></dt>\r
+ <dd>This attribute defaults to <b>null</b>.</dd>\r
+</dl>\r
+<hr noshade size="1">\r
+\r
+\r
+<p><i><a href="mailto:jigsaw@w3.org">Jigsaw Team</a></i> <br>\r
+<i>$Id: org.w3c.jigsaw.frames.HTTPFrame.html,v 1.3 1998/03/27 08:19:12 bmahe\r
+Exp $</i></p>\r
+</body>\r
+</html>\r
projects / Benchmarks_CSolver.git / blobdiff