Internationalization

Owned by Marvin Addison
Last updated: Jun 17, 2014 by Misagh Moayyed

New CAS documentation site

CAS documentation has moved over to jasig.github.io/cas, starting with CAS version 4.x. The wiki will no longer be maintained. For the most recent version of the documentation, please refer to the aforementioned link.

There are a number of considerations for deploying CAS in a locale other than en-US, some of which are discussed here.

Localization

The Localization page describes how to switch from the default en-US locale to any of a number of supported locales, as well as instructions for adding support for a locale not provided out of the box.

UTF-8 Support

Supporting character sets other than ASCII will be a primary concern for many international deployments. The following steps are required to support end-to-end UTF-8 character set encoding in CAS.

  1. Ensure pageEncoding of all JSP views is UTF-8. (This is the default for most if not all views packaged with CAS)

    <%@ page pageEncoding="UTF-8" %>

  2. Ensure the Content-Type header specifies UTF-8 encoding:

    <%@ page contentType="text/html; charset=UTF-8" %>
...
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  ...
</head>
...
  3. Set the character set encoding to UTF-8 for both the request and response as early in the processing stage as possible. The most convenient solution for this is defining a servlet filter that sets HttpServletRequest#setCharacterEncoding() and HttpServletResponse#setCharacterEncoding() to UTF-8. Recent versions of CAS provide this functionality by default using CharacterEncodingFilter.