com.bea.wli.sb.transports
Interface TransportEndPoint

public interface TransportEndPoint

A transport endpoint is an ALSB entity/resource where service messages are originated or targeted

Nested Class Summary

static class

TransportEndPoint.MessagePatternEnum SYNCHRONOUS and ASYNCHRONOUS imply the endpoint uses request/response paradigm.

Method Summary

RequestMetaData	createRequestMetaData()
RequestMetaData	createRequestMetaData(org.apache.xmlbeans.XmlObject rmdXML)
EndPointConfiguration	getConfiguration()
TransportEndPoint.MessagePatternEnum	getMessagePattern() A given endpoint may utilize one of the following message patterns: One Way - meaning no responses are expected, e.g.
TransportProvider	getProvider()
Ref	getServiceRef()
URI[]	getURI()
boolean	isInbound()
boolean	isTransactional()

Method Detail

getServiceRef

Ref getServiceRef()

Returns:

the reference to the service representing this endpoint

getURI

URI[] getURI()

Returns:

the array of URIs for this endpoint. Inbound endpoints will have a single URI, whereas outbound endpoints will be associated with multiple URIs

isInbound

boolean isInbound()

Returns:

true if this is an inbound endpoint

getConfiguration

EndPointConfiguration getConfiguration()

Returns:

an XML Bean that describes the configuration of this endpoint. Configuration properties are specific to the provider type for this endpoint.

getProvider

TransportProvider getProvider()

Returns:

the transport provider for this endpoint

createRequestMetaData

RequestMetaData createRequestMetaData()
                                      throws TransportException

Returns:

empty (new) meta-data for the request part of the outbound message, e.g. headers, etc.

Throws:

TransportException

createRequestMetaData

RequestMetaData createRequestMetaData(org.apache.xmlbeans.XmlObject rmdXML)
                                      throws TransportException

Returns:

return meta-data for the request part of the outbound message initialized according to provider-defined XmlBean representation.

Throws:

TransportException

isTransactional

boolean isTransactional()
                        throws TransportException

Returns:

returns whether or not this endpoint uses transactions

Throws:

TransportException

getMessagePattern

TransportEndPoint.MessagePatternEnum getMessagePattern()
                                                       throws TransportException

A given endpoint may utilize one of the following message patterns:

• One Way - meaning no responses are expected, e.g. JMS proxy service that does not expect a response
• Synchronous – request/response is implied. The response message is paired with the request message implicitly by the virtue of not having any other traffic on the transport channel from the time the request is issued until the time the response is received. In most cases this implies blocking calls for outbound requests. An example of this is EJB endpoint.
• Asynchronous - request/response is implied. Not synchronous. The response is correlated to a request via some transport-specific mechanism. An example of this is JMS business service endpoint with request/reply

Returns:

returns the type of messaging pattern for this endpoint

Throws:

TransportException