com.sap.aii.af.service.administration.api.monitoring

Interface ChannelSelfTestCallback

All Superinterfaces:

AdapterCallback

public interface ChannelSelfTestCallback
extends AdapterCallback

The ChannelSelfTestCallback defines a callback method, which can be implemented by adapters in order to carry out a suite of self-tests. This can be triggered by the user in the monitoring UI. The self-tests are carried out in the context of a particular channel.

The implementing class of the callback needs to be registered by calling AdapterRegistry.registerAdapter(String, String, com.sap.aii.af.service.administration.api.AdapterCapability[], AdapterCallback[])

See Also:

AdapterRegistry, AdapterRegistryFactory

Method Summary

Modifier and Type	Method and Description
com.sap.aii.utilxi.rtcheck.base.TestSuitResult	testChannel(Channel channel, Locale locale) This callback method notifies the ChannelSelfTestCallback implementation whenever the user wants to check the health status of the existing Channel objects.

Method Detail

testChannel

com.sap.aii.utilxi.rtcheck.base.TestSuitResult testChannel(Channel channel,
                                                           Locale locale)

This callback method notifies the ChannelSelfTestCallback implementation whenever the user wants to check the health status of the existing Channel objects. The implementation is supposed to construct and return a TestSuitResult object which contains the results of the self-test.

When providing textual information, the adapter should make use of the locale provided and use a localized version of texts. If no matching translation is available, the adapter should use English texts instead.

Parameters:

channel - the Channel object whose status needs to be found out

locale - the locale in which the result of the test needs to be displayed in

Returns:

a TestSuitResult object containing the test results

See Also:

TestSuitResult