com.github.datalking.util.web.RequestContextUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-mvc Show documentation
simple mvc framework based on java servlet.
The newest version!
package com.github.datalking.util.web;

import com.github.datalking.web.context.WebApplicationContext;
import com.github.datalking.web.servlet.DispatcherServlet;
import com.github.datalking.web.servlet.flash.FlashMap;
import com.github.datalking.web.servlet.FlashMapManager;

import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.util.Locale;
import java.util.Map;

/**
 */
public abstract class RequestContextUtils {

    public static WebApplicationContext getWebApplicationContext(ServletRequest request) throws IllegalStateException {

        return getWebApplicationContext(request, null);
    }

    public static WebApplicationContext getWebApplicationContext(ServletRequest request, ServletContext servletContext) throws IllegalStateException {

        WebApplicationContext webApplicationContext = (WebApplicationContext) request.getAttribute(DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE);
        if (webApplicationContext == null) {
            if (servletContext == null) {
                throw new IllegalStateException("No WebApplicationContext found: not in a DispatcherServlet request?");
            }
            webApplicationContext = WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext);
        }
        return webApplicationContext;
    }

    /**
     * Return the LocaleResolver that has been bound to the request by the
     * DispatcherServlet.
     *
     * @param request current HTTP request
     * @return the current LocaleResolver, or {@code null} if not found
     */
//    public static LocaleResolver getLocaleResolver(HttpServletRequest request) {
//        return (LocaleResolver) request.getAttribute(DispatcherServlet.LOCALE_RESOLVER_ATTRIBUTE);
//    }

    /**
     * Retrieves the current locale from the given request,
     * using the LocaleResolver bound to the request by the DispatcherServlet
     * (if available), falling back to the request's accept-header Locale.
     *
     * @param request current HTTP request
     * @return the current locale, either from the LocaleResolver or from
     * the plain request
     * @see #getLocaleResolver
     * @see javax.servlet.http.HttpServletRequest#getLocale()
     */
//    public static Locale getLocale(HttpServletRequest request) {
//        LocaleResolver localeResolver = getLocaleResolver(request);
//        if (localeResolver != null) {
//            return localeResolver.resolveLocale(request);
//        } else {
//            return request.getLocale();
//        }
//    }

    /**
     * Return the ThemeResolver that has been bound to the request by the
     * DispatcherServlet.
     *
     * @param request current HTTP request
     * @return the current ThemeResolver, or {@code null} if not found
     */
//    public static ThemeResolver getThemeResolver(HttpServletRequest request) {
//        return (ThemeResolver) request.getAttribute(DispatcherServlet.THEME_RESOLVER_ATTRIBUTE);
//    }

    /**
     * Return the ThemeSource that has been bound to the request by the
     * DispatcherServlet.
     *
     * @param request current HTTP request
     * @return the current ThemeSource
     */
//    public static ThemeSource getThemeSource(HttpServletRequest request) {
//        return (ThemeSource) request.getAttribute(DispatcherServlet.THEME_SOURCE_ATTRIBUTE);
//    }

    /**
     * Retrieves the current theme from the given request, using the ThemeResolver
     * and ThemeSource bound to the request by the DispatcherServlet.
     *
     * @param request current HTTP request
     * @return the current theme, or {@code null} if not found
     * @see #getThemeResolver
     */
//    public static Theme getTheme(HttpServletRequest request) {
//        ThemeResolver themeResolver = getThemeResolver(request);
//        ThemeSource themeSource = getThemeSource(request);
//        if (themeResolver != null && themeSource != null) {
//            String themeName = themeResolver.resolveThemeName(request);
//            return themeSource.getTheme(themeName);
//        } else {
//            return null;
//        }
//    }

    /**
     * Return a read-only {@link Map} with "input" flash attributes saved on a
     * previous request.
     *
     * @param request the current request
     * @return a read-only Map, or {@code null} if not found
     */
    @SuppressWarnings("unchecked")
    public static Map getInputFlashMap(HttpServletRequest request) {
        return (Map) request.getAttribute(DispatcherServlet.INPUT_FLASH_MAP_ATTRIBUTE);
    }

    /**
     * Return the "output" FlashMap with attributes to save for a subsequent request.
     *
     * @param request the current request
     * @return a {@link FlashMap} instance (never {@code null} within a DispatcherServlet request)
     */
    public static FlashMap getOutputFlashMap(HttpServletRequest request) {
        return (FlashMap) request.getAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE);
    }

    /**
     * Return the FlashMapManager instance to save flash attributes with
     * before a redirect.
     *
     * @param request the current request
     * @return a {@link FlashMapManager} instance (never {@code null} within a DispatcherServlet request)
     */
    public static FlashMapManager getFlashMapManager(HttpServletRequest request) {
        return (FlashMapManager) request.getAttribute(DispatcherServlet.FLASH_MAP_MANAGER_ATTRIBUTE);
    }

}