Top Description Interfaces Annotations Classes
[default module]

Package javax.resource.spi


The javax.resource.spi package contains APIs for the system contracts defined in the Java EE Connector Architecture specification.

Interface Summary

Modifier and TypeInterface and Description
public interface
ActivationSpec

This interface serves as a marker.

public interface
BootstrapContext

This provides a mechanism to pass a bootstrap context to a resource adapter instance when it is bootstrapped.

public interface
ConnectionEventListener

The ConnectionEventListener interface provides an event callback mechanism to enable an application server to receive notifications from a ManagedConnection instance.

public interface
ConnectionManager

ConnectionManager interface provides a hook for the resource adapter to pass a connection request to the application server.

public interface
ConnectionRequestInfo

The ConnectionRequestInfo interface enables a resource adapter to pass its own request specific data structure across the connection request flow.

public interface
DissociatableManagedConnection

This is a mix-in interface that may be optionally implemented by a ManagedConnection implementation.

public interface
LazyAssociatableConnectionManager

This is a mix-in interface that may be optionally implemented by a ConnectionManager implementation.

public interface
LazyEnlistableConnectionManager

This is a mix-in interface that may be optionally implemented by a ConnectionManager implementation.

public interface
LazyEnlistableManagedConnection

This is a mix-in interface that may be optionally implemented by a ManagedConnection implementation.

public interface
LocalTransaction

LocalTransaction interface provides support for transactions that are managed internal to an EIS resource manager, and do not require an external transaction manager.

public interface
ManagedConnection

ManagedConnection instance represents a physical connection to the underlying EIS.

public interface
ManagedConnectionFactory

ManagedConnectionFactory instance is a factory of both ManagedConnection and EIS-specific connection factory instances.

public interface
ManagedConnectionMetaData

The ManagedConnectionMetaData interface provides information about the underlying EIS instance associated with a ManagedConnection instance.

public interface
ResourceAdapter

This represents a resource adapter instance and contains operations for lifecycle management and message endpoint setup.

public interface
ResourceAdapterAssociation

This interface specifies the methods to associate a ResourceAdapter object with other objects that implement this interface like ManagedConnectionFactory and ActivationSpec.

public interface
RetryableException

A marker interface indicating that the Exception is transient.

public interface
TransactionSupport

This interface may be optionally implemented by a ManagedConnectionFactory to provide its level of transaction support at runtime.

public interface
ValidatingManagedConnectionFactory

This interface is implemented by a ManagedConnectionFactory instance that supports the ability to validate ManagedConnection objects.

public interface
XATerminator

The XATerminator interface is used for transaction completion and crash recovery flows.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Activation

Designates a JavaBean as an ActivationSpec.

public @interface
AdministeredObject

Designates a JavaBean as an administered object.Administered objects are specific to a messaging style or message provider.

public @interface
public @interface
ConfigProperty

Designates a JavaBean property as a configuration property

public @interface
ConnectionDefinition

Defines a set of connection interfaces and classes pertaining to a particular connection type.

public @interface
ConnectionDefinitions

Defines a set of connection definitions that the JavaBean, that has been annotated with this annotation, is a part of.

public @interface
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.

public @interface
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

Class Summary

Modifier and TypeClass and Description
public class
ApplicationServerInternalException

An ApplicationServerInternalException is thrown by an application server to indicate error conditions specific to an application server.

public class
CommException

This indicates errors related to failed or interrupted communication with an EIS instance.

public class
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. A ManagedConnection instance is returned from the method ConnectionEvent.getSource.
  • Connection handle associated with the ManagedConnection instance; required for the CONNECTION_CLOSED event and optional for the other event types.
  • Optionally, an exception indicating the connection related error. Note that exception is used for CONNECTION_ERROR_OCCURRED.
public class
EISSystemException

An EISSystemException is used to indicate any EIS specific system-level error conditions.

public class
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.

public class
InvalidPropertyException

This exception is thrown to indicate invalid configuration property settings.

public class
LocalTransactionException

A LocalTransactionException represents various error conditions related to the local transaction management contract.

public class
ResourceAdapterInternalException

A ResourceAdapterInternalException indicates any system-level error conditions related to a resource adapter.

public class
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).

public class
RetryableUnavailableException

A subclass of the UnavailableException that indicates that the rejection of the work submission is transient.

public class
SecurityException

A SecurityException indicates error conditions related to the security contract between an application server and resource adapter.

public class
SharingViolationException

This is thrown to indicate a connection sharing violation.

public class
UnavailableException

This is thrown to indicate that a service is unavailable.