org.archive.modules.credential

Class HttpAuthenticationCredential

java.lang.Object

org.archive.modules.credential.Credential

org.archive.modules.credential.HttpAuthenticationCredential

All Implemented Interfaces:

Serializable

public class HttpAuthenticationCredential
extends Credential

A Basic/Digest HTTP Authentication (RFC2617) credential. (Previously named "Rfc2617Credential".)

Version:

$Revision$, $Date$

Author:

stack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	login Login.
protected String	password Password.
protected String	realm Basic/Digest Auth realm.

Fields inherited from class org.archive.modules.credential.Credential

domain

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticationCredential() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static HttpAuthenticationCredential	getByRealm(Set<Credential> rfc2617Credentials, String realm, CrawlURI context) Convenience method that does look up on passed set using realm for key.
String	getKey()
String	getLogin()
String	getPassword()
String	getPrerequisite(CrawlURI curi) Return the authentication URI, either absolute or relative, that serves as prerequisite the passed curi.
String	getRealm()
boolean	hasPrerequisite(CrawlURI curi)
boolean	isEveryTime()
boolean	isPost()
boolean	isPrerequisite(CrawlURI curi)
boolean	populate(CrawlURI curi, org.apache.commons.httpclient.HttpClient http, org.apache.commons.httpclient.HttpMethod method, Map<String,String> httpAuthChallenges)
void	setLogin(String login)
void	setPassword(String password)
void	setRealm(String realm)

Methods inherited from class org.archive.modules.credential.Credential

attach, detach, detachAll, getDomain, rootUriMatch, setDomain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

realm

protected String realm

Basic/Digest Auth realm.

login

protected String login

Login.

password

protected String password

Password.

Constructor Detail

HttpAuthenticationCredential

public HttpAuthenticationCredential()

Constructor.

Method Detail

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

getLogin

public String getLogin()

setLogin

public void setLogin(String login)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

isPrerequisite

public boolean isPrerequisite(CrawlURI curi)

Specified by:

isPrerequisite in class Credential

Parameters:

curi - CrawlURI to look at.

Returns:

True if this credential IS a prerequisite for passed CrawlURI.

hasPrerequisite

public boolean hasPrerequisite(CrawlURI curi)

Specified by:

hasPrerequisite in class Credential

Parameters:

curi - CrawlURI to look at.

Returns:

True if this credential HAS a prerequisite for passed CrawlURI.

getPrerequisite

public String getPrerequisite(CrawlURI curi)

Description copied from class: Credential

Return the authentication URI, either absolute or relative, that serves as prerequisite the passed curi.

Specified by:

getPrerequisite in class Credential

Parameters:

curi - CrawlURI to look at.

Returns:

Prerequisite URI for the passed curi.

getKey

public String getKey()

Specified by:

getKey in class Credential

Returns:

Key that is unique to this credential type.

isEveryTime

public boolean isEveryTime()

Specified by:

isEveryTime in class Credential

Returns:

True if this credential is of the type that needs to be offered on each visit to the server (e.g. Rfc2617 is such a type).

populate

public boolean populate(CrawlURI curi,
               org.apache.commons.httpclient.HttpClient http,
               org.apache.commons.httpclient.HttpMethod method,
               Map<String,String> httpAuthChallenges)

Specified by:

populate in class Credential

Parameters:

curi - CrawlURI to as for context.

http - Instance of httpclient.

method - Method to populate.

Returns:

True if added a credentials.

isPost

public boolean isPost()

Specified by:

isPost in class Credential

Returns:

True if this credential is to be posted. Return false if the credential is to be GET'd or if POST'd or GET'd are not pretinent to this credential type.

getByRealm

public static HttpAuthenticationCredential getByRealm(Set<Credential> rfc2617Credentials,
                                      String realm,
                                      CrawlURI context)

Convenience method that does look up on passed set using realm for key.

Parameters:

rfc2617Credentials - Set of Rfc2617 credentials. If passed set is not pure Rfc2617Credentials then will be ClassCastExceptions.

realm - Realm to find in passed set.

context - Context to use when searching the realm.

Returns:

Credential of passed realm name else null. If more than one credential w/ passed realm name, and there shouldn't be, we return first found.