org.apache.hc.client5.http.impl.auth

类 DigestScheme

java.lang.Object

org.apache.hc.client5.http.impl.auth.DigestScheme

所有已实现的接口:

Serializable, AuthScheme

public class DigestScheme
extends Object
implements AuthScheme, Serializable

Digest authentication scheme. 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.

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 used by the connection.

从以下版本开始:

4.0

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
DigestScheme()
DigestScheme(Charset charset)

方法概要

限定符和类型	方法和说明
String	generateAuthResponse(HttpHost host, HttpRequest request, HttpContext context) Generates an authorization response based on the current state.
String	getCnonce()
String	getName() Returns textual designation of the given authentication scheme.
String	getNonce()
long	getNounceCount()
Principal	getPrincipal() Returns Principal whose credentials are used to generate an authentication response.
String	getRealm() Returns authentication realm.
void	initPreemptive(Credentials credentials, String cnonce, String realm)
boolean	isChallengeComplete() Authentication process may involve a series of challenge-response exchanges.
boolean	isConnectionBased() Determines if the authentication scheme is expected to provide an authorization response on a per connection basis instead of the standard per request basis
boolean	isResponseReady(HttpHost host, CredentialsProvider credentialsProvider, HttpContext context) Determines whether or not an authorization response can be generated based on the actual authentication state.
void	processChallenge(AuthChallenge authChallenge, HttpContext context) Processes the given auth challenge.
String	toString()

从类继承的方法 java.lang.Object

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

构造器详细资料

DigestScheme

public DigestScheme()

DigestScheme

public DigestScheme(Charset charset)

方法详细资料

initPreemptive

public void initPreemptive(Credentials credentials,
                           String cnonce,
                           String realm)

getName

public String getName()

从接口复制的说明: AuthScheme

Returns textual designation of the given authentication scheme.

指定者:

getName 在接口中 AuthScheme

返回:

the name of the given authentication scheme

isConnectionBased

public boolean isConnectionBased()

从接口复制的说明: AuthScheme

Determines if the authentication scheme is expected to provide an authorization response on a per connection basis instead of the standard per request basis

指定者:

isConnectionBased 在接口中 AuthScheme

返回:

true if the scheme is connection based, false if the scheme is request based.

getRealm

public String getRealm()

从接口复制的说明: AuthScheme

Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns null.

指定者:

getRealm 在接口中 AuthScheme

返回:

the authentication realm

processChallenge

public void processChallenge(AuthChallenge authChallenge,
                             HttpContext context)
                      throws MalformedChallengeException

从接口复制的说明: AuthScheme

Processes the given auth challenge. Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain internal state when dealing with sequential challenges

指定者:

processChallenge 在接口中 AuthScheme

参数:

authChallenge - the auth challenge

context - HTTP context

抛出:

MalformedChallengeException - in case the auth challenge is incomplete, malformed or otherwise invalid.

isChallengeComplete

public boolean isChallengeComplete()

从接口复制的说明: AuthScheme

Authentication process may involve a series of challenge-response exchanges. This method tests if the authorization process has been fully completed (either successfully or unsuccessfully), that is, all the required authorization challenges have been processed in their entirety.

指定者:

isChallengeComplete 在接口中 AuthScheme

返回:

true if the authentication process has been completed, false otherwise.

isResponseReady

public boolean isResponseReady(HttpHost host,
                               CredentialsProvider credentialsProvider,
                               HttpContext context)
                        throws AuthenticationException

从接口复制的说明: AuthScheme

Determines whether or not an authorization response can be generated based on the actual authentication state. Generally the outcome of this method will depend upon availability of user credentials necessary to produce an authorization response.

指定者:

isResponseReady 在接口中 AuthScheme

credentialsProvider - The credentials to be used for authentication

context - HTTP context

返回:

true if an authorization response can be generated and the authentication handshake can proceed, false otherwise.

抛出:

AuthenticationException - if authorization string cannot be generated due to an authentication failure

getPrincipal

public Principal getPrincipal()

从接口复制的说明: AuthScheme

Returns Principal whose credentials are used to generate an authentication response. Connection based schemes are required to return a user Principal if authorization applies to for the entire life span of connection.

指定者:

getPrincipal 在接口中 AuthScheme

返回:

user principal

另请参阅:

AuthScheme.isConnectionBased()

generateAuthResponse

public String generateAuthResponse(HttpHost host,
                                   HttpRequest request,
                                   HttpContext context)
                            throws AuthenticationException

从接口复制的说明: AuthScheme

Generates an authorization response based on the current state. Some authentication schemes may need to load user credentials required to generate an authorization response from a CredentialsProvider prior to this method call.

指定者:

generateAuthResponse 在接口中 AuthScheme

request - The request being authenticated

context - HTTP context

返回:

authorization header

抛出:

AuthenticationException - if authorization string cannot be generated due to an authentication failure

另请参阅:

AuthScheme.isResponseReady(HttpHost, CredentialsProvider, HttpContext)

getNonce

@Internal
public String getNonce()

getNounceCount

@Internal
public long getNounceCount()

getCnonce

@Internal
public String getCnonce()

toString

public String toString()

覆盖:

toString 在类中 Object