ASP.NET MVC : Handle Session Expire Using Custom Attribute

Tom Mohan

11y199k19100Article

ASP.NET MVC ASP.NET SessionSession expire in ASP.Netustom Attribute in ASP.NET MVC

19 Comments

Join the conversation! Your thoughts help the community grow.

Kishan Kushwah8y ago
Session web api in asp.net c# code demo
Kagiso Mahlobogoane10y ago
I see alll the controllers inherit from BaseController. Where is the code for that?
Vignesh Mani10y ago
Nice one
sushil kumar10y ago
This will not work in ajax requests
Former member11y ago
what this code is doing @using (Html.BeginForm(new { ReturnUrl = ViewBag.ReturnUrl })) ?
Rahul Kumar Saxena11y ago
Good Show...
Gowtham Rajamanickam11y ago
nice show..
Gowtham Rajamanickam11y ago
nice..
Vijay S11y ago
Nice
Tom Mohan11y ago
Thanks Sourabh Somani
Sourabh Somani11y ago
Tom Mohan Nice starting... good article
Dinesh Beniwal11y ago
Thanks for sharing, Welcome to C# Corner.
Sibeesh Venu11y ago
Tom Mohan You are welcome.
Sibeesh Venu11y ago
Good one.
- Tom Mohan11y ago
  Thanks Sibeesh Venu
Harpreet Singh11y ago
nice one
- Tom Mohan11y ago
  Thanks Harpreet Singh
Rahul Kumar Saxena11y ago
helpful..
- Tom Mohan11y ago
  Thanks Rahul Saxena

Managing a session is a common task in web applications. In this article I will show you how to handle sessions with custom attributes.

Scope

In most web applications we previously would keep the user information in the session after login. In some pages we use this session. Before using this session we need to check whether the session is null or not. If the session is null then it should redirect to the login page then after successful login the system should automatically redirect to the requested page.

Here is the code inside SessionExpire Attribute:

public class SessionExpire : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
if (HttpContext.Current.Session["UserInfo"] == null)
{
FormsAuthentication.SignOut();
filterContext.Result =
new RedirectToRouteResult(new RouteValueDictionary
{
{ "action", "Index" },
{ "controller", "Login" },
{ "returnUrl", filterContext.HttpContext.Request.RawUrl}
});
return;
}
}
}

SessionExpire attribute inherits from ActionFilterAttibute and in the OnActionExecuting method we will handle our session. If Session["UserInfo"] is null then it will redirect to the login controller after sign-out.

Example

Here we have implemented SessionExpire in ManageAccountController.

[SessionExpire]
public class ManageAccountController : BaseController
{
public ActionResult Index()
{
return View();
}
}

It will redirect to our LoginController, if the session is null. Here we have returned the URL. We will keep this URL in ViewBag.ReturnUrl.

public class LoginController : BaseController
{
public ActionResult Index(string returnUrl)
{
ViewBag.ReturnUrl = returnUrl;
return View();
}
}

Then we will post loginController with retrun URL. After model validation and form authentication it will redirect to the requested page, here is ManageAccountController.

@using (Html.BeginForm(new { ReturnUrl = ViewBag.ReturnUrl })) // in Index.cshtml
[HttpPost]
public ActionResult Index(Model objUser, string returnUrl)
{
ViewBag.ReturnUrl = returnUrl;
if (ModelState.IsValid)
{
FormsAuthentication.SetAuthCookie("Username", false);
return RedirectToLocal(returnUrl);
}
else
{
return View();
}
}
public ActionResult RedirectToLocal(string returnUrl)
{
if (Url.IsLocalUrl(returnUrl))
{
return Redirect(returnUrl);
}
else
{
return RedirectToAction("Index", "Home");
}
}