oracle.sdp.messaging.driver
Interface DriverResourceAdapter

All Superinterfaces:

javax.resource.spi.ResourceAdapter, Serializable

All Known Implementing Classes:

DriverResourceAdapterBase

public interface DriverResourceAdapter
extends javax.resource.spi.ResourceAdapter, Serializable

This interface defines the specification for a Driver RA implementation.

Note: To write a new Messaging Driver RA, extend the DriverResourceAdapterBase class which is an abstract implementation of this interface.

For example:

 public class XXXDriverResourceAdapter extends DriverResourceAdapterBase {
    ...
    
    public void startDriver(DriverContext context) throws DriverException {
      ...
    }

    public void stopDriver() throws DriverException {
      ...
    }
    
 }
 

Since:

11.0.0

Method Summary

WorkingStateType	startDriver(DriverContext context) The DriverResourceAdapterBase calls this method to start the driver RA.
void	stopDriver() The DriverResourceAdapterBase calls this method to allow the driver RA to perform any clean up before stopping.

Methods inherited from interface javax.resource.spi.ResourceAdapter

endpointActivation, endpointDeactivation, getXAResources, start, stop

Method Detail

startDriver

WorkingStateType startDriver(DriverContext context)
                             throws DriverException

The DriverResourceAdapterBase calls this method to start the driver RA. Upon completion of this call, the DriverResourceAdapterBase registers the driver with the engine if the driver has successfully started.

Parameters:

context - the driver context

Returns:

the current working state: RUNNING indicates driver is successfully initialized and can be registered with the engine, INITIALIZING indicates driver is still initializing, and driver registration should wait until initialization is complete.

Throws:

DriverException - indicates a problem during driver startup.

stopDriver

void stopDriver()
                throws DriverException

The DriverResourceAdapterBase calls this method to allow the driver RA to perform any clean up before stopping.

Throws:

DriverException - indicates a problem during driver shutdown.