commonj.connector.metadata.description
Interface InboundServiceDescription

All Superinterfaces:
ServiceDescription

public interface InboundServiceDescription
extends ServiceDescription

Describes a service for inbound communication from the EIS to the application server. Instances of this interface are created by the resource adapter's metadata discovery implementation during metadata discovery through the MetadataDiscovery interface.

Since:
1.0

Method Summary
 String getFunctionSelectorClassName()
          Returns the fully qualified class name of the desired FunctionSelector class.
 InboundConnectionConfiguration getInboundConnectionAdvancedConfiguration()
          Returns the inbound connection configuration of this service.
 String getListenerClassName()
          Returns the fully qualified class name of the desired Listener interface class which the message driven bean must implement for the inbound service.
 void setInboundConnectionAdvancedConfiguration(InboundConnectionConfiguration input)
          Sets the inbound connection configuration of this service.
 
Methods inherited from interface commonj.connector.metadata.description.ServiceDescription
getBindingDescription, getComment, getFunctionDescriptions, getMetadataConnectionConfiguration, getMetadataSelectionProperties, getName
 

Method Detail

getInboundConnectionAdvancedConfiguration

InboundConnectionConfiguration getInboundConnectionAdvancedConfiguration()
Returns the inbound connection configuration of this service.

Returns:
Returns the inbound connection configuration of this service. The returned value must not be null.

setInboundConnectionAdvancedConfiguration

void setInboundConnectionAdvancedConfiguration(InboundConnectionConfiguration input)
                                               throws MetadataException
Sets the inbound connection configuration of this service. It may be necessary to edit and set the configuration returned from a discovery if it is not complete. For example, the discovery service may not be able to determine all the values necessary for creating a connection.

Parameters:
input - Set the inbound connection properties for this service.
Throws:
MetadataException - Thrown when the InboundConnectionAdvancedConfiguration is not from the adapter ConnectionType or is null. It is valid to set an incomplete InboundConnectionAdvancedConfiguration.

getFunctionSelectorClassName

String getFunctionSelectorClassName()
Returns the fully qualified class name of the desired FunctionSelector class. This class will be used to instantiate instances of FunctionSelector that the runtime will use to map the inbound message to the correct function on the service description.

The FunctionSelector class must be visible to the classLoader of the resource adapter. It is recommended to package it with the resource adapter. The class must also have a public default constructor.

Returns:
The fully qualified class name of the desired FunctionSelector class.
See Also:
FunctionSelector

getListenerClassName

String getListenerClassName()
Returns the fully qualified class name of the desired Listener interface class which the message driven bean must implement for the inbound service. It is recommended to use the MessageListener or InboundListener interfaces.

Returns:
The fully qualified class name of the Listener interface that the message driven bean must implement.
See Also:
InboundListener, MessageListener