com.adnature.framework.util.Struts2Utils.java Source code

Java tutorial

Introduction

Here is the source code for com.adnature.framework.util.Struts2Utils.java

Source

/**
 * Copyright (c) 2010 www.pub.cn
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 
 * $Id: Struts2Utils.java,v 1.4 2010/08/22 07:14:29 xp Exp $
 */
package com.adnature.framework.util;

import java.io.IOException;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

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

import org.apache.commons.lang.StringUtils;
import org.apache.struts2.ServletActionContext;
import org.json.JSONException;
import org.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.util.WebUtils;

/**
 * Struts2 Utils.
 * 
 * ?Request/Response/Sessionjsp/freemaker.
 * 
 * @author pub
 */
public class Struts2Utils implements Serializable {

    private static final long serialVersionUID = 8135767349279345254L;

    public static final String SEARCH_KEY = "SEARCH_CONDATION";

    // -- header ? --//
    private static final String ENCODING_PREFIX = "encoding";
    private static final String NOCACHE_PREFIX = "no-cache";
    private static final String ENCODING_DEFAULT = "UTF-8";
    private static final boolean NOCACHE_DEFAULT = true;

    // -- content-type ? --//
    private static final String TEXT_TYPE = "text/plain";
    private static final String JSON_TYPE = "application/json";
    private static final String XML_TYPE = "text/xml";
    private static final String HTML_TYPE = "text/html";
    private static final String JS_TYPE = "text/javascript";

    private static Logger logger = LoggerFactory.getLogger(Struts2Utils.class);

    // -- ?Request/Response/Session --//
    /**
     * ?HttpSession.
     */
    public static HttpSession getSession() {
        return ServletActionContext.getRequest().getSession();
    }

    /**
     * ?ServletContext.
     */
    public static ServletContext getApplication() {
        return ServletActionContext.getServletContext();
    }

    /**
     * ?HttpRequest.
     */
    public static HttpServletRequest getRequest() {
        return ServletActionContext.getRequest();
    }

    /**
     * ?HttpResponse.
     */
    public static HttpServletResponse getResponse() {
        return ServletActionContext.getResponse();
    }

    /**
     * ?Request Parameter.
     */
    public static String getParameter(String name) {
        return getRequest().getParameter(name);
    }

    // -- jsp/freemaker --//
    /**
     * .
     * 
     * eg. <br/>
     * render("text/plain", "hello", "encoding:GBK"); <br/>
     * render("text/plain", "hello", "no-cache:false"); <br/>
     * render("text/plain", "hello", "encoding:GBK", "no-cache:false");
     * 
     * @param headers
     *            ??header??"encoding:""no-cache:",UTF-8true.
     */
    public static void render(final String contentType, final String content, final String... headers) {
        try {
            // ?headers?
            String encoding = ENCODING_DEFAULT;
            boolean noCache = NOCACHE_DEFAULT;
            for (String header : headers) {
                String headerName = StringUtils.substringBefore(header, ":");
                String headerValue = StringUtils.substringAfter(header, ":");

                if (StringUtils.equalsIgnoreCase(headerName, ENCODING_PREFIX)) {
                    encoding = headerValue;
                } else if (StringUtils.equalsIgnoreCase(headerName, NOCACHE_PREFIX)) {
                    noCache = Boolean.parseBoolean(headerValue);
                } else {
                    throw new IllegalArgumentException(headerName + "??header");
                }
            }

            HttpServletResponse response = ServletActionContext.getResponse();

            // headers?
            String fullContentType = contentType + ";charset=" + encoding;
            response.setContentType(fullContentType);
            if (noCache) {
                response.setHeader("Pragma", "No-cache");
                response.setHeader("Cache-Control", "no-cache");
                response.setDateHeader("Expires", 0);
            }

            response.getWriter().write(content);
            response.getWriter().flush();

        } catch (IOException e) {
            logger.error(e.getMessage(), e);
        }
    }

    /**
     * .
     * 
     * @see #render(String, String, String...)
     */
    public static void renderText(final String text, final String... headers) {
        render(TEXT_TYPE, text, headers);
    }

    /**
     * HTML.
     * 
     * @see #render(String, String, String...)
     */
    public static void renderHtml(final String html, final String... headers) {
        render(HTML_TYPE, html, headers);
    }

    /**
     * XML.
     * 
     * @see #render(String, String, String...)
     */
    public static void renderXml(final String xml, final String... headers) {
        render(XML_TYPE, xml, headers);
    }

    /**
     * JSON.
     * 
     * @param jsonString
     *            json.
     * @throws JSONException 
     * @see #render(String, String, String...)
     */
    public static void renderJson(final String jsonString, final String... headers) throws JSONException {
        String str = new JSONObject(jsonString).toString();
        render(HTML_TYPE, str, headers);
    }

    /**
     * JSON.
     * 
     * @param map
     *            Map,json.
     * @throws JSONException 
     * @see #render(String, String, String...)
     */
    @SuppressWarnings("unchecked")
    public static void renderJson(final Map map, final String... headers) throws JSONException {
        JSONObject json = new JSONObject(map);
        //      json.
        render(JSON_TYPE, json.toString(), headers);
    }

    /**
     * JSON.
     * 
     * @param object
     *            Java,json.
     * @see #render(String, String, String...)
     */
    public static void renderJson(final Object object, final String... headers) {
        //      String jsonString = JSONObject.fromObject(object).toString();
        //      render(JSON_TYPE, jsonString, headers);
    }

    /**
     * JSON.
     * 
     * @param collction
     *            Java?, json.
     * @see #render(String, String, String...)
     */
    public static void renderJson(final Collection<?> collction, final String... headers) {
        //      String jsonString = JSONArray.fromObject(collction).toString();
        //      render(JSON_TYPE, jsonString, headers);
    }

    /**
     * JSON.
     * 
     * @param array
     *            Java, json.
     * @see #render(String, String, String...)
     */
    public static void renderJson(final Object[] array, final String... headers) {
        //      String jsonString = JSONArray.fromObject(array).toString();
        //      render(JSON_TYPE, jsonString, headers);
    }

    /**
     * ?MashupJSONP.
     * 
     * @param callbackName
     *            callback??.
     * @param contentMap
     *            Map,json.
     * @see #render(String, String, String...)
     */
    @SuppressWarnings("unchecked")
    public static void renderJsonp(final String callbackName, final Map contentMap, final String... headers) {
        //      String jsonParam = JSONObject.fromObject(contentMap).toString();

        //      StringBuilder result = new StringBuilder().append(callbackName).append("(").append(jsonParam).append(");");
        //
        //      // Content-Typejavascript,javascript?,
        //      // callback197("{content:'Hello World!!!'}");
        //      render(JS_TYPE, result.toString(), headers);
    }

    /**
     * ??Request
     * @param prefix ??
     */
    public static void fillSearchParams(String prefix) {
        if (StringUtils.isBlank(prefix)) {
            return;
        }
        HttpServletRequest request = getRequest();
        Map<String, Object> parmMap = new HashMap<String, Object>();
        // request??????,?????Map
        Map<String, Object> filterParamMap = WebUtils.getParametersStartingWith(request, prefix + "#filter_");
        if (filterParamMap != null && !filterParamMap.isEmpty()) {
            for (Entry<String, Object> entry : filterParamMap.entrySet()) {
                String filterName = entry.getKey();
                String value = ((String) entry.getValue()).trim().replaceAll("\"", "&quot;");
                value = value.replaceAll("<", "&lt;");
                value = value.replaceAll(">", "&gt;");
                // value,filter.
                boolean omit = StringUtils.isBlank(value);
                if (!omit) {
                    request.setAttribute("filter_" + filterName, value);
                    parmMap.put("filter_" + filterName, value);

                }
            }
            request.setAttribute(SEARCH_KEY, parmMap);
            request.setAttribute(prefix, parmMap);
        }
    }
}