JavaEE API 8.0.1 · javax.resource.spi.endpoint.MessageEndpoint

Method Summary

Modifier and Type	Method and Description
public void	afterDelivery() This is called by a resource adapter after a message is delivered.
public void	beforeDelivery(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. method) This is called by a resource adapter before a message is delivered.
public void	release() This method may be called by the resource adapter to indicate that it no longer needs a proxy endpoint instance.

afterDelivery	back to summary
public void afterDelivery() throws ResourceException This is called by a resource adapter after a message is delivered. Exceptions ResourceException: generic exception. ApplicationServerInternalException: indicates an error condition in the application server. 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. UnavailableException: indicates that the endpoint is not available.

afterDelivery

public void afterDelivery() throws ResourceException

This is called by a resource adapter after a message is delivered.

Exceptions

ResourceException:: generic exception.
ApplicationServerInternalException:: indicates an error condition in the application server.
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.
UnavailableException:: indicates that the endpoint is not available.

beforeDelivery back to summary

beforeDelivery	back to summary
public void beforeDelivery(Method method) throws NoSuchMethodException, ResourceException This is called by a resource adapter before a message is delivered. Parameters method: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. Exceptions NoSuchMethodException: indicates that the specified method does not exist on the target endpoint. ResourceException: generic exception. ApplicationServerInternalException: indicates an error condition in the application server. 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. UnavailableException: indicates that the endpoint is not available.

public void beforeDelivery(Method method) throws NoSuchMethodException, ResourceException

This is called by a resource adapter before a message is delivered.

Parameters

method: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.

Exceptions

NoSuchMethodException:: indicates that the specified method does not exist on the target endpoint.
ResourceException:: generic exception.
ApplicationServerInternalException:: indicates an error condition in the application server.
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.
UnavailableException:: indicates that the endpoint is not available.

release	back to summary
public void release() 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.