org.openstreetmap.josm.io.auth

Class AbstractCredentialsAgent

java.lang.Object

org.openstreetmap.josm.io.auth.AbstractCredentialsAgent

All Implemented Interfaces:

CredentialsAgent

Direct Known Subclasses:

JosmPreferencesCredentialAgent

public abstract class AbstractCredentialsAgent
extends Object
implements CredentialsAgent

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Authenticator.RequestorType,PasswordAuthentication>	memoryCredentialsCache

Constructor Summary

Constructors

Constructor and Description
AbstractCredentialsAgent()

Method Summary

Modifier and Type	Method and Description
CredentialsAgentResponse	getCredentials(Authenticator.RequestorType requestorType, String host, boolean noSuccessWithLastResponse) Returns the credentials needed to to access host.
abstract String	getSaveUsernameAndPasswordCheckboxText() Provide the text for a checkbox that offers to save the username and password that has been entered by the user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.io.auth.CredentialsAgent

getPreferencesDecorationPanel, lookup, lookupOAuthAccessToken, store, storeOAuthAccessToken

Field Detail

memoryCredentialsCache

protected Map<Authenticator.RequestorType,PasswordAuthentication> memoryCredentialsCache

Constructor Detail

AbstractCredentialsAgent

public AbstractCredentialsAgent()

Method Detail

getCredentials

public CredentialsAgentResponse getCredentials(Authenticator.RequestorType requestorType,
                                               String host,
                                               boolean noSuccessWithLastResponse)
                                        throws CredentialsAgentException

Description copied from interface: CredentialsAgent

Returns the credentials needed to to access host.

Specified by:

getCredentials in interface CredentialsAgent

Parameters:

requestorType - the type of service. Authenticator.RequestorType.SERVER for the OSM API server, Authenticator.RequestorType.PROXY for a proxy server

host - the hostname for these credentials

noSuccessWithLastResponse - true, if the last request with the supplied credentials failed; false otherwise. If true, implementations of this interface are advised to prompt the user for new credentials.

Returns:

the credentials

Throws:

CredentialsAgentException - if a problem occurs in a implementation of this interface

getSaveUsernameAndPasswordCheckboxText

public abstract String getSaveUsernameAndPasswordCheckboxText()

Provide the text for a checkbox that offers to save the username and password that has been entered by the user.

Returns:

checkbox text