org.archive.modules.credential

Class Credential

java.lang.Object

org.archive.modules.credential.Credential

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HtmlFormCredential, HttpAuthenticationCredential

public abstract class Credential
extends Object
implements Serializable

Credential type. Let this be also a credential in the JAAS sense to in that this is what gets added to a subject on successful authentication since it contains data needed to authenticate (realm, login, password, etc.).

Settings system assumes that subclasses implement a constructor that takes a name only.

Version:

$Revision$, $Date$

Author:

stack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	domain The root domain this credential goes against: E.g.

Constructor Summary

Constructors

Constructor and Description
Credential() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(CrawlURI curi) Attach this credentials avatar to the passed curi .
boolean	detach(CrawlURI curi) Detach this credential from passed curi.
boolean	detachAll(CrawlURI curi) Detach all credentials of this type from passed curi.
String	getDomain()
abstract String	getKey()
abstract String	getPrerequisite(CrawlURI curi) Return the authentication URI, either absolute or relative, that serves as prerequisite the passed curi.
abstract boolean	hasPrerequisite(CrawlURI curi)
abstract boolean	isEveryTime()
abstract boolean	isPost()
abstract boolean	isPrerequisite(CrawlURI curi)
abstract boolean	populate(CrawlURI curi, org.apache.commons.httpclient.HttpClient http, org.apache.commons.httpclient.HttpMethod method, Map<String,String> httpAuthChallenges)
boolean	rootUriMatch(ServerCache cache, CrawlURI curi) Test passed curi matches this credentials rootUri.
void	setDomain(String domain)

Methods inherited from class java.lang.Object

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

Field Detail

domain

protected String domain

The root domain this credential goes against: E.g. www.archive.org

Constructor Detail

Credential

public Credential()

Constructor.

Method Detail

getDomain

public String getDomain()

Parameters:

context - Context to use when searching for credential domain.

Returns:

The domain/root URI this credential is to go against.

Throws:

AttributeNotFoundException - If attribute not found.

setDomain

public void setDomain(String domain)

attach

public void attach(CrawlURI curi)

Attach this credentials avatar to the passed curi . Override if credential knows internally what it wants to attach as payload. Otherwise, if payload is external, use the below #attach(CrawlURI, String).

Parameters:

curi - CrawlURI to load with credentials.

detach

public boolean detach(CrawlURI curi)

Detach this credential from passed curi.

Parameters:

curi -

Returns:

True if we detached a Credential reference.

detachAll

public boolean detachAll(CrawlURI curi)

Detach all credentials of this type from passed curi.

Parameters:

curi -

Returns:

True if we detached references.

isPrerequisite

public abstract boolean isPrerequisite(CrawlURI curi)

Parameters:

curi - CrawlURI to look at.

Returns:

True if this credential IS a prerequisite for passed CrawlURI.

hasPrerequisite

public abstract boolean hasPrerequisite(CrawlURI curi)

Parameters:

curi - CrawlURI to look at.

Returns:

True if this credential HAS a prerequisite for passed CrawlURI.

getPrerequisite

public abstract String getPrerequisite(CrawlURI curi)

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

Parameters:

curi - CrawlURI to look at.

Returns:

Prerequisite URI for the passed curi.

getKey

public abstract String getKey()

Parameters:

context - Context to use when searching for credential domain.

Returns:

Key that is unique to this credential type.

Throws:

AttributeNotFoundException

isEveryTime

public abstract boolean isEveryTime()

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 abstract boolean populate(CrawlURI curi,
               org.apache.commons.httpclient.HttpClient http,
               org.apache.commons.httpclient.HttpMethod method,
               Map<String,String> httpAuthChallenges)

Parameters:

curi - CrawlURI to as for context.

http - Instance of httpclient.

method - Method to populate.

httpAuthChallenges -

Returns:

True if added a credentials.

isPost

public abstract boolean isPost()

Parameters:

curi - CrawlURI to look at.

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.

rootUriMatch

public boolean rootUriMatch(ServerCache cache,
                   CrawlURI curi)

Test passed curi matches this credentials rootUri.

Parameters:

controller -

curi - CrawlURI to test.

Returns:

True if domain for credential matches that of the passed curi.