Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A SensorKeyProducer with logic shared by all SensorKeyProducers
- AbstractSensorKeyProducer(String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.AbstractSensorKeyProducer
-
The constructor, that requires contexId, and an uri on the authorization server associated with the sensor keys.
- addErrorRequestTime(Throwable, long) - Method in interface io.strimzi.kafka.oauth.common.MetricsHandler
-
Called when a request has failed
- addHttpErrorAttrs(Map<String, String>, Throwable) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Add http error attributes to the passed map of attributes
- addHttpSuccessAttrs(Map<String, String>) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Add http success attributes to the passed map of attributes
- addSuccessRequestTime(long) - Method in interface io.strimzi.kafka.oauth.common.MetricsHandler
-
Called when a request was successful
- addTime(SensorKey, long) - Method in class io.strimzi.kafka.oauth.services.OAuthMetrics
-
Record a request time in millis.
- apply(JsonNode) - Method in class io.strimzi.kafka.oauth.jsonpath.JsonPathQuery
-
Apply the JsonPath query to passed object
- asHexString(byte[]) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Convert a byte array into a hexadecimal string
- asJson(Object) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Convert object to
JsonNode - asListOfString(JsonNode) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
This method takes a JsonNode representing an array, or a string, and converts it into a List of String items.
- asListOfString(JsonNode, String) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
This method takes a JsonNode representing an array, or a string, and converts it into a List of String items.
- asSetOfNodes(ArrayNode) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Convert a JSON array to a Set object
- AUD - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"aud"
B
- BackOffTaskScheduler - Class in io.strimzi.kafka.oauth.validator
-
This scheduler adds support to immediately re-schedule the execution of the provided task, using the provided ExecutorService.
- BackOffTaskScheduler(ScheduledExecutorService, int, int, Runnable) - Constructor for class io.strimzi.kafka.oauth.validator.BackOffTaskScheduler
-
Initialise a new scheduler instance
- base64decode(String) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
A helper method to decode a base64 encoded string
- base64encode(String) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
A helper method to base64 encode a given string
- BearerTokenWithPayload - Interface in io.strimzi.kafka.oauth.common
-
This extension of OAuthBearerToken provides a way to associate any additional information with the token at run time, that is cached for the duration of the client session.
C
- cancel(boolean) - Method in class io.strimzi.kafka.oauth.services.SessionFuture
- cleanupExpired() - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Cleanup the sessions whose lifetime has expired
- close() - Static method in class io.strimzi.kafka.oauth.services.Services
-
Close any configured Services so they can be reinitialised again
- close() - Method in class io.strimzi.kafka.oauth.validator.JWTSignatureValidator
- close() - Method in class io.strimzi.kafka.oauth.validator.OAuthIntrospectionValidator
- close() - Method in interface io.strimzi.kafka.oauth.validator.TokenValidator
-
Close any allocated resources like background threads
- Config - Class in io.strimzi.kafka.oauth.common
-
Configuration handling class
- Config() - Constructor for class io.strimzi.kafka.oauth.common.Config
-
Use this construtor if you only want to lookup configuration in system properties and env without any default configuration.
- Config(Config) - Constructor for class io.strimzi.kafka.oauth.common.Config
-
Use this constructor if you want to wrap another Config object and override some functionality
- Config(Map<String, ?>) - Constructor for class io.strimzi.kafka.oauth.common.Config
-
Use this constructor to provide default values in case some configuration is not set through system properties or ENV.
- Config(Properties) - Constructor for class io.strimzi.kafka.oauth.common.Config
-
Use this constructor to provide default values in case some configuration is not set through system properties or ENV.
- ConfigException - Exception in io.strimzi.kafka.oauth.common
-
The exception used to signal a configuration error
- ConfigException(String) - Constructor for exception io.strimzi.kafka.oauth.common.ConfigException
-
Create a new instance with the specified error message
- ConfigException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.common.ConfigException
-
Create a new instance with the specified error message, and a cause
- ConfigProperties - Class in io.strimzi.kafka.oauth.common
-
A helper class to apply configuration override mechanism to a
java.util.Propertiesobject. - ConfigProperties(Properties) - Constructor for class io.strimzi.kafka.oauth.common.ConfigProperties
-
Construct a new instance for existing
java.util.Propertiesobject - ConfigurationKey - Class in io.strimzi.kafka.oauth.services
-
JAAS configuration for the validator or the client can specify the
oauth.config.idconfiguration property in order to associate a configuration identifier with the metrics so that the metrics are then grouped, and can be queried by that id. - ConfigurationKey(String, ValidatorKey) - Constructor for class io.strimzi.kafka.oauth.services.ConfigurationKey
-
Create a new instance
- configure(Map<String, ?>) - Static method in class io.strimzi.kafka.oauth.services.Services
-
Configure a new
Servicesinstance. - ConfigUtil - Class in io.strimzi.kafka.oauth.common
-
The helper class with methods used in multiple places.
- ConfigUtil() - Constructor for class io.strimzi.kafka.oauth.common.ConfigUtil
- copy(InputStream, OutputStream) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Copy the content of specified InputStream into the specified OutputStream
- crc32(String) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Calculate a CRC32 for the specified String
- createAnyHostHostnameVerifier() - Static method in class io.strimzi.kafka.oauth.common.SSLUtil
-
Create a new instance of HostnameVerifier that accepts any hostname
- createHostnameVerifier(Config) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Create the HostnameVerifier from configuration in the passed
Configobject. - createSSLFactory(Config) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Create the
javax.net.ssl.SSLSocketFactoryfrom configuration in the passedConfigobject. - createSSLFactory(String, String, String, String, String) - Static method in class io.strimzi.kafka.oauth.common.SSLUtil
-
Create a new SSL Factory from given configuration arguments
- Credentials - Class in io.strimzi.kafka.oauth.services
-
A mechanism for OAuth over PLAIN to associate credentials with the PlainSaslServer
- Credentials() - Constructor for class io.strimzi.kafka.oauth.services.Credentials
- currentTime() - Static method in class io.strimzi.kafka.oauth.services.CurrentTime
-
Get current time in millis
- currentTime() - Method in interface io.strimzi.kafka.oauth.services.CurrentTimeProvider
-
Get the current time in millis
- CurrentTime - Class in io.strimzi.kafka.oauth.services
-
The source of time used in several places instead of
java.lang.System.currentTime. - CurrentTime() - Constructor for class io.strimzi.kafka.oauth.services.CurrentTime
- CurrentTimeProvider - Interface in io.strimzi.kafka.oauth.services
-
The source of current time in millis as an alternative to calling
java.lang.System.currentTimeMillis()
D
- DaemonThreadFactory - Class in io.strimzi.kafka.oauth.validator
-
Use daemon thread for refresh job
- DaemonThreadFactory() - Constructor for class io.strimzi.kafka.oauth.validator.DaemonThreadFactory
- debugLogJWT(Logger, String) - Static method in class io.strimzi.kafka.oauth.common.TokenIntrospection
-
Debug log the given raw token by parsing it as JWT and logging its payload section
- DEFAULT - Static variable in interface io.strimzi.kafka.oauth.services.CurrentTimeProvider
-
The default
CurrentTimeProvidersingleton which simply invokesjava.lang.System.currentTimeMillis() - delete(URI, String) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP DELETE request using the default connect and read timeouts (60 seconds).
- delete(URI, SSLSocketFactory, HostnameVerifier, String) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP DELETE request using the default connect and read timeouts (60 seconds).
- delete(URI, SSLSocketFactory, HostnameVerifier, String, int, int) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP DELETE request
- DeprecationUtil - Class in io.strimzi.kafka.oauth.common
-
Helper class with methods to handle deprecated config options
- DeprecationUtil() - Constructor for class io.strimzi.kafka.oauth.common.DeprecationUtil
- doWithRetries(int, long, MetricsHandler, HttpTask<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
A helper method that implements logic for retrying unsuccessful HTTP requests
E
- equals(Object) - Method in class io.strimzi.kafka.oauth.common.TokenInfo
- equals(Object) - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
- equals(Object) - Method in class io.strimzi.kafka.oauth.services.ConfigurationKey
- equals(Object) - Method in class io.strimzi.kafka.oauth.services.ValidatorKey
- equals(Object) - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.IntrospectionValidatorKey
- equals(Object) - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.JwtValidatorKey
- errorKey(Throwable) - Method in class io.strimzi.kafka.oauth.metrics.IntrospectHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about failed HTTP requests - errorKey(Throwable) - Method in class io.strimzi.kafka.oauth.metrics.IntrospectValidationSensorKeyProducer
-
Generate a
SensorKeyfor metrics about failed token validation requests - errorKey(Throwable) - Method in class io.strimzi.kafka.oauth.metrics.JwksHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about failed HTTP requests - errorKey(Throwable) - Method in class io.strimzi.kafka.oauth.metrics.JwksValidationSensorKeyProducer
-
Generate a
SensorKeyfor metrics about failed token validation requests - errorKey(Throwable) - Method in interface io.strimzi.kafka.oauth.metrics.SensorKeyProducer
-
Generate a SensorKey for the sensor representing the failed requests
- errorKey(Throwable) - Method in class io.strimzi.kafka.oauth.metrics.UserInfoHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about failed HTTP requests - executeTask(ExecutorService, Predicate<BearerTokenWithPayload>, Consumer<BearerTokenWithPayload>) - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Iterate over all active sessions (represented by stored token objects) applying a filter and submit a task to the passed executor for each passing token.
- EXP - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"exp"
- EXPIRED_TOKEN - Enum constant in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Token is expired
- expiresAtMs() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get token expiry time in ISO millis time
F
- FileBasedTokenProvider - Class in io.strimzi.kafka.oauth.common
-
A TokenProvider that uses a file as a token source.
- FileBasedTokenProvider(String) - Constructor for class io.strimzi.kafka.oauth.common.FileBasedTokenProvider
-
Create a new instance that refers to a specified file as a token source.
- formatIsoDateTimeUTC(long) - Static method in class io.strimzi.kafka.oauth.common.TimeUtil
-
Format time in millis as ISO DateTime UTC
G
- get() - Method in class io.strimzi.kafka.oauth.services.SessionFuture
- get(long, TimeUnit) - Method in class io.strimzi.kafka.oauth.services.SessionFuture
- get(ConfigurationKey, Supplier<TokenValidator>) - Method in class io.strimzi.kafka.oauth.services.Validators
-
Get a
TokenValidatorfor the givenConfigurationKey. - get(URI, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP GET request and return the response in the specified type.
- get(URI, SSLSocketFactory, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP GET request and return the response in the specified type.
- get(URI, SSLSocketFactory, HostnameVerifier, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP GET request and return the response in the specified type.
- get(URI, SSLSocketFactory, HostnameVerifier, String, Class<T>, int, int) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP GET request and return the response in the specified type.
- get(URI, SSLSocketFactory, HostnameVerifier, String, Class<T>, int, int, boolean) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP GET request and return the response in the specified type.
- getAttributes() - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
-
Get the attributes of this SensorKey as a Map
- getClaimFromJWT(JsonNode, String...) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Get specific claim from token.
- getClaimFromJWT(String, Object) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Get specific claim from token.
- getClaimsJSON() - Method in interface io.strimzi.kafka.oauth.common.BearerTokenWithPayload
-
The token claims as a JSON object.
- getConfigId() - Method in class io.strimzi.kafka.oauth.services.ConfigurationKey
-
Get the config id
- getConfigIdHash() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey
-
Get the calculated configuration hash for this instance
- getConfigIdHash() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.IntrospectionValidatorKey
- getConfigIdHash() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.JwtValidatorKey
- getConfigWithFallbackLookup(Config, String, String) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the configuration value for the key as a string.
- getConnectTimeout(Config) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the value of the
Config.OAUTH_CONNECT_TIMEOUT_SECONDSconfiguration - getCredentials() - Method in class io.strimzi.kafka.oauth.services.Services
-
Get
Credentialssingleton - getCurrentTimeProvider() - Static method in class io.strimzi.kafka.oauth.services.CurrentTime
-
Get the currently set
CurrentTimeProvider - getCutoffIntervalSeconds() - Method in class io.strimzi.kafka.oauth.validator.BackOffTaskScheduler
-
Get the cutoff interval in seconds for exponential backoff
- getDefaultBooleanConfigWithFallbackLookup(Config, String, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the configuration value for the key as a string.
- getGroups() - Method in interface io.strimzi.kafka.oauth.common.BearerTokenWithPayload
-
Get groups associated with this token (principal).
- getId() - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
-
Get a String representation of this SensorKey that uniquely identifies it.
- getInstance() - Static method in class io.strimzi.kafka.oauth.services.Services
-
Get a configured singleton instance
- getMethod() - Method in exception io.strimzi.kafka.oauth.common.HttpException
-
Get the HTTP method
- getMetrics() - Method in class io.strimzi.kafka.oauth.services.Services
-
Get
OAuthMetricssingleton - getMinPauseSeconds() - Method in class io.strimzi.kafka.oauth.validator.BackOffTaskScheduler
-
Get the minimum pause in seconds between two consecutive scheduled runs, so that the next run does not start immediately after the previous run completes.
- getName() - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
-
Get the name of this SensorKey
- getPayload() - Method in interface io.strimzi.kafka.oauth.common.BearerTokenWithPayload
-
Get the usage dependent object previously associated with this instance by calling
BearerTokenWithPayload.setPayload(com.fasterxml.jackson.databind.JsonNode) - getPrincipal(JsonNode) - Method in class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Get the principal name
- getPrincipal(SaslServer) - Method in class io.strimzi.kafka.oauth.services.Principals
-
Get the new principal from the cache
- getPrincipals() - Method in class io.strimzi.kafka.oauth.services.Services
-
Get
Principalssingleton - getReadTimeout(Config) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the value of the
Config.OAUTH_READ_TIMEOUT_SECONDSconfiguration - getResponse() - Method in exception io.strimzi.kafka.oauth.common.HttpException
-
Get the HTTP response body
- getSensorKeyAttrs(String, String, URI, String) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Get the attributes for the sensor key using passed info.
- getSensorKeyAttrs(String, URI, String) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Get the attributes for the sensor key using passed info
- getSessionId() - Method in interface io.strimzi.kafka.oauth.common.BearerTokenWithPayload
-
This method returns an id of the current instance of this object.
- getSessions() - Method in class io.strimzi.kafka.oauth.services.Services
-
Get
Sessionssingleton - getStatus() - Method in exception io.strimzi.kafka.oauth.common.HttpException
-
Get the HTTP status
- getSub(JsonNode) - Method in class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Get the value of
subclaim - getTimeoutAppendingWarnings(Config, String, List<String>) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the configuration value for the key as a timeout in seconds with the default value of 60
- getTimeoutConfigWithFallbackLookup(Config, String, String, List<String>) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Resolve the configuration value for the key as a timeout in seconds with the default value of 60.
- getToken() - Method in class io.strimzi.kafka.oauth.services.SessionFuture
-
Get a
BearerTokenWithPayloadobject representing a session - getUri() - Method in exception io.strimzi.kafka.oauth.common.HttpException
-
Get the target url
- getValidatorId() - Method in class io.strimzi.kafka.oauth.validator.JWTSignatureValidator
- getValidatorId() - Method in class io.strimzi.kafka.oauth.validator.OAuthIntrospectionValidator
- getValidatorId() - Method in interface io.strimzi.kafka.oauth.validator.TokenValidator
-
Return the id of this validator
- getValidatorKey() - Method in class io.strimzi.kafka.oauth.services.ConfigurationKey
-
Get the validator key
- getValidators() - Method in class io.strimzi.kafka.oauth.services.Services
-
Get
Validatorssingleton - getValue(String) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key or null if not found
- getValue(String, String) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key, returning fallback value if configuration for key is not found.
- getValueAsBoolean(String, boolean) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key as boolean or fallback value if not found
- getValueAsInt(String, int) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key as int or fallback value if not found
- getValueAsLong(String, long) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key as long or fallback value if not found
- getValueAsURI(String) - Method in class io.strimzi.kafka.oauth.common.Config
-
Get value for property key as a URI
- GlobalConfig - Class in io.strimzi.kafka.oauth.metrics
-
Configuration that can be specified as ENV vars, System properties or in
server.propertiesconfiguration file, but not as part of the JAAS configuration. - GlobalConfig() - Constructor for class io.strimzi.kafka.oauth.metrics.GlobalConfig
- groups() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get groups for this token
H
- hashCode() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
- hashCode() - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
- hashCode() - Method in class io.strimzi.kafka.oauth.services.ConfigurationKey
- hashCode() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey
- hashCode() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.IntrospectionValidatorKey
- hashCode() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.JwtValidatorKey
- hashForObjects(Object...) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Generate a predictable (deterministic) hash string of length 8 for an array of objects
- hostAttr(URI) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Extract the hostname:port from the passed url For 'http' protocol use port 80 as the default.
- HttpException - Exception in io.strimzi.kafka.oauth.common
-
An exception that signals an error status while performing a HTTP request.
- HttpException(String, URI, int, String) - Constructor for exception io.strimzi.kafka.oauth.common.HttpException
-
Create a new instance
- HttpTask<T> - Interface in io.strimzi.kafka.oauth.common
-
An interface that allows a started task to directly throw an IOException.
- HttpUtil - Class in io.strimzi.kafka.oauth.common
-
A helper class that performs all network calls using java.net.HttpURLConnection.
- HttpUtil() - Constructor for class io.strimzi.kafka.oauth.common.HttpUtil
I
- IAT - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"iat"
- introspectAccessToken(String, PrincipalExtractor) - Static method in class io.strimzi.kafka.oauth.common.TokenIntrospection
-
Parse a raw access token, and extract the basic information from it, including user id by using a given
PrincipalExtractor. - IntrospectHttpSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A
SensorKeyProducerused for introspect endpoint HTTP metrics - IntrospectHttpSensorKeyProducer(String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.IntrospectHttpSensorKeyProducer
-
Create a new instance
- IntrospectionValidatorKey(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, boolean, String, String, String, int, int, boolean, int, long, boolean) - Constructor for class io.strimzi.kafka.oauth.services.ValidatorKey.IntrospectionValidatorKey
-
Create a new instance.
- IntrospectValidationSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A
SensorKeyProducerused for token validation metrics for a listener using an introspection endpoint - IntrospectValidationSensorKeyProducer(String, String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.IntrospectValidationSensorKeyProducer
-
Create a new instance
- INVALID_TOKEN - Enum constant in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Token is invalid
- io.strimzi.kafka.oauth.common - package io.strimzi.kafka.oauth.common
- io.strimzi.kafka.oauth.jsonpath - package io.strimzi.kafka.oauth.jsonpath
- io.strimzi.kafka.oauth.metrics - package io.strimzi.kafka.oauth.metrics
- io.strimzi.kafka.oauth.services - package io.strimzi.kafka.oauth.services
- io.strimzi.kafka.oauth.validator - package io.strimzi.kafka.oauth.validator
- IOUtil - Class in io.strimzi.kafka.oauth.common
-
A helper class that contains commonly used methods for I/O operations
- IOUtil() - Constructor for class io.strimzi.kafka.oauth.common.IOUtil
- isAccessTokenJwt(Config, Logger, String) - Static method in class io.strimzi.kafka.oauth.common.DeprecationUtil
-
Get 'oauth.access.token.is.jwt' config option with fallback to the deprecated 'oauth.tokens.not.jwt'
- isAvailable() - Static method in class io.strimzi.kafka.oauth.services.Services
-
Check if Services singleton has been configured
- isCancelled() - Method in class io.strimzi.kafka.oauth.services.SessionFuture
- isConfigured() - Method in class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Return true if any of the configuration options is configured
- isDone() - Method in class io.strimzi.kafka.oauth.services.SessionFuture
- isFileAccessLimitedToOwner(Path) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Check that there are minimal permissions on the file (owner access only)
- ISS - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"iss"
- issuedAtMs() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get token creation time ISO millis
- isTrue(String) - Static method in class io.strimzi.kafka.oauth.common.Config
-
Helper method the test if some boolean config option is set to 'true' or 'false'
J
- JsonPathFilterQuery - Class in io.strimzi.kafka.oauth.jsonpath
-
This class implements the support for JSONPath filter querying as implemented by: https://github.com/json-path/JsonPath Given the following content of the JWT token:
- JsonPathQuery - Class in io.strimzi.kafka.oauth.jsonpath
-
This class implements the support for JSONPath querying as implemented by: https://github.com/json-path/JsonPath Given the following content of the JWT token:
- JsonPathQueryException - Exception in io.strimzi.kafka.oauth.jsonpath
-
A runtime exception signalling a syntactic or semantic error during JsonPathQuery or JsonPathFilterQuery parsing
- JsonPathQueryException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.jsonpath.JsonPathQueryException
-
Create a new instance
- JSONUtil - Class in io.strimzi.kafka.oauth.common
-
Helper methods to work with JSON
- JSONUtil() - Constructor for class io.strimzi.kafka.oauth.common.JSONUtil
- JwksHttpSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A
SensorKeyProducerused for JWKS endpoint HTTP metrics - JwksHttpSensorKeyProducer(String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.JwksHttpSensorKeyProducer
-
Create a new instance
- JwksValidationSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A
SensorKeyProducerused for token validation metrics for a listener using a JWKS endpoint - JwksValidationSensorKeyProducer(String, String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.JwksValidationSensorKeyProducer
-
Create a new instance
- JWTSignatureValidator - Class in io.strimzi.kafka.oauth.validator
-
This class is responsible for validating the JWT token signatures during session authentication.
- JWTSignatureValidator(String, String, String, TokenProvider, String, SSLSocketFactory, HostnameVerifier, PrincipalExtractor, String, String, String, int, int, int, boolean, boolean, String, String, int, int, boolean, boolean, boolean) - Constructor for class io.strimzi.kafka.oauth.validator.JWTSignatureValidator
-
Create a new instance.
- JwtValidatorKey(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, boolean, String, int, int, int, boolean, boolean, int, int, boolean, boolean, boolean) - Constructor for class io.strimzi.kafka.oauth.services.ValidatorKey.JwtValidatorKey
-
Create a new instance.
L
- loginWithAccessToken(String, boolean, PrincipalExtractor) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Wrap an access token into TokenInfo extracting information from the token if it is a JWT token.
- loginWithClientAssertion(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, String) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using client_credentials grant with client assertion (clientId + assertion + assertion type), and connect and read timeouts of 60 seconds.
- loginWithClientAssertion(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, String, int, int, MetricsHandler, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using client_credentials grant with client assertion (clientId + assertion + assertion type).
- loginWithClientSecret(URI, SSLSocketFactory, HostnameVerifier, String, String, boolean, PrincipalExtractor, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using client_credentials grant (clientId + secret), and connect and read timeouts of 60 seconds.
- loginWithClientSecret(URI, SSLSocketFactory, HostnameVerifier, String, String, boolean, PrincipalExtractor, String, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using client_credentials grant (clientId + secret), and connect and read timeouts of 60 seconds.
- loginWithClientSecret(URI, SSLSocketFactory, HostnameVerifier, String, String, boolean, PrincipalExtractor, String, String, int, int, MetricsHandler, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using client_credentials grant (clientId + secret).
- loginWithPassword(URI, SSLSocketFactory, HostnameVerifier, String, String, String, String, boolean, PrincipalExtractor, String, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using password grant (username + password), and connect and read timeouts of 60 seconds.
- loginWithPassword(URI, SSLSocketFactory, HostnameVerifier, String, String, String, String, boolean, PrincipalExtractor, String, String, int, int, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using password grant (username + password).
- loginWithPassword(URI, SSLSocketFactory, HostnameVerifier, String, String, String, String, boolean, PrincipalExtractor, String, String, int, int, MetricsHandler, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using password grant (username + password).
- loginWithRefreshToken(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using a refresh token, and connect and read timeouts of 60 seconds.
- loginWithRefreshToken(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, String, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
Obtain an access token wrapped into TokenInfo by authenticating to the authorization server's token endpoint using a refresh token, and connect and read timeouts of 60 seconds.
- loginWithRefreshToken(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, String, int, int, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
- loginWithRefreshToken(URI, SSLSocketFactory, HostnameVerifier, String, String, String, boolean, PrincipalExtractor, String, String, int, int, MetricsHandler, int, long, boolean) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
- LogUtil - Class in io.strimzi.kafka.oauth.common
-
The helper class with logging helper methods used in multiple places
- LogUtil() - Constructor for class io.strimzi.kafka.oauth.common.LogUtil
M
- map(Function<BearerTokenWithPayload, T>) - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Get a list of objects retrieved by applying the passed mapping function to the current active sessions set.
- MAPPER - Static variable in class io.strimzi.kafka.oauth.common.JSONUtil
-
A Jackson Databind
ObjectMappersingleton - mask(String) - Static method in class io.strimzi.kafka.oauth.common.LogUtil
-
Return masked input text.
- matches(JsonNode) - Method in class io.strimzi.kafka.oauth.jsonpath.JsonPathFilterQuery
-
Match the json objects against the filter query.
- MetricsHandler - Interface in io.strimzi.kafka.oauth.common
-
An interface defining a callback that receives success and failure callbacks with request times
- MetricsUtil - Class in io.strimzi.kafka.oauth.metrics
-
Static utility methods used for metrics
- MetricsUtil() - Constructor for class io.strimzi.kafka.oauth.metrics.MetricsUtil
N
- newObjectNode() - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Create a new ObjectNode
- newThread(Runnable) - Method in class io.strimzi.kafka.oauth.validator.DaemonThreadFactory
- NimbusPayloadTransformer - Class in io.strimzi.kafka.oauth.common
-
An interface to convert from Nimbus Jose JWT
Payloadobject to Jackson DatabindJsonNodeobject - NimbusPayloadTransformer() - Constructor for class io.strimzi.kafka.oauth.common.NimbusPayloadTransformer
O
- OAUTH_ACCESS_TOKEN_IS_JWT - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.access.token.is.jwt' config option
- OAUTH_AUDIENCE - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.audience' config option
- OAUTH_CLIENT_ID - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.client.id' config option
- OAUTH_CLIENT_SECRET - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.client.secret' config option
- OAUTH_CONFIG_ID - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.config.id' config option
- OAUTH_CONNECT_TIMEOUT_SECONDS - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.connect.timeout.seconds' config option
- OAUTH_ENABLE_METRICS - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.enable.metrics' config option
- OAUTH_FALLBACK_USERNAME_CLAIM - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.fallback.username.claim' config option
- OAUTH_FALLBACK_USERNAME_PREFIX - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.fallback.username.prefix' config option
- OAUTH_HTTP_RETRIES - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.http.retries' config option
- OAUTH_HTTP_RETRY_PAUSE_MILLIS - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.http.retry.pause.millis' config option
- OAUTH_INCLUDE_ACCEPT_HEADER - Static variable in class io.strimzi.kafka.oauth.common.Config
-
Whether http requests should include "application/json" when being sent to the upstream OIDC server.
- OAUTH_READ_TIMEOUT_SECONDS - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.read.timeout.seconds' config option
- OAUTH_SCOPE - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.scope' config option
- OAUTH_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.endpoint.identification.algorithm' config option
- OAUTH_SSL_SECURE_RANDOM_IMPLEMENTATION - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.secure.random.implementation' config option
- OAUTH_SSL_TRUSTSTORE_CERTIFICATES - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.truststore.certificates' config option
- OAUTH_SSL_TRUSTSTORE_LOCATION - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.truststore.location' config option
- OAUTH_SSL_TRUSTSTORE_PASSWORD - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.truststore.password' config option
- OAUTH_SSL_TRUSTSTORE_TYPE - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.ssl.truststore.type' config option
- OAUTH_TOKENS_NOT_JWT - Static variable in class io.strimzi.kafka.oauth.common.Config
-
Deprecated.
- OAUTH_USERNAME_CLAIM - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.username.claim' config option
- OAUTH_USERNAME_PREFIX - Static variable in class io.strimzi.kafka.oauth.common.Config
-
The name of 'oauth.username.prefix' config option
- OAuthAuthenticator - Class in io.strimzi.kafka.oauth.common
-
A class with methods to authenticate a user or a client to the authorization server's token endpoint, and obtain an access token in the form of a
TokenInfoobject. - OAuthAuthenticator() - Constructor for class io.strimzi.kafka.oauth.common.OAuthAuthenticator
- OAuthIntrospectionValidator - Class in io.strimzi.kafka.oauth.validator
-
This class is responsible for validating the token during session authentication by using an introspection endpoint.
- OAuthIntrospectionValidator(String, String, String, TokenProvider, String, SSLSocketFactory, HostnameVerifier, PrincipalExtractor, String, String, String, String, String, String, String, int, int, boolean, int, long, boolean) - Constructor for class io.strimzi.kafka.oauth.validator.OAuthIntrospectionValidator
-
Create a new instance.
- OAuthMetrics - Class in io.strimzi.kafka.oauth.services
-
The singleton for handling a cache of all the Sensors to prevent unnecessary redundant re-registrations.
- of(String, String...) - Static method in class io.strimzi.kafka.oauth.metrics.SensorKey
-
Create a new instance of SensorKey from name and attributes
- of(String, Map<String, String>) - Static method in class io.strimzi.kafka.oauth.metrics.SensorKey
-
Create a new instance of SensorKey from name and a map of attributes
P
- parse(String) - Static method in class io.strimzi.kafka.oauth.jsonpath.JsonPathFilterQuery
-
Construct a new JsonPathFilterQuery
- parse(String) - Static method in class io.strimzi.kafka.oauth.jsonpath.JsonPathQuery
-
Construct a new JsonPathQuery
- pathAttr(URI) - Static method in class io.strimzi.kafka.oauth.metrics.MetricsUtil
-
Resolve the raw path of the passed url
- payload() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get the payload object passed during construction.
- post(URI, String, String, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP POST request and return the response in the specified type.
- post(URI, SSLSocketFactory, String, String, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP POST request and return the response in the specified type.
- post(URI, SSLSocketFactory, HostnameVerifier, String, String, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP POST request and return the response in the specified type.
- post(URI, SSLSocketFactory, HostnameVerifier, String, String, String, Class<T>, int, int, boolean) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP POST request and return the response in the specified type.
- principal() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get a principal (user id) for this token
- PrincipalExtractor - Class in io.strimzi.kafka.oauth.common
-
An object with logic for extracting a principal name (i.e.
- PrincipalExtractor() - Constructor for class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Create a new instance
- PrincipalExtractor(String) - Constructor for class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Create a new instance
- PrincipalExtractor(String, String, String, String) - Constructor for class io.strimzi.kafka.oauth.common.PrincipalExtractor
-
Create a new instance
- Principals - Class in io.strimzi.kafka.oauth.services
-
An in-memory cache of 'sessions' and their associated principals.
- Principals() - Constructor for class io.strimzi.kafka.oauth.services.Principals
- put(BearerTokenWithPayload) - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Put a new token object into sessions cache
- put(URI, String, String, String) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP PUT request
- put(URI, SSLSocketFactory, String, String, String) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP PUT request
- put(URI, SSLSocketFactory, HostnameVerifier, String, String, String) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP PUT request
- put(URI, SSLSocketFactory, HostnameVerifier, String, String, String, int, int) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform HTTP PUT request
- putIfNotNull(Properties, String, Object) - Static method in class io.strimzi.kafka.oauth.common.ConfigUtil
-
Helper method that puts the key-value pair into the passed
java.util.Propertiesonly if the value is not null. - putPrincipal(SaslServer, KafkaPrincipal) - Method in class io.strimzi.kafka.oauth.services.Principals
-
Put a new principal into the cache
R
- randomHexString() - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Generate a random 8 character string of hexadecimal digits
- randomHexString(int) - Static method in class io.strimzi.kafka.oauth.common.IOUtil
-
Generate a random string of hexadecimal digits of the specified length
- readJSON(InputStream, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Parse JSON from
InputStreaminto a specified type - readJSON(String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Parse JSON from String into a specified type
- remove(BearerTokenWithPayload) - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Remove a token from sessions cache
- removeAllWithMatchingAccessToken(String) - Method in class io.strimzi.kafka.oauth.services.Sessions
-
Remove all the active sessions for the passed access token
- request(URI, String, SSLSocketFactory, HostnameVerifier, String, String, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform an HTTP request using the default connect and read timeouts (60 seconds).
- request(URI, String, SSLSocketFactory, HostnameVerifier, String, String, String, Class<T>, int, int, boolean) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform an HTTP request using the default connect and read timeouts (60 seconds).
- request(URI, SSLSocketFactory, HostnameVerifier, String, String, String, Class<T>) - Static method in class io.strimzi.kafka.oauth.common.HttpUtil
-
Perform an HTTP request, auto-detecting a method, and using the default connect and read timeouts (60 seconds)..
- resolve(Properties) - Static method in class io.strimzi.kafka.oauth.common.ConfigProperties
-
Apply the config override mechanism to all the keys in
java.util.Propertiesobject passed as defaults, storing the resolved configuration values into a newjava.util.Propertiesobject that is returned as a result. - resolveAndExportToSystemProperties(Properties) - Static method in class io.strimzi.kafka.oauth.common.ConfigProperties
-
Apply the config override mechanism to all the keys in the passed
java.util.Propertiesobject using it as the final fallback for value resolution. - resolveTo(Properties) - Method in class io.strimzi.kafka.oauth.common.ConfigProperties
-
Apply the config override mechanism to all the keys in
java.util.Propertiesobject used to initialise thisConfigPropertiesstoring the resolved configuration values to the passed destination object. - run() - Method in interface io.strimzi.kafka.oauth.common.HttpTask
-
Run a task, and return the result as an object or a null if successful, otherwise throw an exception.
S
- scheduleTask() - Method in class io.strimzi.kafka.oauth.validator.BackOffTaskScheduler
-
Schedule a task.
- scope() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get scopes for this token
- SCOPE - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"scope"
- SensorKey - Class in io.strimzi.kafka.oauth.metrics
-
The SensorKey represents and uniquely identifies the Kafka Metrics API Sensor, which represents a set of metrics that are updated at the same time.
- SensorKeyProducer - Interface in io.strimzi.kafka.oauth.metrics
-
An interface representing a SensorKey factory.
- ServiceException - Exception in io.strimzi.kafka.oauth.services
-
An exception used to report a background job failure
- ServiceException(String) - Constructor for exception io.strimzi.kafka.oauth.services.ServiceException
-
Create a new instance
- ServiceException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.services.ServiceException
-
Create a new instance
- Services - Class in io.strimzi.kafka.oauth.services
-
This class contains singleton components shared among Kafka Broker sessions
- SessionFuture<T> - Class in io.strimzi.kafka.oauth.services
-
A Java
Futureimplementation used in conjunction withSessions.executeTask(ExecutorService, Predicate, Consumer)method - SessionFuture(BearerTokenWithPayload, Future<T>) - Constructor for class io.strimzi.kafka.oauth.services.SessionFuture
-
Create a new instance
- Sessions - Class in io.strimzi.kafka.oauth.services
-
Sessions entries should automatically get cleared as KafkaPrincipals for the sessions get garbage collected by JVM.
- Sessions() - Constructor for class io.strimzi.kafka.oauth.services.Sessions
- setArrayOfStringsIfNotNull(JsonNode, String, Collection<String>) - Static method in class io.strimzi.kafka.oauth.common.JSONUtil
-
Set an array attribute on a JSON object to a collection of Strings
- setCurrentTimeProvider(CurrentTimeProvider) - Static method in class io.strimzi.kafka.oauth.services.CurrentTime
-
Set the current time provider
- setPayload(JsonNode) - Method in interface io.strimzi.kafka.oauth.common.BearerTokenWithPayload
-
Associate a usage dependent object with this instance
- singleQuote(String) - Static method in class io.strimzi.kafka.oauth.common.LogUtil
-
Wrap the value in single quotes, or return null if value is null
- SSLUtil - Class in io.strimzi.kafka.oauth.common
-
A class containing helper methods that deal with SSL / TLS
- SSLUtil() - Constructor for class io.strimzi.kafka.oauth.common.SSLUtil
- StaticTokenProvider - Class in io.strimzi.kafka.oauth.common
-
A TokenProvider that contains an immutable token that is returned every time a
StaticTokenProvider.token()method is called. - StaticTokenProvider(String) - Constructor for class io.strimzi.kafka.oauth.common.StaticTokenProvider
-
Create a new instance with a token that never changes
- status() - Method in exception io.strimzi.kafka.oauth.validator.TokenValidationException
-
Get the validation check error status for this exception
- storeCredentials(String, KafkaPrincipal) - Method in class io.strimzi.kafka.oauth.services.Credentials
-
Store credentials to communicate them from PLAIN callback handler to OAuthKafkaPrincipalBuilder when OAuth over PLAIN is used.
- STRIMZI_OAUTH_METRIC_REPORTERS - Static variable in class io.strimzi.kafka.oauth.metrics.GlobalConfig
-
The name of the 'strimzi.oauth.metric.reporters' config option
- successKey() - Method in class io.strimzi.kafka.oauth.metrics.IntrospectHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about successful HTTP requests - successKey() - Method in class io.strimzi.kafka.oauth.metrics.IntrospectValidationSensorKeyProducer
-
Generate a
SensorKeyfor metrics about successful token validation requests - successKey() - Method in class io.strimzi.kafka.oauth.metrics.JwksHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about successful HTTP requests - successKey() - Method in class io.strimzi.kafka.oauth.metrics.JwksValidationSensorKeyProducer
-
Generate a
SensorKeyfor metrics about successful token validation requests - successKey() - Method in interface io.strimzi.kafka.oauth.metrics.SensorKeyProducer
-
Generate a SensorKey for the sensor representing the successful requests
- successKey() - Method in class io.strimzi.kafka.oauth.metrics.UserInfoHttpSensorKeyProducer
-
Generate a
SensorKeyfor metrics about successful HTTP requests
T
- takeCredentials(String) - Method in class io.strimzi.kafka.oauth.services.Credentials
-
Take credentials in order to associate them with PlainSaslServer
- TimeUtil - Class in io.strimzi.kafka.oauth.common
-
A helper class containing time functions
- TimeUtil() - Constructor for class io.strimzi.kafka.oauth.common.TimeUtil
- toEnvName(String) - Static method in class io.strimzi.kafka.oauth.common.Config
-
Convert property key to env key.
- token() - Method in class io.strimzi.kafka.oauth.common.FileBasedTokenProvider
- token() - Method in class io.strimzi.kafka.oauth.common.StaticTokenProvider
- token() - Method in class io.strimzi.kafka.oauth.common.TokenInfo
-
Get raw access token
- token() - Method in interface io.strimzi.kafka.oauth.common.TokenProvider
-
Get a token
- TOKEN_TYPE - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"token_type"
- TokenExpiredException - Exception in io.strimzi.kafka.oauth.validator
-
A runtime exception that signals an expired token
- TokenExpiredException(String) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenExpiredException
-
Create a new instance
- TokenExpiredException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenExpiredException
-
Create a new instance
- TokenInfo - Class in io.strimzi.kafka.oauth.common
-
TokenInfo encapsulates the information about the access token.
- TokenInfo(JsonNode, String, String) - Constructor for class io.strimzi.kafka.oauth.common.TokenInfo
-
Create a new instance
- TokenInfo(JsonNode, String, String, Set<String>) - Constructor for class io.strimzi.kafka.oauth.common.TokenInfo
-
Create a new instance
- TokenInfo(String, String, String, Set<String>, long, long) - Constructor for class io.strimzi.kafka.oauth.common.TokenInfo
- TokenInfo(String, Set<String>, String, Set<String>, long, long, JsonNode) - Constructor for class io.strimzi.kafka.oauth.common.TokenInfo
- TokenIntrospection - Class in io.strimzi.kafka.oauth.common
-
A class with methods for introspecting a JWT token
- TokenIntrospection() - Constructor for class io.strimzi.kafka.oauth.common.TokenIntrospection
- TokenProvider - Interface in io.strimzi.kafka.oauth.common
-
A contract for a class that provides a token
- TokenSignatureException - Exception in io.strimzi.kafka.oauth.validator
-
A runtime exception that signals an invalid token signature
- TokenSignatureException(String) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenSignatureException
-
Create a new instance
- TokenSignatureException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenSignatureException
-
Create a new instance
- TokenValidationException - Exception in io.strimzi.kafka.oauth.validator
-
A runtime exception used to signal an invalid token
- TokenValidationException(String) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenValidationException
-
Create a new instance
- TokenValidationException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.validator.TokenValidationException
-
Create a new instance
- TokenValidationException.Status - Enum in io.strimzi.kafka.oauth.validator
-
An Enum for different token validation error statuses
- TokenValidator - Interface in io.strimzi.kafka.oauth.validator
-
An interface specifying a TokenValidator contract
- toString() - Method in class io.strimzi.kafka.oauth.common.FileBasedTokenProvider
- toString() - Method in class io.strimzi.kafka.oauth.common.PrincipalExtractor
- toString() - Method in class io.strimzi.kafka.oauth.common.StaticTokenProvider
- toString() - Method in class io.strimzi.kafka.oauth.jsonpath.JsonPathFilterQuery
- toString() - Method in class io.strimzi.kafka.oauth.jsonpath.JsonPathQuery
- toString() - Method in class io.strimzi.kafka.oauth.metrics.SensorKey
- toString() - Method in class io.strimzi.kafka.oauth.services.ConfigurationKey
- toString() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.IntrospectionValidatorKey
- toString() - Method in class io.strimzi.kafka.oauth.services.ValidatorKey.JwtValidatorKey
- transform(Payload) - Method in class io.strimzi.kafka.oauth.common.NimbusPayloadTransformer
-
Convert a
Payloadobject toJsonNode - TYP - Static variable in class io.strimzi.kafka.oauth.common.TokenInfo
-
"typ"
U
- UNSUPPORTED_TOKEN_TYPE - Enum constant in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Token is rejected based on the token type
- urlencode(String) - Static method in class io.strimzi.kafka.oauth.common.OAuthAuthenticator
-
A helper method to urlencode a given value
- UserInfoHttpSensorKeyProducer - Class in io.strimzi.kafka.oauth.metrics
-
A
SensorKeyProducerused for user info endpoint HTTP metrics - UserInfoHttpSensorKeyProducer(String, URI) - Constructor for class io.strimzi.kafka.oauth.metrics.UserInfoHttpSensorKeyProducer
-
Create a new instance
V
- validate() - Method in class io.strimzi.kafka.oauth.common.Config
-
Validate configuration by checking for unknown or missing properties.
- validate(String) - Method in class io.strimzi.kafka.oauth.validator.JWTSignatureValidator
- validate(String) - Method in class io.strimzi.kafka.oauth.validator.OAuthIntrospectionValidator
- validate(String) - Method in interface io.strimzi.kafka.oauth.validator.TokenValidator
-
Validate the passed access token return it wrapped in TokenInfo with
- ValidationException - Exception in io.strimzi.kafka.oauth.validator
-
A runtime exception used to signal an error while performing token validation
- ValidationException(String) - Constructor for exception io.strimzi.kafka.oauth.validator.ValidationException
-
Create new instance
- ValidationException(String, Throwable) - Constructor for exception io.strimzi.kafka.oauth.validator.ValidationException
-
Create a new instance
- ValidatorKey - Class in io.strimzi.kafka.oauth.services
-
The class that holds the validator configuration and is used to compare different configurations for equality.
- ValidatorKey.IntrospectionValidatorKey - Class in io.strimzi.kafka.oauth.services
-
A
ValidatorKeyforOAuthIntrospectionValidator - ValidatorKey.JwtValidatorKey - Class in io.strimzi.kafka.oauth.services
-
A
ValidatorKeyforJWTSignatureValidator - Validators - Class in io.strimzi.kafka.oauth.services
-
A singleton holding the configured token validators
- Validators() - Constructor for class io.strimzi.kafka.oauth.services.Validators
- value() - Method in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Get enum value as a lowercase String
- valueOf(String) - Static method in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.strimzi.kafka.oauth.validator.TokenValidationException.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form