Exception filter not working in web api

Question

I have a custom exception filter capable handle all the errors in the controller( just a common error handling mechanism) ,

public class ExceptionHandlingAttribute : ExceptionFilterAttribute
    {
        public override void OnException(HttpActionExecutedContext actionExecutedContext)
        {
            var error = actionExecutedContext.Exception;
            if (error is BussinessExcetion)
            {
                var exceptionBase = (BussinessExcetion)error;
                var code = (HttpStatusCode)exceptionBase.HttpExceptionCode;
                throw new HttpResponseException(new HttpResponseMessage(code)
                                                    {
                                                        Content = new StringContent(exceptionBase.Message),
                                                        ReasonPhrase = "Exception"

                                                        ,
                                                    });

            }

            // Now log the error

            /* Error logging */

            LoggingFactory.GetLogger().LogError(string.Format("Exception:{0} ||Stack trace:{1}", error.Message, error.StackTrace), error);



            throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError)
                                                {
                                                    Content = new StringContent("An error occurred, contact the support team."),
                                                    ReasonPhrase = "Critical Exception"
                                                });
        }
    }

I registered this filter in fillterConfig file

 public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        filters.Add(new ExceptionHandlingAttribute());
     filters.Add(new HandleErrorAttribute());

    }

but i am getting an error

The given filter instance must implement one or more of the following filter interfaces: IAuthorizationFilter, IActionFilter, IResultFilter, IExceptionFilter

I know the ExceptionFilterAttribute already implimented IExceptionFilter filter. Why i am getting this error

becouse your filter class must be inherit of IExceptionFilter interface — user1956570
– user1956570, Commented Feb 1, 2014 at 4:24
Solved.. The problem was i am registering filter in FilterConfig file . this for MVC not for web api . i changed the registration in to WebApiConfig file — Binson Eldhose
– Binson Eldhose, Commented Feb 1, 2014 at 4:36

thebiggestlebowski · Accepted Answer · 2014-10-31 15:17:52Z

In order for this to work, you need to implement System.Web.Http.Filters.ExceptionFilterAttribute.

public class NotImplExceptionFilterAttribute : ExceptionFilterAttribute
{
    log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

    public override void OnException(HttpActionExecutedContext context)
    {
        RequestData requestData = new RequestData(context.Request);

        log.Error("NotImplExceptionFilterAttribute", context.Exception);
            context.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
    }
}

Then, in your WebApiConfig.cs, register the filter:

public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{count}",
            defaults: new { count = RouteParameter.Optional }
        );

        config.Filters.Add(new NotImplExceptionFilterAttribute());
    }

yarg · Accepted Answer · 2020-01-12 14:17:40Z

2

make sure you also override the Async version of the filter

class myFilter : ExceptionFilterAttribute
{
...
    public override async Task OnExceptionAsync(HttpActionExecutedContext ctx, 
                                                CancellationToken cancellationToken)
    {
    ...
    }
...
}

answered Jan 12, 2020 at 14:17

yarg

7096 silver badges11 bronze badges

Comments

Fordy · Accepted Answer · 2018-06-11 10:15:52Z

And for anyone using NLog:

public class NlogExceptionFilter : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext filterContext)
    {
        Exception lastException = filterContext.Exception;
        Logger logger = LogManager.GetLogger("");
        logger.Fatal(lastException.Message, lastException);
    }
}

And in the WebApiConfig.cs

public static void Register(HttpConfiguration config)
{
    config.Filters.Add(new NlogExceptionFilter());
    ...
}

Collectives™ on Stack Overflow

Exception filter not working in web api

3 Answers 3

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Linked

Related