Android APIs
Added in API level 1
Deprecated since API level 22
public class

DigestScheme

extends RFC2617Scheme
java.lang.Object
   ↳ org.apache.http.impl.auth.AuthSchemeBase
     ↳ org.apache.http.impl.auth.RFC2617Scheme
       ↳ org.apache.http.impl.auth.DigestScheme

This class was deprecated in API level 22.
Please use openConnection() instead. Please visit this webpage for further details.

Class Overview

Digest authentication scheme as defined in RFC 2617. Both MD5 (default) and MD5-sess are supported. Currently only qop=auth or no qop is supported. qop=auth-int is unsupported. If auth and auth-int are provided, auth is used.

Credential charset is configured via the credential charset parameter. Since the digest username is included as clear text in the generated Authentication header, the charset of the username must be compatible with the http element charset.

Summary

Public Constructors
DigestScheme()
Default constructor for the digest authetication scheme.
Public Methods
Header authenticate(Credentials credentials, HttpRequest request)
Produces a digest authorization string for the given set of Credentials, method name and URI.
static String createCnonce()
Creates a random cnonce value based on the current time.
String getSchemeName()
Returns textual designation of the digest authentication scheme.
boolean isComplete()
Tests if the Digest authentication process has been completed.
boolean isConnectionBased()
Returns false.
void overrideParamter(String name, String value)
void processChallenge(Header header)
Processes the Digest challenge.
[Expand]
Inherited Methods
From class org.apache.http.impl.auth.RFC2617Scheme
From class org.apache.http.impl.auth.AuthSchemeBase
From class java.lang.Object
From interface org.apache.http.auth.AuthScheme

Public Constructors

public DigestScheme ()

Added in API level 1

Default constructor for the digest authetication scheme.

Public Methods

public Header authenticate (Credentials credentials, HttpRequest request)

Added in API level 1

Produces a digest authorization string for the given set of Credentials, method name and URI.

Parameters
credentials A set of credentials to be used for athentication
request The request being authenticated
Returns
  • a digest authorization string
Throws
InvalidCredentialsException if authentication credentials are not valid or not applicable for this authentication scheme
AuthenticationException if authorization string cannot be generated due to an authentication failure

public static String createCnonce ()

Added in API level 1

Creates a random cnonce value based on the current time.

Returns
  • The cnonce value as String.
Throws
UnsupportedDigestAlgorithmException if MD5 algorithm is not supported.

public String getSchemeName ()

Added in API level 1

Returns textual designation of the digest authentication scheme.

Returns
  • digest

public boolean isComplete ()

Added in API level 1

Tests if the Digest authentication process has been completed.

Returns
  • true if Digest authorization has been processed, false otherwise.

public boolean isConnectionBased ()

Added in API level 1

Returns false. Digest authentication scheme is request based.

Returns
  • false.

public void overrideParamter (String name, String value)

Added in API level 1

public void processChallenge (Header header)

Added in API level 1

Processes the Digest challenge.

Parameters
header the challenge header
Throws
MalformedChallengeException is thrown if the authentication challenge is malformed