Troubleshooting the Web messaging service

The following section contains troubleshooting information when using the Web messaging service.


Runtime enablement reference

The Web messaging service run time must be installed and enabled before a Web messaging enabled application is installed. If you install a Web messaging enabled application without the run time installed and enabled, the following error message is displayed, along with a 503 servlet error, when you try to access a Web messaging URI:

    CWPSB1701E:The Web messaging service is not configured for the following incoming URI: /uri

When you encounter this message, you should first verify the Web messaging service is installed and enabled. See Enabled the Web messaging service for more details. Successful installation and enablement of the Web messaging service displays the following log messages on server start:

     CWPSB1102I: The Web messaging service has started.

If you still encounter a configuration error after the Web messaging service is installed and enabled, verify the following:

Client error message reference

The Web messaging service uses the Bayeux protocol. For most Bayeux protocol messages fields there is a successful Boolean field and an associated error field. If a Bayeux operation is unsuccessful, the Web messaging service attempts to send error information to assist application developers and end users in determining why the operation failed. The Bayeux error string format contains 3 arguments separated by colons. The first argument is an error code for easy comparison purposes. The second argument is a comma separated list of arguments that are involved in the failure. The last argument is a short description of the error message. Example error messages follow:

The following table lists most error messages that the Web messaging service send to Bayeux clients when an operation fails. Refer to this table when debugging client failures. In many cases, check the server logs for additional information when encountering these client errors.

Error Code Short Description Arguments Description
300 Version number mismatch Minimum and maximum versions passed to the server. The server could not find a version match for the client supplied version and minimum verison fields. In most cases, the server will request that the client re-handshake with a version number as supplied by the server in the version and minimumVersion fields.
301 Connection Type mismatch The connection types supplied by the client. The client tried to handshake or connect with a connection type not supported by the server. The handshake response will contain a list of supported connection types. If this error message is received during a handshake request, the client should try to reconnect with a valid value from the list of supported connection types. If this error is given in response to a connect request, the server will direct the client to rehandshake and agree on a common connection type.
302 Extension mismatch The extension provided. The Bayeux protocol provides an extension mechanism to enable function above what the Bayeux protocol supports. In some cases, an extension might be provided that is invalid. In this release, the server will ignore any unrecognized extensions.
400 The request could not be recognized by the server. none The client sent a request that was not recognized by the server. You might get this error message for the following reasons:
  • The client sent an request that contains invalid JSON.
  • The JSON request was not send as the message field in a form enconding post request.
401 The client ID specified is unknown. The client ID that is specified. This message is given when a server does not recognized the client ID. In most cases, this error message will be given with Bayeux advice mechanism telling the client to rehandshake and resubscribe to any previous topics subscribed to. This error occurs most often when:
  • The client is blindly trying to connect with an invalid client ID.
  • There was server failure or session affinity failed in a clustered environment.
  • The client tried to connect past a Bayeux session timeout.
402 The request is missing a required parameter. The missing parameter. The Bayeux protocol mandates required fields for many Bayeux messages. If a required field is missing, an error message will be thrown indicating which field is missing.
403 The channel specified is forbidden. The channel that is forbidden. If a client tried to subscribe or publish to a channel without the appropriate authorization permissions, this error will be sent back to the client.
404 The channel specified is unknown. The unknown channel. The client has tried to subscribe, unsubscribe or publish to a channel that is unknown. This error is thrown most often when multipleDestination channel format specified and the first argument does not match an existing service integration bus topic space or topic space alias.
405 The channel syntax specified is invalid. The invalid channel format. This message is given when an invalid channel format is specified. Please refer to the Bayeux protocol for information on valid Bayeux channel formats.
406 The extension field specified is invalid. The invalid extension field. This message is given when an invalid extension field is given. The Web messaging service implementation ignores supplied extension fields it does not recognized, so this error message should not be seen by clients.
407 The publish request has failed. The channel that publish request was issue on. This error messages indicates the publish request has failed. In most cases, this indicates the clientCanPublish option has been set to false.
408 The client does not have authorization to connect to receive or publish messages. none This error message is given during a handshake or connect request. In most cases, this error message is indicate of a problem configuring service integration bus security, in particular granting the bus connector role for this incoming user.
500 The server encountered an interal error and could not complete request. none An internal server error has been encountered. Check the server logs for more information.
503 Service unavailable. none An error communicating with a service integration bus has been encountered. This typically occurs when there is a failure communicating with a messaging engine, such as the messaging engine being stopped. Check the server logs for more information.


Terms of Use | Feedback