RequestData.java

/*
 * Copyright 2013 OmniFaces.
 *
 * 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.
 */
package org.omnifaces.security.jaspic.request;

import java.io.Serializable;
import static org.omnifaces.security.jaspic.Utils.isEmpty;

import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

/**
 * This class stores the core data that makes up an HttpServletRequest.
 *
 * @author Arjan Tijms
 *
 */
public class RequestData implements Serializable {

	private Cookie[] cookies;
	private Map<String, List<String>> headers;
	private List<Locale> locales;
	private Map<String, String[]> parameters;

	private String method;
	private String requestURL;
	private String queryString;

	private boolean restoreRequest = true;

	public Cookie[] getCookies() {
		return cookies;
	}

	public void setCookies(Cookie[] cookies) {
		this.cookies = cookies;
	}

	public Map<String, List<String>> getHeaders() {
		return headers;
	}

	public void setHeaders(Map<String, List<String>> headers) {
		this.headers = headers;
	}

	public List<Locale> getLocales() {
		return locales;
	}

	public void setLocales(List<Locale> locales) {
		this.locales = locales;
	}

	public Map<String, String[]> getParameters() {
		return parameters;
	}

	public void setParameters(Map<String, String[]> parameters) {
		this.parameters = parameters;
	}

	public String getMethod() {
		return method;
	}

	public void setMethod(String method) {
		this.method = method;
	}

	public String getQueryString() {
		return queryString;
	}

	public void setQueryString(String queryString) {
		this.queryString = queryString;
	}

	public String getRequestURL() {
		return requestURL;
	}

	public void setRequestURL(String requestURL) {
		this.requestURL = requestURL;
	}

	public boolean isRestoreRequest() {
		return restoreRequest;
	}

	public void setRestoreRequest(boolean restoreRequest) {
		this.restoreRequest = restoreRequest;
	}

	public String getFullRequestURL() {
		return buildFullRequestURL(requestURL, queryString);
	}

	public boolean matchesRequest(HttpServletRequest request) {
		// (or use requestURI instead of requestURL?)
		return getFullRequestURL().equals(buildFullRequestURL(request.getRequestURL().toString(), request.getQueryString()));
	}

	@Override
	public String toString() {
		return String.format("%s %s", method, getFullRequestURL());
	}

	private String buildFullRequestURL(String requestURL, String queryString) {
		return requestURL + (isEmpty(queryString) ? "" : "?" + queryString);
	}

}