AuthorizeControllerRoleAttribute Class

Defines an MVC filter attribute to handle the GSF role based security model.

Inheritance Hierarchy

SystemObject
  SystemAttribute
    FilterAttribute
      GSF.Web.SecurityAuthorizeControllerRoleAttribute

Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.258-beta

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)]
public class AuthorizeControllerRoleAttribute : FilterAttribute, 
	IAuthorizationFilter, IExceptionFilter

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := false)>
Public Class AuthorizeControllerRoleAttribute
	Inherits FilterAttribute
	Implements IAuthorizationFilter, IExceptionFilter

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = false)]
public ref class AuthorizeControllerRoleAttribute : public FilterAttribute, 
	IAuthorizationFilter, IExceptionFilter

[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)>]
type AuthorizeControllerRoleAttribute = 
    class
        inherit FilterAttribute
        interface IAuthorizationFilter
        interface IExceptionFilter
    end

GSF.Web.Security.AuthorizeControllerRoleAttribute = function();

Type.createClass(
	'GSF.Web.Security.AuthorizeControllerRoleAttribute',
	FilterAttribute,
	IAuthorizationFilter,
	IExceptionFilter);

View Source

The AuthorizeControllerRoleAttribute type exposes the following members.

Constructors

	Name	Description
	AuthorizeControllerRoleAttribute	Creates a new MVC based authorization attribute.
	AuthorizeControllerRoleAttribute(String)	Creates a new MVC based authorization attribute for specified roles.

Top

Properties

	Name	Description
	AllowMultiple	Gets or sets a value that indicates whether more than one instance of the filter attribute can be specified. (Inherited from FilterAttribute)
	Order	Gets or sets the order in which the action filters are executed. (Inherited from FilterAttribute)
	SecurityExceptionViewName	Gets or sets view name to show for security exceptions.
	SecuritySettingsCategory	Gets or sets settings category used to lookup security connection for user data context.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnAuthorization	Called when authorization is required.
	OnException	Called when an exception occurs.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	AllowedRoles	Gets allowed roles as a string array.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.Web.Security Namespace