BEA WebLogic Server User manual

BEA WebLogic
Server™
Internationalization Guide
Release 7.0
Document Revised: August 20, 2002

Copyright
Copyright © 2002 BEA Systems, Inc. All Rights Reserved.
Restricted Rights Legend
This software and documentation is subject to and made available only pursuant to the terms of the BEA Systems
License Agreement and may be used or copied only in accordance with the terms of that agreement. It is against the
law to copy the software except as specifically allowed in the agreement. This document may not, in whole or in part,
be copied photocopied, reproduced, translated, or reduced to any electronic medium or machine readable form
without prior consent, in writing, from BEA Systems, Inc.
Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the BEA Systems License
Agreement and in subparagraph (c)(1) of the Commercial Computer Software-Restricted Rights Clause at FAR
52.227-19; subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS
252.227-7013, subparagraph (d) of the Commercial Computer Software--Licensing clause at NASA FAR
supplement 16-52.227-86; or their equivalent.
Information in this document is subject to change without notice and does not represent a commitment on the part
of BEA Systems. THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” WITHOUT
WARRANTY OF ANY KIND INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. FURTHER, BEA Systems DOES NOT
WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE, OR THE
RESULTS OF THE USE, OF THE SOFTWARE OR WRITTEN MATERIAL IN TERMS OF CORRECTNESS,
ACCURACY, RELIABILITY, OR OTHERWISE.
Trademarks or Service Marks
BEA, Jolt, Tuxedo, and WebLogic are registered trademarks of BEA Systems, Inc. BEA Builder, BEA Campaign
Manager for WebLogic, BEA eLink, BEA Manager, BEA WebLogic Commerce Server, BEA WebLogic
Enterprise, BEA WebLogic Enterprise Platform, BEA WebLogic Express, BEA WebLogic Integration, BEA
WebLogic Personalization Server, BEA WebLogic Platform, BEA WebLogic Portal, BEA WebLogic Server, BEA
WebLogic Workshop and How Business Becomes E-Business are trademarks of BEA Systems, Inc.
All other trademarks are the property of their respective companies.
Internationalization Guide
Part Number Document Revised Software Version
N/A August 20, 2002 BEA WebLogic Server
Version 7.0

Hybrid Templates for FrameMaker 5.5 -iii
Contents
About This Document
Audience............................................................................................................ viii
e-docs Web Site................................................................................................. viii
How to Print the Document............................................................................... viii
Related Information..............................................................................................ix
Contact Us!...........................................................................................................ix
Documentation Conventions.................................................................................x
1. Overview of Internationalization for WebLogic Server
About Internationalization and Localization Standards .................................... 1-1
Understanding Localization for WebLogic Server ........................................... 1-2
Understanding Message Catalogs ..................................................................... 1-3
Understanding Java Interfaces for Internationalization .................................... 1-4
Main Steps for Creating an Internationalized Message .................................... 1-4
2. Using Message Catalogs with BEA WebLogic Server
Overview of Message Catalogs......................................................................... 2-1
Message Catalog Hierarchy .............................................................................. 2-2
Choosing Names for Message Catalogs............................................................ 2-3
Using Message Arguments................................................................................ 2-4
Message Catalog Formats ................................................................................. 2-5
Elements of a Log Message Catalog.......................................................... 2-5
message_catalog ................................................................................. 2-6
log_message........................................................................................ 2-7
Other log_message Catalog Elements ................................................ 2-8
Log Message Catalog Example .......................................................... 2-9
Elements of a Simple Text Message Catalog........................................... 2-10

-iv Hybrid Templates for FrameMaker 5.5
message_catalog................................................................................ 2-11
message ............................................................................................. 2-11
messagebody ..................................................................................... 2-12
Simple Text Catalog Example .......................................................... 2-13
Elements of a Locale-Specific Catalog .................................................... 2-14
locale_message_catalog.................................................................... 2-14
log_message...................................................................................... 2-14
Other locale_message_catalog Elements .......................................... 2-14
Locale Message Catalog Syntax ....................................................... 2-15
3. Using the BEA WebLogic Server Message Editor
About the Message Editor ................................................................................. 3-1
Starting the Message Editor............................................................................... 3-3
Working with Catalogs...................................................................................... 3-4
Browsing to an Existing Catalog................................................................ 3-5
Creating a New Catalog ............................................................................. 3-7
Adding Messages to Catalogs ........................................................................... 3-9
Entering a New Log Message .................................................................... 3-9
Entering a New Simple Text Message..................................................... 3-11
Finding Messages ............................................................................................ 3-12
Finding a Log Message ............................................................................ 3-12
Finding a Simple Text Message............................................................... 3-13
Using the Message Viewer.............................................................................. 3-14
Viewing All Messages in a Catalog ......................................................... 3-14
Viewing All Messages in Several Catalogs ............................................. 3-15
Choosing a Message to Edit from the Message Viewer........................... 3-15
Editing an Existing Message ........................................................................... 3-16
4. Using the BEA WebLogic Server Internationalization Utilities
About the WebLogic Server Internationalization Utilities................................ 4-1
About the WebLogic Server Internationalization and Localization Interfaces. 4-2
18ngen Utility.................................................................................................... 4-4
Syntax.................................................................................................. 4-4
Options................................................................................................ 4-4
l10ngen Utility................................................................................................... 4-5

Hybrid Templates for FrameMaker 5.5 -v
Syntax ................................................................................................. 4-5
Options................................................................................................ 4-6
CatInfo Utility ................................................................................................... 4-6
Syntax ................................................................................................. 4-6
Options................................................................................................ 4-7
A. Localizer Class Reference for BEA WebLogic Server
About Localizer Classes....................................................................................A-1
Localizer Methods.............................................................................................A-2
Localizer Lookup Class.....................................................................................A-3
B. Logger Class Reference for BEA WebLogic Server
About Logger Classes .......................................................................................B-1
Example of a Generated Logger Class..............................................................B-2
C. Loggable Object Reference for BEA WebLogic Server
About Loggable Objects....................................................................................C-1
How Loggable Objects Are Used......................................................................C-2
D. TextFormatter Class Reference for BEA WebLogic Server
About TextFormatter Classes............................................................................D-1
Example of an Application Using a TextFormatter Class.................................D-2

-vi Hybrid Templates for FrameMaker 5.5

Internationalization Guide vii
About This Document
This document defines internationalization and localization, and explains how to use
the templates and tools provided with WebLogic Server to create or edit message
catalogs that are locale-specific.
The document is organized as follows:
Chapter 1, “Overview of Internationalization for WebLogic Server,” summarizes
the processes required for internationalization and localization.
Chapter 2, “Using Message Catalogs with BEA WebLogic Server,” describes
message catalog types, message definitions, elements, and arguments.
Chapter 3, “Using the BEA WebLogic Server Message Editor,” explains how to
use the Message Editor that is included with WebLogic Server.
Chapter 4, “Using the BEA WebLogic Server Internationalization Utilities,”
explains how to use the internationalization utilities included with WebLogic
Server.
Appendix A, “Localizer Class Reference for BEA WebLogic Server,” describes
Localizer classes, Localizer methods, key values for Localizers, and
lookup properties for Localizers.
Appendix B, “Logger Class Reference for BEA WebLogic Server,” describes
Logger classes and provides an example of a message catalog and its
corresponding Logger class.
Appendix C, “Loggable Object Reference for BEA WebLogic Server,” describes
loggable objects and how they are used.
Appendix D, “TextFormatter Class Reference for BEA WebLogic Server,”
provides and example of an application that uses a TextFormatter class.

viii Internationalization Guide
Audience
This document is written for application developers who must internationalize or
localize the message catalogs included in the WebLogic Server distribution for
locale-specific administration and management. It is assumed that readers are familiar
with the WebLogic Server Platform and know Web technologies, object-oriented
programming techniques, and the Java programming language.
e-docs Web Site
BEA product documentation is available on the BEA corporate Web site. From the
BEA Home page, click on Product Documentation.
How to Print the Document
You can print a copy of this document from a Web browser, one main topic at a time,
by using the File→Print option on your Web browser.
A PDF version of this document is available on the WebLogic Server documentation
Home page on the e-docs Web site (and also on the documentation CD). You can open
the PDF in Adobe Acrobat Reader and print the entire document (or a portion of it) in
book format. To access the PDFs, open the WebLogic Server documentation Home
page, click Download Documentation, and select the document you want to print.
Adobe Acrobat Reader is available at no charge from the Adobe Web site at
http://www.adobe.com.

Internationalization Guide ix
Related Information
For more information in general about internationalization and localization, refer to the
following sources:
The Java Developer Connection™ at java.sun.com
The Internationalization section of the World Wide Web Consortium (W3C) Web
Site at http://www.w3.org
Contact Us!
Your feedback on BEA documentation is important to us. Send us e-mail at
[email protected] if you have questions or comments. Your comments will be
reviewed directly by the BEA professionals who create and update the documentation.
In your e-mail message, please indicate the software name and version you are using,
as well as the title and document date of your documentation. If you have any questions
about this version of BEA WebLogic Server, or if you have problems installing and
running BEA WebLogic Server, contact BEA Customer Support through BEA
WebSupport at http://www.bea.com. You can also contact Customer Support by using
the contact information provided on the Customer Support Card, which is included in
the product package.
When contacting Customer Support, be prepared to provide the following information:
Your name, e-mail address, phone number, and fax number
Your company name and company address
Your machine type and authorization codes
The name and version of the product you are using
A description of the problem and the content of pertinent error messages

xInternationalization Guide
Documentation Conventions
The following documentation conventions are used throughout this document.
Convention Usage
Ctrl+Tab Keys you press simultaneously.
italics Emphasis and book titles.
monospace
text
Code samples, commands and their options, Java classes, data types,
directories, and file names and their extensions. Monospace text also
indicates text that you enter from the keyboard.
Examples:
import java.util.Enumeration;
chmod u+w *
config/examples/applications
.java
config.xml
float
monospace
italic
text
Variables in code.
Example:
String CustomerName;
UPPERCASE
TEXT
Device names, environment variables, and logical operators.
Examples:
LPT1
BEA_HOME
OR
{ } A set of choices in a syntax line.
[ ] Optional items in a syntax line. Example:
java utils.MulticastTest -n name -a address
[-p portnumber] [-t timeout] [-s send]