Package | Description |
---|---|
javax.resource |
The javax.resource package is the top-level package for the Jakarta™ Connectors specification.
|
javax.resource.cci |
The javax.resource.cci package contains API specification for the Common
Client Interface (CCI).
|
javax.resource.spi |
The javax.resource.spi package contains APIs for the system
contracts defined in the Jakarta Connectors specification.
|
javax.resource.spi.endpoint |
This package contains system contracts for service endpoint interactions.
|
javax.resource.spi.work |
This package contains APIs for the Work Management, Generic and Security Work Context contracts.
|
Modifier and Type | Class and Description |
---|---|
class |
NotSupportedException
A
NotSupportedException is thrown to indicate that
callee (resource adapter
or application server for system contracts) cannot execute an operation
because the operation is not a supported feature. |
Modifier and Type | Class and Description |
---|---|
class |
ResourceWarning
A
ResourceWarning provides information on warnings related to
execution of an interaction with an EIS. |
Modifier and Type | Method and Description |
---|---|
void |
LocalTransaction.begin()
Begins a local transaction on an EIS instance.
|
void |
Interaction.clearWarnings()
Clears all the warning reported by this Interaction instance.
|
void |
Interaction.close()
Closes the current Interaction and release all the resources
held for this instance by the resource adapter.
|
void |
Connection.close()
Initiates close of the connection handle at the application level.
|
void |
LocalTransaction.commit()
Commits the current local transaction and release all locks held
by the underlying EIS instance.
|
IndexedRecord |
RecordFactory.createIndexedRecord(String recordName)
Creates a IndexedRecord.
|
Interaction |
Connection.createInteraction()
Creates an Interaction associated with this Connection.
|
MappedRecord |
RecordFactory.createMappedRecord(String recordName)
Creates a MappedRecord.
|
boolean |
ResultSetInfo.deletesAreDetected(int type)
Indicates whether or not a visible row delete can be detected by
calling ResultSet.rowDeleted.
|
Record |
Interaction.execute(InteractionSpec ispec,
Record input)
Executes an interaction represented by the InteractionSpec.
|
boolean |
Interaction.execute(InteractionSpec ispec,
Record input,
Record output)
Executes an interaction represented by the InteractionSpec.
|
Connection |
ConnectionFactory.getConnection()
Gets a connection to an EIS instance.
|
Connection |
ConnectionFactory.getConnection(ConnectionSpec properties)
Gets a connection to an EIS instance.
|
String |
ConnectionMetaData.getEISProductName()
Returns product name of the underlying EIS instance connected
through the Connection that produced this metadata.
|
String |
ConnectionMetaData.getEISProductVersion()
Returns product version of the underlying EIS instance.
|
LocalTransaction |
Connection.getLocalTransaction()
Returns an LocalTransaction instance that enables a component to
demarcate resource manager local transactions on the Connection.
|
ResourceAdapterMetaData |
ConnectionFactory.getMetaData()
Gets metadata for the Resource Adapter.
|
ConnectionMetaData |
Connection.getMetaData()
Gets the information on the underlying EIS instance represented
through an active connection.
|
RecordFactory |
ConnectionFactory.getRecordFactory()
Gets a RecordFactory instance.
|
ResultSetInfo |
Connection.getResultSetInfo()
Gets the information on the ResultSet functionality supported by
a connected EIS instance.
|
String |
ConnectionMetaData.getUserName()
Returns the user name for an active connection as known to
the underlying EIS instance.
|
ResourceWarning |
Interaction.getWarnings()
Gets the first ResourceWarning from the chain of warnings
associated with this Interaction instance.
|
boolean |
ResultSetInfo.insertsAreDetected(int type)
Indicates whether or not a visible row insert can be detected
by calling ResultSet.rowInserted.
|
Record |
MessageListener.onMessage(Record inputData)
This method allows an EIS to call a message endpoint using a
request-response style communication.
|
boolean |
ResultSetInfo.othersDeletesAreVisible(int type)
Indicates whether deletes made by others are visible.
|
boolean |
ResultSetInfo.othersInsertsAreVisible(int type)
Indicates whether inserts made by others are visible.
|
boolean |
ResultSetInfo.othersUpdatesAreVisible(int type)
Indicates whether updates made by others are visible.
|
boolean |
ResultSetInfo.ownDeletesAreVisible(int type)
Indicates whether a ResultSet's own deletes are visible.
|
boolean |
ResultSetInfo.ownInsertsAreVisible(int type)
Indicates whether a ResultSet's own inserts are visible.
|
boolean |
ResultSetInfo.ownUpdatesAreVisible(int type)
Indicates whether a ResultSet's own updates are visible.
|
void |
LocalTransaction.rollback()
Rollbacks the current resource manager local transaction.
|
boolean |
ResultSetInfo.supportsResultSetType(int type)
Indicates whether or not a resource adapter supports a type
of ResultSet.
|
boolean |
ResultSetInfo.supportsResultTypeConcurrency(int type,
int concurrency)
Indicates whether or not a resource adapter supports the
concurrency type in combination with the given ResultSet type/
|
boolean |
ResultSetInfo.updatesAreDetected(int type)
Indicates whether or not a visible row update can be detected
by calling the method
ResultSet.rowUpdated . |
Modifier and Type | Class and Description |
---|---|
class |
ApplicationServerInternalException
An
ApplicationServerInternalException is thrown
by an application
server to indicate error conditions specific to an application server. |
class |
CommException
This indicates errors related to failed or interrupted
communication with an EIS instance.
|
class |
EISSystemException
An
EISSystemException is used to indicate any EIS
specific system-level
error conditions. |
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. |
class |
InvalidPropertyException
This exception is thrown to indicate invalid configuration
property settings.
|
class |
LocalTransactionException
A
LocalTransactionException represents various
error conditions related to the local transaction management contract. |
class |
ResourceAdapterInternalException
A
ResourceAdapterInternalException indicates any
system-level error conditions related to a resource adapter. |
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). |
class |
RetryableUnavailableException
A subclass of the
UnavailableException that
indicates that the rejection of the work submission is transient. |
class |
SecurityException
A
SecurityException indicates error conditions
related to the security
contract between an application server and resource adapter. |
class |
SharingViolationException
This is thrown to indicate a connection sharing violation.
|
class |
UnavailableException
This is thrown to indicate that a service is unavailable.
|
Modifier and Type | Method and Description |
---|---|
Object |
ConnectionManager.allocateConnection(ManagedConnectionFactory mcf,
ConnectionRequestInfo cxRequestInfo)
The method allocateConnection gets called by the resource adapter's
connection factory instance.
|
void |
ManagedConnection.associateConnection(Object connection)
Used typically by the container to change the association of an
application-level connection handle with a ManagedConnection
instance.
|
void |
LazyAssociatableConnectionManager.associateConnection(Object connection,
ManagedConnectionFactory mcf,
ConnectionRequestInfo cxReqInfo)
This method is called by a resource adapter (that is capable of
lazy connection association optimization) in order to lazily associate
a connection object with a
ManagedConnection instance. |
void |
LocalTransaction.begin()
Begin a local transaction
|
void |
ManagedConnection.cleanup()
Application server calls this method to force any cleanup on the
ManagedConnection instance.
|
void |
LocalTransaction.commit()
Commit a local transaction
|
Object |
ManagedConnectionFactory.createConnectionFactory()
Creates a Connection Factory instance.
|
Object |
ManagedConnectionFactory.createConnectionFactory(ConnectionManager cxManager)
Creates a Connection Factory instance.
|
ManagedConnection |
ManagedConnectionFactory.createManagedConnection(Subject subject,
ConnectionRequestInfo cxRequestInfo)
Creates a new physical connection to the underlying EIS
resource manager.
|
void |
ManagedConnection.destroy()
Destroys the physical connection to the underlying resource manager.
|
void |
DissociatableManagedConnection.dissociateConnections()
This method is called by an application server (that is capable of lazy
connection association optimization) in order to dissociate a
ManagedConnection instance from all of its connection
handles. |
void |
ResourceAdapter.endpointActivation(MessageEndpointFactory endpointFactory,
ActivationSpec spec)
This is called during the activation of a message endpoint.
|
Object |
ManagedConnection.getConnection(Subject subject,
ConnectionRequestInfo cxRequestInfo)
Creates a new connection handle for the underlying physical connection
represented by the ManagedConnection instance.
|
String |
ManagedConnectionMetaData.getEISProductName()
Returns Product name of the underlying EIS instance connected
through the ManagedConnection.
|
String |
ManagedConnectionMetaData.getEISProductVersion()
Returns product version of the underlying EIS instance connected
through the ManagedConnection.
|
Set |
ValidatingManagedConnectionFactory.getInvalidConnections(Set connectionSet)
This method returns a set of invalid
ManagedConnection
objects chosen from a specified set of ManagedConnection
objects. |
LocalTransaction |
ManagedConnection.getLocalTransaction()
Returns an
javax.resource.spi.LocalTransaction instance. |
PrintWriter |
ManagedConnectionFactory.getLogWriter()
Get the log writer for this ManagedConnectionFactory instance.
|
PrintWriter |
ManagedConnection.getLogWriter()
Gets the log writer for this ManagedConnection instance.
|
int |
ManagedConnectionMetaData.getMaxConnections()
Returns maximum limit on number of active concurrent connections
that an EIS instance can support across client processes.
|
ManagedConnectionMetaData |
ManagedConnection.getMetaData()
Gets the metadata information for this connection's underlying
EIS resource manager instance.
|
String |
ManagedConnectionMetaData.getUserName()
Returns name of the user associated with the ManagedConnection
instance.
|
XAResource |
ManagedConnection.getXAResource()
Returns an
javax.transaction.xa.XAresource instance. |
XAResource[] |
ResourceAdapter.getXAResources(ActivationSpec[] specs)
This method is called by the application server during crash recovery.
|
void |
LazyEnlistableConnectionManager.lazyEnlist(ManagedConnection mc)
This method is called by a resource adapter (that is capable of
lazy transaction enlistment optimization) in order to lazily enlist
a connection object with a XA transaction.
|
ManagedConnection |
ManagedConnectionFactory.matchManagedConnections(Set connectionSet,
Subject subject,
ConnectionRequestInfo cxRequestInfo)
Returns a matched connection from the candidate set of connections.
|
void |
LocalTransaction.rollback()
Rollback a local transaction
|
void |
ManagedConnectionFactory.setLogWriter(PrintWriter out)
Set the log writer for this ManagedConnectionFactory instance.
|
void |
ManagedConnection.setLogWriter(PrintWriter out)
Sets the log writer for this ManagedConnection instance.
|
void |
ResourceAdapterAssociation.setResourceAdapter(ResourceAdapter ra)
Associate this object with a
ResourceAdapter object. |
Modifier and Type | Method and Description |
---|---|
void |
MessageEndpoint.afterDelivery()
This is called by a resource adapter after a message is delivered.
|
void |
MessageEndpoint.beforeDelivery(Method method)
This is called by a resource adapter before a message is delivered.
|
Modifier and Type | Class and Description |
---|---|
class |
RetryableWorkRejectedException
A subclass of the
WorkRejectedException that
indicates that the the service unavailability is transient. |
class |
WorkCompletedException
This exception is thrown by a
WorkManager to indicate that
a submitted Work instance has completed with an exception. |
class |
WorkException
A common base class for all
Work processing related exceptions. |
class |
WorkRejectedException
This exception is thrown by a
WorkManager to indicate
that a submitted Work instance has been rejected. |
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.