View Source

Class OpenIdDictApplicationManagerBase

Serves as the base class for managing OpenIddict application entities in Umbraco CMS, providing common functionality for application management operations.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Security

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class OpenIdDictApplicationManagerBase

Constructors

OpenIdDictApplicationManagerBase(IOpenIddictApplicationManager)

Initializes a new instance of the OpenIdDictApplicationManagerBase class.

Declaration

[Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 19.")]
protected OpenIdDictApplicationManagerBase(IOpenIddictApplicationManager applicationManager)

Parameters

Type	Name	Description
IOpenIddictApplicationManager	applicationManager	The OpenIddict application manager.

OpenIdDictApplicationManagerBase(IOpenIddictApplicationManager, ILogger)

Initializes a new instance of the OpenIdDictApplicationManagerBase class.

Declaration

protected OpenIdDictApplicationManagerBase(IOpenIddictApplicationManager applicationManager, ILogger logger)

Parameters

Type	Name	Description
IOpenIddictApplicationManager	applicationManager	The OpenIddict application manager.
ILogger	logger	The logger used to report contention while registering an application.

Properties

ApplicationManager

Gets the OpenIddict application manager used to read and write application registrations.

Declaration

protected IOpenIddictApplicationManager ApplicationManager { get; }

Property Value

Type	Description
IOpenIddictApplicationManager

Methods

CreateOrUpdate(OpenIddictApplicationDescriptor, CancellationToken)

Creates or updates an application from a fixed descriptor.

Declaration

protected Task CreateOrUpdate(OpenIddictApplicationDescriptor clientDescriptor, CancellationToken cancellationToken)

Parameters

Type	Name	Description
OpenIddictApplicationDescriptor	clientDescriptor	The descriptor to apply.
CancellationToken	cancellationToken	A System.Threading.CancellationToken to observe while waiting for the task to complete.

Returns

Type	Description
Task

CreateOrUpdate(Func<CancellationToken, Task<OpenIddictApplicationDescriptor>>, CancellationToken)

Creates or updates an application, rebuilding the descriptor for each attempt so a descriptor derived from stored state is re-derived if another instance writes first.

Declaration

protected Task CreateOrUpdate(Func<CancellationToken, Task<OpenIddictApplicationDescriptor>> clientDescriptorFactory, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Func<CancellationToken, Task<OpenIddictApplicationDescriptor>>	clientDescriptorFactory	Builds the descriptor to apply.
CancellationToken	cancellationToken	A System.Threading.CancellationToken to observe while waiting for the task to complete.

Returns

Type	Description
Task

Delete(string, CancellationToken)

Deletes the application with the given client identifier, if it exists.

Declaration

protected Task Delete(string identifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	identifier	The client identifier of the application to delete.
CancellationToken	cancellationToken	A System.Threading.CancellationToken to observe while waiting for the task to complete.

Returns

Type	Description
Task