SessionHandler Class

Represents an HTTP messaging handler that can inject a session ID that can be used for security and user state.

Inheritance Hierarchy

SystemObject
  System.Net.HttpHttpMessageHandler
    System.Net.HttpDelegatingHandler
      GSF.Web.SecuritySessionHandler

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

Syntax

C++

JavaScript

Copy

public class SessionHandler : DelegatingHandler

Public Class SessionHandler
	Inherits DelegatingHandler

public ref class SessionHandler : public DelegatingHandler

type SessionHandler = 
    class
        inherit DelegatingHandler
    end

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

Type.createClass(
	'GSF.Web.Security.SessionHandler',
	DelegatingHandler);

View Source

The SessionHandler type exposes the following members.

Constructors

	Name	Description
	SessionHandler	Creates a new SessionHandler.

Top

Properties

	Name	Description
	AuthenticationToken	Gets the token used for identifying the authentication token in cookie headers.
	InnerHandler	Gets or sets the inner handler which processes the HTTP response messages. (Inherited from DelegatingHandler)
	SessionMonitorInterval	Gets interval, in milliseconds, over which the client session cache will be evaluated for expired sessions.
	SessionTimeout	Gets timeout, in minutes, for which inactive client sessions will be expired and removed from the cache.
	SessionToken	Gets the token used for identifying the session ID in cookie headers.

Top

Methods

	Name	Description
	ClearSessionCache	Clears any cached session for the specified sessionID.
	Dispose	Releases the unmanaged resources and disposes of the managed resources used by the HttpMessageHandler. (Inherited from HttpMessageHandler)
	Dispose(Boolean)	Releases the unmanaged resources used by the DelegatingHandler, and optionally disposes of the managed resources. (Inherited from DelegatingHandler)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetAuthenticationTokenFromCookie(HttpRequestMessage, String)	Gets the authentication token as defined in the request cookie header values.
	GetAuthenticationTokenFromCookie(IOwinRequest, String)	Gets the authentication token as defined in the request cookie header values.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSessionIDFromCookie(HttpRequestMessage, String)	Gets the session ID Guid as defined in the request cookie header values.
	GetSessionIDFromCookie(IOwinRequest, String)	Gets the session ID Guid as defined in the Owin cookie header values.
	GetSessionIDFromCookie(IRequest, String)	Gets the session ID Guid as defined in the SignalR cookie header values.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SendAsync	Modifies the HTTP request message pipeline to include a session identifier. (Overrides DelegatingHandlerSendAsync(HttpRequestMessage, CancellationToken))
	SetCookie	Gets the session state as defined in the request cookie header values.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetCachedCredentials	Attempts to use the authentication token to retrieve the user's credentials from the credential cache.
	TryGetSessionID	Tries to get the session ID Guid as defined in the request properties dictionary.
	TryGetSessionState	Tries to get the session state as defined in the request properties dictionary.

Top

Events

	Name	Description
	ProcessException	Occurs when a static method encounters an exception.
	SessionExpired	Raised when a client session is being expired.

Top

Fields

	Name	Description
	DefaultAuthenticationToken	Default value for AuthenticationToken;
	DefaultSessionExpirationDays	Default value for a cached session expiration, in days.
	DefaultSessionMonitorInterval	Default value for SessionMonitorInterval.
	DefaultSessionTimeout	Default value for SessionTimeout.
	DefaultSessionToken	Default value for SessionToken;

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