Menu
Simba Technologies
Simba Technologies

SimbaEngine X SDK 10.1.3
Developing Drivers for Data Stores Without SQL

Including Error Message Files

This section describes the error message files used by the SDK for ODBC and JDBC drivers.

Error Messages in ODBC

The ODBC error messages are defined in .xml files. The table below describes each file, and explains which error message files must be included when you distribute your driver.

Error Message File Name Description Do I Need to Ship this File?

ODBCMessages.xml

Contains the error messages for the ODBC, DSI, and Support components.

Yes, always with your driver.

If you distribute SimbaClient for ODBC, you will also need to include this file.

SQLEngineMessages.xml

Contains the error messages for the SimbaEngine components.

Only if your driver uses SimbaEngine.

ClientMessages.xml

Contains the error messages for SimbaClient for ODBC.

Only if you are distributing SimbaClient for ODBC.

CSCommonMessages.xml

Contains the error messages for the Client/Server protocol components.

Only if you have built your driver as a server.

If you distribute SimbaClient for ODBC, you will also need to include this file.

ServerMessages.xml

Contains the error messages for SimbaServer.

Only if you have built your driver as a server.

CLIDSIMessages.xml

Contains the error messages for the CLIDSI component.

Only if your driver uses the CLIDSI component.

JNIDSIMessages.xml

Contains the error messages for the JNIDSI component.

Only if your driver uses the JNIDSI component.

Organizing your ODBC Error Message Files

By default the SDK uses the English – United States (en-US) locale. You can add support for additional locales by organizing your additional language files in one of the following ways:

Subdirectory organization

You can store each locale’s message files in a subdirectory, where the subdirectory is named using the locale code.

Example: Subdirectory organization of message files

...\ErrorMessages\en-US\ODBCMessages.xml

...\ErrorMessages\fr-CA\ODBCMessages.xml

...\ErrorMessages\ja-JA\ODBCMessages.xml

Single directory organization

You can store all message files for every locale in a single folder. The name of each locale is added as a suffix in the file names.

Example: Single directory organization of message files

...\ErrorMessages\ODBCMessages_en-US.xml

...\ErrorMessages\fr-CA\ODBCMessages_fr-CA.xml

...\ErrorMessages\ja-JA\ODBCMessages_ja.xml

Error Messages in JDBC

The JDBC error messages are divided into several files. The table below describes each file, and explains which error message files must be included when you distribute your driver.

Error Message File Name Description Do I Need to Ship this File?

JDBCMessages.properties

Contains the error messages for the JDBC component.

Yes, always with your driver.

If you distribute SimbaClient for JDBC, you will also need to include this file.

DSIMessages.properties

Contains the error messages for the DSI and Support components.

Yes, always with your driver.

If you distribute SimbaClient for JDBC, you will also need to include this file.

CSMessages.properties

CommunicationsMessages.properties

Messages.properties

Contains the error messages for SimbaClient for JDBC and the Client/Server protocol components.

Only if you are distributing SimbaClient for JDBC.

Organizing your JDBC Error Message Files

By default, the SDK uses the English – United States (en-US) locale. You can add support for additional locales using Java Resource Bundles.

The common convention for localization with resource bundles is to organize the error message files in a hierarchy. This ensures that messages from a parent message file will be used, even if a locale is not supported.

For example, the structure for message files could be organized in the following hierarchy. In this example, is the base file name is messages:

                                  

Note:

Each message file must be registered separately with DSIMessageSource .

 

Related Links

Handling Errors and Exceptions

Posting Warning Messages

Localizing Messages