--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
+<HTML>\r
+<HEAD>\r
+ <link rel="stylesheet" type="text/css" href="../style/doc.css"><style type="text/css">\r
+body { margin: 20pt; color: black; background: white; font-family: helvetica;} \r
+</STYLE>\r
+ <TITLE>The SSIFrame reference manual</TITLE>\r
+ <LINK HREF="jigsaw@w3.org" REL="made">\r
+</HEAD>\r
+<BODY>\r
+<P>\r
+<A HREF="../../.." TARGET="_top_"><IMG SRC="../../../Icons//WWW/w3c_home.gif"\r
+ ALT="W3C" BORDER="0" WIDTH="72" HEIGHT="48">\r
+</A><A HREF="../../" TARGET="_top_">\r
+<IMG SRC="../../../Icons//jigsaw" ALT="Jigsaw"BORDER="0"></A>\r
+ <hr noshade size="1">\r
+<A HREF="resources.html">All resources</A> <A HREF="frames.html">All frames\r
+</A> \r
+ <hr noshade size="1">\r
+<H1>\r
+ SSIFrame\r
+</H1>\r
+<P>\r
+The SSI frame implements server-side parsing of HTML documents. Inside an\r
+SSIFrame-indexed file, any comment of the form <TT><!--#commandName\r
+param1=val1 param2=val2 ... paramn=valn --></TT> will be interpreted as\r
+a command. Commands are looked up in an instance of the class supplied in\r
+the <A HREF="#registry-class">registryClass</A> attribute. This class must\r
+be a subclass of the abstract class\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/ssi/commands/CommandRegistry.html">org.w3c.jigsaw.ssi.commands.CommandRegistry</A>.\r
+Commands are implementations of the\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/ssi/commands/Command.html">Command</A>\r
+interface or the\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/ssi/commands/ControlCommand.html">ControlCommand</A>\r
+interface. \r
+<P>\r
+If no command registry is specified, the resource will default to\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/ssi/commands/DefaultCommandRegistry.html">org.w3c.jigsaw.ssi.commands.DefaultCommandRegistry</A>,\r
+which incorporates the most commonly used commands (including a set of commands\r
+analogous to the directives used by the NCSA server SSI module.) \r
+<P>\r
+The replies from each of the commands ("partial replies") are merged into\r
+a global reply. A Content-Length header will be emitted, provided that each\r
+of the commands emits one. \r
+<P>\r
+The following variables are always defined initially, independent of the\r
+command registry used: \r
+<UL>\r
+ <LI>\r
+ <TT>Boolean secure</TT>: the value of the <A HREF="#secure">secure</A> attribute\r
+ at the time of the request. \r
+ <LI>\r
+ <TT>Integer maxDepth</TT>: the value of the <A HREF="#maxDepth">maxDepth</A>\r
+ attribute at the time of the request. \r
+ <LI>\r
+ <TT>Integer depth</TT>: the current include nesting depth. \r
+ <LI>\r
+ <TT>CommandRegistry registry</TT>: the current command registry. \r
+</UL>\r
+<P>\r
+Please note that both the CommandRegistry base class and the Command interface\r
+are likely to change in future releases. \r
+<H2>\r
+ Known Bugs / Limitations \r
+</H2>\r
+<UL>\r
+ <LI>\r
+ In EchoCommand, GMT dates are not formatted using the datefmt config variable\r
+ (instead, they're always formatted in "Java format"). \r
+ <LI>\r
+ Validation using entity tags is not supported (yet). \r
+ <LI>\r
+ There is no support of a customized failure message in DefaultCommandRegistry.\r
+ <LI>\r
+ Commands have no option of determining their own persistency format. This\r
+ could give better performance for some commands. \r
+ <LI>\r
+ Not all the headers from partial replies are merged. (It doesn't really make\r
+ sense for some). \r
+</UL>\r
+<P>\r
+ <hr noshade size="1">\r
+<H2>\r
+ Inherits\r
+</H2>\r
+<P>\r
+The <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/ssi/SSIFrame.html">SSIFrame</A>\r
+class inerits from the following classes:\r
+<UL>\r
+ <LI>\r
+ <A HREF="org.w3c.tools.resources.Resource.html">Resource</A>\r
+ <LI>\r
+ <A HREF="org.w3c.tools.resources.FramedResource.html">FramedResource</A>\r
+ <LI>\r
+ <A HREF="org.w3c.tools.resources.ResourceFrame.html">ResourceFrame</A>\r
+ <LI>\r
+ <A HREF="org.w3c.tools.resources.ProtocolFrame.html">ProtocolFrame</A>\r
+ <LI>\r
+ <A HREF="org.w3c.jigsaw.frames.HTTPFrame.html">HTTPFrame</A>\r
+</UL>\r
+<P>\r
+ <hr noshade size="1">\r
+<H2>\r
+ Attributes description\r
+</H2>\r
+<P>\r
+The SSIFrame defines the following attributes:\r
+<UL>\r
+ <LI>\r
+ <A HREF="#maxDepth">maxDepth</A>\r
+ <LI>\r
+ <A HREF="#secure">secure</A>\r
+ <LI>\r
+ <A HREF="#registryClass">registryClass</A>\r
+</UL>\r
+<P>\r
+ <hr noshade size="1">\r
+<CODE><A NAME="maxDepth">maxDepth</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ 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 maxDepth,\r
+ any further inclusion commands will be ignored. (Note that whether or not\r
+ a command qualifies as an "inclusion command" is completely dependent on\r
+ the command registry being used). If set to <B>0</B>, no recursion limit\r
+ will be enforced. \r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/IntegerAttribute.html">IntegerAttribute</A>\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute defaults to <B>10</B>.\r
+</DL>\r
+<P>\r
+ <hr noshade size="1">\r
+<CODE><A NAME="secure">secure</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ If true, only <I>secure</I> commands will be permitted. The definition of\r
+ "secure" is fully dependent on the command registry used. In the case of\r
+ the\r
+ <A HREF="org.w3c.jigsaw.ssi.commands.DefaultCommandRegistry.html">DefaultCommandRegistry</A>,\r
+ all commands except for exec are considered secure. \r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</A>\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute defaults to <B>true</B>.\r
+</DL>\r
+<P>\r
+ <hr noshade size="1">\r
+<CODE><A NAME="registryClass">registryClass</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The class that the command registry is to be an instance of. It must be a\r
+ subclass of\r
+ <A HREF="org.w3c.jigsaw.ssi.commands.DefaultCommandRegistry.html">org.w3c.jigsaw.ssi.commands.CommandRegistry</A>.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/ClassAttribute.html">ClassAttribute</A>\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute defaults to\r
+ <B>org.w3c.jigsaw.ssi.commands.DefaultCommandRegistry</B>.\r
+</DL>\r
+<P>\r
+<P>\r
+ <hr noshade size="1">\r
+<P>\r
+<I><A HREF="mailto:jigsaw@w3.org">Jigsaw Team</A><BR>\r
+$Id: org.w3c.jigsaw.ssi.SSIFrame.html,v 1.3 1998/03/27 08:24:08 bmahe Exp\r
+$</I>\r
+</BODY></HTML>\r
projects / Benchmarks_CSolver.git / blobdiff