C# Class Catbert4.Providers.CatbertServiceRoleProvider

CatbertServiceRoleProvider inherits from the generic RoleProvider provided by ASP.NET that is part of their provider model (which includes Membership, Role and Profile Providers)

Inheritance: System.Web.Security.RoleProvider

Show file Open project: ucdavis/Catbert

Private Properties

Property	Type	Description
GetClient	RoleServiceClient

Public Methods

Method	Description
AddUsersToRoles ( string usernames, string roleNames ) : void
CreateRole ( string roleName ) : void
DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
FindUsersInRole ( string roleName, string usernameToMatch ) : string[]
GetAllRoles ( ) : string[]	Gets all roles in the application context
GetRolesForUser ( string username ) : string[]	Gets all roles for the user in the context of this application
GetUsersInRole ( string roleName ) : string[]	Gets all users that are in the current role in the application context
InitWithoutConfig ( string appName, string serviceUrl, string authToken ) : void	Just set the appname and connection string
Initialize ( string name, NameValueCollection config ) : void	Initialized from the web.config file when the application loads for the first time.
IsUserInRole ( string username, string roleName ) : bool	Determine if a user is in the supplied role in this application.
RemoveUsersFromRoles ( string usernames, string roleNames ) : void
RoleExists ( string roleName ) : bool	Find out if a role exists within an application context A return of false doesn't mean that the role doesn't exist in the db, just that it doesn't exists withing the context of this application

Private Methods

Method	Description
GetClient ( ) : RoleServiceClient

Method Details

AddUsersToRoles() public method

public AddUsersToRoles ( string usernames, string roleNames ) : void
usernames	string
roleNames	string
return	void

CreateRole() public method

public CreateRole ( string roleName ) : void
roleName	string
return	void

DeleteRole() public method

public DeleteRole ( string roleName, bool throwOnPopulatedRole ) : bool
roleName	string
throwOnPopulatedRole	bool
return	bool

FindUsersInRole() public method

public FindUsersInRole ( string roleName, string usernameToMatch ) : string[]
roleName	string
usernameToMatch	string
return	string[]

GetAllRoles() public method

Gets all roles in the application context

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

GetRolesForUser() public method

Gets all roles for the user in the context of this application

public GetRolesForUser ( string username ) : string[]
username	string	LoginID to get the roles for
return	string[]

GetUsersInRole() public method

Gets all users that are in the current role in the application context

public GetUsersInRole ( string roleName ) : string[]
roleName	string
return	string[]

InitWithoutConfig() public method

Just set the appname and connection string

public InitWithoutConfig ( string appName, string serviceUrl, string authToken ) : void
appName	string
serviceUrl	string
authToken	string
return	void

Initialize() public method

Initialized from the web.config file when the application loads for the first time.

public Initialize ( string name, NameValueCollection config ) : void
name	string	The name of the role provider
config	System.Collections.Specialized.NameValueCollection	Collection of keys. They need to include ApplicationName, ConnectionString. /// Description is optional
return	void

IsUserInRole() public method

Determine if a user is in the supplied role in this application.

public IsUserInRole ( string username, string roleName ) : bool
username	string	LoginID
roleName	string	RoleName
return	bool

RemoveUsersFromRoles() public method

public RemoveUsersFromRoles ( string usernames, string roleNames ) : void
usernames	string
roleNames	string
return	void

RoleExists() public method

Find out if a role exists within an application context

A return of false doesn't mean that the role doesn't exist in the db, just that it doesn't exists withing the context of this application

public RoleExists ( string roleName ) : bool
roleName	string	RoleName
return	bool