AuthenticateControllerAttribute Class

Defines an MVC filter attribute to handle basic authentication using the current GSF security provider.

Inheritance Hierarchy

SystemObject
  SystemAttribute
    FilterAttribute
      GSF.Web.SecurityAuthenticateControllerAttribute

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

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)]
public class AuthenticateControllerAttribute : FilterAttribute, 
	IAuthenticationFilter, IFilter

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := false)>
Public Class AuthenticateControllerAttribute
	Inherits FilterAttribute
	Implements IAuthenticationFilter, IFilter

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = false)]
public ref class AuthenticateControllerAttribute : public FilterAttribute, 
	IAuthenticationFilter, IFilter

[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)>]
type AuthenticateControllerAttribute =  
    class
        inherit FilterAttribute
        interface IAuthenticationFilter
        interface IFilter
    end

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

Type.createClass(
	'GSF.Web.Security.AuthenticateControllerAttribute',
	FilterAttribute,
	IAuthenticationFilter,
	IFilter);

Request Example View Source

The AuthenticateControllerAttribute type exposes the following members.

Constructors

	Name	Description
	AuthenticateControllerAttribute	Initializes a new instance of the AuthenticateControllerAttribute class

Top

Properties

	Name	Description
	AllowMultiple	Gets a value that indicates whether multiple filters are allowed. (Inherited from FilterAttribute.)
	LoginPage	Gets or sets the login page used as a redirect location when authentication fails.
	SecuritySettingsCategory	Gets or sets settings category used to lookup security connection for user data context.
	SessionToken	Gets or sets the token used for identifying the session ID in cookie headers.
	SettingsCategory	Gets or sets settings category used to load configured settings. When defined, SessionToken and LoginPage will be loaded from the configuration file settings when not otherwise explicitly defined.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	AuthenticateAsync	Authenticates the request.
	ChallengeAsync	Challenges the request.
	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault(Type, Object)	Overloaded. Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions.)
	GetEnumValueOrDefaultT(Object)	Overloaded. 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