IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Adapter Toolkit > Implementing code from the IBM WebSphere Adapter Toolkit > Problem determination
Exception messages
Exception messages, like trace messages, convey information about problems. The difference is that exception messages are tailored more directly to support teams familiar with adapter source code, and therefore need not be translated.
Treat text included in exception messages as you would text for trace messages. In general, exception messages are not directed at general users but rather at support teams who have the ability to investigate adapter source code. For that reason, exception messages need not be translated and can be hard-coded. If an exception is thrown and the customer must be informed of the problem, use an appropriate log message, which can be translated, to inform the customer; refrain from simply printing out the contents of the exception.
When implementing an adapter exception message, do the following:
- Define subclasses of ResourceException where appropriate and include relevant properties on these implementations
- Raise the exception with a message that can be hard-coded in English.
- Print the stack trace of the exception using the trace API. This allows support teams to see all exception details.
- When appropriate, the exception messages raised should have a corresponding high-level message in the LogMessages.properties file. The developer should log this high-level message after raising the exception so that general users can see an explanation of the error in their native language.