Class NTLMScheme
java.lang.Object
org.apache.hc.client5.http.impl.auth.NTLMScheme
- All Implemented Interfaces:
AuthScheme
Deprecated.
Do not use. the NTLM authentication scheme is no longer supported.
Consider using Basic or Bearer authentication with TLS instead.
NTLM is a proprietary authentication scheme developed by Microsoft
and optimized for Windows platforms.
- Since:
- 4.0
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Deprecated.private NTCredentials
Deprecated.private final NTLMEngine
Deprecated.private static final org.slf4j.Logger
Deprecated.private NTLMScheme.State
Deprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongenerateAuthResponse
(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) Deprecated.Generates an authorization response based on the current state.getName()
Deprecated.Returns textual designation of the given authentication scheme.Deprecated.ReturnsPrincipal
whose credentials are used to generate an authentication response.getRealm()
Deprecated.Returns authentication realm.boolean
Deprecated.Authentication process may involve a series of challenge-response exchanges.boolean
Deprecated.Determines if the authentication scheme is expected to provide an authorization response on a per connection basis instead of the standard per request basisboolean
isResponseReady
(org.apache.hc.core5.http.HttpHost host, CredentialsProvider credentialsProvider, org.apache.hc.core5.http.protocol.HttpContext context) Deprecated.Determines whether or not an authorization response can be generated based on the actual authentication state.void
processChallenge
(AuthChallenge authChallenge, org.apache.hc.core5.http.protocol.HttpContext context) Deprecated.Processes the given auth challenge.toString()
Deprecated.
-
Field Details
-
LOG
private static final org.slf4j.Logger LOGDeprecated. -
engine
Deprecated. -
state
Deprecated. -
challenge
Deprecated. -
credentials
Deprecated.
-
-
Constructor Details
-
NTLMScheme
Deprecated. -
NTLMScheme
public NTLMScheme()Deprecated.- Since:
- 4.3
-
-
Method Details
-
getName
Deprecated.Description copied from interface:AuthScheme
Returns textual designation of the given authentication scheme.- Specified by:
getName
in interfaceAuthScheme
- Returns:
- the name of the given authentication scheme
-
isConnectionBased
public boolean isConnectionBased()Deprecated.Description copied from interface: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- Specified by:
isConnectionBased
in interfaceAuthScheme
- Returns:
true
if the scheme is connection based,false
if the scheme is request based.
-
getRealm
Deprecated.Description copied from interface:AuthScheme
Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returnsnull
.- Specified by:
getRealm
in interfaceAuthScheme
- Returns:
- the authentication realm
-
processChallenge
public void processChallenge(AuthChallenge authChallenge, org.apache.hc.core5.http.protocol.HttpContext context) throws MalformedChallengeException Deprecated.Description copied from interface: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- Specified by:
processChallenge
in interfaceAuthScheme
- Parameters:
authChallenge
- the auth challengecontext
- HTTP context- Throws:
MalformedChallengeException
- in case the auth challenge is incomplete, malformed or otherwise invalid.
-
isResponseReady
public boolean isResponseReady(org.apache.hc.core5.http.HttpHost host, CredentialsProvider credentialsProvider, org.apache.hc.core5.http.protocol.HttpContext context) throws AuthenticationException Deprecated.Description copied from interface: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.- Specified by:
isResponseReady
in interfaceAuthScheme
- Parameters:
credentialsProvider
- The credentials to be used for authenticationcontext
- HTTP context- Returns:
true
if an authorization response can be generated and the authentication handshake can proceed,false
otherwise.- Throws:
AuthenticationException
- if authorization string cannot be generated due to an authentication failure
-
getPrincipal
Deprecated.Description copied from interface:AuthScheme
ReturnsPrincipal
whose credentials are used to generate an authentication response. Connection based schemes are required to return a userPrincipal
if authorization applies to for the entire life span of connection.- Specified by:
getPrincipal
in interfaceAuthScheme
- Returns:
- user principal
- See Also:
-
generateAuthResponse
public String generateAuthResponse(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws AuthenticationException Deprecated.Description copied from interface: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 aCredentialsProvider
prior to this method call.- Specified by:
generateAuthResponse
in interfaceAuthScheme
- Parameters:
request
- The request being authenticatedcontext
- HTTP context- Returns:
- authorization header
- Throws:
AuthenticationException
- if authorization string cannot be generated due to an authentication failure- See Also:
-
isChallengeComplete
public boolean isChallengeComplete()Deprecated.Description copied from interface: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.- Specified by:
isChallengeComplete
in interfaceAuthScheme
- Returns:
true
if the authentication process has been completed,false
otherwise.
-
toString
Deprecated.
-