From: Nick Kew <niq@apache.org>
Date: Wed, 5 Jan 2011 12:44:33 +0000 (+0000)
Subject: Change AuthnCacheProvider --> AuthnCacheProvideFor to deal with overloading
X-Git-Tag: 2.3.11~274
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=31ec3c475095dd3097181d331f5a1353b12cf035;p=thirdparty%2Fapache%2Fhttpd.git

Change AuthnCacheProvider --> AuthnCacheProvideFor to deal with overloading
of "provider" and likely confusion with AuthnCacheSOCache.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1055447 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/CHANGES b/CHANGES
index 8b23dce4ca6..42a65dfbc66 100644
--- a/CHANGES
+++ b/CHANGES
@@ -2,6 +2,13 @@
 
 Changes with Apache 2.3.11
 
+  *) mod_authn_socache: change directive name from AuthnCacheProvider
+     to AuthnCacheProvideFor.  The term "provider" is overloaded in
+     this module, and we should avoid confusion between the provider
+     of a backend (AuthnCacheSOCache) and the authn provider(s) for
+     which this module provides cacheing (AuthnCacheProvideFor).
+     [Nick Kew]
+
   *) mod_proxy_http: Allocate the fake backend request from a child pool
      of the backend connection, instead of misusing the pool of the frontend
      request. Fixes a thread safety issue where buckets set aside in the
diff --git a/docs/manual/mod/mod_authn_dbd.xml b/docs/manual/mod/mod_authn_dbd.xml
index 3e984e12f27..ab501c31333 100644
--- a/docs/manual/mod/mod_authn_dbd.xml
+++ b/docs/manual/mod/mod_authn_dbd.xml
@@ -93,7 +93,7 @@ DBDExptime 300
   AuthBasicProvider socache dbd
 
   # Also required for caching: tell the cache to cache dbd lookups!
-  AuthnCacheProvider dbd
+  AuthnCacheProvideFor dbd
   AuthnCacheContext my-server
 
   # mod_authz_core configuration
diff --git a/docs/manual/mod/mod_authn_socache.xml b/docs/manual/mod/mod_authn_socache.xml
index aa1017ec58b..8a0d85c32cb 100644
--- a/docs/manual/mod/mod_authn_socache.xml
+++ b/docs/manual/mod/mod_authn_socache.xml
@@ -60,7 +60,7 @@ the load on backends</description>
     <module>mod_authn_dbd</module> will usually benefit from this cache.</p>
     <p>The basic rules to cache for a provider are:</p>
     <ol><li>Include the provider you're cacheing for in an
-            <directive>AuthnCacheProvider</directive> directive.</li>
+            <directive>AuthnCacheProvideFor</directive> directive.</li>
         <li>List <var>socache</var> ahead of the provider you're
             cacheing for in your <directive module="mod_auth_basic"
             >AuthBasicProvider</directive> or <directive module=
@@ -74,7 +74,7 @@ the load on backends</description>
         AuthName "Cached Authentication Example"
         AuthBasicProvider socache dbd
         AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
-        AuthnCacheProvider dbd
+        AuthnCacheProvideFor dbd
         AuthnCacheContext dbd-authn-example
         AuthnCacheSOCache dbm
         Require valid-user
@@ -110,9 +110,9 @@ the load on backends</description>
 </directivesynopsis>
 
 <directivesynopsis>
-<name>AuthnCacheProvider</name>
+<name>AuthnCacheProvideFor</name>
 <description>Specify which authn provider(s) to cache for</description>
-<syntax>AuthnCacheProvider <var>authn-provider</var> [...]</syntax>
+<syntax>AuthnCacheProvideFor <var>authn-provider</var> [...]</syntax>
 <default>None</default>
 <contextlist><context>directory</context><context>.htaccess</context></contextlist>
 <override>AuthConfig</override>
@@ -120,13 +120,13 @@ the load on backends</description>
 <usage>
     <p>This directive specifies an authentication provider or providers
     to cache for.  Credentials found by a provider not listed in an
-    AuthnCacheProvider directive will not be cached.</p>
+    AuthnCacheProvideFor directive will not be cached.</p>
 
     <p>For example, to cache credentials found by <module>mod_authn_dbd</module>
     or by a custom provider <var>myprovider</var>, but leave those looked
     up by lightweight providers like file or dbm lookup alone:</p>
     <example>
-        AuthnCacheProvider dbd myprovider
+        AuthnCacheProvideFor dbd myprovider
     </example>
 </usage>
 </directivesynopsis>
diff --git a/modules/aaa/mod_authn_socache.c b/modules/aaa/mod_authn_socache.c
index 89b8f8e4779..1ec76e80ebf 100644
--- a/modules/aaa/mod_authn_socache.c
+++ b/modules/aaa/mod_authn_socache.c
@@ -205,7 +205,7 @@ static const command_rec authn_cache_cmds[] =
     AP_INIT_TAKE1("AuthnCacheSOCache", authn_cache_socache, NULL, RSRC_CONF,
                   "socache provider for authn cache"),
     /* per-dir stuff */
-    AP_INIT_ITERATE("AuthnCacheProvider", authn_cache_setprovider, NULL,
+    AP_INIT_ITERATE("AuthnCacheProvideFor", authn_cache_setprovider, NULL,
                     OR_AUTHCFG, "Determine what authn providers to cache for"),
     AP_INIT_TAKE1("AuthnCacheTimeout", authn_cache_timeout, NULL,
                   OR_AUTHCFG, "Timeout (secs) for cached credentials"),