26.115. Class AuthenticationCacheKey

Namespace: ArmoniK.Core.Common.Auth.Authentication
Assembly: ArmoniK.Core.Common.dll

Class used as the key for the authentication cache

public sealed class AuthenticationCacheKey : IEquatable<AuthenticationCacheKey>

26.115.1. Inheritance

objectAuthenticationCacheKey

26.115.2. Implements

IEquatable<AuthenticationCacheKey>

26.115.3. Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

26.115.4. Constructors

26.115.4.1. AuthenticationCacheKey(string, string?, string?, string?, string?)

Creates an authentication cache key from request headers

public AuthenticationCacheKey(string connectionId, string? cn = "", string? fingerprint = "", string? impersonateId = "", string? impersonateUsername = "")

26.115.4.1.1. Parameters

connectionId string

Connection id

cn string?

Certificate Common Name

fingerprint string?

Certificate fingerprint

impersonateId string?

User Id to impersonate

impersonateUsername string?

Username to impersonate

26.115.5. Properties

26.115.5.1. Cn

Certificate common name

public string Cn { get; }

26.115.5.1.1. Property Value

string

26.115.5.2. ConnectionId

Id of the connection

public string ConnectionId { get; }

26.115.5.2.1. Property Value

string

26.115.5.3. Fingerprint

Certificate fingerprint

public string Fingerprint { get; }

26.115.5.3.1. Property Value

string

26.115.5.4. ImpersonateId

User id to impersonate

public string ImpersonateId { get; }

26.115.5.4.1. Property Value

string

26.115.5.5. ImpersonateUsername

Username to impersonate

public string ImpersonateUsername { get; }

26.115.5.5.1. Property Value

string

26.115.6. Methods

26.115.6.1. Equals(AuthenticationCacheKey?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(AuthenticationCacheKey? other)

26.115.6.1.1. Parameters

other AuthenticationCacheKey?

An object to compare with this object.

26.115.6.1.2. Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

26.115.6.2. Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

26.115.6.2.1. Parameters

obj object?

The object to compare with the current object.

26.115.6.2.2. Returns

bool

true if the specified object is equal to the current object; otherwise, false.

26.115.6.3. GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

26.115.6.3.1. Returns

int

A hash code for the current object.