The jakarta.resource.spi package contains APIs for the system contracts defined in the Jakarta Connectors specification.
Interface Summary Interface Description ActivationSpecThis interface serves as a marker. BootstrapContextThis provides a mechanism to pass a bootstrap context to a resource adapter instance when it is bootstrapped. ConnectionEventListenerThe
ConnectionEventListenerinterface provides an event callback mechanism to enable an application server to receive notifications from a
ConnectionManagerConnectionManager interface provides a hook for the resource adapter to pass a connection request to the application server. ConnectionRequestInfoThe ConnectionRequestInfo interface enables a resource adapter to pass its own request specific data structure across the connection request flow. DissociatableManagedConnectionThis is a mix-in interface that may be optionally implemented by a
LazyAssociatableConnectionManagerThis is a mix-in interface that may be optionally implemented by a
LazyEnlistableConnectionManagerThis is a mix-in interface that may be optionally implemented by a
LazyEnlistableManagedConnectionThis is a mix-in interface that may be optionally implemented by a
LocalTransactionLocalTransaction interface provides support for transactions that are managed internal to an EIS resource manager, and do not require an external transaction manager. ManagedConnectionManagedConnection instance represents a physical connection to the underlying EIS. ManagedConnectionFactoryManagedConnectionFactory instance is a factory of both ManagedConnection and EIS-specific connection factory instances. ManagedConnectionMetaDataThe ManagedConnectionMetaData interface provides information about the underlying EIS instance associated with a ManagedConnection instance. ResourceAdapterThis represents a resource adapter instance and contains operations for lifecycle management and message endpoint setup. ResourceAdapterAssociationThis interface specifies the methods to associate a
ResourceAdapterobject with other objects that implement this interface like
RetryableExceptionA marker interface indicating that the Exception is transient. TransactionSupportThis interface may be optionally implemented by a
ManagedConnectionFactoryto provide its level of transaction support at runtime.
ValidatingManagedConnectionFactoryThis interface is implemented by a
ManagedConnectionFactoryinstance that supports the ability to validate
XATerminatorThe XATerminator interface is used for transaction completion and crash recovery flows.
Class Summary Class Description ConnectionEventThe 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.CredentialInterfaceAn enumerated type that represents the various interfaces that a resource adapter may support for the representation of the credentials. TransactionSupport.TransactionSupportLevelAn enumerated type that represents the levels of transaction support a resource adapter may support.
Exception Summary Exception Description ApplicationServerInternalExceptionAn
ApplicationServerInternalExceptionis thrown by an application server to indicate error conditions specific to an application server.
CommExceptionThis indicates errors related to failed or interrupted communication with an EIS instance. EISSystemExceptionAn
EISSystemExceptionis used to indicate any EIS specific system-level error conditions.
IllegalStateExceptionis 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.
InvalidPropertyExceptionThis exception is thrown to indicate invalid configuration property settings. LocalTransactionExceptionA
LocalTransactionExceptionrepresents various error conditions related to the local transaction management contract.
ResourceAdapterInternalExceptionindicates any system-level error conditions related to a resource adapter.
ResourceAllocationExceptioncan be thrown by an application server or resource adapter to indicate any failure to allocate system resources (example: threads, physical connections).
RetryableUnavailableExceptionA subclass of the
UnavailableExceptionthat indicates that the rejection of the work submission is transient.
SecurityExceptionindicates error conditions related to the security contract between an application server and resource adapter.
SharingViolationExceptionThis is thrown to indicate a connection sharing violation. UnavailableExceptionThis is thrown to indicate that a service is unavailable.
Annotation Types Summary Annotation Type Description ActivationDesignates a JavaBean as an
AdministeredObjectDesignates a JavaBean as an administered object.Administered objects are specific to a messaging style or message provider. AuthenticationMechanism ConfigPropertyDesignates a JavaBean property as a configuration property ConnectionDefinitionDefines a set of connection interfaces and classes pertaining to a particular connection type. ConnectionDefinitionsDefines a set of connection definitions that the JavaBean, that has been annotated with this annotation, is a part of. ConnectorThe
Connectorannotation 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.
SecurityPermissionThe 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