oracle.panama.messaging.transport
Interface DriverFinder

public interface DriverFinder

The driver finder interface. DriverFinder should be implemented by the customer as a part of the configuration. It can then be registered as the DriverFinder hook by an admistrator. The expected semantics of this hook is to map an address to a set of driver instances. This is optional and when provided might be able to fill in the driver info that the application developer might not know, helping the transport system to make its routing decision and enhance its performance.

Author:

jxiang

Method Summary

void	destroy() Destroy the driver finder.
void	getDriver(Destination[] d, Message m) Find a list of driver names of driver instances which can be used to send messages to a given list of devices.
void	getDriver(Destination d, Message m) Find the name of a driver instance which can be used to send messages to a given device.
java.lang.String	getDriver(DeviceInfo d, MessageInfo mi, Message m) Find the name of a driver instance which can be used to send messages to device of given info.
java.lang.String	getVersion() Get the version of the driver finder.
void	init(java.util.Properties properties) Initialize the driver finder.

Method Detail

init

public void init(java.util.Properties properties)

Initialize the driver finder.

Parameters:

properties - the driver finder's properties.

destroy

public void destroy()

Destroy the driver finder.

getVersion

public java.lang.String getVersion()

Get the version of the driver finder.

Returns:

the version of the driver finder.

getDriver

public java.lang.String getDriver(DeviceInfo d,
MessageInfo mi,
Message m)

Find the name of a driver instance which can be used to send messages to device of given info.

Parameters:

d - the destination device info.

mi - the message info.

m - the message to send.

Returns:

the driver instance name.

getDriver

public void getDriver(Destination d,
Message m)

Find the name of a driver instance which can be used to send messages to a given device. The finder should set the device's driver to the found driver's name. If the device's driver name is already set, the finder should not change it.

Parameters:

d - the destination device.

m - the message to send.

getDriver

public void getDriver(Destination[] d,
Message m)

Find a list of driver names of driver instances which can be used to send messages to a given list of devices. The finder should set the devices' drivers to those found drivers' names. If a device's driver name is already set, the finder should not change it.

Parameters:

d - the destination devices.

m - the message to send.