com.sonicsw.xq.adapter
Interface XQResourceAdapter

public interface XQResourceAdapter

Users must provide an implementation of XQResourceAdapter for any EIS that they wish to asynchronously receive messages from. The application server will call start on the adapter when it is first referenced as an entry. All calls to subscribe will result from the configuration of a listener on an entry endpoint of the defined type. This interface is an interim solution until JCA 1.5 is released. Upon release, these interfaces will be deprecated and replaced with the apporiate javax.resource defined interfaces.

Method Summary

void	start() called when the adapter is first referenced
void	stop() called when the adapter is being removed from the system
void	subscribe(XQMessageListenerFactory mlf, java.util.Map subscriptionSpec) add a subscription for the particular factory for messages that conform to the subscriptionSpec
void	unsubscribe(XQMessageListenerFactory mlf, java.util.Map subscriptionSpec) removes the factory from the subscribers

Method Detail

start

void start()

called when the adapter is first referenced

stop

void stop()

called when the adapter is being removed from the system

subscribe

void subscribe(XQMessageListenerFactory mlf,
               java.util.Map subscriptionSpec)
               throws NotSupportedException

add a subscription for the particular factory for messages that conform to the subscriptionSpec

Parameters:

mlf - the factory to subscribe

subscriptionSpec - the RA specific propertied describing the subscription

Throws:

NotSupportedException - thrown when the RA cannot accept subscriptions

unsubscribe

void unsubscribe(XQMessageListenerFactory mlf,
                 java.util.Map subscriptionSpec)

removes the factory from the subscribers

Parameters:

mlf - the factory to unsubscribe

subscriptionSpec - the properties of the subscription