com.nike.backstopper.handler.UnhandledExceptionHandlerServletApiBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of backstopper-servlet-api Show documentation

Backstopper module backstopper-servlet-api

There is a newer version: 2.0.1

Show newest version

package com.nike.backstopper.handler;

import com.nike.backstopper.apierror.projectspecificinfo.ProjectApiErrors;
import com.nike.backstopper.handler.adapter.RequestInfoForLoggingServletApiAdapter;

import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Simple extension of {@link com.nike.backstopper.handler.UnhandledExceptionHandlerBase} that provides some convenience
 * when working in a Servlet API based framework. Implementors can call {@link #handleException(Throwable,
 * javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)} instead of {@link
 * #handleException(Throwable, RequestInfoForLogging)} to populate the servlet response's headers and status code
 * automatically.
 *
 * @author Nic Munroe
 */
public abstract class UnhandledExceptionHandlerServletApiBase extends UnhandledExceptionHandlerBase {

    /**
     * Creates a new instance with the given arguments.
     *
     * @param projectApiErrors The {@link ProjectApiErrors} used for this project - cannot be null.
     * @param utils            The {@link ApiExceptionHandlerUtils} that should be used by this instance. You can pass
     *                         in {@link ApiExceptionHandlerUtils#DEFAULT_IMPL} if you don't need custom logic.
     */
    public UnhandledExceptionHandlerServletApiBase(ProjectApiErrors projectApiErrors, ApiExceptionHandlerUtils utils) {
        super(projectApiErrors, utils);
    }

    /**
     * Helper wrapper around {@link #handleException(Throwable, RequestInfoForLogging)} that takes in servlet request
     * and servlet response. The request will be wrapped in a {@link RequestInfoForLoggingServletApiAdapter} so that it
     * can be passed along to the method that does the work. If there are any headers in the returned {@link
     * ErrorResponseInfo#headersToAddToResponse} then they will be automatically added to the given servlet response,
     * and {@link javax.servlet.http.HttpServletResponse#setStatus(int)} will be automatically set with {@link
     * ErrorResponseInfo#httpStatusCode} as well.
     */
    public ErrorResponseInfo handleException(Throwable ex, HttpServletRequest servletRequest,
                                                HttpServletResponse servletResponse) {

        ErrorResponseInfo errorResponseInfo = handleException(
            ex, new RequestInfoForLoggingServletApiAdapter(servletRequest)
        );

        processServletResponse(errorResponseInfo, servletResponse);

        return errorResponseInfo;
    }

    @SuppressWarnings("WeakerAccess")
    protected void processServletResponse(ErrorResponseInfo errorResponseInfo, HttpServletResponse servletResponse) {
        for (Map.Entry> header : errorResponseInfo.headersToAddToResponse.entrySet()) {
            for (String headerValue : header.getValue()) {
                servletResponse.addHeader(header.getKey(), headerValue);
            }
        }

        servletResponse.setStatus(errorResponseInfo.httpStatusCode);
    }
}