Skip to content

BSL278 — Wrong handler for web service

← All rules

Summary

Wrong handler for web service

Identifiers

Field Value
Rule code BSL278
Compatible alias WrongWebServiceHandler
Severity ERROR
Enabled by default Yes
Implemented Yes
Tags correctness, web-service

Behavior

  • The public identifier BSL278 and alias WrongWebServiceHandler are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL278"]
ignore = ["WrongWebServiceHandler"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL278
  • bsl-disable:
Value = "example";  // bsl-disable: BSL278
  • compatible BSLLS form:
Value = "example";  // BSLLS:WrongWebServiceHandler-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL278
// code without this diagnostic
// noqa-enable: BSL278

// bsl-disable: BSL278
// code without this diagnostic
// bsl-enable: BSL278

// BSLLS:WrongWebServiceHandler-off
// code without this diagnostic
// BSLLS:WrongWebServiceHandler-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

If there is no web-service operation handler, then the call to the operation will return neither data, nor errors on the client side of the service, nor errors on the side of the service itself.

It is important to remember: the number of parameters of the web service operation method must match the number of parameters specified in the settings of the web service operation.

The configurator notices violations only when the "Check for the existence of assigned handlers" flag is enabled.

Examples

Invalid handler method with empty body 

Function FillCatalogs(MobileDeviceID, MessageExchange)

EndFunction

Correct handler method - there is a method body and the correct set of parameters is specified 

Function FillCatalogs(MobileDeviceID, MessageExchange)
    Return MobileOrders.FillCatalogs(MobileDeviceID, MessageExchange);
EndFunction

Invalid handler method with the wrong number of parameters 

Function FillCatalogs(MobileDeviceID, MessageExchange, Additional)
Return MobileOrders.FillCatalogs(MobileDeviceID, MessageExchange);
EndFunction

Sources