Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / jigsaw / WWW / Doc / Reference / org.w3c.jigsaw.auth.AuthFilter.html
diff --git a/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.auth.AuthFilter.html b/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.auth.AuthFilter.html
new file mode 100644 (file)
index 0000000..0f4d222
--- /dev/null
@@ -0,0 +1,172 @@
+<!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 AuthFilter 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
+  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 noshade size="1">\r
+<H2>\r
+  Inherits\r
+</H2>\r
+<P>\r
+The\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/auth/AuthFilter.html">AuthFilter</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.ResourceFilter.html">ResourceFilter</A>\r
+</UL>\r
+<P>\r
+  <hr noshade size="1">\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="#realm">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 noshade size="1">\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 an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringArrayAttribute.html">StringArrayAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="realm">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. Jigsaw manages\r
+    a catalog of realms, allowing you to define as many of them as needed. This\r
+    attribute is a realm identifier, i.e it is the symbolic name under which\r
+    the realm catalog knows about it. When undefined, the filter will not run\r
+    any authentication code. \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/StringAttribute.html">StringAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\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 true, the authentication filter will decorate replies\r
+    on the way back, marking the reply as being cachable by proxies only if the\r
+    proxy is willing to revalidate it. \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>false</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="private-cachability">private-cachability</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    When this flag is set to true, it overrides all other settings, and mark\r
+    the reply on its way back as being cachable by any cache (a private or shared\r
+    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="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>false</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="public-cachability">public-cachability</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    When set to true, the filter will mark all outgoing replies it catches as\r
+    being cachable, witouht even requiring revalidation. \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>false</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.auth.AuthFilter.html,v 1.3 1998/03/27 08:14:58 bmahe\r
+Exp $</I>\r
+</BODY></HTML>\r