commonj.connector.metadata.description
Interface OutboundServiceDescription

All Superinterfaces:
ServiceDescription

public interface OutboundServiceDescription
extends ServiceDescription

Describes a service using outbound communication from the application server to invoke functions in an EIS. Instances of this interface are created by the resource adapter's metadata discovery and import implementation through the MetaDataDiscovery interface.

Since:
1.0

Method Summary
 OutboundConnectionConfiguration getOutboundConnectionAdvancedConfiguration()
          Returns the outbound connection configuration, which contains the connection information to the EIS system.
 void setOutboundConnectionAdvancedConfiguration(OutboundConnectionConfiguration input)
          Sets the outbound connection configuration of this service.
 
Methods inherited from interface commonj.connector.metadata.description.ServiceDescription
getBindingDescription, getComment, getFunctionDescriptions, getMetadataConnectionConfiguration, getMetadataSelectionProperties, getName
 

Method Detail

getOutboundConnectionAdvancedConfiguration

OutboundConnectionConfiguration getOutboundConnectionAdvancedConfiguration()
Returns the outbound connection configuration, which contains the connection information to the EIS system.

Returns:
OutboundConnectionAdvancedConfiguration Returns the outbound connection information for the EIS. The returned value must not be null.

setOutboundConnectionAdvancedConfiguration

void setOutboundConnectionAdvancedConfiguration(OutboundConnectionConfiguration input)
                                                throws MetadataException
Sets the outbound 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 outbound connection properties for this service.
Throws:
MetadataException - Thrown when the OutboundConnectionAdvancedConfiguration is not from the adapter ConnectionType or is null. It is valid to set an incomplete OutboundConnectionAdvancedConfiguration.