Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / mcr-test / WWW / User / Reference / w3c.jigsaw.ssi.SSIResource.html
diff --git a/JMCR-Stable/mcr-test/WWW/User/Reference/w3c.jigsaw.ssi.SSIResource.html b/JMCR-Stable/mcr-test/WWW/User/Reference/w3c.jigsaw.ssi.SSIResource.html
new file mode 100644 (file)
index 0000000..4c17ab1
--- /dev/null
@@ -0,0 +1,175 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">\r
+<HTML>\r
+<HEAD>\r
+   <TITLE>The SSIResource reference guide.</TITLE>\r
+   <META NAME="GENERATOR" CONTENT="Mozilla/3.01Gold (X11; I; SunOS 5.5 sun4u) [Netscape]">\r
+</HEAD>\r
+<BODY BGCOLOR="#FFFFFF">\r
+\r
+<P><!-- Created by GNNpress --><!-- Changed by: Anselm Baird-Smith,  4-Feb-1997 --><A HREF="http://www.w3.org/pub/WWW/" TARGET="_top_"><IMG SRC="/icons/WWW/w3c_home.gif" ALT="W3C" BORDER=0 HEIGHT=48 WIDTH=72></A>\r
+<A HREF="http://www.w3.org/pub/WWW/Jigsaw/" TARGET="_top_"><IMG SRC="/icons/jigsaw" ALT="Jigsaw" BORDER=0 ></A><A HREF="http://www.w3.org/pub/WWW/Jigsaw/" TARGET="_top_">\r
+\r
+<HR></A><A HREF="resources.html">All Resources</A> <A HREF="filters.html">All\r
+filters </A>\r
+<HR></P>\r
+\r
+<H1>SSIResource </H1>\r
+\r
+<P>The SSI resource implements server-side parsing of HTML documents. Inside\r
+an SSIResource-indexed file, any comment of the form <TT>&lt;!--#commandName\r
+param1=val1 param2=val2 ... paramn=valn --&gt; </TT>will be interpreted\r
+as a command. Commands are looked up in an instance of the class supplied\r
+in the <A HREF="#registryClass">registryClass</A> attribute. This class\r
+must be a subclass of the abstract class <A HREF="../api/w3c.jigsaw.ssi.CommandRegistry.html">w3c.jigsaw.ssi.CommandRegistry</A>.\r
+Commands are implementations of the <A HREF="../api/w3c.jigsaw.ssi.Command.html">Command</A>\r
+interface or the <A HREF="../api/w3c.jigsaw.ssi.ControlCommand.html">w3c.jigsaw.ssi.ControlCommand\r
+</A>interface. </P>\r
+\r
+<P>If no command registry is specified, the resource will default to <A HREF="../api/w3c.jigsaw.ssi.DefaultCommandRegistry.html">w3c.jigsaw.ssi.DefaultCommandRegistry</A>,\r
+which incorporates the most commonly used commands (including a set of\r
+commands analogous to the directives used by the NCSA server SSI module.)\r
+</P>\r
+\r
+<P>The replies from each of the commands (&quot;partial replies&quot;)\r
+are merged into a global reply. A <TT>Content-Length</TT> header will be\r
+emitted, provided that each of the commands emits one. </P>\r
+\r
+<P><A NAME="very-global-variables"></A><!-- -->The following variables\r
+are always defined initially, independent of the command registry used:\r
+</P>\r
+\r
+<UL>\r
+<LI><TT>Boolean secure</TT>: the value of the <TT><A HREF="#secure">secure</A></TT>\r
+attribute at the time of the request. </LI>\r
+\r
+<LI><TT>Integer maxDepth</TT>: the value of the <TT><A HREF="#maxDepth">maxDepth</A></TT>\r
+attribute at the time of the request. </LI>\r
+\r
+<LI><TT>Integer depth</TT>: the current include nesting depth. </LI>\r
+\r
+<LI><TT>CommandRegistry registry</TT>: the current command registry. </LI>\r
+</UL>\r
+\r
+<P>Please note that both the CommandRegistry base class and the Command\r
+interface are likely to change in future releases. </P>\r
+\r
+<H3>Known Bugs / Limitations </H3>\r
+\r
+<UL>\r
+<LI>In EchoCommand, GMT dates are not formatted using the datefmt config\r
+variable (instead, they're always formatted in &quot;Java format&quot;).\r
+</LI>\r
+\r
+<LI>Validation using entity tags is not supported (yet). </LI>\r
+\r
+<LI>There is no support of a customized failure message in DefaultCommandRegistry.\r
+</LI>\r
+\r
+<LI>Commands have no option of determining their own persistency format.\r
+This could give better performance for some commands. </LI>\r
+\r
+<LI>Not all the headers from partial replies are merged. (It doesn't really\r
+make sense for some). </LI>\r
+</UL>\r
+\r
+<P>\r
+<HR></P>\r
+\r
+<H2>Inherits </H2>\r
+\r
+<P>The <A HREF="../api/w3c.jigsaw.ssi.SSIResource.html">SSIResource</A>\r
+class inherits from the following classes: </P>\r
+\r
+<UL>\r
+<LI><A HREF="w3c.jigsaw.resources.FileResource.html">FileResource</A> </LI>\r
+</UL>\r
+\r
+<P>\r
+<HR></P>\r
+\r
+<H2>Attributes description </H2>\r
+\r
+<P>The DirectoryResource defines the following attributes: </P>\r
+\r
+<UL>\r
+<LI><A HREF="#registryClass">registryClass</A> </LI>\r
+\r
+<LI><A HREF="#maxDepth">maxDepth</A> </LI>\r
+\r
+<LI><A HREF="#secure">secure</A> </LI>\r
+</UL>\r
+\r
+<P>\r
+<HR><A NAME="registryClass"></A><TT>registryClass</TT> </P>\r
+\r
+<DL>\r
+<DT><I>semantics</I> </DT>\r
+\r
+<DD>The class that the command registry is to be an instance of. It must\r
+be a subclass of <A HREF="../api/w3c.jigsaw.ssi.CommandRegistry.html">w3c.jigsaw.ssi.CommandRegistry</A>.\r
+</DD>\r
+\r
+<DT><I>type</I> </DT>\r
+\r
+<DD>This attribute is an editable <A HREF="../api/w3c.jigsaw.resources.ClassAttribute.html">ClassAttribute</A>.\r
+</DD>\r
+\r
+<DT><I>default value</I> </DT>\r
+\r
+<DD>This attribute defaults to <A HREF="../api/w3c.jigsaw.ssi.DefaultCommandRegistry.html">w3c.jigsaw.ssi.DefaultCommandRegistry</A>.\r
+</DD>\r
+</DL>\r
+\r
+<P>\r
+<HR><A NAME="maxDepth"></A>maxDepth </P>\r
+\r
+<DL>\r
+<DT><I>semantics</I> </DT>\r
+\r
+<DD>The maximum depth of recursive document inclusion. Every time a document\r
+is included, a counter is increased. If this count gets to be equal to\r
+maxDepth, any further inclusion commands will be ignored. (Note that whether\r
+or not a command qualifies as an &quot;inclusion command&quot; is completely\r
+dependent on the command registry being used).<BR>\r
+If set to <B>0</B>, no recursion limit will be enforced. </DD>\r
+\r
+<DT><I>type</I> </DT>\r
+\r
+<DD>This attribute is an editable <A HREF="../api/w3c.jigsaw.resources.IntegerAttribute.html">IntegerAttribute</A>.\r
+</DD>\r
+\r
+<DT><I>default value</I> </DT>\r
+\r
+<DD>This attribute defaults to <B>10</B>. </DD>\r
+</DL>\r
+\r
+<P>\r
+<HR><A NAME="secure"></A>secure </P>\r
+\r
+<DL>\r
+<DT><I>semantics</I> </DT>\r
+\r
+<DD>If <B>true</B>, only <I>secure</I> commands will be permitted. The\r
+definition of &quot;secure&quot; is fully dependent on the command registry\r
+used. In the case of the <A HREF="../api/w3c.jigsaw.ssi.DefaultCommandRegistry.html">DefaultCommandRegistry</A>,\r
+all commands except for <TT>exec</TT> are considered secure. </DD>\r
+\r
+<DT><I>type</I> </DT>\r
+\r
+<DD>This attribute is an editable <A HREF="../api/w3c.jigsaw.resources.BooleanAttribute.html">BooleanAttribute</A>.\r
+</DD>\r
+\r
+<DT><I>default value</I> </DT>\r
+\r
+<DD>This attribute defaults to <B>true</B>. </DD>\r
+</DL>\r
+\r
+<P>\r
+<HR><I><A HREF="mailto:anto@w3.org">Antonio Ram&iacute;rez<BR>\r
+</A>$Id: w3c.jigsaw.ssi.SSIResource.html,v 1.7 1996/09/25 14:23:16 abaird\r
+Exp $</I> </P>\r
+\r
+<P></bodytext></P>\r
+\r
+</BODY>\r
+</HTML>\r