Error Handling

The main role of WSO2 Enterprise Integrator (WSO2 EI) is to act as the backbone of an organization’s service-oriented architecture. It is the spine through which all the systems and applications within the enterprise (and external applications that integrate with the enterprise) communicate with each other. For example, an ESB (which is contained in WSO2 EI) often has to deal with many wire-level protocols, messaging standards, and remote APIs. But applications and networks can be full of errors. Applications crash. Network routers and links get into states where they cannot pass messages through with the expected efficiency. These error conditions are very likely to cause a fault or trigger a runtime exception in the ESB.

Using fault sequences

WSO2 EI provides fault sequences for dealing with errors. A fault sequence is a collection of mediators just like any other sequence, and it can be associated with another sequence or a proxy service. When the sequence or the proxy service encounters an error during mediation or while forwarding a message, the message that triggered the error is delegated to the specified fault sequence. Using the available mediators it is possible to log the erroneous message, forward it to a special error-tracking service, and send a SOAP fault back to the client indicating the error or even send an email to the system admin.

It is not mandatory to associate each sequence and proxy service with a fault sequence. In situations where a fault sequence is not specified explicitly, a default fault sequence will be used to handle errors. Sample 4: Specifying a Fault Sequence with a Regular Mediation Sequence shows how to specify a fault sequence with a regular mediation sequence.

Whenever an error occurs in WSO2 EI, the mediation engine attempts to provide as much information as possible on the error to the user by initializing the following properties on the erroneous message:

• ERROR_CODE
• ERROR_MESSAGE
• ERROR_DETAIL
• ERROR_EXCEPTION      

Within the fault sequence, you can access these property values using the get-property XPath function. Sample 4 uses the log mediator as follows to log the actual error message:  
<log level="custom">
  <property name="text" value="An unexpected error occured"/>
    <property name="message" expression="get-property('ERROR_MESSAGE')"/>      
</log>  

Note how the ERROR_MESSAGE property is being used to get the error message text. If you want to customize the error message that is sent back to the client, you can use the Fault mediator as demonstrated in Sample 5: Creating SOAP Fault Messages and Changing the Direction of a Message.

Error codes

This section describes error codes and their meanings.

Transport error codes

If the HTTP PassThrough transport is used, and a connection-level error occurs, the error code is calculated using the following equation:

Error code = Base error code + Protocol State

The sender side of the transport matches the protocol state, which changes according to the phase of the message.

Following are the possible protocol states and the description for each:

Since there are several possible protocol states in which a request can time out, you can calculate the error code accordingly using the values in the table above. For example, in a scenario where you send a request and the request is completely sent to the backend, but a timeout happens before the response headers are received, the error code is calculated as follows:

In this scenario, the base error code is CONNECTION_TIMEOUT(101504) and the protocol state is REQUEST_DONE(3).

Therefore, 

Error code = 101504 + 3 = 101507

Endpoint failures

This section describes the error codes for endpoint failures. For more information on handling endpoint errors, see Endpoint Error Handling.

General errors

Failure on endpoint in the session

Non-fatal warnings

Referring real endpoint is null

Callout operation failed

XML / JSON parsing errors

Custom error codes