C# Class BlogEngine.Core.Providers.XmlRoleProvider

The xml role provider.

Inheritance: System.Web.Security.RoleProvider

Show file Open project: rasmuskl/ReSharperCourse

Private Properties

Property	Type	Description
ReadMembershipDataStore	void
ReadRoleDataStore	void
RemoveItemFromList	void

Public Methods

Method	Description
AddUsersToRoles ( string usernames, string roleNames ) : void	Adds the specified user names to the specified roles for the configured applicationName.
CreateRole ( string roleName ) : void	Adds a new role to the data source for the configured applicationName.
DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool	Removes a role from the data source for the configured applicationName.
FindUsersInRole ( string roleName, string usernameToMatch ) : string[]	Gets an array of user names in a role where the user name contains the specified user name to match.
GetAllRoles ( ) : string[]	Gets a list of all the roles for the configured applicationName.
GetRolesForUser ( string username ) : string[]	Gets a list of the roles that a specified user is in for the configured applicationName.
GetUsersInRole ( string roleName ) : string[]	Gets a list of users in the specified role for the configured applicationName.
Initialize ( string name, NameValueCollection config ) : void	Initializes the provider.
IsUserInRole ( string username, string roleName ) : bool	Gets a value indicating whether the specified user is in the specified role for the configured applicationName.
RemoveUsersFromRoles ( string usernames, string roleNames ) : void	Removes the specified user names from the specified roles for the configured applicationName.
RoleExists ( string roleName ) : bool	Gets a value indicating whether the specified role name already exists in the role data source for the configured applicationName.
Save ( ) : void	Saves this instance.

Private Methods

Method	Description
ReadMembershipDataStore ( ) : void	Only so we can add users to the adminstrators role.
ReadRoleDataStore ( ) : void	Builds the internal cache of users.
RemoveItemFromList ( ICollection list, string item ) : void	The remove item from list.

Method Details

AddUsersToRoles() public method

Adds the specified user names to the specified roles for the configured applicationName.

public AddUsersToRoles ( string usernames, string roleNames ) : void
usernames	string	/// A string array of user names to be added to the specified roles. ///
roleNames	string	/// A string array of the role names to add the specified user names to. ///
return	void

CreateRole() public method

Adds a new role to the data source for the configured applicationName.

public CreateRole ( string roleName ) : void
roleName	string	/// The name of the role to create. ///
return	void

DeleteRole() public method

Removes a role from the data source for the configured applicationName.

public DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
roleName	string	/// The name of the role to delete. ///
throwOnPopulatedRole	bool	/// If true, throw an exception if roleName has one or more members and do not delete roleName. ///
return	bool

FindUsersInRole() public method

Gets an array of user names in a role where the user name contains the specified user name to match.

public FindUsersInRole ( string roleName, string usernameToMatch ) : string[]
roleName	string	/// The role to search in. ///
usernameToMatch	string	/// The user name to search for. ///
return	string[]

GetAllRoles() public method

Gets a list of all the roles for the configured applicationName.

public GetAllRoles ( ) : string[]
return	string[]

GetRolesForUser() public method

Gets a list of the roles that a specified user is in for the configured applicationName.

public GetRolesForUser ( string username ) : string[]
username	string	/// The user to return a list of roles for. ///
return	string[]

GetUsersInRole() public method

Gets a list of users in the specified role for the configured applicationName.

public GetUsersInRole ( string roleName ) : string[]
roleName	string	/// The name of the role to get the list of users for. ///
return	string[]

Initialize() public method

Initializes the provider.

/// The name of the provider is null. /// /// The name of the provider has a length of zero. /// /// An attempt is made to call on a provider after the provider has already been initialized. ///

public Initialize ( string name, NameValueCollection config ) : void
name	string	/// The friendly name of the provider. ///
config	System.Collections.Specialized.NameValueCollection	/// A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider. ///
return	void

IsUserInRole() public method

Gets a value indicating whether the specified user is in the specified role for the configured applicationName.

public IsUserInRole ( string username, string roleName ) : bool
username	string	/// The user name to search for. ///
roleName	string	/// The role to search in. ///
return	bool

RemoveUsersFromRoles() public method

Removes the specified user names from the specified roles for the configured applicationName.

public RemoveUsersFromRoles ( string usernames, string roleNames ) : void
usernames	string	/// A string array of user names to be removed from the specified roles. ///
roleNames	string	/// A string array of role names to remove the specified user names from. ///
return	void

RoleExists() public method

Gets a value indicating whether the specified role name already exists in the role data source for the configured applicationName.

public RoleExists ( string roleName ) : bool
roleName	string	/// The name of the role to search for in the data source. ///
return	bool

Save() public method

Saves this instance.

public Save ( ) : void
return	void