Package jakarta.resource.spi

The jakarta.resource.spi package contains APIs for the system contracts defined in the Jakarta Connectors specification.

See: Description

Interface Summary

Interface	Description
ActivationSpec	This interface serves as a marker.
BootstrapContext	This provides a mechanism to pass a bootstrap context to a resource adapter instance when it is bootstrapped.
ConnectionEventListener	The ConnectionEventListener interface provides an event callback mechanism to enable an application server to receive notifications from a ManagedConnection instance.
ConnectionManager	ConnectionManager interface provides a hook for the resource adapter to pass a connection request to the application server.
ConnectionRequestInfo	The ConnectionRequestInfo interface enables a resource adapter to pass its own request specific data structure across the connection request flow.
DissociatableManagedConnection	This is a mix-in interface that may be optionally implemented by a ManagedConnection implementation.
LazyAssociatableConnectionManager	This is a mix-in interface that may be optionally implemented by a ConnectionManager implementation.
LazyEnlistableConnectionManager	This is a mix-in interface that may be optionally implemented by a ConnectionManager implementation.
LazyEnlistableManagedConnection	This is a mix-in interface that may be optionally implemented by a ManagedConnection implementation.
LocalTransaction	LocalTransaction interface provides support for transactions that are managed internal to an EIS resource manager, and do not require an external transaction manager.
ManagedConnection	ManagedConnection instance represents a physical connection to the underlying EIS.
ManagedConnectionFactory	ManagedConnectionFactory instance is a factory of both ManagedConnection and EIS-specific connection factory instances.
ManagedConnectionMetaData	The ManagedConnectionMetaData interface provides information about the underlying EIS instance associated with a ManagedConnection instance.
ResourceAdapter	This represents a resource adapter instance and contains operations for lifecycle management and message endpoint setup.
ResourceAdapterAssociation	This interface specifies the methods to associate a ResourceAdapter object with other objects that implement this interface like ManagedConnectionFactory and ActivationSpec.
RetryableException	A marker interface indicating that the Exception is transient.
TransactionSupport	This interface may be optionally implemented by a ManagedConnectionFactory to provide its level of transaction support at runtime.
ValidatingManagedConnectionFactory	This interface is implemented by a ManagedConnectionFactory instance that supports the ability to validate ManagedConnection objects.
XATerminator	The XATerminator interface is used for transaction completion and crash recovery flows.

Class Summary

Class	Description
ConnectionEvent	The ConnectionEvent class provides information about the source of a connection related event.A ConnectionEvent instance contains the following information: Type of the connection event ManagedConnection instance that generated the connection event.

Enum Summary

Enum	Description
AuthenticationMechanism.CredentialInterface	An enumerated type that represents the various interfaces that a resource adapter may support for the representation of the credentials.
TransactionSupport.TransactionSupportLevel	An enumerated type that represents the levels of transaction support a resource adapter may support.

Exception Summary

Exception	Description
ApplicationServerInternalException	An ApplicationServerInternalException is thrown by an application server to indicate error conditions specific to an application server.
CommException	This indicates errors related to failed or interrupted communication with an EIS instance.
EISSystemException	An EISSystemException is used to indicate any EIS specific system-level error conditions.
IllegalStateException	An IllegalStateException is thrown from a method if the callee (resource adapter or application server for system contracts) is in an illegal or inappropriate state for the method invocation.
InvalidPropertyException	This exception is thrown to indicate invalid configuration property settings.
LocalTransactionException	A LocalTransactionException represents various error conditions related to the local transaction management contract.
ResourceAdapterInternalException	A ResourceAdapterInternalException indicates any system-level error conditions related to a resource adapter.
ResourceAllocationException	A ResourceAllocationException can be thrown by an application server or resource adapter to indicate any failure to allocate system resources (example: threads, physical connections).
RetryableUnavailableException	A subclass of the UnavailableException that indicates that the rejection of the work submission is transient.
SecurityException	A SecurityException indicates error conditions related to the security contract between an application server and resource adapter.
SharingViolationException	This is thrown to indicate a connection sharing violation.
UnavailableException	This is thrown to indicate that a service is unavailable.

Annotation Types Summary

Annotation Type	Description
Activation	Designates a JavaBean as an ActivationSpec.
AdministeredObject	Designates a JavaBean as an administered object.Administered objects are specific to a messaging style or message provider.
AuthenticationMechanism
ConfigProperty	Designates a JavaBean property as a configuration property
ConnectionDefinition	Defines a set of connection interfaces and classes pertaining to a particular connection type.
ConnectionDefinitions	Defines a set of connection definitions that the JavaBean, that has been annotated with this annotation, is a part of.
Connector	The Connector annotation is a component-defining annotation and it can be used by the resource adapter developer to specify that the JavaBean is a resource adapter JavaBean.
SecurityPermission	The SecurityPermission annotation can be used by the developer, as part of the Connector annotation, to specify the extended security permissions required by the resource adapter

Package jakarta.resource.spi Description

The jakarta.resource.spi package contains APIs for the system contracts defined in the Jakarta Connectors specification.