org.apache.commons.httpclient.auth

Interface CredentialsProvider

public interface CredentialsProvider

Credentials provider interface can be used to provide HTTP method with a means to request authentication credentials if no credentials have been given or given credentials are incorrect. Classes implementing this interface must synchronize access to shared data as methods of this interfrace may be executed from multiple threads

Authors:
Ortwin Glueck
Oleg Kalnichevski

Since:
3.0

Field Summary

static String
PROVIDER
Sets the credentials provider parameter.

Method Summary

Credentials
getCredentials(AuthScheme scheme, String host, int port, boolean proxy)
Requests additional authentication credentials.

Field Details

PROVIDER

public static final String PROVIDER

Method Details

getCredentials

public Credentials getCredentials(AuthScheme scheme,
                                  String host,
                                  int port,
                                  boolean proxy)
            throws CredentialsNotAvailableException
Requests additional authentication credentials.

Parameters:
scheme - the authentication scheme
host - the authentication host
port - the port of the authentication host
proxy - true if authenticating with a proxy, false otherwise


Copyright (c) 1999-2005 - Apache Software Foundation