Class AbstractMessageEndpointFactory.AbstractMessageEndpoint

java.lang.Object

org.springframework.jca.endpoint.AbstractMessageEndpointFactory.AbstractMessageEndpoint

All Implemented Interfaces:

jakarta.resource.spi.endpoint.MessageEndpoint

Enclosing class:

AbstractMessageEndpointFactory

protected abstract class AbstractMessageEndpointFactory.AbstractMessageEndpoint
extends Object
implements jakarta.resource.spi.endpoint.MessageEndpoint

Inner class for actual endpoint implementations, based on template method to allow for any kind of concrete endpoint implementation.

Since:

2.5

Author:

Juergen Hoeller

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessageEndpoint()

Method Summary

Modifier and Type	Method	Description
void	afterDelivery()	This afterDelivery implementation resets the thread context ClassLoader and completes the transaction, if any.
void	beforeDelivery(@Nullable Method method)	This beforeDelivery implementation starts a transaction, if necessary, and exposes the endpoint ClassLoader as current thread context ClassLoader.
protected abstract ClassLoader	getEndpointClassLoader()	Template method for exposing the endpoint's ClassLoader (typically the ClassLoader that the message listener class has been loaded with).
protected final boolean	hasBeforeDeliveryBeenCalled()	Return whether the beforeDelivery(Method) method of this endpoint has already been called.
protected void	onEndpointException(Throwable ex)	Callback method for notifying the endpoint base class that the concrete endpoint invocation led to an exception.
void	release()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractMessageEndpoint

protected AbstractMessageEndpoint()

Method Details

beforeDelivery

public void beforeDelivery(@Nullable Method method)
                    throws jakarta.resource.ResourceException

This beforeDelivery implementation starts a transaction, if necessary, and exposes the endpoint ClassLoader as current thread context ClassLoader.

Note that the JCA 1.7 specification does not require a ResourceAdapter to call this method before invoking the concrete endpoint. If this method has not been called (check hasBeforeDeliveryBeenCalled()), the concrete endpoint method should call beforeDelivery and its sibling afterDelivery() explicitly, as part of its own processing.

Specified by:

beforeDelivery in interface jakarta.resource.spi.endpoint.MessageEndpoint

Throws:

jakarta.resource.ResourceException

getEndpointClassLoader

protected abstract ClassLoader getEndpointClassLoader()

Template method for exposing the endpoint's ClassLoader (typically the ClassLoader that the message listener class has been loaded with).

Returns:

the endpoint ClassLoader (never null)

hasBeforeDeliveryBeenCalled

protected final boolean hasBeforeDeliveryBeenCalled()

Return whether the beforeDelivery(Method) method of this endpoint has already been called.

onEndpointException

protected void onEndpointException(Throwable ex)

Callback method for notifying the endpoint base class that the concrete endpoint invocation led to an exception.

To be invoked by subclasses in case of the concrete endpoint throwing an exception.

Parameters:

ex - the exception thrown from the concrete endpoint

afterDelivery

public void afterDelivery()
                   throws jakarta.resource.ResourceException

This afterDelivery implementation resets the thread context ClassLoader and completes the transaction, if any.

Note that the JCA 1.7 specification does not require a ResourceAdapter to call this method after invoking the concrete endpoint. See the explanation in beforeDelivery(Method)'s javadoc.

Specified by:

afterDelivery in interface jakarta.resource.spi.endpoint.MessageEndpoint

Throws:

jakarta.resource.ResourceException

release

public void release()

Specified by:

release in interface jakarta.resource.spi.endpoint.MessageEndpoint