Instruction/ maintenance manual of the product Server BEA
Go to page of 88
BEA W ebLogic Server ™ Internationalization Guide Release 7.0 Document Revised: Augu st 20, 2002.
Copyright Copyright © 2002 BEA Systems, Inc. All Rights Reserved. Restricted Rights Legen d This software and documentat ion is subject to and made available only pursuant to the terms of the BEA Systems License Agreement and may be used or copi ed only in ac cordance with the terms of that agreem ent.
Hybrid Templates fo r FrameMaker 5.5 -iii Contents About This Document Audience..................... ......................... ........... .............. .......................... ........... viii e-docs Web Site .................. ..................
-iv Hybrid T emplates for FrameMaker 5.5 message_catalog....................... ......................... ............... ........... ...... 2-11 message .............. ......................... ........... .............. ............ .............. .
Hybrid Templates fo r FrameMaker 5.5 -v Syntax ............ .......................... ........... .............. ........... ............... ........ 4-5 Options .............. ............ .............. ......................... ........... .......
-vi Hybrid T emplates for FrameMaker 5.5.
Internationalization Guide vii About T his Document This document defines intern ationalization an d localization, and ex plains how to use the templates and tools provided with WebLo gic Server to create or edit message catalogs that are locale-specific.
viii Internationa lization Guide Audience This document is written for application de velopers who must internation alize or localize the message catalogs included in the WebLogic Server distribution for locale-specific admi nistration and management.
Internationalization Guide ix Related Inf ormation For more informatio n in general about internat ionalization and localizatio n, refer to the following sources: The Java Develo per Connection™ at java.sun.com The Internationalization section of the W orld W ide W eb Consortium (W3C) W eb Site at http://www.
x Internationalizat ion Guide Document ation Conv entions The following documentation conv entions are used throughout this document. Convention Usage Ctrl+Tab Keys you press simultaneously.
Internationalization Guide xi | Separates mutually exclusive choices in a syntax line. Example : java weblogic.de ploy [list|de ploy|undeploy| update] password {appl ication} {sou rce} ... Indicates one of the follo wing in a command line: An argument can be repeated seve ral times in the command line.
xii Internationalizat ion Guide.
Internationalization Guide 1-1 C HAPTER 1 Ov erview of Internationalization f or W ebL ogic Serv er The following sections provide an overview of localizatio n and internationalization: About Inte.
1 Overview of Internationalization for WebLogic Server 1-2 Internationalizat ion Guide (I18N) refers to the preparation of software so that it behaves properly in multiple locations. Localization (L10N) is the use of locale-speci fic language and constructs at run time.
Understanding Message Catalogs Internationalization Guide 1-3 Underst anding Message Cat alogs All internationalized text is defined in message catalogs, each of which defines a collection of log messages or sim ple text.
1 Overview of Internationalization for WebLogic Server 1-4 Internationalizat ion Guide Underst anding Jav a Interf aces f or Internationalization WebLogic Server uses the Java internationalization interf aces for providing internationalization and localization.
Main Steps for Creating an Internationalized Message Internationalization Guide 1-5 2. Run i18ngen to validate the catalo g you created or edited in Step 1 and generate runtime classes. The generated classes contain a method fo r each message. The method is defined according to information specified in the message cata log entry .
1 Overview of Internationalization for WebLogic Server 1-6 Internationalizat ion Guide.
Internationalization Guide 2-1 C HAPTER 2 Using Message Cat alogs with B EA W ebL ogic Serv er The following sections describe message catalogs and how to use them: Overview of Message Catalogs .
2 Using Message Catalogs with BEA WebLogic Server 2-2 Internationalizat ion Guide Message catalogs support multiple locales or languages. For a specific message catalog there is exactly one default version, known as the top-level catalog. Then there are corresponding locale-speci fic catalogs, one for each additional supported locale.
Choosing Names for Message Catalogs Internationalization Guide 2-3 Note: This directory path may vary, depending on where you cho se to install WebLogic Server. Catalogs that provide different local izat ions of the base catalogs are defin ed in msgcat subdirectories named fo r the locale (for example, msgcatde for Germany).
2 Using Message Catalogs with BEA WebLogic Server 2-4 Internationalizat ion Guide Java allows you to group classes into a collection called a package . A package name should be consistent with th e name of the subsystem in which a part icular catalog resides.
Message Catalog Formats Internationalization Guide 2-5 An example of a method attribute for the above message is as follows: -method=“logN oFile(Strin g name , String path )” The message expects two arguments, {0} and {1} : {0} is used in the message body .
2 Using Message Catalogs with BEA WebLogic Server 2-6 Internationalizat ion Guide log_message Other log_message Catalog Elements message_cat alog The following table describes the attr ibutes that you can define for the message_catal og element.
Message Catalog Formats Internationalization Guide 2-7 log_message The following table describes the attributes th at you can define for the log_mes sage element. endid 499999 for WebLogic Server catalogs 999999 for user-defined catalogs Optional Specifies the highest message ID used in this catalog.
2 Using Message Catalogs with BEA WebLogic Server 2-8 Internationalizat ion Guide Other log_message Cat alog Elements The following table describes the child elements of the log_message element. method None Required Method signature for logging this message.
Message Catalog Formats Internationalization Guide 2-9 L og Message Cat alog Example The following example show s a log message catalog, MyUtilLog.xml , with one log message.
2 Using Message Catalogs with BEA WebLogic Server 2-10 Internationalizat ion Guide version="1. 0" baseid="600 000" endid="6001 00" <log_messag e messageid ="600001" severity= "warning" method="l ogNoAuthori zation(String arg0, java.
Message Catalog Formats Internationalization Guide 2-1 1 message_cat alog The following table describes the attr i butes that you can define for the message_catal og element. message The following table describes the attr i butes that you can define for the message element.
2 Using Message Catalogs with BEA WebLogic Server 2-12 Internationalizat ion Guide messagebody The following table describes the ch ild element of the message element. method None Optional Method signature fo r formatting this message. The syntax is a standard Ja va method sig nature, less return type, qualifier s, se micolon, and extensions.
Message Catalog Formats Internationalization Guide 2-13 Simple T ext Catalog Example The following example shows a simple text catalog, MyUtilLabels.x ml , with one text definiti on. Listing 2- 3 Example of a Simple Tex t Catalo g <?xml version ="1.
2 Using Message Catalogs with BEA WebLogic Server 2-14 Internationalizat ion Guide Elements of a L ocale-Specific Cat alog The locale-specific catalogs are subsets of top-level catalogs. They are maintained in subdirectories name d for the locales they represent.
Message Catalog Formats Internationalization Guide 2-15 L ocale Message Cata log S yntax The following example shows a French translat ion of a message that is available in ...msgcatfr MyUtilLabe ls.xml . The translated message appears as shown in Lis t ing 2-4 .
2 Using Message Catalogs with BEA WebLogic Server 2-16 Internationalizat ion Guide.
Internationalization Guide 3-1 C HAPTER 3 Using the B EA W ebL ogic Serv er Message E ditor The following sections describe how to use the Message Editor: About the Message Editor Starting the.
3 Using the BEA WebLogic Server Message Editor 3-2 Internationalizat ion Guide Note: The Message Editor does not support the editin g of localized catalogs.
Starting the Message Editor Internationalization Guide 3-3 St arting the Message E ditor Before you start the Message Editor, you s hould have instal led and configured your WebLogic Server system and se t your environment variable s ( setExamplesEnv.
3 Using the BEA WebLogic Server Message Editor 3-4 Internationalizat ion Guide Figure 3-1 WebLogic Messag e Editor for Log Messag es W orking with Cat alogs The following sections describe how to use .
Working with Catalogs Internationalization Guide 3-5 Br owsing to an Existing Cat alog To find an existing catalog from the ma in WebLogic Message Editor window, enter the full pathname in the Message Catalog field, or click Br owse and n avigate to the existing catalog from the Open dialog.
3 Using the BEA WebLogic Server Message Editor 3-6 Internationalizat ion Guide Figure 3-3 WebLogic Messag e Editor for Log Messag es If a simple messages catalog is selected in the Message catalog field, the WebLogic Message Editor window fo r Simple Messages displays as shown in Fi gure 3-4 .
Working with Catalogs Internationalization Guide 3-7 Figure 3-4 WebLogic Message Editor for Simple Messages Cr eating a New Cat alog To create a new catalog, comple te the following procedure: 1. Choose the File menu from the main menu bar of the WebLogi c Message Editor window .
3 Using the BEA WebLogic Server Message Editor 3-8 Internationalizat ion Guide Figure 3-5 Create New Catalog 3. In the Message Catal og field, ente r the full pathname and the name of the new catalog, which must include the xml extension. Or , click Browse and navigate to the W ebLogic cat alog directory , msgcat .
Adding Messages to Catalogs Internationalization Guide 3-9 Adding Messages to Cat alogs The following sections describe how to use the Message Editor to add messages to catalogs: Entering a New Lo.
3 Using the BEA WebLogic Server Message Editor 3-10 Internationalizat ion Guide Figure 3-6 Log Messages 2. Enter a unique alphanumeric Messa ge ID or click Get next I D to get the next unique numerical ID in the context catalog. 3. Enter the appropriate Method for your log message, includin g parentheses and any arguments.
Adding Messages to Catalogs Internationalization Guide 3-1 1 6. T oggle the Display stacktrace option on or off by clicking the checkmark box. Use this option to print a stacktrace al ong with the message when a Logger method takes an exception as one of its arguments.
3 Using the BEA WebLogic Server Message Editor 3-12 Internationalizat ion Guide 5. Enter the Message body text. 6. Click Add. The message is added and the entire catalog is immediately written to disk .
Finding Messages Internationalization Guide 3-13 5. Enter as much informat ion as you need in the Message text search field to find the correct message. The search for text do es a partial match in any of the text fields. 6. Click Find first or Find next .
3 Using the BEA WebLogic Server Message Editor 3-14 Internationalizat ion Guide Using the Message V iew er The W ebLogic M essage Editor contains a Messa ge Viewer that allows you to view all messages in a catalog, view all messages in multiple catalogs, and choose any message to edit.
Using the Mess age Viewer Internationalization Guide 3-15 Figure 3-10 Message Viewer V iewing All Messages in Sever al Cat alogs If you view the messages from the current context catal og, and then ch.
3 Using the BEA WebLogic Server Message Editor 3-16 Internationalizat ion Guide E diting an Existing Message To edit an existing message, co mplete the following procedure: 1.
Internationalization Guide 4-1 C HAPTER 4 Using the B EA W ebL ogic Serv er Internationalization Utilities The following sections contain info rmation about the WebLogic Server utilities used for inte.
4 Using the BEA WebLogic Server Internationalization Utilities 4-2 Internationalizat ion Guide 18ngen Utilit y —Message catalog parser . Use this utilit y to generate classes used for localizing text in log messages. l10ngen Utility —Locale-specific message catalog parser .
About the WebLogic Server Internationa lization and Locali zation Interfaces Internationalization Guide 4-3 As another example, when the MyUtilLog.xm l catalog is used, the class programs.
4 Using the BEA WebLogic Server Internationalization Utilities 4-4 Internationalizat ion Guide The output prints the message text in the current locale, with the someVal argument inserted appropriately.
l10ngen Utility Internationalization Guide 4-5 l10ngen Utility The l10ngen utility processes the locale-specifi c catalogs in directories that are subordinate to the top-level catalogs. Syn t ax java -classpath <l1 0n_Classpa th> weblogic.i18n tools.
4 Using the BEA WebLogic Server Internationalization Utilities 4-6 Internationalizat ion Guide Note: Utilities can be run from any directory, but if files are listed on the command line, then their path is relative to the current directory. Options CatInf o Utility This utility generates a listing of in stall ed log messages.
CatInfo Utility Internationalization Guide 4-7 Options Note: All options may be abbreviated to a single character. To export the detailed list of messages to a file, use the fo llowing command: java weblogic.i1 8ntools.Cat Info -detail > Errors. txt Option Definition -id nnnnnn where nnnnnn represents the mess age ID.
4 Using the BEA WebLogic Server Internationalization Utilities 4-8 Internationalizat ion Guide.
Internationalization Guide A-1 A PPENDIX A L o calizer Class R e fe re n c e fo r B E A W ebL ogic Serv er The following sections provide reference inform ation for Localizer classes: About Locali.
A Localizer Class Reference for BEA WebLogic Server A-2 Internationalizat ion Guide Lo c a l i z e r M e t h o d s Localizers are extensions to the java.u til.ListResou rceBundle class. Four additional methods are provided to simplify the access of the localization data in the Localizer .
Localizer Lookup Class Internationalization Guide A-3 The following list shows the seve rity values that are returned: weblogic.logg ing.severit ies.EMERGENCY weblogic.logg ing.severit ies.ALERT weblogic.logg ing.severit ies.CRITICAL weblogic.
A Localizer Class Reference for BEA WebLogic Server A-4 Internationalizat ion Guide Localizer class is the name of the generated Localizer class For example, message 001234 is identified as an EJB su bsystem message ID from the weblogic.i18n .ejbLogLoca lizer class by the following property in the lo okup file: 001234=EJB:we blogic.
Internationalization Guide B-1 A PPENDIX B L ogger Class Ref er ence f or B EA W ebL ogic Serv er The following sections provide reference inform ation for Logger classes: About Logger Classes Example of a Generated Logger Class Note: This information on Logger classes is provided as reference of methods for normal usage.
B Logger Class Reference for BEA WebLogic Server B-2 Internationalizat ion Guide Example of a Gener ated L ogger Class Listing B-1 show an example of a catalog wi th a single message defini tion: Listing B-1 Example of Message Catalog <?xml version ="1.
Example of a Generate d Logger Class Internationalization Guide B-3 stacktra ce="true" > <messa gebody>This m essage is f ollowed by a trace</messag ebody> <message detail&.
B Logger Class Reference for BEA WebLogic Server B-4 Internationalizat ion Guide Listing B-2 Example of Generated Logger Class package examples .i18n.loggi ng; import weblog ic.logging. MessageLogger; import weblog ic.logging. Loggable; import java.u til.
Example of a Generate d Logger Class Internationalization Guide B-5 public static Loggable testArgsLogga ble(String arg0, int arg1) throws MissingResour ceException { Object[] args = { ar g0, new Inte.
B Logger Class Reference for BEA WebLogic Server B-6 Internationalizat ion Guide * messageid: 600004 * severity : info */ public stat ic String g etId() { Object [] args = { }; MessageLo gger.log( "600004", args, "examples.i18 n.logging.
Example of a Generate d Logger Class Internationalization Guide B-7 import java.u til.Locale; import weblog ic.i18n.Loc alizer; import weblog ic.i18ntool s.L10nLookup; import weblog ic.logging. Loggable; /** * @author Co pyright (c) 2000 by BEA S ystems, Inc.
B Logger Class Reference for BEA WebLogic Server B-8 Internationalizat ion Guide */ Throwab le t = new Throwable("Tes t with stack trace"); I18nLog Logger.logT race(t); /** * Mess ages can op tionally be de fined to not log a stack tr ace. */ I18nLog Logger.
Example of a Generate d Logger Class Internationalization Guide B-9 System. out.println (fmt.i18nPacka ge(messageId, lcl.getI18nPac kage())); System. out.println (fmt.subsystem (messageId,lc l.getSubSystem ())); System. out.println (fmt.severity( messageId,lcl .
B Logger Class Reference for BEA WebLogic Server B-10 Internationalizat ion Guide.
Internationalization Guide C-1 A PPENDIX C L oggable Object R e fe re n c e fo r B E A W ebL ogic Serv er The following sections provide reference inform ation for Loggable objects : About Loggabl.
C Loggable Object Reference for BEA WebLogic Server C-2 Internationalizat ion Guide How L oggable Objects Ar e Used To create a Logger that provides met hods to return Loggable o bjects , you need to set the loggables attribute in the message catalog.
How Loggable Objects Are Used Internationalization Guide C-3 logIOErrorLog gable (Throwable)— returns a Loggable object The Loggable class can be used as shown in Listing C -2 . Listing C- 2 Example of Use of Lo ggable Clas s package test; import weblog ic.
C Loggable Object Reference for BEA WebLogic Server C-4 Internationalizat ion Guide.
Internationalization Guide D-1 A PPENDIX D T extF ormatter Class R e fe re n c e fo r B E A W ebL ogic Serv er The following sections provide reference inform ation for TextFormatter classes: Abou.
D TextFormatter Class Refere nce for BEA WebLogic Server D-2 Internationalizat ion Guide Example of an Application Using a T extF ormatter Class Listing 4-3 shows an example of a simple message catalog for the HellowWorld application. Listing 4- 3 Example of a Simple Messag e Catalog <?xml version ="1.
Example of an Application Using a TextFormatter Class Internationalization Guide D-3 </message> <!-- --> <message message id="NTH_HEL LO" datelas tchanged="9 67575770971" method= "nthHello(i nt count)" > <messag ebody> This is hello n umber {0,numbe r}.
D TextFormatter Class Refere nce for BEA WebLogic Server D-4 Internationalizat ion Guide datelas tchanged="9 67578755587" method= "subSystem( String sub)" > <messag ebody>.
Example of an Application Using a TextFormatter Class Internationalization Guide D-5 * using the catalog edi ting utility, weblogic.i18n tools.gui.M essageEditor. * <p> * <pre> * English(ba se language ) ../msg cat/Helloworl d.xml * French .
D TextFormatter Class Refere nce for BEA WebLogic Server D-6 Internationalizat ion Guide */ HelloWorldTextForm atter fmt = new Hell oWorldTextFor matter(lcl); fmt.setEx tendedForma t(true); /* * print the text in the current l ocale */ System.ou t.println(f mt.
Example of an Application Using a TextFormatter Class Internationalization Guide D-7 Listing 4- 5 Example of G enerated Te xtFormatter Class for the HelloWorld Catalog <?xml version ="1.0" enco ding="UTF-8"?> <!DOCTYPE mes sage_catalo g PUBLIC "webl ogic-message- catalog-dtd" "http://www.
D TextFormatter Class Refere nce for BEA WebLogic Server D-8 Internationalizat ion Guide <!-- --> <message message id="VERSION " datelas tchanged="9 67578656214" method= &.
Example of an Application Using a TextFormatter Class Internationalization Guide D-9.
D TextFormatter Class Refere nce for BEA WebLogic Server D-10 Internationalizat ion Guide.
Hybrid Templates fo r FrameMaker 5.5 I--i Index A argument key A-2 message 2-4 C catalog browsing for 3-5 context 3-2 creating 3-7 entering a new log message 3-9 entering a simple text message 3-11 lo.
I--ii Hybrid T emplates for FrameMaker 5.5 definition of 1-2 log messages 1-2 simple text 1-2 Localizers 4-2, A-1 log message catalog elements 2-5 example 2-9 syntax 2-15 Loggable object C-1 Logger B-.
An important point after buying a device BEA Server (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought BEA Server yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data BEA Server - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, BEA Server you will learn all the available features of the product, as well as information on its operation. The information that you get BEA Server will certainly help you make a decision on the purchase.
If you already are a holder of BEA Server, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime BEA Server.
However, one of the most important roles played by the user manual is to help in solving problems with BEA Server. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device BEA Server along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
