com.github.datalking.web.servlet.ServletWebRequest Maven / Gradle / Ivy

Go to download
package com.github.datalking.web.servlet;

import com.github.datalking.util.CollectionUtils;
import com.github.datalking.util.ObjectUtils;
import com.github.datalking.util.StringUtils;
import com.github.datalking.util.web.WebUtils;
import com.github.datalking.web.context.request.WebRequest;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.security.Principal;
import java.util.Date;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;

/**
 * 同时存放request和response，主要作为获取请求信息的getter
 *
 * @author yaoo on 4/25/18
 */
public class ServletWebRequest extends ServletRequestAttributes implements WebRequest {

    private static final String HEADER_ETAG = "ETag";

    private static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since";

    private static final String HEADER_IF_NONE_MATCH = "If-None-Match";

    private static final String HEADER_LAST_MODIFIED = "Last-Modified";

    private static final String METHOD_GET = "GET";

    private static final String METHOD_HEAD = "HEAD";

    private HttpServletResponse response;

    private boolean notModified = false;

    public ServletWebRequest(HttpServletRequest request) {
        super(request);
    }

    public ServletWebRequest(HttpServletRequest request, HttpServletResponse response) {
        this(request);
        this.response = response;
    }

    public final HttpServletResponse getResponse() {
        return this.response;
    }

    public Object getNativeRequest() {
        return getRequest();
    }

    public  T getNativeRequest(Class requiredType) {
        return WebUtils.getNativeRequest(getRequest(), requiredType);
    }

    public Object getNativeResponse() {
        return getResponse();
    }

    public  T getNativeResponse(Class requiredType) {
        return WebUtils.getNativeResponse(getResponse(), requiredType);
    }

    public String getHeader(String headerName) {
        return getRequest().getHeader(headerName);
    }

    public String[] getHeaderValues(String headerName) {
        String[] headerValues = StringUtils.toStringArray(getRequest().getHeaders(headerName));
        return (!ObjectUtils.isEmpty(headerValues) ? headerValues : null);
    }

    public Iterator getHeaderNames() {
        return CollectionUtils.toIterator(getRequest().getHeaderNames());
    }

    public String getParameter(String paramName) {
        return getRequest().getParameter(paramName);
    }

    public String[] getParameterValues(String paramName) {
        return getRequest().getParameterValues(paramName);
    }

    public Iterator getParameterNames() {
        return CollectionUtils.toIterator(getRequest().getParameterNames());
    }

    public Map getParameterMap() {
        return getRequest().getParameterMap();
    }

    public Locale getLocale() {
        return getRequest().getLocale();
    }

    public String getContextPath() {
        return getRequest().getContextPath();
    }

    public String getRemoteUser() {
        return getRequest().getRemoteUser();
    }

    public Principal getUserPrincipal() {
        return getRequest().getUserPrincipal();
    }

    public boolean isUserInRole(String role) {
        return getRequest().isUserInRole(role);
    }

    public boolean isSecure() {
        return getRequest().isSecure();
    }

    @SuppressWarnings("deprecation")
    public boolean checkNotModified(long lastModifiedTimestamp) {
        if (lastModifiedTimestamp >= 0 && !this.notModified &&
                (this.response == null || !this.response.containsHeader(HEADER_LAST_MODIFIED))) {
            long ifModifiedSince = -1;
            try {
                ifModifiedSince = getRequest().getDateHeader(HEADER_IF_MODIFIED_SINCE);
            } catch (IllegalArgumentException ex) {
                String headerValue = getRequest().getHeader(HEADER_IF_MODIFIED_SINCE);
                // Possibly an IE 10 style value: "Wed, 09 Apr 2014 09:57:42 GMT; length=13774"
                int separatorIndex = headerValue.indexOf(';');
                if (separatorIndex != -1) {
                    String datePart = headerValue.substring(0, separatorIndex);
                    try {
                        ifModifiedSince = Date.parse(datePart);
                    } catch (IllegalArgumentException ex2) {
                        // Giving up
                    }
                }
            }
            this.notModified = (ifModifiedSince >= (lastModifiedTimestamp / 1000 * 1000));
            if (this.response != null) {
                if (this.notModified && supportsNotModifiedStatus()) {
                    this.response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                } else {
                    this.response.setDateHeader(HEADER_LAST_MODIFIED, lastModifiedTimestamp);
                }
            }
        }
        return this.notModified;
    }

    @Override
    public boolean checkNotModified(String etag) {
        if (StringUtils.hasLength(etag) && !this.notModified &&
                (this.response == null || !this.response.containsHeader(HEADER_ETAG))) {
            String ifNoneMatch = getRequest().getHeader(HEADER_IF_NONE_MATCH);
            this.notModified = etag.equals(ifNoneMatch);
            if (this.response != null) {
                if (this.notModified && supportsNotModifiedStatus()) {
                    this.response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
                } else {
                    this.response.setHeader(HEADER_ETAG, etag);
                }
            }
        }
        return this.notModified;
    }

    private boolean supportsNotModifiedStatus() {
        String method = getRequest().getMethod();
        return (METHOD_GET.equals(method) || METHOD_HEAD.equals(method));
    }

    public boolean isNotModified() {
        return this.notModified;
    }

    public String getDescription(boolean includeClientInfo) {
        HttpServletRequest request = getRequest();
        StringBuilder sb = new StringBuilder();
        sb.append("uri=").append(request.getRequestURI());
        if (includeClientInfo) {
            String client = request.getRemoteAddr();
            if (StringUtils.hasLength(client)) {
                sb.append(";client=").append(client);
            }
            HttpSession session = request.getSession(false);
            if (session != null) {
                sb.append(";session=").append(session.getId());
            }
            String user = request.getRemoteUser();
            if (StringUtils.hasLength(user)) {
                sb.append(";user=").append(user);
            }
        }
        return sb.toString();
    }

    @Override
    public String toString() {
        return "ServletWebReq: " + getDescription(true);
    }

}