Search code examples
jsfjakarta-eeexceptionejbservice-layer

Handling service layer exception in Java EE frontend method

I maintain a web application that have a page with the JSF tag <f:event. I have rewrote a method in a service class for it to throw a business exception. However, when the business exception is thrown, it isn't caught in managed bean and the exception is showed on the page. Seems that my code try/catch doesn't work.

In XHTML:

<f:event listener="#{resourceBean.init(enrollment)}" type="preRenderView" />

Listener method in Managed Bean:

private boolean canCreateResource;

public void init(Enrollment enrollment) {
    (...)

    try {
        canCreateResource = resourceService.canCreateResource(enrollment);
    } catch (BusinessException e) {
        canCreateResource = false;
    }
}

Method in service class:

public boolean canCreateResource(Enrollment enrollment) {
    if (...) {
        if (mandateService.isCoordinator(user, course)) {
            return true;
        } else {
            throw new BusinessException("Undefined business rule.");
        }
    }

    return false;
}

From what I read on other sites, I suppose I have to implement some JSF's handler class. But which and how?

EDITED

OBS 1: The BusinessException class extends RuntimeException class.

OBS 2: The attribute canCreateResource was created to control the render of a button.

Solution

  • It's because you threw a RuntimeException from an EJB.

    When such RuntimeException is not annotated with @ApplicationException, then the EJB container will wrap it in an javax.ejb.EJBException and rethrow it. This is done so because runtime exceptions are usually only used to indicate bugs in code logic, i.e. programmer's mistakes and not enduser's mistakes. You know, NullPointerException, IllegalArgumentException, IndexOutOfBoundsException, NumberFormatException and friends. This allows the EJB client to have one catch-all point for such runtime exceptions, like catch (EJBException e) { There's a bug in the service layer or in the way how we are using it! }

    If you had tried catch (Exception e) and inspected the actual exception, then you'd have noticed that.

    Fix your BusinessException class accordingly to add that annotation, it will then be recognized as a real application exception and not be wrapped in an EJBException:

    @ApplicationException(rollback=true)
public class BusinessException extends RuntimeException {
    // ...
}

    Do note that in case you throw an non-RuntimeException, then you still need to keep the annotation on that, explicitly with rollback=true, because by default it wouldn't perform a rollback, on the contrary to a RuntimeException without the annotation.

    @ApplicationException(rollback=true)
public class BusinessException extends Exception {
    // ...
}

    Summarized:

    1. RuntimeException thrown from transactional EJB method will perform full rollback, but exception will be wrapped in EJBException.
    2. RuntimeException with @ApplicationException from transactional EJB method will only perform full rollback when rollback=true is explicitly set.
    3. Exception from transactional EJB method will not perform full rollback.
    4. Exception with @ApplicationException from transactional EJB method will only perform full rollback when rollback=true is explicitly set.

    Note that @ApplicationException is inherited over all subclasses of the custom exception, so you don't need to repeat it over all of them. Best would be to have it as an abstract class. See also the examples in the related question linked below.

    See also: