From 4583ff7306397bd0f7b30e89698dab22b562af92 Mon Sep 17 00:00:00 2001 From: gojomo Date: Mon, 6 Jul 2009 22:09:52 +0000 Subject: [PATCH] Rename Rrc2617Credential to HttpAuthenticationCredential * (multiple) use more-familiar name for HTTP authentication --- .../org/archive/crawler/datamodel/CrawlURI.java | 4 ++-- .../crawler/selftest/HttpAuthSelfTest.java | 2 +- .../main/java/org/archive/modules/Processor.java | 10 +++++----- .../modules/credential/CredentialStore.java | 2 +- ...al.java => HttpAuthenticationCredential.java} | 16 +++++++++------- .../org/archive/modules/fetcher/FetchHTTP.java | 10 +++++----- ...ava => HttpAuthenticationCredentialTest.java} | 2 +- 7 files changed, 24 insertions(+), 22 deletions(-) rename modules/src/main/java/org/archive/modules/credential/{Rfc2617Credential.java => HttpAuthenticationCredential.java} (91%) rename modules/src/test/java/org/archive/modules/credential/{Rfc2617CredentialTest.java => HttpAuthenticationCredentialTest.java} (93%) diff --git a/engine/src/main/java/org/archive/crawler/datamodel/CrawlURI.java b/engine/src/main/java/org/archive/crawler/datamodel/CrawlURI.java index e7a4632a..c24fa52b 100644 --- a/engine/src/main/java/org/archive/crawler/datamodel/CrawlURI.java +++ b/engine/src/main/java/org/archive/crawler/datamodel/CrawlURI.java @@ -79,7 +79,7 @@ import org.apache.commons.httpclient.methods.PostMethod; import org.archive.modules.ModuleAttributeConstants; import org.archive.modules.ProcessorURI; import org.archive.modules.credential.CredentialAvatar; -import org.archive.modules.credential.Rfc2617Credential; +import org.archive.modules.credential.HttpAuthenticationCredential; import org.archive.modules.extractor.HTMLLinkContext; import org.archive.modules.extractor.Hop; import org.archive.modules.extractor.Link; @@ -983,7 +983,7 @@ implements ProcessorURI, MultiReporter, Serializable, OverlayContext { if (avatars != null && avatars.size() > 0) { for (Iterator i = avatars.iterator(); i.hasNext();) { if (((CredentialAvatar)i.next()). - match(Rfc2617Credential.class)) { + match(HttpAuthenticationCredential.class)) { result = true; break; } diff --git a/engine/src/test/java/org/archive/crawler/selftest/HttpAuthSelfTest.java b/engine/src/test/java/org/archive/crawler/selftest/HttpAuthSelfTest.java index 93015ec9..56c0305b 100644 --- a/engine/src/test/java/org/archive/crawler/selftest/HttpAuthSelfTest.java +++ b/engine/src/test/java/org/archive/crawler/selftest/HttpAuthSelfTest.java @@ -111,7 +111,7 @@ public class HttpAuthSelfTest " \n" + " \n" + " \n" + - " \n" + + " \n" + " \n" + " \n" + " \n" + diff --git a/modules/src/main/java/org/archive/modules/Processor.java b/modules/src/main/java/org/archive/modules/Processor.java index 131d2f6c..fa685402 100644 --- a/modules/src/main/java/org/archive/modules/Processor.java +++ b/modules/src/main/java/org/archive/modules/Processor.java @@ -30,7 +30,7 @@ import java.util.concurrent.atomic.AtomicLong; import org.apache.commons.httpclient.HttpStatus; import org.archive.modules.credential.CredentialAvatar; -import org.archive.modules.credential.Rfc2617Credential; +import org.archive.modules.credential.HttpAuthenticationCredential; import org.archive.modules.deciderules.AcceptDecideRule; import org.archive.modules.deciderules.DecideResult; import org.archive.modules.deciderules.DecideRule; @@ -207,7 +207,7 @@ implements Serializable, HasKeyedProperties, Lifecycle { boolean result = false; int statusCode = puri.getFetchStatus(); if (statusCode == HttpStatus.SC_UNAUTHORIZED && - hasRfc2617CredentialAvatar(puri)) { + hasHttpAuthenticationCredentialAvatar(puri)) { result = false; } else { result = (statusCode > 0); @@ -226,12 +226,12 @@ implements Serializable, HasKeyedProperties, Lifecycle { /** - * @return True if we have an rfc2617 payload. + * @return True if we have an HttpAuthentication (rfc2617) payload. */ - public static boolean hasRfc2617CredentialAvatar(ProcessorURI puri) { + public static boolean hasHttpAuthenticationCredentialAvatar(ProcessorURI puri) { Set avatars = puri.getCredentialAvatars(); for (CredentialAvatar ca: avatars) { - if (ca.match(Rfc2617Credential.class)) { + if (ca.match(HttpAuthenticationCredential.class)) { return true; } } diff --git a/modules/src/main/java/org/archive/modules/credential/CredentialStore.java b/modules/src/main/java/org/archive/modules/credential/CredentialStore.java index 2db2c329..a84c89bd 100644 --- a/modules/src/main/java/org/archive/modules/credential/CredentialStore.java +++ b/modules/src/main/java/org/archive/modules/credential/CredentialStore.java @@ -89,7 +89,7 @@ public class CredentialStore implements Serializable, HasKeyedProperties { // Initialize the credentialType data member. static { // Array of all known credential types. - Class [] tmp = {HtmlFormCredential.class, Rfc2617Credential.class}; + Class [] tmp = {HtmlFormCredential.class, HttpAuthenticationCredential.class}; credentialTypes = Collections.unmodifiableList(Arrays.asList(tmp)); } diff --git a/modules/src/main/java/org/archive/modules/credential/Rfc2617Credential.java b/modules/src/main/java/org/archive/modules/credential/HttpAuthenticationCredential.java similarity index 91% rename from modules/src/main/java/org/archive/modules/credential/Rfc2617Credential.java rename to modules/src/main/java/org/archive/modules/credential/HttpAuthenticationCredential.java index a4b56665..1cceddfb 100644 --- a/modules/src/main/java/org/archive/modules/credential/Rfc2617Credential.java +++ b/modules/src/main/java/org/archive/modules/credential/HttpAuthenticationCredential.java @@ -31,16 +31,18 @@ import org.apache.commons.httpclient.auth.AuthScope; import org.archive.modules.ProcessorURI; /** - * A Basic/Digest auth RFC2617 credential. + * A Basic/Digest HTTP Authentication (RFC2617) credential. * + * (Previously named "Rfc2617Credential".) + * * @author stack * @version $Revision$, $Date$ */ -public class Rfc2617Credential extends Credential { +public class HttpAuthenticationCredential extends Credential { private static final long serialVersionUID = 3L; private static Logger logger = - Logger.getLogger(Rfc2617Credential.class.getName()); + Logger.getLogger(HttpAuthenticationCredential.class.getName()); /** Basic/Digest Auth realm. */ @@ -73,7 +75,7 @@ public class Rfc2617Credential extends Credential { /** * Constructor. */ - public Rfc2617Credential() { + public HttpAuthenticationCredential() { } public boolean isPrerequisite(ProcessorURI curi) { @@ -158,16 +160,16 @@ public class Rfc2617Credential extends Credential { * credential w/ passed realm name, and there shouldn't be, we return first * found. */ - public static Rfc2617Credential getByRealm(Set rfc2617Credentials, + public static HttpAuthenticationCredential getByRealm(Set rfc2617Credentials, String realm, ProcessorURI context) { - Rfc2617Credential result = null; + HttpAuthenticationCredential result = null; if (rfc2617Credentials == null || rfc2617Credentials.size() <= 0) { return result; } if (rfc2617Credentials != null && rfc2617Credentials.size() > 0) { for (Iterator i = rfc2617Credentials.iterator(); i.hasNext();) { - Rfc2617Credential c = (Rfc2617Credential)i.next(); + HttpAuthenticationCredential c = (HttpAuthenticationCredential)i.next(); if (c.getRealm().equals(realm)) { result = c; break; diff --git a/modules/src/main/java/org/archive/modules/fetcher/FetchHTTP.java b/modules/src/main/java/org/archive/modules/fetcher/FetchHTTP.java index 192e92c2..3e1725ca 100644 --- a/modules/src/main/java/org/archive/modules/fetcher/FetchHTTP.java +++ b/modules/src/main/java/org/archive/modules/fetcher/FetchHTTP.java @@ -94,7 +94,7 @@ import org.archive.modules.ProcessorURI; import org.archive.modules.credential.Credential; import org.archive.modules.credential.CredentialAvatar; import org.archive.modules.credential.CredentialStore; -import org.archive.modules.credential.Rfc2617Credential; +import org.archive.modules.credential.HttpAuthenticationCredential; import org.archive.modules.deciderules.AcceptDecideRule; import org.archive.modules.deciderules.DecideResult; import org.archive.modules.deciderules.DecideRule; @@ -1120,8 +1120,8 @@ public class FetchHTTP extends Processor implements Lifecycle { // any of them for this realm? If so, then the credential failed // if we got a 401 and it should be let die a natural 401 death. Set curiRfc2617Credentials = getCredentials(curi, - Rfc2617Credential.class); - Rfc2617Credential extant = Rfc2617Credential.getByRealm( + HttpAuthenticationCredential.class); + HttpAuthenticationCredential extant = HttpAuthenticationCredential.getByRealm( curiRfc2617Credentials, realm, curi); if (extant != null) { // Then, already tried this credential. Remove ANY rfc2617 @@ -1141,12 +1141,12 @@ public class FetchHTTP extends Processor implements Lifecycle { String serverKey = getServerKey(curi); CrawlServer server = serverCache.getServerFor(serverKey); Set storeRfc2617Credentials = getCredentialStore().subset(curi, - Rfc2617Credential.class, server.getName()); + HttpAuthenticationCredential.class, server.getName()); if (storeRfc2617Credentials == null || storeRfc2617Credentials.size() <= 0) { logger.info("No rfc2617 credentials for " + curi); } else { - Rfc2617Credential found = Rfc2617Credential.getByRealm( + HttpAuthenticationCredential found = HttpAuthenticationCredential.getByRealm( storeRfc2617Credentials, realm, curi); if (found == null) { logger.info("No rfc2617 credentials for realm " + realm diff --git a/modules/src/test/java/org/archive/modules/credential/Rfc2617CredentialTest.java b/modules/src/test/java/org/archive/modules/credential/HttpAuthenticationCredentialTest.java similarity index 93% rename from modules/src/test/java/org/archive/modules/credential/Rfc2617CredentialTest.java rename to modules/src/test/java/org/archive/modules/credential/HttpAuthenticationCredentialTest.java index 3952c1e3..78864e16 100644 --- a/modules/src/test/java/org/archive/modules/credential/Rfc2617CredentialTest.java +++ b/modules/src/test/java/org/archive/modules/credential/HttpAuthenticationCredentialTest.java @@ -32,7 +32,7 @@ import org.archive.state.ModuleTestBase; * @author pjack * */ -public class Rfc2617CredentialTest extends ModuleTestBase { +public class HttpAuthenticationCredentialTest extends ModuleTestBase { //TODO: add tests