From 30981f6b3a460a5c5dd749f90c05125b1fac43d7 Mon Sep 17 00:00:00 2001
From: ribeaudc <ribeaudc>
Date: Tue, 29 May 2007 08:06:16 +0000
Subject: [PATCH] Add logging to Crowd authentication.
SVN: 219
---
.../crowd/CrowdAuthenticationService.java | 128 +++++++++++++-----
1 file changed, 93 insertions(+), 35 deletions(-)
diff --git a/authentication/source/java/ch/systemsx/cisd/authentication/crowd/CrowdAuthenticationService.java b/authentication/source/java/ch/systemsx/cisd/authentication/crowd/CrowdAuthenticationService.java
index 0f22d337f63..dc2ee4ecfc6 100644
--- a/authentication/source/java/ch/systemsx/cisd/authentication/crowd/CrowdAuthenticationService.java
+++ b/authentication/source/java/ch/systemsx/cisd/authentication/crowd/CrowdAuthenticationService.java
@@ -22,71 +22,111 @@ import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.StringRequestEntity;
import org.apache.commons.lang.StringEscapeUtils;
+import org.apache.commons.lang.StringUtils;
+import org.apache.log4j.Logger;
import ch.systemsx.cisd.authentication.IAuthenticationService;
import ch.systemsx.cisd.common.exceptions.CheckedExceptionTunnel;
+import ch.systemsx.cisd.common.logging.LogCategory;
+import ch.systemsx.cisd.common.logging.LogFactory;
/**
+ * This <code>IAuthenticationService</code> implementation first registers the application on the <i>Crowd</i>
+ * server, then authenticates the user.
*
- *
* @author felmer
*/
public class CrowdAuthenticationService implements IAuthenticationService
{
+ private static final Logger operationLog =
+ LogFactory.getLogger(LogCategory.OPERATION, CrowdAuthenticationService.class);
+
private static final MessageFormat AUTHENTICATE_APPL =
- new MessageFormat("<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" "
- + "xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" "
- + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n" + " <soap:Body>\n"
- + " <authenticateApplication xmlns=\"urn:SecurityServer\">\n" + " <in0>\n"
- + " <credential xmlns=\"http://authentication.integration.crowd.atlassian.com\">\n"
- + " <credential>{1}</credential>\n" + " </credential>\n"
- + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</name>\n"
- + " <validationFactors xmlns=\"http://authentication.integration.crowd.atlassian.com\" "
- + " xsi:nil=\"true\" />\n" + " </in0>\n"
- + " </authenticateApplication>\n" + " </soap:Body>\n" + "</soap:Envelope>\n");
+ new MessageFormat("<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" "
+ + "xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" "
+ + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n" + " <soap:Body>\n"
+ + " <authenticateApplication xmlns=\"urn:SecurityServer\">\n" + " <in0>\n"
+ + " <credential xmlns=\"http://authentication.integration.crowd.atlassian.com\">\n"
+ + " <credential>{1}</credential>\n" + " </credential>\n"
+ + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</name>\n"
+ + " <validationFactors xmlns=\"http://authentication.integration.crowd.atlassian.com\" "
+ + " xsi:nil=\"true\" />\n" + " </in0>\n"
+ + " </authenticateApplication>\n" + " </soap:Body>\n" + "</soap:Envelope>\n");
private static final MessageFormat AUTHENTICATE_USER =
- new MessageFormat(
- "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" "
- + "xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" "
- + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"
- + " <soap:Body>\n"
- + " <authenticatePrincipal xmlns=\"urn:SecurityServer\">\n"
- + " <in0>\n"
- + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</name>\n"
- + " <token xmlns=\"http://authentication.integration.crowd.atlassian.com\">{1}</token>\n"
- + " </in0>\n"
- + " <in1>\n"
- + " <application xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</application>\n"
- + " <credential xmlns=\"http://authentication.integration.crowd.atlassian.com\">\n"
- + " <credential>{3}</credential>\n"
- + " </credential>\n"
- + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{2}</name>\n"
- + " <validationFactors xmlns=\"http://authentication.integration.crowd.atlassian.com\" />\n"
- + " </in1>\n" + " </authenticatePrincipal>\n" + " </soap:Body>\n"
- + "</soap:Envelope>\n");
+ new MessageFormat(
+ "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" "
+ + "xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" "
+ + "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"
+ + " <soap:Body>\n"
+ + " <authenticatePrincipal xmlns=\"urn:SecurityServer\">\n"
+ + " <in0>\n"
+ + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</name>\n"
+ + " <token xmlns=\"http://authentication.integration.crowd.atlassian.com\">{1}</token>\n"
+ + " </in0>\n"
+ + " <in1>\n"
+ + " <application xmlns=\"http://authentication.integration.crowd.atlassian.com\">{0}</application>\n"
+ + " <credential xmlns=\"http://authentication.integration.crowd.atlassian.com\">\n"
+ + " <credential>{3}</credential>\n"
+ + " </credential>\n"
+ + " <name xmlns=\"http://authentication.integration.crowd.atlassian.com\">{2}</name>\n"
+ + " <validationFactors xmlns=\"http://authentication.integration.crowd.atlassian.com\" />\n"
+ + " </in1>\n" + " </authenticatePrincipal>\n" + " </soap:Body>\n"
+ + "</soap:Envelope>\n");
private final String url;
+
private final String application;
- private final String applicationPassword;
+ private final String applicationPassword;
public CrowdAuthenticationService(String host, int port, String application, String applicationPassword)
{
this("https://" + host + ":" + port + "/crowd/services/SecurityServer", application, applicationPassword);
}
-
+
public CrowdAuthenticationService(String url, String application, String applicationPassword)
{
this.url = url;
this.application = application;
this.applicationPassword = applicationPassword;
+ if (operationLog.isDebugEnabled())
+ {
+ String msg = "A new CrowdAuthenticationService instance has been created with following values [";
+ msg += "url=" + url + ",application=" + application + "]";
+ operationLog.debug(msg);
+ }
}
-
+
public boolean authenticate(String user, String password)
{
- String applicationToken = StringEscapeUtils.unescapeXml(execute("token", AUTHENTICATE_APPL, application, applicationPassword));
- String userToken = StringEscapeUtils.unescapeXml(execute("out", AUTHENTICATE_USER, application, applicationToken, user, password));
+ String applicationToken =
+ StringEscapeUtils.unescapeXml(execute("token", AUTHENTICATE_APPL, application, applicationPassword));
+ if (applicationToken == null)
+ {
+ operationLog.warn("Application '" + application + "' could not be authenticated.");
+ return false;
+ } else
+ {
+ if (operationLog.isInfoEnabled())
+ {
+ operationLog.info("Application '" + application + "' successfully authenticated.");
+ }
+ }
+ String userToken =
+ StringEscapeUtils.unescapeXml(execute("out", AUTHENTICATE_USER, application, applicationToken, user,
+ password));
+ if (userToken == null)
+ {
+ operationLog.warn("User '" + user + "' could not be authenticated with application '" + application + "'.");
+ } else
+ {
+ if (operationLog.isInfoEnabled())
+ {
+ operationLog.info("User '" + user + "' successfully authenticated with application '" + application
+ + "'.");
+ }
+ }
return userToken != null;
}
@@ -101,21 +141,39 @@ public class CrowdAuthenticationService implements IAuthenticationService
return pickElementContent(response, responseElement);
}
+ /**
+ * Tries to find given <code>element</code> in given <code>xmlString</code>.
+ * <p>
+ * Returns <code>null</code> if given element could not be found.
+ * </p>
+ */
private String pickElementContent(String xmlString, String element)
{
int index = xmlString.indexOf("<" + element);
if (index < 0)
{
+ if (operationLog.isDebugEnabled())
+ {
+ operationLog.debug("Element '" + element + "' could not be found in '" + StringUtils.abbreviate(xmlString, 50) + "'.");
+ }
return null;
}
index = xmlString.indexOf(">", index);
if (index < 0)
{
+ if (operationLog.isDebugEnabled())
+ {
+ operationLog.debug("Element '" + element + "' could not be found in '" + StringUtils.abbreviate(xmlString, 50) + "'.");
+ }
return null;
}
int endIndex = xmlString.indexOf("</" + element, index);
if (endIndex < 0)
{
+ if (operationLog.isDebugEnabled())
+ {
+ operationLog.debug("Element '" + element + "' could not be found in '" + StringUtils.abbreviate(xmlString, 50) + "'.");
+ }
return null;
}
return xmlString.substring(index + 1, endIndex);
--
GitLab