DataPortalExceptionHandler.cs

Go to the documentation of this file.

//-----------------------------------------------------------------------
// <copyright file="DataPortalExceptionHandler.cs" company="Marimer LLC">
//     Copyright (c) Marimer LLC. All rights reserved.
//     Website: https://cslanet.com
// </copyright>
// <summary>This class provides a hoook for developers to add custom error handling in the DataPortal. </summary>
//-----------------------------------------------------------------------
using System;
using Csla.Configuration;
using Csla.Properties;
using Csla.Reflection;
 
namespace Csla.Server
{
 
  public class DataPortalExceptionHandler
  {
    #region Custom Exception Inspector Loader
 
    private static string _datePortalInspecorName;
 
    public static string ExceptionInspector
    {
      get
      {
        if (_datePortalInspecorName == null)
        {
          string setting = ConfigurationManager.AppSettings["CslaDataPortalExceptionInspector"];
          if (!string.IsNullOrEmpty(setting))
            _datePortalInspecorName = setting;
        }
        return _datePortalInspecorName;
      }
      set
      {
        _datePortalInspecorName = value;
      }
    }
 
 
    private static IDataPortalExceptionInspector GetExceptionInspector()
    {
      if (string.IsNullOrEmpty(ExceptionInspector)) return null;
 
#if NETFX_CORE
      var t = Type.GetType(ExceptionInspector);
#else
      var t = Type.GetType(ExceptionInspector, true, true);
#endif
      return (IDataPortalExceptionInspector)Reflection.MethodCaller.CreateInstance(t);
 
    }
    #endregion
 
    #region DataPortal Exception
 
    public Exception InspectException(Type objectType, object criteria, string methodName, Exception ex)
    {
      Exception handledException;
      if (ex is CallMethodException)
      {
        if (CallExceptionInspector(objectType, null, criteria, methodName, ex.InnerException, out handledException))
        {
          ex = new CallMethodException(methodName + " " + Resources.MethodCallFailed, handledException);
        }
      }
      else
      {
        if (CallExceptionInspector(objectType, null, criteria, methodName, ex, out handledException))
        {
          ex = handledException;
        }
      }
 
      return ex;
    }
 
    public Exception InspectException(Type objectType, object businessObject, object criteria, string methodName, Exception ex)
    {
      // The exception as parameter is always a CallMethodException containing the business exception as Inner exception 
      Exception handledException;
      if (ex is CallMethodException)
      {
        if (CallExceptionInspector(objectType, businessObject, criteria, methodName, ex.InnerException, out handledException))
        {
          // developer should only transform and if rethrows a new we will wrap as new CallMethodException
          ex = new Csla.Reflection.CallMethodException(methodName + " " + Resources.MethodCallFailed, handledException);
        }
      }
      else
      {
        if (CallExceptionInspector(objectType, null, criteria, methodName, ex, out handledException))
        {
          ex = handledException;
        }
      }
      return ex;
    }
 
    private bool CallExceptionInspector(Type objectType, object businessObject, object criteria, string methodName, Exception exception, out Exception handledException)
    {
      handledException = null;
      var inspector = GetExceptionInspector();
      // if no inspector is defined then just return false 
      if (inspector == null) return false;
 
      try
      {
        // This method should rethrow a new exception to be handled 
        inspector.InspectException(objectType, businessObject, criteria, methodName, exception);
      }
      catch (Exception ex)
      {
        handledException = ex;
        return true;  // new exception returned
      }
      return false;  // exception was not handled 
    }
 
    #endregion
  }
}