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

Since:
3.0
Author:
Ortwin Glueck, Oleg Kalnichevski

Field Summary
static java.lang.String PROVIDER
          Sets the credentials provider parameter.
 
Method Summary
 Credentials getCredentials(AuthScheme scheme, java.lang.String host, int port, boolean proxy)
          Requests additional authentication credentials.
 

Field Detail

PROVIDER

public static final java.lang.String PROVIDER
Sets the credentials provider parameter.

This parameter expects a value of type CredentialsProvider.

See Also:
Constant Field Values
Method Detail

getCredentials

public Credentials getCredentials(AuthScheme scheme,
                                  java.lang.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
Throws:
CredentialsNotAvailableException


Copyright (c) 1999-2005 - Apache Software Foundation