com.crashnote.servlet.report.ServletReporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crashnote-servlet Show documentation
Reports exceptions from Java servlet apps to crashnote.com
There is a newer version: 0.6.0
/**
 * Copyright (C) 2011 - 101loops.com 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.crashnote.servlet.report;

import com.crashnote.logger.report.LoggerReporter;
import com.crashnote.servlet.collect.RequestCollector;
import com.crashnote.servlet.collect.SessionCollector;
import com.crashnote.servlet.config.ServletConfig;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.net.InetAddress;
import java.util.HashSet;
import java.util.Set;

/**
 * Customized implementation of the core {@link LoggerReporter}. Adds servlet-specific functionality.
 */
public class ServletReporter
        extends LoggerReporter {

    // VARS =======================================================================================

    private final RequestCollector reqCollector;
    private final SessionCollector sesCollector;

    private boolean ignoreLocalhost;
    private final Set localAddresses;


    // SETUP ======================================================================================

    public ServletReporter(final C config) {
        super(config);
        this.reqCollector = new RequestCollector(config);
        this.sesCollector = new SessionCollector(config);

        // initialize list of local addresses (in order to distinguish remote calls from local ones)
        localAddresses = new HashSet();
        try {
            localAddresses.add(InetAddress.getLocalHost().getHostAddress());
            for (final InetAddress inetAddress : InetAddress.getAllByName("localhost")) {
                localAddresses.add(inetAddress.getHostAddress());
            }
        } catch (Exception ignored) {
        }
    }

    @Override
    public void updateConfig(final C config) {
        super.updateConfig(config);
        this.ignoreLocalhost = config.getIgnoreLocalRequests();
    }


    // INTERFACE ==================================================================================

    /**
     * Before each request, start the internal log session
     *
     * @param request the HTTP request
     */
    public void beforeRequest(final ServletRequest request) {
        startSession();
    }

    /**
     * In case of an uncaught exception, process it
     *
     * @param request the HTTP request
     * @param t       the thread where the error occurred
     * @param th      the exception details
     */
    public void uncaughtException(final ServletRequest request, final Thread t, final Throwable th) {
        if (!isRequestFromLocalhost(request))
            uncaughtException(t, th);
    }

    /**
     * After each request, evaluate and finish the internal log session
     *
     * @param request  the HTTP request
     * @param response the HTTP response
     */
    public void afterRequest(final ServletRequest request, final ServletResponse response) {
        final HttpServletRequest httpReq = (HttpServletRequest) request;

        if (!isSessionEmpty()) { // log session empty? just skip this then..

            if (ignoreLocalhost && isRequestFromLocalhost(request)) {
                // ignore requests made from localhost
                getLogger().debug("error for '{} {}' is ignored (local requests are disabled in config)",
                        httpReq.getMethod(), httpReq.getRequestURL().toString());

            } else {
                // enrich log context with detailed request information
                put("request", reqCollector.collect(httpReq));
                put("session", sesCollector.collect(httpReq));
                endSession();
            }
        }
    }


    // SHARED =====================================================================================

    /**
     * Do not flush reports out immediately - wait till the session has finished
     */
    @Override
    protected boolean isAutoFlush() {
        return false;
    }

    protected boolean isRequestFromLocalhost(final ServletRequest req) {
        return localAddresses.contains(req.getRemoteAddr());
    }
}