public interface ResourceAdapter
Modifier and Type | Method and Description |
---|---|
void |
endpointActivation(MessageEndpointFactory endpointFactory,
ActivationSpec spec)
This is called during the activation of a message endpoint.
|
void |
endpointDeactivation(MessageEndpointFactory endpointFactory,
ActivationSpec spec)
This is called when a message endpoint is deactivated.
|
javax.transaction.xa.XAResource[] |
getXAResources(ActivationSpec[] specs)
This method is called by the application server during crash recovery.
|
void |
start(BootstrapContext ctx)
This is called when a resource adapter instance is bootstrapped.
|
void |
stop()
This is called when a resource adapter instance is undeployed or
during application server shutdown.
|
void start(BootstrapContext ctx) throws ResourceAdapterInternalException
During this method call a ResourceAdapter JavaBean is responsible for initializing the resource adapter instance. Any exception thrown during this method call causes the application server to abort the bootstrap procedure for this specific resource adapter instance.
ctx
- a bootstrap context containing references to
useful facilities that could be used by a resource adapter instance.ResourceAdapterInternalException
- indicates bootstrap failure.
The resource adapter instance is unusable and must be discarded.void stop()
During this method call, a ResourceAdapter JavaBean is responsible for performing an orderly shutdown of the resource adapter instance. Any exception thrown by this method call does not alter the processing of the application server shutdown or resource adapter undeployment that caused this method call. The application server may log the exception information for error reporting purposes.
void endpointActivation(MessageEndpointFactory endpointFactory, ActivationSpec spec) throws ResourceException
Endpoint activation is deemed successful only when this method completes successfully without throwing any exceptions.
endpointFactory
- a message endpoint factory instance.spec
- an activation spec JavaBean instance.NotSupportedException
- indicates message endpoint
activation rejection due to incorrect activation
setup information.ResourceException
void endpointDeactivation(MessageEndpointFactory endpointFactory, ActivationSpec spec)
endpointActivation
call.
This causes the resource adapter to stop delivering messages to the
message endpoint.
Any exception thrown by this method is ignored. After this method call, the endpoint is deemed inactive.
endpointFactory
- a message endpoint factory instance.spec
- an activation spec JavaBean instance.javax.transaction.xa.XAResource[] getXAResources(ActivationSpec[] specs) throws ResourceException
ActivationSpec
JavaBeans
and returns an array of XAResource
objects each of which
represents a unique resource manager.
The resource adapter may return null if it does not implement the
XAResource
interface. Otherwise, it must return an array
of XAResource
objects, each of which represents a unique
resource manager that was used by the endpoint applications.
The application server uses the XAResource
objects to
query each resource manager for a list of in-doubt transactions.
It then completes each pending transaction by sending the commit
decision to the participating resource managers.specs
- an array of ActivationSpec
JavaBeans each of
which corresponds to an deployed endpoint application that was
active prior to the system crash.XAResource
objects each of which
represents a unique resource manager.ResourceException
- generic exception if operation fails due to an
error condition.