Author: julien(a)jboss.com Date: 2007-08-20 18:42:42 -0400 (Mon, 20 Aug 2007) New Revision: 8006 Added: modules/web/trunk/web/src/main/org/jboss/portal/web/IllegalRequestException.java modules/web/trunk/web/src/main/org/jboss/portal/web/RequestInfo.java Log: Added RequestInfo which extracts useful information from an HttpServletRequest (at least for portal) Added: modules/web/trunk/web/src/main/org/jboss/portal/web/IllegalRequestException.java =================================================================== --- modules/web/trunk/web/src/main/org/jboss/portal/web/IllegalRequestException.java (rev 0) +++ modules/web/trunk/web/src/main/org/jboss/portal/web/IllegalRequestException.java 2007-08-20 22:42:42 UTC (rev 8006) @@ -0,0 +1,49 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.web; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public class IllegalRequestException extends Exception +{ + public IllegalRequestException() + { + } + + public IllegalRequestException(String string) + { + super(string); + } + + public IllegalRequestException(String string, Throwable throwable) + { + super(string, throwable); + } + + public IllegalRequestException(Throwable throwable) + { + super(throwable); + } +} Added: modules/web/trunk/web/src/main/org/jboss/portal/web/RequestInfo.java =================================================================== --- modules/web/trunk/web/src/main/org/jboss/portal/web/RequestInfo.java (rev 0) +++ modules/web/trunk/web/src/main/org/jboss/portal/web/RequestInfo.java 2007-08-20 22:42:42 UTC (rev 8006) @@ -0,0 +1,214 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.web; + +import org.jboss.portal.common.http.QueryStringParser; +import org.jboss.portal.common.util.ParameterMap; + +import javax.servlet.http.HttpServletRequest; +import java.util.Map; +import java.util.Collections; +import java.util.Iterator; +import java.util.HashMap; +import java.nio.charset.Charset; +import java.io.UnsupportedEncodingException; + +/** + * Compute useful information about an <code>HttpServletRequest</code>. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public class RequestInfo +{ + + /** . */ + public static final int GET_METHOD = 0; + + /** . */ + public static final int POST_METHOD = 1; + + /** . */ + public static final String APPLICATION_X_WWW_FORM_URLENCODED_MEDIA_TYPE = "application/x-www-form-urlencoded"; + + /** . */ + public static final String MULTIPART_FORM_DATA_MEDIA_TYPE = "multipart/form-data"; + + /** . */ + public static final Charset UTF_8_CHARSET = Charset.forName("UTF-8"); + + /** . */ + private final ParameterMap queryParameterMap; + + /** . */ + private final ParameterMap bodyParameterMap; + + /** . */ + private final int method; + + /** . */ + private final String mediaType; + + public RequestInfo(HttpServletRequest req) throws UnsupportedEncodingException, IllegalRequestException + { + int method; + if ("GET".equals(req.getMethod())) + { + method = GET_METHOD; + } + else if ("POST".equals(req.getMethod())) + { + method = POST_METHOD; + } + else + { + throw new IllegalRequestException("HTTP Method " + req.getMethod() + " not accepted"); + } + + // Compute the media type in the content type + String mediaType = retrieveMediaType(req.getContentType()); + + // Only affect the charset encoding if the servlet container will decode the request + if (method == POST_METHOD && APPLICATION_X_WWW_FORM_URLENCODED_MEDIA_TYPE.equals(mediaType)) + { + // Now we must ensure that we have either an equals or a trailing space after the media-type + String characterEncoding = req.getCharacterEncoding(); + if (characterEncoding == null) + { + // Set out charset for the request + req.setCharacterEncoding(UTF_8_CHARSET.name()); + } + else + { + Charset charset = Charset.forName(characterEncoding); + if (!UTF_8_CHARSET.equals(charset)) + { + throw new IllegalRequestException("Charset " + characterEncoding + " not accepted, it should be UTF8"); + } + } + } + + // Parse the query string to have the get parameters + // The resulting map has its parameters decoded from the x-www-form-url encoding + Map queryParameterMap = Collections.EMPTY_MAP; + String queryString = req.getQueryString(); + if (queryString != null) + { + queryParameterMap = QueryStringParser.parseQueryString(queryString); + } + + // + Map bodyParameterMap = null; + if (method == POST_METHOD && APPLICATION_X_WWW_FORM_URLENCODED_MEDIA_TYPE.equals(mediaType)) + { + bodyParameterMap = Collections.EMPTY_MAP; + for (Iterator i = req.getParameterMap().entrySet().iterator(); i.hasNext();) + { + Map.Entry entry = (Map.Entry)i.next(); + + // Get param name + String paramName = (String)entry.getKey(); + + // Values that are aggregated from the query string and the body + String[] paramValues = (String[])entry.getValue(); + + // Values decoded from the query string + String[] queryValues = (String[])queryParameterMap.get(paramName); + if (queryValues != null) + { + int bodyValuesLength = paramValues.length - queryValues.length; + if (bodyValuesLength > 0) + { + String[] bodyValues = new String[bodyValuesLength]; + System.arraycopy(paramValues, queryValues.length, bodyValues, 0, bodyValuesLength); + if (bodyParameterMap.isEmpty()) + { + bodyParameterMap = new HashMap(); + } + bodyParameterMap.put(paramName, bodyValues); + } + } + else + { + if (bodyParameterMap.isEmpty()) + { + bodyParameterMap = new HashMap(); + } + bodyParameterMap.put(paramName, paramValues); + } + } + + // Make the map unmodifiable + bodyParameterMap = bodyParameterMap.isEmpty() ? bodyParameterMap : Collections.unmodifiableMap(bodyParameterMap); + } + + // + this.method = method; + this.queryParameterMap = new ParameterMap(queryParameterMap); + this.bodyParameterMap = new ParameterMap(bodyParameterMap); + this.mediaType = mediaType; + } + + public ParameterMap getQueryParameterMap() + { + return queryParameterMap; + } + + public ParameterMap getBodyParameterMap() + { + return bodyParameterMap; + } + + public int getMethod() + { + return method; + } + + public String getMediaType() + { + return mediaType; + } + + private String retrieveMediaType(String contentType) + { + String mediaType = contentType; + + // + if (mediaType != null) + { + // Remove any parameters + int index = mediaType.indexOf(';'); + if (index != -1) + { + mediaType = contentType.substring(0, index); + } + + // Trim + mediaType = mediaType.trim(); + + // Media type matching is case insensitive, so we convert to lower case + mediaType = mediaType.toLowerCase(); + } + return mediaType; + } +}