ServletHelper.java

/*
 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * 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.
 *
 * Contributors:
 *     Florent Guillaume
 */
package org.nuxeo.ecm.platform.web.common;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.ecm.core.io.download.DownloadHelper;
import org.nuxeo.runtime.transaction.TransactionHelper;

/**
 * Helpers for servlets.
 *
 * @since 5.6
 */
public class ServletHelper {

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

    public static final String TX_TIMEOUT_HEADER_KEY = "Nuxeo-Transaction-Timeout";

    private static final ThreadLocal<ServletContext> SERVLET_CONTEXT = new ThreadLocal<>();

    private ServletHelper() {
        // utility class
    }

    public static boolean startTransaction(HttpServletRequest request) {
        String header = request.getHeader(TX_TIMEOUT_HEADER_KEY);
        int timeout = 0; // default
        if (header != null) {
            try {
                timeout = Integer.parseInt(header);
            } catch (NumberFormatException e) {
                // bad header
                log.warn("Invalid request transaction timeout: " + header);
            }
        }
        return TransactionHelper.startTransaction(timeout);
    }

    /**
     * Generate a Content-Disposition string based on the servlet request for a given filename. The value follows
     * RFC2231
     *
     * @param request
     * @param filename
     * @return a full string to set as value of a {@code Content-Disposition} header
     * @since 5.7.2
     */
    public static String getRFC2231ContentDisposition(HttpServletRequest request, String filename) {
        return DownloadHelper.getRFC2231ContentDisposition(request, filename);
    }

    /**
     * @since 8.3
     */
    public static void setServletContext(ServletContext servletContext) {
        SERVLET_CONTEXT.set(servletContext);
    }

    /**
     * @since 8.3
     */
    public static ServletContext getServletContext() {
        return SERVLET_CONTEXT.get();
    }

    /**
     * @since 8.3
     */
    public static void removeServletContext() {
        SERVLET_CONTEXT.remove();
    }

}