AuthorizeHubRoleAttribute Class

Defines a SignalR authorization attribute to handle the GSF role based security model.

Inheritance Hierarchy

SystemObject
  SystemAttribute
    AuthorizeAttribute
      GSF.Web.SecurityAuthorizeHubRoleAttribute

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

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)]
public class AuthorizeHubRoleAttribute : AuthorizeAttribute

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, Inherited := false)>
Public Class AuthorizeHubRoleAttribute
	Inherits AuthorizeAttribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, Inherited = false)]
public ref class AuthorizeHubRoleAttribute : public AuthorizeAttribute

[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = false)>]
type AuthorizeHubRoleAttribute = 
    class
        inherit AuthorizeAttribute
    end

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

Type.createClass(
	'GSF.Web.Security.AuthorizeHubRoleAttribute',
	Microsoft.AspNet.SignalR.AuthorizeAttribute);

View Source

The AuthorizeHubRoleAttribute type exposes the following members.

Constructors

	Name	Description
	AuthorizeHubRoleAttribute	Creates a new AuthorizeHubRoleAttribute.
	AuthorizeHubRoleAttribute(String)	Creates a new AuthorizeHubRoleAttribute with specified allowed roles.

Top

Properties

	Name	Description
	AllowedRoles	Gets the allowed Roles as a string array.
	RequireOutgoing	Set to false to apply authorization only to the invocations of any of the Hub's server-side methods. This property only affects attributes applied to the Hub class. This property cannot be read. (Inherited from AuthorizeAttribute)
	Roles	Gets or sets the user roles. (Inherited from AuthorizeAttribute)
	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)
	Users	Gets or sets the authorized users. (Inherited from AuthorizeAttribute)

Top

Methods

	Name	Description
	AuthorizeHubConnection	Determines whether client is authorized to connect to IHub. (Inherited from AuthorizeAttribute)
	AuthorizeHubMethodInvocation	Determines whether client is authorized to invoke the IHub method. (Inherited from AuthorizeAttribute)
	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)
	UserAuthorized	Provides an entry point for custom authorization checks. (Overrides AuthorizeAttribute.UserAuthorized(IPrincipal))

Top

Fields

	Name	Description
	_requireOutgoing	(Inherited from AuthorizeAttribute)

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