oracle.panama.messaging.transport
Interface CarrierFinder

public interface CarrierFinder

The carrier finder interface. CarrierFinder should be implemented by the customer as a part of the configuration. It then can be registered by an administrator an the CarrierFinder hook. The hook is optional and the expected semantics is to provide carrier info for message delivery request to help transport in making its routing decisions and enhance performance.

Author:

jxiang

Method Summary

void	destroy() Destroy the carrier finder.
void	getCarrierName(Destination d) Find the carrier name of a device.
void	getCarrierName(Destination[] d) Find the carrier names of a list of devices.
java.lang.String	getVersion() Get the version of the carrier finder.
void	init(java.util.Properties properties) Initialize the carrier finder.

Method Detail

init

public void init(java.util.Properties properties)

Initialize the carrier finder.

Parameters:

properties - the carrier finder's properties.

destroy

public void destroy()

Destroy the carrier finder.

getVersion

public java.lang.String getVersion()

Get the version of the carrier finder.

Returns:

the version of the carrier finder.

getCarrierName

public void getCarrierName(Destination d)

Find the carrier name of a device. The finder will set the device's carrier to the found name if found. If the device's carrier name is already set, the finder should not change it.

Parameters:

d - the destination device.

getCarrierName

public void getCarrierName(Destination[] d)

Find the carrier names of a list of devices. The finder should set the devices' carriers to those found name if so. If any device's carrier name is already set, the finder should not change it.

Parameters:

d - the destination devices.