SystemLogRestlet.java

/*
 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * Contributors:
 *     Florent Guillaume
 */

package org.nuxeo.ecm.platform.ui.web.restAPI;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.runtime.api.Framework;
import org.restlet.data.Form;
import org.restlet.data.Method;
import org.restlet.data.Request;
import org.restlet.data.Response;

/**
 * Small restlet logging in the commons logging log.
 * <p>
 * Very useful when running functional tests for instance, to separate cleanly
 * what happens in the logs.
 */
public class SystemLogRestlet extends BaseStatelessNuxeoRestlet {

    private static final Log log = LogFactory.getLog(SystemLogRestlet.class);

    public static final String LEVEL = "level";

    public static final String MESSAGE = "message";

    public static final String TOKEN = "token";

    public static final String TOKEN_PROP = "org.nuxeo.systemlog.token";

    @Override
    protected void doHandleStatelessRequest(Request req, Response res) {
        if (Method.HEAD.equals(req.getMethod())) {
            // selenium does a HEAD first, then a GET
            return;
        }
        Form form = req.getResourceRef().getQueryAsForm();
        String level = form.getFirstValue(LEVEL);
        String message = form.getFirstValue(MESSAGE);
        String token = form.getFirstValue(TOKEN);
        String tokenProp = Framework.getProperty(TOKEN_PROP);
        if (tokenProp == null || !tokenProp.equals(token)) {
            log.debug(String.format("Provided token '%s' does not match %s",
                    token, TOKEN_PROP));
        } else if ("error".equalsIgnoreCase(level)) {
            log.error(message);
        } else if ("warn".equalsIgnoreCase(level)) {
            log.warn(message);
        } else if ("info".equalsIgnoreCase(level)) {
            log.info(message);
        } else if ("debug".equalsIgnoreCase(level)) {
            log.debug(message);
        } else {
            log.trace(message);
        }
    }

}