Class UserServiceBase

Namespace

Tharga.Team

Assembly

Tharga.Team.dll

public abstract class UserServiceBase : IUserService, IUserCacheInvalidator

Inheritance

object

UserServiceBase

Implements

IUserService

IUserCacheInvalidator

Derived

UserServiceRepositoryBase<TUserEntity>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UserServiceBase(AuthenticationStateProvider, ILogger<UserServiceBase>, IIconStore, ITeamCache)

protected UserServiceBase(AuthenticationStateProvider authenticationStateProvider, ILogger<UserServiceBase> logger = null, IIconStore iconStore = null, ITeamCache cache = null)

Parameters

authenticationStateProvider AuthenticationStateProvider

Resolves the calling principal when none is supplied.

logger ILogger<UserServiceBase>

Optional. Used to report activity-stamping failures, which never fail a resolve.

iconStore IIconStore

Optional. Required only for user icons; see SetUserIconAsync(string, byte[], string).

cache ITeamCache

Where resolved users are kept. Defaults to the process-local InMemoryTeamCache, which is correct for a single instance only — forward this parameter from your own service's constructor so a shared implementation can be registered, or a multi-instance deployment will not see a user disabled through another instance. See ITeamCache.

Fields

_authenticationStateProvider

protected readonly AuthenticationStateProvider _authenticationStateProvider

Field Value

AuthenticationStateProvider

Properties

LastSeenStampInterval

How often (at most) LastSeen is written on resolve. Null disables stamping; Zero stamps on every resolve. The throttle is per process, so a multi-instance deployment writes at most once per interval per instance.

protected virtual TimeSpan? LastSeenStampInterval { get; }

Property Value

TimeSpan?

Methods

ClearOwnIconAsync()

Clears the current user's own icon and deletes the stored bytes (self-service).

public virtual Task ClearOwnIconAsync()

Returns

Task

ClearUserIconAsync(string)

Clears a specific user's icon (administrative). Requires Manage.

public virtual Task ClearUserIconAsync(string userKey)

Parameters

userKey string

Returns

Task

DeleteUserAsync(string)

public virtual Task DeleteUserAsync(string userKey)

Parameters

userKey string

Returns

Task

GetAllAsync()

protected abstract IAsyncEnumerable<IUser> GetAllAsync()

Returns

IAsyncEnumerable<IUser>

GetAsync()

All users. Cross-user enumeration — requires Manage.

public virtual IAsyncEnumerable<IUser> GetAsync()

Returns

IAsyncEnumerable<IUser>

GetClaims(ClaimsPrincipal)

The caller, either as supplied or resolved from the circuit. Null when there is no circuit to ask — an MCP request handler, a hosted service, a message handler — because nothing there can name a caller, and crashing is not a better answer than saying so.

protected virtual Task<ClaimsPrincipal> GetClaims(ClaimsPrincipal claimsPrincipal)

Parameters

claimsPrincipal ClaimsPrincipal

Returns

Task<ClaimsPrincipal>

GetCurrentUserAsync(ClaimsPrincipal)

public Task<IUser> GetCurrentUserAsync(ClaimsPrincipal claimsPrincipal)

Parameters

claimsPrincipal ClaimsPrincipal

Returns

Task<IUser>

GetUserAsync(ClaimsPrincipal)

protected abstract Task<IUser> GetUserAsync(ClaimsPrincipal claimsPrincipal)

Parameters

claimsPrincipal ClaimsPrincipal

Returns

Task<IUser>

GetUserByKeyAsync(string)

The user with the given key, or null. The default implementation scans GetAsync(); storage-backed services override it with a direct read.

public virtual Task<IUser> GetUserByKeyAsync(string userKey)

Parameters

userKey string

Returns

Task<IUser>

InvalidateUserByKey(string)

Drops any cached copy of the user with this key. A no-op when nothing is cached for it, so it is always safe to call and safe to call twice.

public void InvalidateUserByKey(string userKey)

Parameters

userKey string

Remarks

See InvalidateUserCache(string) on why blocking here is safe for the built-in cache and not for a remote one.

InvalidateUserByKeyAsync(string)

The asynchronous form, which is what the toolkit calls. Prefer implementing this one: the cache may be a remote store (see ITeamCache), and the synchronous member can then only be served by blocking.

public Task InvalidateUserByKeyAsync(string userKey)

Parameters

userKey string

Returns

Task

Remarks

Defaulted to the synchronous member so an existing implementation keeps compiling and keeps working.

InvalidateUserCache(string)

Drops the cached user for identity. Retained for hosts that call it; the toolkit's own paths use RemoveUserAsync(string) directly.

protected void InvalidateUserCache(string identity)

Parameters

identity string

Remarks

Synchronous, so it waits on the cache. That is free for the built-in InMemoryTeamCache — every member completes synchronously — but a host that has registered a remote ITeamCache should prefer InvalidateUserCacheAsync(string) rather than blocking a request thread on it.

InvalidateUserCacheAsync(string)

Drops the cached user for identity. A no-op when nothing is cached.

protected Task InvalidateUserCacheAsync(string identity)

Parameters

identity string

Returns

Task

RaiseUserCreated(IUser, ClaimsPrincipal)

Announces a first-sign-in creation. Call only after the record is durably stored, and only for the caller that actually created it - a store losing the insert race re-reads the winner and must not report a creation it did not perform.

protected void RaiseUserCreated(IUser user, ClaimsPrincipal claimsPrincipal)

Parameters

user IUser

claimsPrincipal ClaimsPrincipal

SeedUserNameAsync(string, string)

Sets the user's display name only if it is currently null/empty. Used by the invitation-accept flow to promote the admin-entered invitation name into the new user's identity without clobbering an IdP-provided name.

public virtual Task SeedUserNameAsync(string userKey, string name)

Parameters

userKey string

name string

Returns

Task

SetOwnIconAsync(byte[], string)

Sets the current user's own icon from raw image bytes (self-service): stores them via the registered IIconStore, persists the reference on the user, and deletes any previous icon. Requires a registered icon store and an authenticated caller.

public virtual Task SetOwnIconAsync(byte[] data, string contentType)

Parameters

data byte[]

contentType string

Returns

Task

SetUserDirectoryIdAsync(string, string)

Links the user to their external-directory id (DirectoryId). Called by the oid backfill (internal self-call) and by directory verification on an email-fallback match (relink). Default is a no-op — stores that track the directory id override it.

public virtual Task SetUserDirectoryIdAsync(string userKey, string directoryId)

Parameters

userKey string

directoryId string

Returns

Task

SetUserDisabledAsync(string, DateTime?, string)

public virtual Task SetUserDisabledAsync(string userKey, DateTime? disabledAt, string disabledBy)

Parameters

userKey string

disabledAt DateTime?

disabledBy string

Returns

Task

Remarks

Throws rather than no-opping when unimplemented, exactly as DeleteUserAsync(string) does: silently accepting a disable would report a containment that never happened.

SetUserIconAsync(string, byte[], string)

Sets a specific user's icon (administrative). The mechanism is the same as SetOwnIconAsync(byte[], string) but targets userKey; requires Manage.

public virtual Task SetUserIconAsync(string userKey, byte[] data, string contentType)

Parameters

userKey string

data byte[]

contentType string

Returns

Task

SetUserIconReferenceAsync(string, string)

Backs SetOwnIconAsync(byte[], string) / ClearOwnIconAsync() — persists the icon reference (or null to clear) on the user document. Default no-op; stores that track Icon override it.

protected virtual Task SetUserIconReferenceAsync(string userKey, string reference)

Parameters

userKey string

reference string

Returns

Task

SetUserLastSeenAsync(string, DateTime)

Stamps when the user last made an authenticated request. The automatic throttled stamping is an internal self-call that bypasses the authorization decorator; calling this member from outside requires Manage. The default is a no-op — stores that track LastSeen override it.

public virtual Task SetUserLastSeenAsync(string userKey, DateTime lastSeen)

Parameters

userKey string

lastSeen DateTime

Returns

Task

SetUserNameAsync(string, string)

Always sets the user's display name. Used by the user self-edit flow where the caller has explicitly chosen a name for themselves.

public virtual Task SetUserNameAsync(string userKey, string name)

Parameters

userKey string

name string

Returns

Task

Events

UserCreatedEvent

Raised when a user record is created as a side effect of someone signing in for the first time.

public event EventHandler<UserCreatedEventArgs> UserCreatedEvent

Event Type

EventHandler<UserCreatedEventArgs>

Remarks

An event rather than a constructor dependency, on purpose. The creation happens in the storage base (Tharga.Team.MongoDB), which cannot see the audit types - they live in Tharga.Team.Service. An optional constructor parameter would also be one more thing a host's own service must remember to forward, which is the hazard TeamCacheWiringCheck exists to catch.

Not the same as an administrator creating a user. That path is already audited by AuditingUserManagementServiceDecorator. This one has no actor but the new user themselves.