/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* 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.apache.jetspeed.util.parser;
import javax.servlet.http.HttpServletRequest;
import org.apache.turbine.util.parser.DefaultParameterParser;
import org.apache.jetspeed.om.registry.MediaTypeEntry;
import org.apache.jetspeed.services.Registry;
import org.apache.jetspeed.services.logging.JetspeedLogFactoryService;
import org.apache.jetspeed.services.logging.JetspeedLogger;
import org.apache.jetspeed.capability.CapabilityMap;
import org.apache.jetspeed.capability.CapabilityMapFactory;
import org.apache.jetspeed.services.resources.JetspeedResources;
/**
* DefaultJetspeedParameterParser is a utility object to handle parsing and
* retrieving the data passed via the GET/POST/PATH_INFO arguments.
*
* <p>NOTE: The name= portion of a name=value pair may be converted
* to lowercase or uppercase when the object is initialized and when
* new data is added. This behaviour is determined by the url.case.folding
* property in TurbineResources.properties. Adding a name/value pair may
* overwrite existing name=value pairs if the names match:
*
* <pre>
* ParameterParser pp = data.getParameters();
* pp.add("ERROR",1);
* pp.add("eRrOr",2);
* int result = pp.getInt("ERROR");
* </pre>
*
* In the above example, result is 2.
*
* @author <a href="mailto:shinsuke@yahoo.co.jp">Shinsuke SUGAYA</a>
* @version $Id: DefaultJetspeedParameterParser.java,v 1.4 2004/02/23 03:18:08 jford Exp $
*/
public class DefaultJetspeedParameterParser extends DefaultParameterParser
{
/**
* Static initialization of the logger for this class
*/
private static final JetspeedLogger logger = JetspeedLogFactoryService.getLogger(DefaultJetspeedParameterParser.class.getName());
public DefaultJetspeedParameterParser()
{
super();
}
public DefaultJetspeedParameterParser(String characterEncoding)
{
super (characterEncoding);
}
/**
* Sets the servlet request to be parser. This requires a
* valid HttpServletRequest object. It will attempt to parse out
* the GET/POST/PATH_INFO data and store the data into a Hashtable.
* There are convenience methods for retrieving the data as a
* number of different datatypes. The PATH_INFO data must be a
* URLEncoded() string.
*
* <p>To add name/value pairs to this set of parameters, use the
* <code>add()</code> methods.
*
* @param req An HttpServletRequest.
*/
public void setRequest(HttpServletRequest req)
{
super.setRequest(req);
String enc = JetspeedResources.getString(JetspeedResources.CONTENT_ENCODING_KEY,"US-ASCII");
CapabilityMap cm = CapabilityMapFactory.getCapabilityMap( req.getHeader("User-Agent") );
String mimeCode = cm.getPreferredType().getCode();
if ( mimeCode != null )
{
MediaTypeEntry media = (MediaTypeEntry)Registry.getEntry(Registry.MEDIA_TYPE, mimeCode);
if ( media != null && media.getCharacterSet() != null)
{
enc = media.getCharacterSet();
}
}
if ( req.getCharacterEncoding() != null )
{
enc = req.getCharacterEncoding();
}
setCharacterEncoding( enc );
}
/**
* Return a String for the given name. If the name does not
* exist, return null.
*
* @param name A String with the name.
* @return A String.
*/
public String getString(String name)
{
String str = super.getString(name);
if (str == null) return null;
try
{
return new String(str.getBytes("8859_1"), getCharacterEncoding());
}
catch (Exception e)
{
logger.warn("DefaultJetspeedParameterParser: Exception: " + e.toString());
return str;
}
}
}