Skip to main content

ASP.net - Http handlers - implementing IHttpHandler



Implementing a generic HTTP handler has its own limitations. To give more power to handle request in any URL we can create our own HTTP handlers using the interface IHttpHandler. This interface defines the contract that ASP.NET implements to synchronously process HTTP Web requests using custom HTTP handlers.

You can create HTTP handler in any of the .net language which can run in the framework (any CLS compliant language).
In the following example I have used C#

public class ImageHandlerNew :IHttpHandler
    {
        const string connectionStringName = "Images";

        public void ProcessRequest(HttpContext context)
        {
           

        }

        public bool IsReusable
        {
            get { return true; }
        }

    }

In this example the most important function is ProcessRequest which handles the incoming request from browser, process it and sends back the response. This function takes the current running context as parameter. This context enables has all the runtime objects & context information of ASPX execution thread.
As mentioned in http://thetechjungle.blogspot.com/2010/02/aspnet-http-handlers-generic-hander.html , The IsReusable property indicates whether the same handler can be reused over multiple requests. 

You can add a lot of different functionalities like generating the PDF, excel files or retrieving the stock quotes in ProcessRequest function (when client requests for a specific resource). For testing you can use the following function which retrieves the image file stored in SQL server database.

  public void ProcessRequest(HttpContext context)
        {
            context.Response.Buffer = false;

            string filename = VirtualPathUtility.GetFileName(context.Request.Path);

            string connstring = ConfigurationManager.ConnectionStrings[connectionStringName].ConnectionString;

            SqlConnection con = new SqlConnection(connstring);
            SqlCommand cmd = new SqlCommand("SELECT Image FROM Images WHERE FileName=@FileName", con);
            cmd.Parameters.AddWithValue("@FileName", filename);

            using (con)
            {
                con.Open();
                SqlDataReader reader = cmd.ExecuteReader(CommandBehavior.SequentialAccess);
                if (reader.Read())
                {
                    int bufferSize = 8040;
                    byte[] chunk = new byte[bufferSize];
                    long retcount;
                    long startindex = 0;
                    retcount = reader.GetBytes(0, startindex, chunk, 0, bufferSize);
                    while (retcount == bufferSize)
                    {
                        context.Response.BinaryWrite(chunk);

                        startindex += bufferSize;
                        retcount = reader.GetBytes(0, startindex, chunk, 0, bufferSize);
                    }

                    byte[] actualchunk = new byte[retcount - 1];
                    Buffer.BlockCopy(chunk, 0, actualchunk, 0,(int) retcount-1);
                    context.Response.BinaryWrite(actualchunk);
                }
            }

        }

After adding thie CS file in your application add the following in web.config

<httpHandlers>
              <add verb="*" path="*.gif" validate="false" type="AspNet.ImageHandlerNew"/>
              <add verb="*" path="*.jpg" validate="false" type="AspNet.ImageHandlerNew"/>
              <add verb="*" path="*.jpeg" validate="false" type="AspNet.ImageHandlerNew"/>
      httpHandlers>

  • path: Enables you to specify the path associated with the handler. You can use wildcards in the path expression.
  • verb:Enables you to specify the HTTP verbs, such as GET or POST, associated with the handler. You can specify multiple verbs in a comma-separated list. You can represent any verb with the * wildcard.
  • type : Enables you to specify the name of the class that implements the handler.
  • validate:Enables you to specify whether the handler is loaded during application startup. When true, the handler is loaded at startup. When false, the handler is not loaded until a request associated with the handler is made. This second option can improve your application’s performance.

How to execute this Handler?
Remember once you create this handler all the requests for .gif,.jpg & .jpeg resources will be handled by this. So if the corresponding data is not available in database this code will not display anything. You don’t have to add any special code in your aspx or associated class files, ASPNET/IIS runtime will automatically redirect the corresponding resource request to this class/dll.


Using this you can create your own extensions & produce the output !!!!

Comments

Popular posts from this blog

Product Backlog: Should you write everything in user story format?

I like user stories a lot. They help everyone talk the same language and results in a better product. User story alone does not constitute product requirement. User story is supposed to be a place holder for discussion which should happen between the team, Product Owner and the customer. This discussion result in a common understanding which along with the user story content is the product requirement. This format captures the essence of requirement without confusing the readers User Story is only one of the many different ways in which requirements can be represented. This is not mandatory in any Agile “process”. But many have made this mandatory. I have seen many spending countless hours trying to write the requirements in user story format when they could have easily written that in simple one-line sentence in few minutes.   I have seen team members refusing to even discuss the requirement until product owner rewrote the requirement in user story format. ...

PDCA & SCRUM (or Agile); Why is it important?

The PDCA (Plan DO Check Act) cycle was made popular by Dr. W. Edwards Deming. This is a scientific cyclic process which can be used to improve the process (or product). This is cyclic in nature and usually time boxed. Plan  This is the first stage of the process. During this step the team discusses the objectives, the process and the clear conditions of exit (conditions of acceptance). This stage sets the measurable and achievable goals for the team. DO Team works together to achieve the objective set in the planning phase. Team works with the set of agreed process. Check Once the implantation is done team regroups and verifies the output and compares it to the agreed conditions of acceptance decided during the planning phase. The deviation, if any, is noted down. ACT If any deviation in planned tasks is observed during the Check stage, a root cause analysis is conducted. Team brainstorms and identifies the changes required to prevent such deviatio...

SQL Server: GETDATE() & GETUTCDATE() & different time zones

Most of us will use GetDate() function for providing default value in SQL server columns. This function Returns the current database system timestamp as a   datetime   value without the database time zone offset. This value is derived from the operating system of the computer on which the instance of SQL Server is running. This works perfectly if you don’t have to show reports and such stuffs for users from different time zones. In case you want to store time independent of time zones in some universal format; what will do? Well there is GetUtcDate() function for you. This function will return then UTC date based on the setting of the server on which SQL server is installed. I executed the following function & I got the two different date output values. SELECT  GETDATE() AS Expr1, GETUTCDATE () AS Expr2 2/28/2010 1:27:17 PM ,  2/28/2010 7:57:17 AM SQL Server 2008 SQL Server 2008 has two new DataTypes: date & time You can use them to ret...