Class SynchronizingRolesSecurityEntityProvider
NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. SecurityEntityProvider that uses SynchronizingUserService to retrieve users and roles.
Inheritance
Inherited Members
Namespace: EPiServer.Security
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public class SynchronizingRolesSecurityEntityProvider : PagingSupportingSecurityEntityProvider
Constructors
SynchronizingRolesSecurityEntityProvider()
Creates instance of SynchronizingRolesSecurityEntityProvider
Declaration
public SynchronizingRolesSecurityEntityProvider()
SynchronizingRolesSecurityEntityProvider(SynchronizingUserService)
Creates instance of SynchronizingRolesSecurityEntityProvider
Declaration
public SynchronizingRolesSecurityEntityProvider(SynchronizingUserService synchingUsersService)
Parameters
| Type | Name | Description |
|---|---|---|
| SynchronizingUserService | synchingUsersService | The SynchronizingUserService used. |
Methods
GetRolesForUser(String)
Retrieves all roles for user with given userName.
Declaration
public override IEnumerable<string> GetRolesForUser(string userName)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userName | The name of the user. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of all roles for the user. |
Overrides
Search(String, String)
Searches all security entities of given type with a matching name.
Declaration
public override IEnumerable<SecurityEntity> Search(string partOfValue, string claimType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfValue | Part of value to match or null to get all of given type. |
| System.String | claimType | The claimType to search for. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SecurityEntity> | A list of all matching entities or an empty list if no matches. |
Overrides
Search(String, String, Int32, Int32, out Int32)
Searches all security entities of given type with a matching name with paging support.
Declaration
public override IEnumerable<SecurityEntity> Search(string partOfValue, string claimType, int startIndex, int maxRows, out int totalCount)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfValue | Part of value to match or null to get all of given type. |
| System.String | claimType | The claim type to search for. |
| System.Int32 | startIndex | The start index, used for paging |
| System.Int32 | maxRows | The maximum number of rows returned |
| System.Int32 | totalCount | The total amount of matched entites. Return -1 if provider does not support paging. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SecurityEntity> | A list of all matching entities or an empty list if no matches. |