Take the community feedback survey now.

AI OnAI Off

Class VirtualRolesElement

Configuration for virtual roles

Inheritance
System.Object
VirtualRolesElement
Namespace: EPiServer.Framework.Configuration
Assembly: EPiServer.Framework.dll
Version: 10.10.4
Syntax
public class VirtualRolesElement : ConfigurationElement

Constructors

VirtualRolesElement()

Declaration
public VirtualRolesElement()

Properties

AddClaims

Declaration
public bool AddClaims { get; set; }
Property Value
Type Description
System.Boolean

DefaultRoles

Declaration
public static VirtualRolesElement DefaultRoles { get; }
Property Value
Type Description
VirtualRolesElement

FailSafeIsInRole

Gets or sets a value indicating whether IsInRole on VirtualRolePrincipal may throw an exception.

Declaration
public bool FailSafeIsInRole { get; set; }
Property Value
Type Description
System.Boolean

true if IsInRole is fail safe (cannot throw exception); otherwise, false.
Remarks

This setting can be useful to emulate the behavior of IsInRole as it worked in .NET Framework 1.0 / 1.1 In these versions any exceptions thrown by code executing beneath IsInRole were caught and ignored. The IsInRole for a WindowsPrincipal in .NET 2.0 may throw an exception if a domain controller is unavailable - this may be undesired behavior since it could prevent the logon process, thus preventing any user from logging on. By setting this property to True you will cause any exceptions thrown by IsInRole to be caught and ignored. The IsInRole call will be interpreted as returning False on throw.

Providers

Declaration
public ProviderSettingsCollection Providers { get; }
Property Value
Type Description
System.Configuration.ProviderSettingsCollection

ReplacePrincipal

Declaration
public bool ReplacePrincipal { get; set; }
Property Value
Type Description
System.Boolean

ReplicationType

The type that will handle replication of changes in virtual roles

Declaration
public string ReplicationType { get; set; }
Property Value
Type Description
System.String

Extension Methods