com.sonicsw.xq
Interface XQEndpoint

public interface XQEndpoint

An XQEndpoint is a logical destination that is used to link Business Services. An endpoint provides queuing and persistence between Business Services. This persistence is what allows a Business Process to be fault-tolerant, and provides the overall guarantees of processing over provider failures. XQEndpoints are named entities and are accessed via the XQEndpointManager.

See Also:

XQEndpointManager

Method Summary

XQMessage	call(XQMessage request, long timeout) Sends a message to the endpoint and waits for a reply.
XQMessage	createMessage() Create an XQMessage that is (possibly) optimized for this endpoint.
java.lang.String	getName() Returns the string name of the endpoint.

Method Detail

getName

java.lang.String getName()

Returns the string name of the endpoint.

Returns:

the name of the endpoint.

call

XQMessage call(XQMessage request,
               long timeout)
               throws XQEndpointException,
                      XQEndpointTimeoutException

Sends a message to the endpoint and waits for a reply. The assumption is that the endpoint is connected to some service that will return a reply. Null is returned if no message is returned in the timeout.

Parameters:

request - The request message.

timeout - The number of milliseconds to wait for a reply.

Returns:

The reply message.

Throws:

XQEndpointException - In the event of some provider failure.

XQEndpointTimeoutException - In the event of a timeout.

createMessage

XQMessage createMessage()
                        throws XQEndpointException

Create an XQMessage that is (possibly) optimized for this endpoint. The message created can be sent to any endpoint, however, the provider can initialize the message in a way that minimizes system resources, or copying, when the message is send to this endpoint.

Returns:

A message.

Throws:

XQEndpointException - In the event of some provider failure.