Apache HttpClient 5.3 · org.apache.hc.client5.http.impl.DefaultUserTokenHandler

Default implementation of UserTokenHandler. This class will use an instance of Principal as a state object for HTTP connections, if it can be obtained from the given execution context. This helps ensure persistent connections created with a particular user identity within a particular security context can be reused by the same user only.

DefaultUserTokenHandler will use the user principal of connection based authentication schemes such as NTLM or that of the SSL session with the client authentication turned on. If both are unavailable, null token will be returned.

Field Summary

Modifier and Type	Field and Description
public static final DefaultUserTokenHandler	INSTANCE

Constructor Summary

Access	Constructor and Description
public	DefaultUserTokenHandler()

Method Summary

Modifier and Type	Method and Description
private static Principal	getAuthPrincipal(final AuthExchange authExchange)
public Object	getUserToken(final HttpRoute HTTP route route, final HttpContext the execution context context) Implements org.apache.hc.client5.http.UserTokenHandler.getUserToken. The token object returned by this method is expected to uniquely identify the current user if the context is user specific or to be `null` if it is not.
public Object	getUserToken(final HttpRoute HTTP route route, final HttpRequest HTTP request request, final HttpContext the execution context context) Overrides default org.apache.hc.client5.http.UserTokenHandler.getUserToken. The token object returned by this method is expected to uniquely identify the current user if the context is user specific or to be `null` if it is not.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE	back to summary
public static final DefaultUserTokenHandler INSTANCE

Constructor Detail

DefaultUserTokenHandler	back to summary
public DefaultUserTokenHandler()

Method Detail

getAuthPrincipal	back to summary
private static Principal getAuthPrincipal(final AuthExchange authExchange)

getUserToken back to summary

getUserToken	back to summary
public Object getUserToken(final HttpRoute route, final HttpContext context) Implements org.apache.hc.client5.http.UserTokenHandler.getUserToken. Doc from org.apache.hc.client5.http.UserTokenHandler.getUserToken. The token object returned by this method is expected to uniquely identify the current user if the context is user specific or to be `null` if it is not. Parameters route:HttpRoute HTTP route context:HttpContext the execution context Returns:Object user token that uniquely identifies the user or `null` if the context is not user specific. Annotations @Override

public Object getUserToken(final HttpRoute route, final HttpContext context)

Implements org.apache.hc.client5.http.UserTokenHandler.getUserToken.

Doc from org.apache.hc.client5.http.UserTokenHandler.getUserToken.

The token object returned by this method is expected to uniquely identify the current user if the context is user specific or to be null if it is not.

Parameters

route:HttpRoute: HTTP route
context:HttpContext: the execution context

Returns:Object

user token that uniquely identifies the user or null if the context is not user specific.

Annotations

@Override