Skip to main content

Throwing custom Web Service Exception from Web Service

Suppose in a real scenario an exception is generated in the Data access or any other layer of our application and we want to show a custom message then we can use SoapException class in System.Web.Services.Protocols which will do the trick for us.

This is sample DAO class which has a method getEmpData which throws an exception

1    public class DAO
2 {
3 public DAO()
4 {
5 //
6 // TODO: Add constructor logic here
7 //

8 }
10 public static string getEmpData(int id)
11 {
12 throw new Exception("Method not supported");
14 }
15 }
The following is a sample Webservice with the webmethod in the same project which used the above DAO class
1    using System;
2 using System.Web;
3 using System.Web.Services;
4 using System.Web.Services.Protocols;
6 [WebService(Namespace = "")]
7 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
8 public class Service : System.Web.Services.WebService
9 {
10 public Service () {
12 //Uncomment the following line if using designed components
13 //InitializeComponent();

14 }
16 [WebMethod]
17 public string HelloWorld() {
18 try
19 {
20 return DAO.getEmpData(9);
21 }
22 catch (Exception ex)
23 {
24 throw new SoapException(ex.Message, SoapException.ServerFaultCode, Context.Request.Url.AbsoluteUri);
25 // return;
26 }
27 }
29 }

line 20 getEmpData pf the DAO class is called. The exception thrown is catched in the webmethod of the webservice in line 22, In this fasion you can bubble up the exception from any layer (even if it is a custom exception ) and handle that in the webmethod, it is better that you handle the soapException in webmethod, (if you want it to be present in any other class you will have to import System.Web.Services.Protocols namespace).

In this manner you can handle any Exception and pass the custom error messages to the client rather than the default error messages.

Some important properties of SoapException class (

  • Message : The Message property of the original exception.
  • Code: ServerFaultCode.
  • Actor:The URL of the XML Web service method.
  • Detail:a null reference (Nothing in Visual Basic), but an empty detail element is present in the fault element.

After this i created a sample web application and called the Webmethod which throws the SoapException at line 2

     1  localhost.Service myser = new localhost.Service();
2 myser.HelloWorld();

Here at line 2 i got the custom error message passed from the DAO layer of the web service.


Popular posts from this blog

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 deviations in future. Team also

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. Once I

Why is potentially shippable product quality important

Agile teams work in iterations. During this period, they are supposed to work on product increments which can be “delivered” at the end of iteration. But how you know that the correct product was delivered? Many teams have different kinds of acceptance criteria and Definition of Done (DoD). But in many cases, this “done” is not the real “done” there might be some testing pending, some integration or review pending or anything else which prevents the actual use of the product increment. Many of these teams will need additional iterations to finish hardening their products. Many teams will implement different types of “gates” or approval steps to move to next stage. The free flow of product will be interrupted. They might end up doing mini waterfall within their agile process. Many don’t even realize this. This results in poor quality and requires additional effort to “harden” the product. Potentially Shippable Product increment The acceptance criteria and DoD should be modified