Adapter Interface Reference

Adapter interface (required). More...

Public Member Functions
abstract Connection	createConnection (String routingServiceName, String routingServiceGroupName, StreamReaderListener inputStreamDiscoveryListener, StreamReaderListener outputStreamDiscoveryListener, Properties properties) throws AdapterException
	Creates a com.rti.routingservice.adapter.Connection. More...
abstract void	deleteConnection (Connection connection) throws AdapterException
	Deletes a com.rti.routingservice.adapter.Connection. More...
abstract Version	getVersion ()
	Returns the version of this adapter plugin. More...

Detailed Description

Adapter interface (required).

Java adapters are registered with RTI Routing Service using the XML tag <java_adapter_plugin>

For example:

<dds>
    ...
    <adapter_library name="MyAdapterLib">
        <java_adapter_plugin name="MyAdapterPlugin">
            <class_name>com.rti.adapters.MyAdapter</class_name>
        </java_adapter_plugin>
        ...
    </adapter_library>
    ...
    <routing_service>
    ...
    </routing_service>
    ...
</dds>

In the above example, the interface is implemented by the com.rti.adapters.MyAdapter class.

When RTI Routing Service creates a Java adapter, it uses a constructor with one java.lang.Properties parameter. Those properties contain the configuration of the adapter and, in addition, the following special properties:

• rti.routing_service.app_name: whose value contains the given application name
• rti.routing_service.group_name: whose value represents the given group_name
• rti.routing_service.version: whose value represents the RTI Routing Service version
• rti.routing_service.verbosity: whose value represents the verbosity in use by RTI Routing Service and is one of the following strings: NONE, EXCEPTION, WARN, INFO, DEBUG.

If that constructor is not found the constructor with no parameters is used instead.

Member Function Documentation

createConnection()

abstract Connection createConnection ( String  routingServiceName, String  routingServiceGroupName, StreamReaderListener  inputStreamDiscoveryListener, StreamReaderListener  outputStreamDiscoveryListener, Properties  properties  ) throws AdapterException

abstract

Creates a com.rti.routingservice.adapter.Connection.

A Connection provides access to a data domain (such as a DDS domain or a JMS network provider).

Connection objects are created when the DomainRoutes that contain them are enabled.

Required: Yes

Parameters

routingServiceName	<<in>> The routing service execution name.
routingServiceGroupName	<<in>> The group name of the routing service execution.
inputStreamDiscoveryListener	<<in>> The listener of the built-in StreamReader that notifies the discovery of new input streams.
outputStreamDiscoveryListener	<<in>> The listener of the built-in StreamReader that notifies the discovery of new output streams.

Parameters

properties

<<in>> Configuration properties for the Connection.

Returns

New Connection if successful.

Exceptions

AdapterException

- if an error occurs.

See also

com.rti.routingservice.adapter.Adapter.deleteConnection

deleteConnection()

abstract void deleteConnection ( Connection  connection ) throws AdapterException

abstract

Deletes a com.rti.routingservice.adapter.Connection.

Connection objects are deleted when the DomainRoutes that contain them are disabled or RTI Routing Service is closed.

Required: Yes

Parameters

connection

<<in>> Connection to be deleted

Exceptions

AdapterException

- if an error occurs.

See also

com.rti.routingservice.adapter.Adapter.createConnection

getVersion()

abstract Version getVersion ( )

abstract

Returns the version of this adapter plugin.