Technical Note: Sun Java System Access Manager Localization Guide

Adding New Language Support

Access Manager is an internationalized application that facilitates support for new languages apart from the seven default languages. Administrators can add new language support to Access Manager without having to change the source code.

The process can be divided into two parts:

Adding a New Language to the Supported Language List

Adding a new language to the Access Manager supported language list means that the iPlanetG11NSettings service must be modified as shown in the following examples.

Create two new files and store them in a temporary location.


Example 1 setServiceRevision.xmlFile

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE Requests PUBLIC "-//iPlanet//Sun Java System Access Manager 7.1 Admin CLI DTD//EN" "jar://com/iplanet/am/admin/cli/amAdmin.dtd">

<!-- apply this file by: amadmin -u admin-user -w admin-pwd -t filename.xml -->

<Requests>

<SchemaRootNodeRequests serviceName="iPlanetG11NSettings">

<SetServiceRevisionNumber number="new-revision-number" />

</SchemaRootNodeRequests>

</Requests>



Note –

filename— Name of the file in which XML content will be stored, setServiceRevision.xml in this example.

new-revision-number — Add 10 to the existing revision number. The default value is 0.


To update the iPlanetG11NSettings service, run the amadmin utility as mentioned in Example 1.


Example 2 amG11nSettings_mod.xml File

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE Requests PUBLIC "-//iPlanet//Sun Java System Access Manager 7.1 Admin CLI DTD//EN" "jar://com/iplanet/am/admin/cli/amAdmin.dtd">

<!-- apply this file by: amadmin -u admin-user -w admin-pwd -t filename.xml -->

<Requests>

<SchemaRequests serviceName="iPlanetG11NSettings" SchemaType="Global">

<AddDefaultValues>

<AttributeValuePair>

<Attribute name="sun-identity-g11n-settings-locale-charset-mapping"/>

<Value>locale|charset=charset-list</Value>

</AttributeValuePair>

</AddDefaultValues>

</SchemaRequests>

</Requests>



Note –

filename — Name of the file in which XML content will be stored, amG11nSettings_mod.xml in this example.

locale — Standard ISO language value supported by the browser, for example, nl, ja, or fr.

charset-list — Semicolon-separated list of supported character sets for the language specified by locale, for example, UTF-8;Shift_JIS;EUC-JP.


To update the iPlanetG11NSettings service, run the amadmin utility as mentioned in Example 2.

After the iPlanetG11NSettings service is updated, Access Manager supports the new specified language. To finalize support of the added language, you must add software message resources to this language.

For instructions on how to add a new language to the Access Manager supported language list, see Hands-on Lab Format.

Adding Localization Resources for a Newly Supported Language

This section describes how to add and customize files that contain Access Manager Console authentication interface messages. It then explains how to add and customize the Access Manager Console user interface messages. Access Manager detects the client language that uses information in the HTTP request from the browser. Hence, to add L10n resources for a new language, the only requirement is to follow the Access Manager file name conventions and directory organization.

Localizing Authentication Interface Files

When providing authentication interfaces for localized environments, a separate directory for each language that contains customized XML files must be created. For each language, a subdirectory structure similar to the Access Manager information tree must also be created. The subdirectory starts from the authentication interface base directory, that is, AM_INS/web-src/services/config/auth/default_locale/

The first directory structure is needed to receive the new authentication interface file. This directory structure is then populated with existing interface files. Finally, these files are customized.

For instructions on how to localize authentication interface files for a new language, see Hands-on Lab Format.

The following procedures explain what must be done to localize authentication interface files.

ProcedureTo Create a Subdirectory Structure for the AMRoot Realm and All Its Sub-realms

  1. Open a terminal window (if necessary) on a system where Access Manager is installed.

  2. Navigate to the authentication interface base directory.

  3. Create a subdirectory structure.

  4. Change to the created subdirectory.

ProcedureTo Populate the Created Subdirectory With Desired Interface Files

  1. Copy the default Login.jsp file to the current directory.

  2. Copy the default Logout.jsp file to the current directory.

  3. Copy the default LDAP.xml file to the current directory.

ProcedureTo Customize Previously Copied Files

  1. Open the files in a text editor.

  2. Insert the new strings.

  3. Save the files.

Localizing the Access Manager Administration Console

To add language support to the Access Manager Administration Console, a new Java properties file for the desired module must be created. For example:


Example 3 Adding Language Support for the Policy Module for the Dutch Language

  1. Change to the AM_INS/locale directory.

  2. Copy the amPolicy.properties file to a new amPolicy_nl.properties file.

  3. Modify the created amPolicy_nl.properties file.

  4. Save the file.

  5. Restart the web container.


Another example is the customization of the copyright notice displayed at the bottom of the Access Manager Administration Console Login page.


Example 4 Customizing the Copyright Notice

  1. Change to the AM_INS/locale directory.

  2. Copy the amAuthUI.properties file to a new amAuthUI_nl.properties file.

  3. Modify the copyright.notice key in the created amAuthUI_nl.properties file.

  4. Save the file.

  5. Restart the web container.


After adding support for a new locale to Access Manager, newly added language software resources must be customized as described in the following section.