org.apache.catalina.util.CharsetMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 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.
*/
/*
* This class is based on a class originally written by Jason Hunter
* as part of the book "Java Servlet Programming"
* (O'Reilly). See http://www.servlets.com/book for more information.
* Used by Sun Microsystems with permission.
*/
package org.apache.catalina.util;
import java.io.InputStream;
import java.util.Locale;
import java.util.Properties;
/**
* Utility class that attempts to map from a Locale to the corresponding
* character set to be used for interpreting input text (or generating
* output text) when the Content-Type header does not include one. You
* can customize the behavior of this class by modifying the mapping data
* it loads, or by subclassing it (to change the algorithm) and then using
* your own version for a particular web application.
*
* @author Craig R. McClanahan
* @revision $Date: 2005/12/08 01:28:14 $ $Version$
*/
/* SJSAS 6292972
public class CharsetMapper {
*/
// START SJSAS 6292972
public class CharsetMapper implements Cloneable {
// END SJSAS 6292972
// ---------------------------------------------------- Manifest Constants
/**
* Default properties resource name.
*/
public static final String DEFAULT_RESOURCE =
"/org/apache/catalina/util/CharsetMapperDefault.properties";
// ---------------------------------------------------------- Constructors
/**
* Construct a new CharsetMapper using the default properties resource.
*/
public CharsetMapper() {
this(DEFAULT_RESOURCE);
}
/**
* Construct a new CharsetMapper using the specified properties resource.
*
* @param name Name of a properties resource to be loaded
*
* @exception IllegalArgumentException if the specified properties
* resource could not be loaded for any reason.
*/
public CharsetMapper(String name) {
InputStream stream = null;
try {
stream =
this.getClass().getResourceAsStream(name);
map.load(stream);
} catch (Throwable t) {
throw new IllegalArgumentException(t.toString());
} finally {
if (stream != null) {
try {
stream.close();
} catch(Throwable t2) {
}
}
}
}
// ---------------------------------------------------- Instance Variables
/**
* The mapping properties that have been initialized from the specified or
* default properties resource.
*/
// START RIMOD 4870531
/*
private Properties map = new Properties();
*/
protected Properties map = new Properties();
// END RIMOD 4870531
// ------------------------------------------------------- Public Methods
/**
* Calculate the name of a character set to be assumed, given the specified
* Locale and the absence of a character set specified as part of the
* content type header.
*
* @param locale The locale for which to calculate a character set
*/
public String getCharset(Locale locale) {
String charset = null;
// First, try a full name match (language and country)
charset = map.getProperty(locale.toString());
if (charset != null)
return (charset);
// Second, try to match just the language
charset = map.getProperty(locale.getLanguage());
return (charset);
}
/**
* The deployment descriptor can have a
* locale-encoding-mapping-list element which describes the
* webapp's desired mapping from locale to charset. This method
* gets called when processing the web.xml file for a context
*
* @param locale The locale for a character set
* @param charset The charset to be associated with the locale
*/
public void addCharsetMappingFromDeploymentDescriptor(String locale,String charset) {
map.put( locale, charset );
}
// START SJSAS 6292972
@Override
public final Object clone() {
try {
CharsetMapper clone = (CharsetMapper)super.clone();
clone.map = (Properties)map.clone();
return clone;
} catch (CloneNotSupportedException e) {
throw new InternalError(e.toString());
}
}
// END SJSAS 6292972
}