Mailing-List: contact commits-help@manifoldcf.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@manifoldcf.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1536587 - in /manifoldcf/integration/solr-4.x/trunk:
 CHANGES.txt mcf/README.txt
Date: Tue, 29 Oct 2013 05:07:58 -0000
To: commits@manifoldcf.apache.org
From: kwright@apache.org
Message-Id: <20131029050758.5903C23888A6@eris.apache.org>

Author: kwright
Date: Tue Oct 29 05:07:57 2013
New Revision: 1536587

URL: http://svn.apache.org/r1536587
Log:
Update documentation

Modified:
    manifoldcf/integration/solr-4.x/trunk/CHANGES.txt
    manifoldcf/integration/solr-4.x/trunk/mcf/README.txt

Modified: manifoldcf/integration/solr-4.x/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/manifoldcf/integration/solr-4.x/trunk/CHANGES.txt?rev=1536587&r1=1536586&r2=1536587&view=diff
==============================================================================
--- manifoldcf/integration/solr-4.x/trunk/CHANGES.txt (original)
+++ manifoldcf/integration/solr-4.x/trunk/CHANGES.txt Tue Oct 29 05:07:57 2013
@@ -3,6 +3,11 @@ $Id$
 
 ======================= 0.5-dev =====================
 
+Add functionality making the plugin compatible with multi-domain
+features of ManifoldCF.  Specifically, allow multiple domain/username
+tuples to be passed in the request.
+(Karl Wright)
+
 ======================= Release 0.4 =====================
 
 CONNECTORS-534: Repackage plugins to have a true binary release,

Modified: manifoldcf/integration/solr-4.x/trunk/mcf/README.txt
URL: http://svn.apache.org/viewvc/manifoldcf/integration/solr-4.x/trunk/mcf/README.txt?rev=1536587&r1=1536586&r2=1536587&view=diff
==============================================================================
--- manifoldcf/integration/solr-4.x/trunk/mcf/README.txt (original)
+++ manifoldcf/integration/solr-4.x/trunk/mcf/README.txt Tue Oct 29 05:07:57 2013
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+Compatibility
+------------
+
+This version of this component is only compatible with ManifoldCF 1.5 and above, and cannot be used with earlier releases of ManifoldCF.
 
 Getting Started
 ---------------
@@ -73,3 +77,34 @@ Hook up the search component in the solr
   ...
 </requestHandler>
 
+
+Supplying authenticated usernames and domains
+----------------------------------------------
+
+This component looks for the following parameters in the Solr request object:
+
+AuthenticatedUserName
+AuthenticatedUserDomain
+AuthenticatedUserName_XX
+AuthenticatedUserDomain_XX
+
+At a minimum, AuthenticatedUserName must be present in order for the component to communicate with
+the ManifoldCF Authority Service and obtain user access tokens.  In that case, the user identity will consist
+of one user and one authorization domain.  If AuthenticatedUserDomain is not set, then the authorization domain
+chosen will be the standard default domain, an empty string.
+
+If you need multiple user/domain tuples for the user identity, you may pass these as parameter pairs starting with
+AuthenticatedUserName_0 and AuthenticatedUserDomain_0, and counting up as high as you like.
+
+Operation in conjunction with mod-authz-annotate
+------------------------------------------------
+
+An optional component of ManifoldCF can be built and deployed as part of Apache - mod-authz-annotate.  The
+mod-authz-annotate module obtains the Kerberos principal from the Kerberos tickets present if mod-auth-kerb is used, and uses
+the MCF Authority Service to look up the appropriate access tokens.  If you choose to use that architecture,
+you will still need to use this Solr component to modify the user query.  All you have to do is the following:
+
+- Make sure you do not set AuthenticatedUserName or AuthenticatedUserName_0 in the request
+- Make sure the HTTP request from Apache to Solr translates all AAAGRP header values into "UserToken" parameters
+   for the Solr request
+