Struct KafkaPrincipal 

pub struct KafkaPrincipal { /* private fields */ }

Principals in Kafka are defined by a type and a name.

The principal type will always be "User" for the simple authorizer that is enabled by default, but custom authorizers can leverage different principal types (such as to enable group or role-based ACLs).

Implementations

impl KafkaPrincipal

pub const USER_TYPE: &'static str = "User"

The principal type used by the default authorizer.

pub fn new(principal_type: impl Into<String>, name: impl Into<String>) -> Self

Creates a new principal from a type and name (not token-authenticated).

Arguments

• principal_type - the principal type, such as Self::USER_TYPE
• name - the principal name

pub fn with_token_authenticated( principal_type: impl Into<String>, name: impl Into<String>, token_authenticated: bool, ) -> Self

Creates a new principal from a type, name, and token-authenticated flag.

Arguments

• principal_type - the principal type, such as Self::USER_TYPE
• name - the principal name
• token_authenticated - whether the principal was authenticated with a delegation token

pub fn anonymous() -> Self

The anonymous principal (User:ANONYMOUS).

Modeled as a function rather than a constant because the name is an owned String.

pub fn name(&self) -> &str

Returns the principal name.

pub fn principal_type(&self) -> &str

Returns the principal type.

pub fn set_token_authenticated(&mut self, token_authenticated: bool)

Sets whether the principal was authenticated with a delegation token.

Arguments

• token_authenticated - whether the principal was authenticated with a delegation token

pub fn token_authenticated(&self) -> bool

Returns whether the principal was authenticated with a delegation token.

Trait Implementations

impl Clone for KafkaPrincipal

fn clone(&self) -> KafkaPrincipal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KafkaPrincipal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for KafkaPrincipal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for KafkaPrincipal

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KafkaPrincipal

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for KafkaPrincipal