Class SessionHelper

Helper class for handling session.

Inheritance
System.Object
SessionHelper
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Terrasoft.Web.Common
Assembly: Terrasoft.Web.Common.dll
Syntax
public class SessionHelper : ISessionHelper

Constructors

SessionHelper()

Declaration
public SessionHelper()

Fields

AppConnectionParameterName

Declaration
public const string AppConnectionParameterName = "AppConnection"
Field Value
Type Description
System.String

DisableAutoLoginQueryParameterName

Declaration
public const string DisableAutoLoginQueryParameterName = "DisableAutoLogin"
Field Value
Type Description
System.String

UserConnectionParameterName

Declaration
public const string UserConnectionParameterName = "UserConnection"
Field Value
Type Description
System.String

Properties

PersonalSessionTimeouts

List of personal user session timeouts.

Declaration
public static ConcurrentDictionary<string, int> PersonalSessionTimeouts { get; set; }
Property Value
Type Description
System.Collections.Concurrent.ConcurrentDictionary<System.String, System.Int32>

Methods

CheckCurrentPrincipalAuthentication()

Declaration
public void CheckCurrentPrincipalAuthentication()

CloseUserConnectionAndAbandonSession(SessionEndMethod, Boolean)

Declaration
public static void CloseUserConnectionAndAbandonSession(SessionEndMethod sessionEndMethod, bool removeAuthCookie)
Parameters
Type Name Description
SessionEndMethod sessionEndMethod
System.Boolean removeAuthCookie

CloseUserConnectionAndAbandonSession(SessionEndMethod, Boolean, HttpSessionStateBase)

Declaration
public static void CloseUserConnectionAndAbandonSession(SessionEndMethod sessionEndMethod, bool removeAuthCookie, HttpSessionStateBase session)
Parameters
Type Name Description
SessionEndMethod sessionEndMethod
System.Boolean removeAuthCookie
System.Web.HttpSessionStateBase session

CorrectAuthCookiePath(String)

Declaration
public static void CorrectAuthCookiePath(string authCookiePath)
Parameters
Type Name Description
System.String authCookiePath

GetAuthData()

Declaration
public AuthData GetAuthData()
Returns
Type Description
AuthData

GetAuthData(HttpContextBase)

Declaration
public AuthData GetAuthData(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext
Returns
Type Description
AuthData

GetCurrentWebOperationIdentity(HttpContextBase)

Returns current user name from HttpContext's Items collection.

Declaration
public static string GetCurrentWebOperationIdentity(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext

System.Web.HttpContextBase instance.
Returns
Type Description
System.String

Current user name.

GetParentApplicationPath()

Declaration
public static string GetParentApplicationPath()
Returns
Type Description
System.String

GetSessionId(HttpContextBase)

Declaration
public string GetSessionId(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext
Returns
Type Description
System.String

GetUserSessionTimeout()

Returns common user session timeout.

Declaration
public int GetUserSessionTimeout()
Returns
Type Description
System.Int32

Session timeout value in minutes.

GetUserSessionTimeout(String)

Returns personal user session timeout if exists and feature is enabled, otherwise returns common session timeout.

Declaration
public int GetUserSessionTimeout(string userName)
Parameters
Type Name Description
System.String userName

User name.
Returns
Type Description
System.Int32

Session timeout value in minutes.

InitializeCurrentPrincipal()

Declaration
[Obsolete("7.12.1 | Method is not in use and will be removed in upcoming builds")]
public static void InitializeCurrentPrincipal()

InitializeCurrentPrincipal(HttpContextBase)

Declaration
public void InitializeCurrentPrincipal(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext

InitializeSessionId(HttpContextBase)

Declaration
public void InitializeSessionId(HttpContextBase httpContext)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext

InitializeSystemCurrentPrincipal()

Declaration
public static void InitializeSystemCurrentPrincipal()

IsAnonymousAccessAllowed(HttpRequest)

Declaration
public static bool IsAnonymousAccessAllowed(HttpRequest request)
Parameters
Type Name Description
System.Web.HttpRequest request
Returns
Type Description
System.Boolean

IsAnonymousAccessAllowed(HttpRequestBase)

Declaration
public static bool IsAnonymousAccessAllowed(HttpRequestBase request)
Parameters
Type Name Description
System.Web.HttpRequestBase request
Returns
Type Description
System.Boolean

RecreateUserConnection(AuthData)

Declaration
public static void RecreateUserConnection(AuthData authData)
Parameters
Type Name Description
AuthData authData

RemovePersonalUserSessionTimeoutFromCache(String)

Removes personal user session timeout from cache.

Declaration
public bool RemovePersonalUserSessionTimeoutFromCache(string userName)
Parameters
Type Name Description
System.String userName

User name.
Returns
Type Description
System.Boolean

SetPersonalUserSessionTimeouts(UserConnection)

Sets personal session timeouts for all users.

Declaration
public void SetPersonalUserSessionTimeouts(UserConnection userConnection)
Parameters
Type Name Description
UserConnection userConnection

Instance of UserConnection

SetSessionCookie(Boolean)

Declaration
public static void SetSessionCookie(bool isExpired = false)
Parameters
Type Name Description
System.Boolean isExpired

SignOutFromParent()

Declaration
public static void SignOutFromParent()

SingleLogout()

Initiates single log out.

Declaration
public static void SingleLogout()

SingleLogout(AppConnection, HttpContextBase, ISamlServiceProviderApi)

Initiates single log out.

Declaration
public static void SingleLogout(AppConnection appConnection, HttpContextBase httpContext, ISamlServiceProviderApi provider)
Parameters
Type Name Description
AppConnection appConnection

Terrasoft.Web.Common.SessionHelper.AppConnection instance.
System.Web.HttpContextBase httpContext

System.Web.HttpContextBase instance.
ISamlServiceProviderApi provider

ISamlServiceProviderApi instance.

SpecifyWebOperationIdentity(HttpContextBase, SysUserInfo)

Sets current user name into HttpContext's Items collection.

Declaration
[Obsolete("7.14.1 | Use SpecifyWebOperationIdentity(Terrasoft.Web.Http.Abstractions.HttpContext httpContext, SysUserInfo currentUser) instead")]
public static void SpecifyWebOperationIdentity(HttpContextBase httpContext, SysUserInfo currentUser)
Parameters
Type Name Description
System.Web.HttpContextBase httpContext

System.Web.HttpContextBase instance.
SysUserInfo currentUser

Current SysUserInfo instance.

SpecifyWebOperationIdentity(HttpContext, SysUserInfo)

Sets current user name into HttpContext's Items collection.

Declaration
public static void SpecifyWebOperationIdentity(HttpContext httpContext, SysUserInfo currentUser)
Parameters
Type Name Description
HttpContext httpContext

HttpContext instance.
SysUserInfo currentUser

Current SysUserInfo instance.

UpdatePersonalUserSessionTimeoutFromDB(UserConnection, Guid)

Update personal user session timeout from DB.

Declaration
public void UpdatePersonalUserSessionTimeoutFromDB(UserConnection userConnection, Guid userId)
Parameters
Type Name Description
UserConnection userConnection

Instance of UserConnection
System.Guid userId

User Id.

UpdatePersonalUserSessionTimeoutInCache(String, Int32)

Updates personal user session timeout in cache.

Declaration
public void UpdatePersonalUserSessionTimeoutInCache(string userName, int sessionTimeout)
Parameters
Type Name Description
System.String userName

User name.
System.Int32 sessionTimeout

Session timeout value.

Extension Methods