--- /dev/null
+<HTML>\r
+<HEAD>\r
+ <!-- Created by GNNpress -->\r
+ <TITLE>The AuthFilter administration guide.</TITLE>\r
+<!-- Changed by: Anselm Baird-Smith, 4-Feb-1997 -->\r
+</HEAD>\r
+<BODY BGCOLOR="white">\r
+<A HREF="http://www.w3.org/pub/WWW/" TARGET="_top_">\r
+ <IMG SRC="/icons/WWW/w3c_home.gif"\r
+ ALT="W3C"\r
+ BORDER="0" WIDTH="72" HEIGHT="48"></A>\r
+<A HREF="http://www.w3.org/pub/WWW/Jigsaw/" TARGET="_top_">\r
+ <IMG SRC="/icons/jigsaw" ALT="Jigsaw" BORDER="0">\r
+</A>\r
+<HR>\r
+<A HREF="resources.html">All Resources</A> \r
+<A HREF="filters.html">All filters </A>\r
+<HR>\r
+<H1>\r
+ AuthFilter\r
+</H1>\r
+<P>\r
+A filter that implements authentication. Currently this filter handles only\r
+Basic Authentication, as defined by the HTTP/1.1 specification.\r
+<P>\r
+ <HR>\r
+<H2>\r
+ Inherits\r
+</H2>\r
+<P>\r
+The <A HREF="../api/w3c.jigsaw.auth.GenericAuthFilter.html">AuthFilter</A>\r
+class inherits from the following classes:\r
+<UL>\r
+ <LI>\r
+ ResourceFilter (aka abstract class)\r
+</UL>\r
+<P>\r
+ <HR>\r
+<H2>\r
+ Attributes description\r
+</H2>\r
+<P>\r
+The AuthFilter defines the following attributes:\r
+<UL>\r
+ <LI>\r
+ <A HREF="#methods">methods</A>\r
+ <LI>\r
+ <A HREF="#realms">realm</A>\r
+ <LI>\r
+ <A HREF="#shared-cachability">shared-cachability</A>\r
+ <LI>\r
+ <A HREF="#private-cachability">private-cachability</A>\r
+ <LI>\r
+ <A HREF="#public-cachability">public-cachability</A>\r
+</UL>\r
+<P>\r
+ <HR>\r
+<CODE><A NAME="methods">methods</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The set of methods to protect against. When undefined, the filter will protected\r
+ all HTTP method, otherwise it will just protect against the given set of\r
+ methods. Each method is given by its name (in upper case).\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is a editable\r
+ <A HREF="../api/w3c.jigsaw.resources.StringArrayAttribute.html">StringArrayAttribute</A>.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute is undefined by default (so the filter will protect all methods).\r
+</DL>\r
+<P>\r
+ <HR>\r
+<CODE><A NAME="realms">realm</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ The realm (a.k.a. database) to use to obtain user information. <B>Jigsaw</B>\r
+ manages a catalog of realms, allowing you to define as many of them as needed.\r
+ This attribute is a realm <I>identifier</I>, i.e it is the symbolic name\r
+ under which the realm catalog knows about it.<BR>\r
+ When undefined, the filter will <I>not</I> run any authentication code.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="../api/w3c.jigsaw.resources.StringAttribute.html">StringAttribute</A>.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute is undefined by default.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<CODE><A NAME="shared-cachability">shared-cachability</A></CODE>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ When this flag is set to <STRONG>true</STRONG>, the authentication filter\r
+ will decorate replies on the way back, marking the reply as being cachable\r
+ by proxies <I>only</I> if the proxy is willing to revalidate it.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="../api/w3c.jigsaw.resources.BooleanAttribute.html">BooleanAttribute</A>.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute is set to <STRONG>false</STRONG> by default.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<A NAME="private-cachability">private<CODE>-cachability</CODE></A>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ When this flag is set to <STRONG>true</STRONG>, it overrides all other settings,\r
+ and mark the reply on its way back as being cachable by any cache (a private\r
+ or shared cache) prvided that cache revalidates it on each access.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="../api/w3c.jigsaw.resources.BooleanAttribute.html">BooleanAttribute</A>.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute is set to <STRONG>false</STRONG> by default.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<A NAME="public-cachability">public<CODE>-cachability</CODE></A>\r
+<DL>\r
+ <DT>\r
+ <I>semantics</I>\r
+ <DD>\r
+ When set to <STRONG>true</STRONG>, the filter will mark all outgoing replies\r
+ it catches as being cachable, witouht even requiring revalidation.\r
+ <DT>\r
+ <I>type</I>\r
+ <DD>\r
+ This attribute is an editable\r
+ <A HREF="../api/w3c.jigsaw.resources.BooleanAttribute.html">BooleanAttribute</A>.\r
+ <DT>\r
+ <I>default value</I>\r
+ <DD>\r
+ This attribute is set to <STRONG>false</STRONG> by default.\r
+</DL>\r
+<P>\r
+ <HR>\r
+<P>\r
+<I><A HREF="mailto:jigsaw@w3.org">Jigsaw Team</A><BR>\r
+$Id: w3c.jigsaw.auth.AuthFilter.html,v 1.1 1996/04/13 02:23:05 abaird Exp\r
+$</I>\r
+</BODY></HTML>\r