io.strimzi.kafka.oauth.common

Class PrincipalExtractor

java.lang.Object

io.strimzi.kafka.oauth.common.PrincipalExtractor

public class PrincipalExtractor
extends java.lang.Object

An object with logic for extracting a principal name (i.e. a user id) from a JWT token. First a claim configured as usernameClaim is looked up. If not found the claim configured as fallbackUsernameClaim is looked up. If that one is found and if the fallbackUsernamePrefix is configured prefix the found value with the prefix, otherwise not.

Constructor Summary

Constructors

Constructor and Description
PrincipalExtractor() Create a new instance
PrincipalExtractor(java.lang.String usernameClaim, java.lang.String fallbackUsernameClaim, java.lang.String fallbackUsernamePrefix) Create a new instance

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrincipal(com.fasterxml.jackson.databind.JsonNode json) Get the principal name
java.lang.String	getSub(com.fasterxml.jackson.databind.JsonNode json) Get the value of sub claim
boolean	isConfigured() Return true if any of the configuration options is configured
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrincipalExtractor

public PrincipalExtractor()

Create a new instance

PrincipalExtractor

public PrincipalExtractor(java.lang.String usernameClaim,
                          java.lang.String fallbackUsernameClaim,
                          java.lang.String fallbackUsernamePrefix)

Create a new instance

Parameters:

usernameClaim - Attribute name for an attribute containing the user id to lookup first

fallbackUsernameClaim - Attribute name for an attribute containg the user id to lookup as a fallback

fallbackUsernamePrefix - A prefix to prepend to the value of the fallback attribute value if set

Method Detail

getPrincipal

public java.lang.String getPrincipal(com.fasterxml.jackson.databind.JsonNode json)

Get the principal name

Parameters:

json - JWT token as a JsonNode object

Returns:

Principal name

getSub

public java.lang.String getSub(com.fasterxml.jackson.databind.JsonNode json)

Get the value of sub claim

Parameters:

json - JWT token as a JsonNode object

Returns:

The value of sub attribute

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isConfigured

public boolean isConfigured()

Return true if any of the configuration options is configured

Returns:

True if any of the constructor parameters is set