pegasus/doc/Globalization_HOWTO.htm - diff

Return to Globalization_HOWTO.htm CVS log

Up to [Pegasus] / pegasus / doc

Diff for /pegasus/doc/Globalization_HOWTO.htm between version 1.5.2.1 and 1.11

version 1.5.2.1, 2003/12/01 19:57:38

version 1.11, 2008/12/16 18:55:36

Line 30

used as part of the table name inside the bundle.

</td>

</tr>

<tr>

<td style="vertical-align: top;">08/04/06

</td>

<td style="vertical-align: top;">Marek Szermutzky

</td>

<td style="vertical-align: top;">Section 2.2.5.   Added information how to write platform specific messages.

</td>

</tr>

<tr>

<td style="vertical-align: top;">01/23/07

</td>

<td style="vertical-align: top;">Sushma Fernandes

</td>

<td style="vertical-align: top;">Section 2.2.5.   Added information on special considerations while creating a new message.

</td>

</tr>

</tbody>

</table>

Line 253

Line 269

different language.  Please refer to PEP58 for details on these

provider scenarios.

Pegasus 2.3 has added classes for the localization support.

There are new classes called AcceptLanguages and ContentLanguages that

The Accept-Language and Content-Language headers are encapsulated

encapsulate the Accept-Language and Content-Language headers,

in AcceptLanguageList and ContentLanguageList classes, respectively.

respectively.  These classes are basically containers of

These classes contain LanguageTag objects. The AcceptLanguageList class

AcceptLanguageElement and ContentLanguageElement, where a language

keeps its LanguageTags prioritized based on quality,

element represents one language tag.  The AcceptLanguages class

will keep the AcceptLanguageElement's prioritized based on quality,

according to RFC 2616.

AcceptLanguages and ContentLanguages are the objects used by code

AcceptLanguageList and ContentLanguageList are the objects used by code

throughout the request/response processing, from the client to the

server to the providers and back.  The server handles the creation

of these objects from the HTTP headers.  Code at each point in the

process will have access to these objects.

Please refer to the following files for details on the new Pegasus

Please refer to the following files for details on the Pegasus

classes.

language interfaces.

<ul>

<li> pegasus/src/Pegasus/Common/AcceptLanguages.h</li>

<li> pegasus/src/Pegasus/Common/AcceptLanguageList.h</li>

<li> pegasus/src/Pegasus/Common/AcceptLanguageElement.h</li>

<li> pegasus/src/Pegasus/Common/ContentLanguageList.h</li>

<li> pegasus/src/Pegasus/Common/ContentLanguages.h</li>

<li> pegasus/src/Pegasus/Common/LanguageTag.h</li>

<li> pegasus/src/Pegasus/Common/ContentLanguageElement.h</li>

<li> pegasus/src/Pegasus/Common/LanguageElementContainer.h</li>

<li> pegasus/src/Pegasus/Common/LanguageElement.h</li>

</ul>

See the sections below for details on how to write clients and

Line 391

Line 402

The MessageLoader is the place where the Accept-Language header,

Content-Language header, and the ICU resource bundles, join up. 

The MessageLoader class is designed to receive an AcceptLanguages

The MessageLoader class is designed to receive an AcceptLanguageList

object, and a set of parameters indicating the bundle base-name and

message ID to use.  The AcceptLanguages object contains the list of

message ID to use.  The AcceptLanguageList object contains the list of

requested languages sent by the client.  The MessageLoader

searches for the message in the set of bundles named with the base-name,

using the AcceptLanguages for the list of specific translated bundles

using the AcceptLanguageList for the list of specific translated bundles

to search.  The MessageLoader returns the message that it found,

along with a ContentLanguages object indicating the language of the

along with a ContentLanguageList object indicating the language of the

message.  The ContentLanguages object should be used to indicate

message.  The ContentLanguageList object should be used to indicate

the language of the response sent back to the client.

The MessageLoaderParms object contains the parameters to load the

Line 441

Line 452

Note: defaults to the bundle containing the Pegasus server messages.</td>

</tr>

<tr>

<td>AcceptLanguages acceptlanguages;</td>

<td>AcceptLanguageList acceptlanguages;</td>

<td>Input.

Optional

Default: AcceptLanguages::EMPTY</td>

Default: AcceptLanguageList()</td>

<td>Contains the list of preferred languages, in priority

order.  This is combined with msg_src_path to determine which

resource bundles to search for for the msg_id.   If not empty,

overrides useThreadLocale and useProcessLocale.</td>

</tr>

<tr>

<td>ContentLanguages contentlanguages;</td>

<td>ContentLanguageList contentlanguages;</td>

<td>Output</td>

<td>Contains the language that MessageLoader found for the

msg_id. </td>

Line 469

Line 480

<td>Input

Optional

Default = true</td>

<td>If true, MessageLoader will use the AcceptLanguages set by

<td>If true, MessageLoader will use the AcceptLanguageList set by

Pegasus into the caller's Thread.   See the Note below for

details. </td>

</tr>

<tr>

<td>Boolean useICUfallback</td>

<td>Input

Optional

Default = false</td>

<td>If true, use ICU's fallback mechnism to search more general

resource bundles if the msg_id cannot be found.  Note: the

recommended setting is false if you are using an AcceptLanguages from a

CIM client.  The Accept-Languages HTTP header from the client

contains the fallback specifications.  Using ICU's fallback in this

case may lead to returning a language that the client didn't ask for.</td>

</tr>

<tr>

<td>Formatter::Arg arg0;

Formatter::Arg arg1;

Formatter::Arg arg2;

Line 508

Line 507

Notes:

The "useThreadLocale" parameter defaults to true.  This flag

indicates to use the AcceptLanguages object set by Pegasus into the

indicates to use the AcceptLanguageList object set by Pegasus into the

Pegasus Thread in which the caller's code is running.  This

AcceptLanguages object reflects the languages requested by the

AcceptLanguageList object reflects the languages requested by the

client.  This is useful for code that may not have access to the

AcceptLanguages from the client.  Pegasus sets this AcceptLanguages

AcceptLanguageList from the client.  Pegasus sets this AcceptLanguageList

object into the Thread of providers and internal Pegasus code. 

For this reason, it is recommended that provider and internal Pegasus

code use the "useThreadLocale" flag instead of explicity passing in an

AcceptLanguages object.  See the Provider Developer and Pegasus

AcceptLanguageList object.  See the Provider Developer and Pegasus

Developer sections for details.

The "useProcessLocale" flag can be used to tell MessageLoader to use

Line 529

Line 528

"Master switch"

The MessageLoader class has a public static Boolean variable called

_useProcessLocale that may be used to override all the AcceptLanguages

_useProcessLocale that may be used to override all the AcceptLanguageList

and useThreadLocale settings in the MessageLoaderParms objects passed

in.  This is useful for CLI code (eg cimconfig) that needs to

localize its messages based on the locale of its process, which refects

the locale set by the user running the CLI (eg. $LANG on Unix). 

The CLI code may call Pegasus APIs that are coded to use the Thread's

AcceptLanguages, which will not be set in this case.  The

AcceptLanguageList, which will not be set in this case.  The

_useProcessLocale static variable tells the MessageLoader to ignore the

AcceptLanguages, useThreadLocale, and useProcessLocale settings in

AcceptLanguageList, useThreadLocale, and useProcessLocale settings in

MessageLoaderParms that it gets.  The MessageLoader will use the

default process locale, as determined by ICU, in this case.

Important Note:  The MessageLoader defaults to not use

Important Note:  The MessageLoader does not use

the "fallback" mechanism described in the ICU Resource Management

section.  This is because the Accept-Language header itself

describes the fallback that the client wants.  However, the

describes the fallback that the client wants.  If the

MessageLoader does "fallback" to the root resource bundle if none of the

MessageLoader cannot find a message file for any of the languages

languages in AcceptLanguages can be found.  If the root resource

in the AcceptLanguageList, it will try the default process locale.

bundle cannot be found, then the default_msg is returned.  The

If this fails, the ICU root resource bundle will be tried.

"useICUFallback" flag can be set to have MessageLoader use ICU fallback

on all message load attempts.  However, usage of this flag for

client requests may lead to incorrect results.  For example, a

client sets Accept-Language to french, german, and spanish, in that

order, but there is no french resource bundle.  A call to

MessageLoader with useICUfallback == true would cause the root resource

bundle string to be returned on the attempt to load from the french

bundle.  But the client requested german to be the fallback after

french.

Please refer to the following files for details on the new Pegasus

classes.

Line 570

Line 560

classes described above.  Note: this a generic example.  Each

of the developer sections below have 'real-life' examples that are

better suited to each type of code.

// Build an AcceptLanguages with some language elements

// Build an AcceptLanguageList with some language elements

AcceptLanguages acceptLangs;

AcceptLanguageList acceptLangs;

acceptLangs.add(AcceptLanguageElement("fr", 0.5));

acceptLangs.insert(LanguageTag("fr"), 0.5);

acceptLangs.add(AcceptLanguageElement("de", 0.8));

acceptLangs.insert(LanguageTag("de"), 0.8);

acceptLangs.add(AcceptLanguageElement("es", 0.4));

acceptLangs.insert(LanguageTag("es"), 0.4);

// Construct a MessageLoaderParms

MessageLoaderParms parms("msgID", "default message");

parms. msg_src_path = "/my_msg_dir/my_bundle";

Line 584

Line 574

String localizedMsg = MessageLoader::getMessage(parms);

<h4> 2.2.4 Message Writing Guidelines</h4>

<h4> 2.2.5 Message Writing Guidelines</h4>

Here are some basic rules for writing messages:

Line 603

Line 593

ultimately the customer.</li>

<li> TODO - find a good message writing guide to link to</li>

</ul>

When do I create a new message ?

A new message should be created if a message is needed with a content not

described by any existing message.

A new message should be created if the number or placement of substitution

parameters of an existing message would require an update.

It is not necessary to create a new message if just the text of the message

is changed, while the meaning is kept. For instance if the

event(error,warning,whatever) is described more precisely by the new message

text, it is not necessary to create a new message, but the existing one should

be updated.

Are there any special considerations while creating a new message ?

<ul>

<li>If a message definition contains text within a single quote

it is not interpreted in any way.

Example:

Server.CIMOperationRequestAuthorizer.NOT_IN_AUTHORIZED_GRP:

string {"PGS05202: User '{0}' is not authorized to access CIM data."}

Processed message:

User {0} is not authorized to access CIM data.

</li>

<li> For a single quote to appear in a processed message, it needs to be preceded by

another single quote.

Example:

Server.CIMOperationRequestAuthorizer.NOT_IN_AUTHORIZED_GRP:

string {"PGS05202: User ''{0}'' is not authorized to access CIM data."}

Processed message:

User 'wbemuser' is not authorized to access CIM data.

</li>

<li> For a double quote to appear in a processed message, it needs to be preceded by

a back slash.

Example:

ControlProviders.ProviderRegistrationProvider.ProviderRegistrationProvider.

UNSUPPORTED_USERCONTEXT_VALUE:string {"PGS03029: Unsupported UserContext

value: \"{0}\"."}

Processed message:

Unsupported UserContext value: "10".

</li>

</ul>

How do I write a platform specific

message ?

Platform specific messages generate in a non-platform specific source file

should be formatted with a .<platform> or .STANDARD suffix.

Example:

Compiler.cmdline.cimmof.cmdline.MENU.PEGASUS_OS_HPUX

Compiler.cmdline.cimmof.cmdline.MENU.PEGASUS_OS_OS40

Compiler.cmdline.cimmof.cmdline.MENU.STANDARD

Where should I place platform specific

messages ?

As described in the message bundle file pegasusServer_en.txt messages belong

into the section corresponding the file they are created in. This does account

the same to platform specific messages.

If a message is generated inside a source file not specific to a single

platform, the message should be part of the message bundle section of that

source file.

If a new platform specific message is generated inside a platform specific

source file, the message belongs to the platform specific section of the

message bundle file.

Examples:

ProviderManager.ProviderAgent.ProviderAgent.UNINITIALIZED_SECURITY_SETUP.PEGASUS_OS_ZOS

- this message is and should be part of the section for the ProviderAgent as it

is generated inside the provider agent and not a z/OS platform specific file

Common.safCheckzOS_inline.BAD_WBEM_SECURITY_SETUP - this message does and

should reside inside the platform specific section as the message is generated

in a z/OS platform only file

<h4> 2.2.5 Localized Exceptions</h4>

The base Exception class, and derived classes, have been updated to

Line 610

Line 696

MessageLoaderParms object.  These constructors will use the

MessageLoaderParms object to call the MessageLoader to load the

localized exception message.  The localized message is saved in the

Exception.  The ContentLanguages object returned by MessageLoader

Exception.  The ContentLanguageList object returned by MessageLoader

is also saved in the Exception.  This indicates the language of

the message.  The ContentLanguages object is used later to set the

the message.  The ContentLanguageList object is used later to set the

Content-Language header in the HTTP message to the client.

The old Exception constructors that take a String will remain.

Line 671

Line 757

provider does not need to know what the Accept-Language is.  This

is the recommended method to load messages based on the client's request.</li>

<li> The OperationContext will contain an AcceptLanguages object

<li> The OperationContext will contain an AcceptLanguageList object

that has the Accept-Language requested by the client.  The provider

can use this AcceptLanguages object to load strings with MessageLoader.</li>

can use this AcceptLanguageList object to load strings with MessageLoader.</li>

</ul>

The OperationContext will also contain a ContentLanguages object that

The OperationContext will also contain a ContentLanguageList object that

is set from the Content-Language in the client request.  This is

the language of the CIM objects being passed to the provider on that

request.  A localized provider should store the content language

Line 733

Line 819

// We are going to let the message loader parameters default to use the

// AcceptLanguages that Pegasus set into our thread.

// AcceptLanguageList that Pegasus set into our thread.

// (this equals the AcceptLanguages requested by the client)

// (this equals the AcceptLanguageList requested by the client)

// Note: This parms object could be constructed once and

Line 769

Line 855

// of parms to the language that it found for the message.

ContentLanguages rtnLangs = parms.contentlanguages;

ContentLanguageList rtnLangs = parms.contentlanguages;

// We need to tag the instance we are returning with the

                 // the

Line 801

Line 887

// We are going to let the message loader parameters default to use the

// AcceptLanguages that Pegasus set into our thread.

// AcceptLanguageList that Pegasus set into our thread.

// (this equals the AcceptLanguages requested by the client)

// (this equals the AcceptLanguageList requested by the client)

// Note: This parms object could be constructed once and

Line 897

Line 983

// Language priority is martian, pig-latin, and

french.  We should

// get french back, even though its the lowest priority

AcceptLanguages acceptLangs;

AcceptLanguageList acceptLangs;

acceptLangs.add(AcceptLanguageElement("x-martian"));

acceptLangs.insert(LanguageTag("x-martian"), 1.0);

acceptLangs.add(AcceptLanguageElement("fr", 0.1));

acceptLangs.insert(LanguageTag("fr"), 0.1);

acceptLangs.add(AcceptLanguageElement("x-pig-latin", 0.4));

acceptLangs.insert(LanguageTag("x-pig-latin"), 0.4);

// Set the requested languages into the CIMClient

client.setRequestAcceptLanguages(acceptLangs);

// Get the instance

Line 919

Line 1005

get(returnedString);

// Check that we got back french

ContentLanguages CL_FR("fr");

ContentLanguageList CL_FR();

CL_FR.append(LanguageTag("fr"));

String expectedFRString = "oui";

PEGASUS_ASSERT(CL_FR == client.getResponseContentLanguages());

PEGASUS_ASSERT(expectedFRString == returnedString);

Line 961

Line 1048

ICU.  If ICU is installed on the client system then CIMClient will

set the Accept-Language from the default ICU process locale.  If

ICU is not installed then the caller is required to set an

AcceptLanguages into CIMClient that meets the ISO-639 and IS0-3166

AcceptLanguageList into CIMClient that meets the ISO-639 and IS0-3166

standards.  Note:  this is useful for local clients, such as

the Pegasus CLIs, where ICU would be installed on both the client and

server sides.

Line 1006

Line 1093

Server Design Points:

The CIMMessage object has been expanded to include an

AcceptLanguages object and a ContentLanguages object.  For

AcceptLanguageList object and a ContentLanguageList object in its

OperationContext member.  For

CIMRequestMessage, these objects contain the Accept-Language and

Content-Language headers that were built from the client request. 

For CIMResponseMessage, the ContentLanguages object is used to build the

For CIMResponseMessage, the ContentLanguageList object is used to build the

Content-Language header associated with the CIM objects in the

response message.  The AcceptLanguages object in the

response message.  The AcceptLanguageList object in the

CIMResponseMessage is ignored.

The localization of the cimException object in the

Line 1020

Line 1108

localized by the time it is built into the XML.  For this reason,

the localization of the exception is the responsibility of the code

throwing the exception.  (The goal of the design is to make that

easy - see below).  The ContentLanguages object in the

easy - see below).  The ContentLanguageList object in the

CIMResponseMessage has NO relation to this exception.  The

cimException object keeps its own localization information once it is

created.

Line 1028

Line 1116

To enable exceptions to be localized, the ability was added to set a

global language for all the code running from a Pegasus Thread

object.  The top level code for a Thread can set a global

AcceptLanguages object that can be accessed by all the low-level

AcceptLanguageList object that can be accessed by all the low-level

functions that it calls.  This will allow an exception thrown by

the low-level function to be localized based on this global

AcceptLanguages object.  Note:  This applies only to Threads

AcceptLanguageList object.  Note:  This applies only to Threads

that are managed by a ThreadPool.

Each service in the request path of the Pegasus server sets the

AcceptLanguages into its Thread from the AcceptLanguages in the

AcceptLanguageList into its Thread from the AcceptLanguageList in the

CIMRequestMessage object that it dequeues.  This sets the global

langauge for all the functions in the same thread that are called below

handleEnqueue.  If you are writing a new service that processes

Line 1047

Line 1135

With all that background, here is how code running in a Pegasus

service can throw a localized exception:

This example assumes that the top-level code in the service had set the

global thread AcceptLanguages beforehand.  As described above,

global thread AcceptLanguageList beforehand.  As described above,

every service in Pegasus should do that.  The code here may be

buried several layers deep in the call chain, but does not need to know

the AcceptLanguage of the current client request.

the AcceptLanguagList of the current client request.

// First, construct a MessageLoaderParms

//

// Notes:

Line 1060

Line 1148

//  3) The MessageLoaderParms will default to use the Pegasus

server resource bundle

//  4) The MessageLoaderParms will default to use the

AcceptLanguages set into the current Thread.  Don't change this!

AcceptLanguageList set into the current Thread.  Don't change this!

//  5) You might need to set the arguments for the message into

the MessageLoaderParms

MessageLoaderParms parms("errorMessageID", "default message");

Line 1088

Line 1176

e.getMessage());

}

This type of code would have lost the ContentLanguages saved in "e",

This type of code would have lost the ContentLanguageList saved in "e",

so that the Content-Language would not be set in HTTP response to the

client.

For Pegasus 2.3, these types of macro calls can stay.  The

TraceableCIMException constructed by the macro will "re-localize". 

That is, the "CIM" part of the message (the part based on the error

code) will be localized at throw time, and the ContentLanguages

code) will be localized at throw time, and the ContentLanguageList

re-established.  A key is to avoid a "language mismatch" problem

between the CIM part of the message and the extra part of the

message.  The design point here is that all internal exceptions

thrown by Pegasus code are localized using the global AcceptLanguages

thrown by Pegasus code are localized using the global AcceptLanguageList

of the Thread...see above.

In the future, it will be safer and more maintainable to use of

Line 1118

Line 1206

e.getMessage( ));

}

This guarantees that the ContentLanguages in "e" is copied to the

This guarantees that the ContentLanguageList in "e" is copied to the

newly created TraceableCIMException.

In the case where the extra message for the CIMException is

Line 1176

Line 1264

<hr>

Company, L.P.; IBM Corp.; The Open Group

Permission is hereby granted, free of charge, to any person

Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

obtaining a copy  of this software and associated documentation

files (the "Software"), to deal in the Software without restriction,

IBM Corp.; EMC Corporation, The Open Group.

including without limitation the rights to use, copy, modify, merge,

publish, distribute, sublicense, and/or sell copies of the Software, and

IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

to permit persons to whom the Software is furnished to do so, subject

to the following conditions:

EMC Corporation; VERITAS Software Corporation; The Open Group.

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE

INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE

EMC Corporation; Symantec Corporation; The Open Group.

SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

Permission is hereby granted, free of charge, to any person obtaining a copy

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

of this software and associated documentation files (the "Software"), to

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

deal in the Software without restriction, including without limitation the

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

</body>

</html>

Legend:

Removed from v.1.5.2.1
changed lines
	Added in v.1.11

No CVS admin address has been configured