org.archive.modules.credential

Class CredentialStore

java.lang.Object

org.archive.modules.credential.CredentialStore

All Implemented Interfaces:

Serializable, HasKeyedProperties

public class CredentialStore
extends Object
implements Serializable, HasKeyedProperties

Front door to the credential store. Come here to get at credentials.

See Credential Store Design.

Version:

$Revision$, $Date$

Author:

stack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyedProperties	kp

Constructor Summary

Constructors

Constructor and Description
CredentialStore() Constructor.

Method Summary

Modifier and Type	Method and Description
Credential	get(Object context, String name)
Collection<Credential>	getAll()
Map<String,Credential>	getCredentials()
static List<Class<?>>	getCredentialTypes()
KeyedProperties	getKeyedProperties()
void	setCredentials(Map<String,Credential> map)
Set<Credential>	subset(CrawlURI context, Class<?> type) Return set made up of all credentials of the passed type.
Set<Credential>	subset(CrawlURI context, Class<?> type, String rootUri) Return set made up of all credentials of the passed type.

Methods inherited from class java.lang.Object

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

Field Detail

kp

protected KeyedProperties kp

Constructor Detail

CredentialStore

public CredentialStore()

Constructor.

Method Detail

getKeyedProperties

public KeyedProperties getKeyedProperties()

Specified by:

getKeyedProperties in interface HasKeyedProperties

getCredentials

public Map<String,Credential> getCredentials()

setCredentials

public void setCredentials(Map<String,Credential> map)

getCredentialTypes

public static List<Class<?>> getCredentialTypes()

Returns:

Unmodifable list of credential types.

getAll

public Collection<Credential> getAll()

Returns:

An iterator or null.

get

public Credential get(Object context,
                      String name)

Parameters:

context - Used to set context.

name - Name to give the manufactured credential. Should be unique else the add of the credential to the list of credentials will fail.

Returns:

Returns name'd credential.

subset

public Set<Credential> subset(CrawlURI context,
                              Class<?> type)

Return set made up of all credentials of the passed type.

Parameters:

context - Used to set context.

type - Type of the list to return. Type is some superclass of credentials.

Returns:

Unmodifable sublist of all elements of passed type.

subset

public Set<Credential> subset(CrawlURI context,
                              Class<?> type,
                              String rootUri)

Return set made up of all credentials of the passed type.

Parameters:

context - Used to set context.

type - Type of the list to return. Type is some superclass of credentials.

rootUri - RootUri to match. May be null. In this case we return all. Currently we expect the CrawlServer name to equate to root Uri. Its not. Currently it doesn't distingush between servers of same name but different ports (e.g. http and https).

Returns:

Unmodifable sublist of all elements of passed type.