SaslAuthenticationContext (clients 7.6.9-ce API)

java.lang.Object
- org.apache.kafka.common.security.auth.SaslAuthenticationContext

All Implemented Interfaces:: AuthenticationContext

public class SaslAuthenticationContext
extends Object
implements AuthenticationContext

Constructor Summary

Constructors
Constructor and Description
`SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName)`
`SaslAuthenticationContext(long sessionId, SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName, Optional<SSLSession> sslSession)`
`SaslAuthenticationContext(SaslServer server, SecurityProtocol securityProtocol, InetAddress clientAddress, String listenerName)` Method used for tests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InetAddress`	`clientAddress()` Address of the authenticated client
`String`	`listenerName()` Name of the listener used for the connection
`SecurityProtocol`	`securityProtocol()` Underlying security protocol of the authentication session.
`SaslServer`	`server()`
`long`	`sessionId()` Unique ID assigned to each connection
`Optional<SSLSession>`	`sslSession()` Returns SSL session for the connection if security protocol is SASL_SSL.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
                                 SaslServer server,
                                 SecurityProtocol securityProtocol,
                                 InetAddress clientAddress,
                                 String listenerName)

SaslAuthenticationContext

public SaslAuthenticationContext(SaslServer server,
                                 SecurityProtocol securityProtocol,
                                 InetAddress clientAddress,
                                 String listenerName)

Method used for tests. Session id is not required to be generated in case of tests.

SaslAuthenticationContext

public SaslAuthenticationContext(long sessionId,
                                 SaslServer server,
                                 SecurityProtocol securityProtocol,
                                 InetAddress clientAddress,
                                 String listenerName,
                                 Optional<SSLSession> sslSession)

Method Detail
- server
```
public SaslServer server()
```
- sslSession
```
public Optional<SSLSession> sslSession()
```
  Returns SSL session for the connection if security protocol is SASL_SSL. If SSL mutual client authentication is enabled for the listener, peer principal can be determined using SSLSession.getPeerPrincipal().
- securityProtocol
```
public SecurityProtocol securityProtocol()
```
  Description copied from interface: AuthenticationContext
  Underlying security protocol of the authentication session.
  Specified by:
  securityProtocol in interface AuthenticationContext
- clientAddress
```
public InetAddress clientAddress()
```
  Description copied from interface: AuthenticationContext
  Address of the authenticated client
  Specified by:
  clientAddress in interface AuthenticationContext
- listenerName
```
public String listenerName()
```
  Description copied from interface: AuthenticationContext
  Name of the listener used for the connection
  Specified by:
  listenerName in interface AuthenticationContext
- sessionId
```
public long sessionId()
```
  Description copied from interface: AuthenticationContext
  Unique ID assigned to each connection
  Specified by:
  sessionId in interface AuthenticationContext

Class SaslAuthenticationContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SaslAuthenticationContext

SaslAuthenticationContext

SaslAuthenticationContext

Method Detail

server

sslSession

securityProtocol

clientAddress

listenerName

sessionId