org.apache.commons.httpclient.auth

Class BasicScheme

Implemented Interfaces:
AuthScheme

public class BasicScheme
extends RFC2617Scheme

Basic authentication scheme as defined in RFC 2617.

Constructor Summary

BasicScheme()
Default constructor for the basic authetication scheme.
BasicScheme(String challenge)
Deprecated. Use parameterless constructor and AuthScheme.processChallenge(String) method

Method Summary

String
authenticate(Credentials credentials, String method, String uri)
Deprecated. Use authenticate(Credentials,HttpMethod)
String
authenticate(Credentials credentials, HttpMethod method)
Produces basic authorization string for the given set of Credentials.
static String
authenticate(UsernamePasswordCredentials credentials)
Deprecated. Use authenticate(UsernamePasswordCredentials,String) Returns a basic Authorization header value for the given UsernamePasswordCredentials.
static String
authenticate(UsernamePasswordCredentials credentials, String charset)
Returns a basic Authorization header value for the given UsernamePasswordCredentials and charset.
String
getSchemeName()
Returns textual designation of the basic authentication scheme.
boolean
isComplete()
Tests if the Basic authentication process has been completed.
boolean
isConnectionBased()
Returns false.
void
processChallenge(String challenge)
Processes the Basic challenge.

Methods inherited from class org.apache.commons.httpclient.auth.RFC2617Scheme

getID, getParameter, getParameters, getRealm, processChallenge

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicScheme

public BasicScheme()
Default constructor for the basic authetication scheme.
Since:
3.0
Usages and Demos :

View More Examples of BasicScheme()
   1:     
   2:     public static final String BASIC_AUTH_SCHEME_NAME = (new BasicScheme()).getSchemeName();
   3: 
   4:     
   5:     

View Full Code Here
   1:             if (key.equals("basic")) {
   2:                 authscheme = new BasicScheme();
   3:             } else if (key.equals("digest")) {
   4:                 authscheme = new DigestScheme();
   5:             } else {

View Full Code Here

BasicScheme

public BasicScheme(String challenge)
            throws MalformedChallengeException

Deprecated. Use parameterless constructor and AuthScheme.processChallenge(String) method

Constructor for the basic authetication scheme.
Parameters:
challenge - authentication challenge
Throws:
MalformedChallengeException - is thrown if the authentication challenge is malformed

Method Details

authenticate

public String authenticate(Credentials credentials,
                           String method,
                           String uri)
            throws AuthenticationException

Deprecated. Use authenticate(Credentials,HttpMethod)

Produces basic authorization string for the given set of Credentials.
Specified by:
authenticate in interface AuthScheme
Parameters:
credentials - The set of credentials to be used for athentication
method - Method name is ignored by the basic authentication scheme
uri - URI is ignored by the basic authentication scheme
Returns:
a basic authorization string
Throws:
AuthenticationException - if authorization string cannot be generated due to an authentication failure

authenticate

public String authenticate(Credentials credentials,
                           HttpMethod method)
            throws AuthenticationException
Produces basic authorization string for the given set of Credentials.
Specified by:
authenticate in interface AuthScheme
Parameters:
credentials - The set of credentials to be used for athentication
method - The method being authenticated
Returns:
a basic authorization string
Throws:
AuthenticationException - if authorization string cannot be generated due to an authentication failure
Since:
3.0

authenticate

public static String authenticate(UsernamePasswordCredentials credentials)

Deprecated. Use authenticate(UsernamePasswordCredentials,String) Returns a basic Authorization header value for the given UsernamePasswordCredentials.

Parameters:
credentials - The credentials to encode.
Returns:
a basic authorization string

authenticate

public static String authenticate(UsernamePasswordCredentials credentials,
                                  String charset)
Returns a basic Authorization header value for the given UsernamePasswordCredentials and charset.
Parameters:
credentials - The credentials to encode.
charset - The charset to use for encoding the credentials
Returns:
a basic authorization string
Since:
3.0

getSchemeName

public String getSchemeName()
Returns textual designation of the basic authentication scheme.
Specified by:
getSchemeName in interface AuthScheme
Returns:
basic

isComplete

public boolean isComplete()
Tests if the Basic authentication process has been completed.
Specified by:
isComplete in interface AuthScheme
Returns:
true if Basic authorization has been processed, false otherwise.
Since:
3.0

isConnectionBased

public boolean isConnectionBased()
Returns false. Basic authentication scheme is request based.
Specified by:
isConnectionBased in interface AuthScheme
Returns:
false.
Since:
3.0

processChallenge

public void processChallenge(String challenge)
            throws MalformedChallengeException
Processes the Basic challenge.
Specified by:
processChallenge in interface AuthScheme
Overrides:
processChallenge in interface RFC2617Scheme
Parameters:
challenge - the challenge string
Throws:
MalformedChallengeException - is thrown if the authentication challenge is malformed
Since:
3.0