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 }
9
10 public static string getEmpData(int id)
11 {
12 throw new Exception("Method not supported");
13
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;
5
6 [WebService(Namespace = "http://tempuri.org/")]
7 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
8 public class Service : System.Web.Services.WebService
9 {
10 public Service () {
11
12 //Uncomment the following line if using designed components
13 //InitializeComponent();

14 }
15
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 }
28
29 }
30

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 (http://msdn2.microsoft.com/en-us/library/system.web.services.protocols.soapexception.aspx)

  • 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.

Comments

Popular posts from this blog

SCRUM- Who should write a user story

Traditionally user stories (or requirements) were written by Business analysts. They used to prepare big documents after months of study. It was a herculean task. I used to get such UI/Functional specification documents. I have fixed a lot of bugs because I missed few text in such 1000 + pages document. This is not the only interesting part. Some of the requirements were so weird that I often wondered why I am creating the features which no one is going to use. If I had the option I would have recommended a better option. If the BA’s misunderstood some requirements & customers failed to correct those few words in the epic requirement then we will have a nice situation. In the agile world the story is different. Product Owners are primarily responsible for user stories. But can anyone else also contribute? Yes. Definitely yes In actual environment many users write user stories. The first requirement may come from end user. The PO, tech architect, scrum master, BA’s... anyone can up

What are the rules of scrum?

A relatively new person to scrum asked me this question last day. My answer to that person was yes. But really does the scrum have any rules? Scrum is a framework which helps us in developing software. It has very few rules and apart from those basic rules rest of them are guidelines like best practices. Some of the rules  The roles of Scrum • Scrum Master -  http://www.theagileschool.com/2012/03/scrummasters-checklist-roles.html • Product Owner • Feature Team The PDCA cycle ( http://www.theagileschool.com/2012/05/pdca-scrum-or-agile-why-is-it-important.html  )  frequent communication about risks (daily) • Plan – Sprint planning • Do – Actual engineering sprint – deliver a potential shippable code • Check – Sprint review • Act – Retrospective  The scrum guide @ http://www.scrum.org/Scrum-Guides will be a good guideline for teams/companies planning to start scrum. If you are following the recommendation in these then you are following scrum. Apart from these rest of

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