Skip to main content

How to implement multi-tenancy with subdomains using Route Constraint in ASP.NET MVC




According to Wikipedia, The term "software multitenancy" refers to a software architecture in which a single instance of software runs on a server and serves multiple tenants. A tenant is a group of users who share a common access with specific privileges to the software instance. With a multitenant architecture, a software application is designed to provide every tenant a dedicated share of the instance - including its data, configuration, user management, tenant individual functionality and non-functional properties. Multitenancy contrasts with multi-instance architectures, where separate software instances operate on behalf of different tenants. By giving companies, access to a tenant through a subdomain of choice, will help to personalise the experience more and gives a sense of ownership to each tenant. This will go along way to bring consistency in there branding.

Implementing Route Constraint

You use route constraints to restrict the browser requests that match a particular route. To make this most easy, we shall be making our class to inherit the IRouteConstraint interface and this will help to route all specific tenant request. What then is an IRouteConstraint, according to msdn, IRouteConstraint Defines the contract that a class must implement in order to check whether a URL parameter value is valid for a constraint. The following implementation will get the tenant id and add it to route value dictionary.



public class RoutingConstraint : IRouteConstraint  
{
   public bool Match(HttpContextBase httpContext, Route route, string getParameter, RouteValueDictionary values, RouteDirection routeDirection)
   {
    var GetAddress = httpContext.Request.Headers["Host"].Split('.');
       if (GetAddress.Length < 2)
       {
           return false;
       }

       var tenant = GetAddress[0];
      
       if (!values.ContainsKey("tenant"))
       {
           values.Add("tenant", tenantId);
       }

       return true;
   }
}

Modify the Routes by adding the Route Constraints

routes.MapRoute(  
           name: "Default", url: "{controller}/{action}/{id}",
           defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional },
           constraints: new { TenantRouting = new RoutingConstraint() }
);

To get the tenant id from the controller that processes the request, simply add


public ActionResult Index()  
{
   var mytenant = this.RouteData.Values["tenant"]; // it will extract tenant data
   return View();
}



Summary

With the implementation, we can identify tenant specific data a user is trying to access.

Comments

This comment has been removed by the author.

Popular posts from this blog

How to do partial update for HTTP APIs in ASP.NET CORE MVC with JSON Patch

JSON Patch is a format for describing changes to a JSON document. It can be used to avoid sending a whole document when only a part has changed. When used in combination with the HTTP PATCH method, it allows partial updates for HTTP APIs in a standards compliant way. A JSON Patch document is just a JSON file containing an array of patch operations. The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move”, “copy” and “test”. The operations are applied in order: if any of them fail then the whole patch operation should abort.
The JSON Patch supports the following operations:
Add - Adds a value to an object or inserts it into an array.Remove -  Removes a value from an object or array. Replace - Replaces a value. Equivalent to a “remove” followed by an “add”. Copy - Copy a value from one location to another within the JSON document. Both from and path are JSON Pointers. Move - Move a value from one location to the other. Both from and path are JSON Pointers. Test - Te…

Top 2 ways to pass parameters to a view component

View components is a feature of ASP.NET Core MVC, that’s similar to partial view and child actions, one cool thing about view component it allows you to create reusable components with or without logic.
The purpose of this post is to show you how to pass view component as a parameter when invoking it from view and controller.
Another  cool thing about View Components is that it separates the logic of which markup to display from the markup itself. It’s a class that inherits from View component and implements Invoke and InvokeAsync Methods, the return type can vary, and that depends on largely what you intend to render.
Example of Simple View Component
public class ItemViewComponent : ViewComponent
{
   public IViewComponentResult Invoke()
   {
       return View();
   }
}
To use the View Component, we have to invoke the Item View component from _Layout.cshtml