To ensure that the application server receives the request parameters in the correct encoding from client requests you have to configure the tomcat connector. If you use JBoss AS, add the system properties org.apache.catalina.connector.URI_ENCODING and org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING to the server configuration. For JBoss AS 7.1.1 change ${JBOSS_HOME}/standalone/configuration/standalone.xml:

        

<system-properties>

     <property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>

     <property name="org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING" value="true"/>

</system-properties>

        

You'll also need localized strings for all the messages in your application (for example field labels on your views). First you need to ensure that your resource bundle is encoded using the desired character encoding. By default ASCII is used. Although ASCII is enough for many languages, it doesn't provide characters for all languages.

Resource bundles must be created in ASCII, or use Unicode escape codes to represent Unicode characters. Since you don't compile a property file to byte code, there is no way to tell the JVM which character set to use. So you must use either ASCII characters or escape characters not in the ASCII character set. You can represent a Unicode character in any Java file using \uXXXX, where XXXX is the hexadecimal representation of the character.

You can write your translation of labels ( Section 17.3, “Labels”) to your messages resource bundle in the native encoding and then convert the content of the file into the escaped format through the tool native2ascii provided in the JDK. This tool will convert a file written in your native encoding to one that represents non-ASCII characters as Unicode escape sequences.

Usage of this tool is described here for Java 5 or here for Java 6. For example, to convert a file from UTF-8:

$ native2ascii -encoding UTF-8 messages_cs.properties > messages_cs_escaped.properties

We need to make sure that the view displays your localized data and messages using the correct character set and also any data submitted uses the correct encoding.

To set the display character encoding, you need to use the <f:view locale="cs_CZ"/> tag (here we tell JSF to use the Czech locale). You may want to change the encoding of the xml document itself if you want to embed localized strings in the xml. To do this alter the encoding attribute in xml declaration <?xml version="1.0" encoding="UTF-8"?> as required.

Also JSF/Facelets should submit any requests using the specified character encoding, but to make sure any requests that don't specify an encoding you can force the request encoding using a servlet filter. Configure this in components.xml:

<web:character-encoding-filter encoding="UTF-8" 

   override-client="true" 

   url-pattern="*.seam" />

Seam provides a java.util.ResourceBundle (available to the application as a org.jboss.seam.core.resourceBundle). You'll need to make your internationalized labels available via this special resource bundle. By default, the resource bundle used by Seam is named messages and so you'll need to define your labels in files named messages.properties, messages_en.properties, messages_en_AU.properties, etc. These files usually belong in the WEB-INF/classes directory.

So, in messages_en.properties:

Hello=Hello

And in messages_en_AU.properties:

Hello=G'day

You can select a different name for the resource bundle by setting the Seam configuration property named org.jboss.seam.core.resourceLoader.bundleNames. You can even specify a list of resource bundle names to be searched (depth first) for messages.

<core:resource-loader>

    <core:bundle-names>

        <value>mycompany_messages</value>

        <value>standard_messages</value>       

    </core:bundle-names>

</core:resource-loader>

If you want to define a message just for a particular page, you can specify it in a resource bundle with the same name as the JSF view id, with the leading / and trailing file extension removed. So we could put our message in welcome/hello_en.properties if we only needed to display the message on /welcome/hello.jsp.

You can even specify an explicit bundle name in pages.xml:

<page view-id="/welcome/hello.jsp" bundle="HelloMessages"/>

Then we could use messages defined in HelloMessages.properties on /welcome/hello.jsp.

If you define your labels using the Seam resource bundle, you'll be able to use them without having to type <f:loadBundle ... /> on every page. Instead, you can simply type:

<h:outputText value="#{messages['Hello']}"/>

or:

<h:outputText value="#{messages.Hello}"/>

Even better, the messages themselves may contain EL expressions:

Hello=Hello, #{user.firstName} #{user.lastName}

Hello=G'day, #{user.firstName}

You can even use the messages in your code:

@In private Map<String, String> messages;

@In("#{messages['Hello']}") private String helloMessage;

The facesMessages component is a super-convenient way to display success or failure messages to the user. The functionality we just described also works for faces messages:

@Name("hello")

@Stateless

public class HelloBean implements Hello {

    @In FacesMessages facesMessages;

    

    public String sayIt() {

        facesMessages.addFromResourceBundle("Hello");

    }

}

This will display Hello, Gavin King or G'day, Gavin, depending upon the user's locale.