public interface Authenticator
Authenticator encapsulates authentication strategies.
Please only use the implementations of this class, since the actual interfaces are unstable, internal and may change at any time!
| Modifier and Type | Method and Description |
|---|---|
default void |
applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
The authenticator gets the chance to attach the client certificate to the ssl context if needed.
|
default void |
authHttpRequest(ServiceType serviceType,
com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
Allows to add authentication credentials to the http request for the given service.
|
default void |
authKeyValueConnection(EndpointContext endpointContext,
com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
Allows the authenticator to add KV handlers during connection bootstrap to perform
authentication.
|
default boolean |
supportsNonTls()
If this authenticator supports non-encrypted connections.
|
default boolean |
supportsTls()
If this authenticator supports encrypted connections.
|
@Stability.Internal default void authKeyValueConnection(EndpointContext endpointContext, com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
endpointContext - the endpoint context.pipeline - the pipeline when the endpoint is constructed.@Stability.Internal default void authHttpRequest(ServiceType serviceType, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
serviceType - the service for this request.request - the http request.@Stability.Internal default void applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
sslContextBuilder - the netty context builder@Stability.Internal default boolean supportsTls()
@Stability.Internal default boolean supportsNonTls()
Copyright © 2021 Couchbase, Inc.. All rights reserved.