Skip to main content

Handling exceptions thrown by WCF service

Exceptions thrown by the WCF services are represented as SOAP faults to the clients.Clients can handle these exceptions using a try and catch block. It is important to note that the services itself will continue running after throwing the exception. However, the exception will cause the client to fail if the exception is not handled by the client.

Further, when an exception occurs, the client may not see all the information related to the exception thrown. This is to ensure the security of the service. The amount of information depends on the type of the exception thrown. If it is a FaultException, lots of information about the exception is transmitted. However if it is not FaultException, just a generic fault information is sent to the client. In such situation, the faultcode in the SOAP message would be InternalServiceFault.

To include exception information, do one of the following:

  • Add the following annotation
                [ServiceBehavior(IncludeExceptionDetailInFaults=true)]

  • Add the following code to app.config

<system.serviceModel><behaviors><behavior name="default">
<serviceDebug includeExceptionDetailInFaults="true" />
 </behavior></behaviors></system.serviceModel>

Enabling Message Logging

To enable message logging use the following step:
  • Right click App.config of the host application
  • Select Edit WCF Configuration 
  • Select Diagnostics under Configuration
  • Click Enable MessageLogging
  • Click Message Logging under Diagnostics in Configuration
  • Set LogEntireMessage to True
To check the message you can use SvcTraceViewer, use the following steps:
  • Make your service throw an exception when one of the service operation is invoked
  • Run the application and make sure the an exception is thrown. 
  • Go to your host application folder. Now you should  be able to see a file called app_messages.svclog.
  • Double click on this file. It should open in SvcTraceViewer utility. 
  • Double click the first Activity. This should show you two MessageLogTrace. 
  • Notice that first message is a HttpRequest and the second message has a fault with faultcode InternalServiceFault.

Creating a FaultException

If you want to intentionally create a exception that is sent to the client then the best way to do this is to throw an exception of type FaultException or a type that derives from it.

throw new FaultException("An Error Occurred");

When a service throws a fault in this manner. This fault will be re-thrown as FaultException by the client.

You can also create a FaultException of type TDetails if you want the client to handle a contractually specified SOAP faults.

Order of handling exceptions in the client application 

  • FaultExceptions<TDetail>
  • FaultExceptions
  • ComminicationExceptions
  • TimeOutExceptions
  • Use finally block to check if the client channel has entered a faulted state if it has then the abort the client and create a new instance of the client if the client is required again. 

Links and references 

Comments

Post a Comment

Popular posts from this blog

A Comprehensive Evaluation of the Internal Consulting Process: Steps and Considerations

Introduction Internal consulting has emerged as a critical function within organizations, offering in-house expertise to solve complex business problems and drive change. It closely mirrors external consulting in methodology but is differentiated by the consultant's intimate knowledge of the organization and a vested interest in its long-term success. This article aims to evaluate the key steps involved in the internal consulting process, offering insights into each phase's significance and challenges. Steps in the Internal Consulting Process The internal consulting process can generally be segmented into five distinct stages: Initial Assessment, Data Collection and Analysis, Solution Development, Implementation, and Evaluation. Below is an evaluation of each step: Step 1: Initial Assessment Objective: To understand the problem or opportunity area and define the scope of the project. Significance: A well-defined scope ensures that the consulting project stays focused and manage...
Post a Comment
Read more

The Evolving Landscape of Consulting Practice: Changes and Implications

Introduction Consulting is a field that thrives on its ability to adapt to market demands and emerging trends. As businesses evolve due to technological advancements, shifts in consumer behavior, and fluctuations in global markets, consulting practices must keep pace. This article explores some of the significant changes currently transforming the consulting industry and discusses their implications for both consultants and clients. Technological Disruption Data Analytics and Artificial Intelligence Consulting firms are increasingly integrating data analytics and artificial intelligence into their service offerings. These technologies allow consultants to offer data-driven insights that can significantly enhance strategic decision-making. This evolution means consultants now need skills in data interpretation and analysis, alongside their traditional expertise in business strategy. Virtual Consulting Platforms The advent of digital platforms enables consulting services to be offered re...
Post a Comment
Read more

The Imperative of Transition Structure in Implementing Change and A Model for Effective Transition

Introduction Organizational change is an inevitable phenomenon in the dynamic business landscape of today. While the conception of change is significant, its successful implementation is even more crucial. One key factor that often determines the success of implementing change is the presence of a well-designed transition structure. This article aims to discuss the necessity of having a transition structure in place and proposes a model to effectively guide the transition during organizational change. The Need for a Transition Structure Aligning Stakeholders Any significant change involves a variety of stakeholders, from senior management to front-line employees. A transition structure ensures that all parties are aligned, understand their roles, and are committed to the objectives of the change. Mitigating Risks Change often comes with risks, such as resistance from employees, potential loss in productivity, or lapses in quality. A structured approach can help mitigate these risks by ...
Post a Comment
Read more