FileDocCategorySizeDatePackage
MessageEndpoint.javaAPI DocGlassfish v2 API4738Fri May 04 22:35:38 BST 2007javax.resource.spi.endpoint

MessageEndpoint

public interface MessageEndpoint
This defines a contract for a message endpoint. This is implemented by an application server.
version
1.0
author
Ram Jeyaraman

Fields Summary
Constructors Summary
Methods Summary
public voidafterDelivery()
This is called by a resource adapter after a message is delivered.

throws
ResourceException generic exception.
throws
ApplicationServerInternalException indicates an error condition in the application server.
throws
IllegalStateException indicates that the endpoint is in an illegal state for the method invocation. For example, this occurs when beforeDelivery and afterDelivery method calls are not paired.
throws
UnavailableException indicates that the endpoint is not available.

public voidbeforeDelivery(java.lang.reflect.Method method)
This is called by a resource adapter before a message is delivered.

param
method description of a target method. This information about the intended target method allows an application server to decide whether to start a transaction during this method call, depending on the transaction preferences of the target method. The processing (by the application server) of the actual message delivery method call on the endpoint must be independent of the class loader associated with this descriptive method object.
throws
NoSuchMethodException indicates that the specified method does not exist on the target endpoint.
throws
ResourceException generic exception.
throws
ApplicationServerInternalException indicates an error condition in the application server.
throws
IllegalStateException indicates that the endpoint is in an illegal state for the method invocation. For example, this occurs when beforeDelivery and afterDelivery method calls are not paired.
throws
UnavailableException indicates that the endpoint is not available.

public voidrelease()
This method may be called by the resource adapter to indicate that it no longer needs a proxy endpoint instance. This hint may be used by the application server for endpoint pooling decisions.