org.eclipse.jetty.client.util

Class DigestAuthentication

java.lang.Object

org.eclipse.jetty.client.util.AbstractAuthentication

org.eclipse.jetty.client.util.DigestAuthentication

All Implemented Interfaces:

Authentication

public class DigestAuthentication
extends AbstractAuthentication

Implementation of the HTTP "Digest" authentication defined in RFC 2617.

Applications should create objects of this class and add them to the AuthenticationStore retrieved from the HttpClient via HttpClient.getAuthenticationStore().

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Authentication

Authentication.HeaderInfo, Authentication.Result

Field Summary

Fields inherited from interface org.eclipse.jetty.client.api.Authentication

ANY_REALM

Constructor Summary

Constructors

Constructor and Description
DigestAuthentication(java.net.URI uri, java.lang.String realm, java.lang.String user, java.lang.String password) Construct a DigestAuthentication with a SecureRandom nonce.
DigestAuthentication(java.net.URI uri, java.lang.String realm, java.lang.String user, java.lang.String password, java.util.Random random)

Method Summary

Modifier and Type	Method and Description
Authentication.Result	authenticate(Request request, ContentResponse response, Authentication.HeaderInfo headerInfo, Attributes context) Executes the authentication mechanism for the given request, returning a Result that can be used to actually authenticate the request via Authentication.Result.apply(Request).
java.lang.String	getType()
boolean	matches(java.lang.String type, java.net.URI uri, java.lang.String realm) Matches Authentications based on the given parameters

Methods inherited from class org.eclipse.jetty.client.util.AbstractAuthentication

getRealm, getURI, matchesURI

Methods inherited from class java.lang.Object

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

Constructor Detail

DigestAuthentication

public DigestAuthentication(java.net.URI uri,
                            java.lang.String realm,
                            java.lang.String user,
                            java.lang.String password)

Construct a DigestAuthentication with a SecureRandom nonce.

Parameters:

uri - the URI to match for the authentication

realm - the realm to match for the authentication

user - the user that wants to authenticate

password - the password of the user

DigestAuthentication

public DigestAuthentication(java.net.URI uri,
                            java.lang.String realm,
                            java.lang.String user,
                            java.lang.String password,
                            java.util.Random random)

Parameters:

uri - the URI to match for the authentication

realm - the realm to match for the authentication

user - the user that wants to authenticate

password - the password of the user

random - the Random generator to use for nonces.

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in class AbstractAuthentication

matches

public boolean matches(java.lang.String type,
                       java.net.URI uri,
                       java.lang.String realm)

Description copied from interface: Authentication

Matches Authentications based on the given parameters

Specified by:

matches in interface Authentication

Overrides:

matches in class AbstractAuthentication

Parameters:

type - the Authentication type such as "Basic" or "Digest"

uri - the request URI

realm - the authentication realm as provided in the WWW-Authenticate response header

Returns:

true if this authentication matches, false otherwise

authenticate

public Authentication.Result authenticate(Request request,
                                          ContentResponse response,
                                          Authentication.HeaderInfo headerInfo,
                                          Attributes context)

Description copied from interface: Authentication

Executes the authentication mechanism for the given request, returning a Result that can be used to actually authenticate the request via Authentication.Result.apply(Request).

If a request for "/secure" returns a Result, then the result may be used for other requests such as "/secure/foo" or "/secure/bar", unless those resources are protected by other realms.

Parameters:

request - the request to execute the authentication mechanism for

response - the 401 response obtained in the previous attempt to request the protected resource

headerInfo - the WWW-Authenticate (or Proxy-Authenticate) header chosen for this authentication (among the many that the response may contain)

context - the conversation context in case the authentication needs multiple exchanges to be completed and information needs to be stored across exchanges

Returns:

the authentication result, or null if the authentication could not be performed