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

Interface ChannelStatusCallback

All Superinterfaces:

AdapterCallback

public interface ChannelStatusCallback
extends AdapterCallback

A callback registered with the Adapter Framework to provide channel status information on demand.

The implementing class of the callback needs to be registered by calling AdapterRegistry.registerAdapter.

This callback obsoletes the com.sap.aii.af.monitor.api.AdapterMonitor callback used with earlier versions of the XI Adapter Framework and still offered for backwards compatibility.

If reporting channel state information by registering an instance of this callback, an adapter must not report channel state information via the MonitoringManager.reportChannelStatus API.

Version:

$Id: //tc/xpi.af/710_SP_REL/src/_af_service/psrv/api/com/sap/aii/af/service/administration/api/monitoring/ChannelStatusCallback.java#1 $

See Also:

AdapterRegistry, AdapterRegistryFactory, MonitoringManager

Method Summary

ChannelStatus

getChannelStatus(Channel channel, Locale locale) This method is invoked by the Adapter Framework to obtain detailed status information for a channel from an adapter.

Method Detail

getChannelStatus

ChannelStatus getChannelStatus(Channel channel,
                               Locale locale)
                               throws ChannelUnknownException

This method is invoked by the Adapter Framework to obtain detailed status information for a channel from an adapter. The adapter is supposed to construct and return a ChannelStatus container using ChannelStatusFactory after populating it with status information.

When providing textual status 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 to provide status information for

locale - the locale to provide any textual status information in

Returns:

a ChannelStatus container filled with status information about the channel

Throws:

ChannelUnknownException - if the adapter does not recognize the specified channel

See Also:

ChannelStatus, ChannelStatusFactory