ID |
Return |
Method/Field |
Description |
Required |
Deprecated |
Testable |
Connector:JAVADOC:1 |
NotSupportedException |
jakarta.resource.NotSupportedException.NotSupportedException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:2 |
NotSupportedException |
jakarta.resource.NotSupportedException.NotSupportedException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:3 |
NotSupportedException |
jakarta.resource.NotSupportedException.NotSupportedException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:4 |
NotSupportedException |
jakarta.resource.NotSupportedException.NotSupportedException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:5 |
NotSupportedException |
jakarta.resource.NotSupportedException.NotSupportedException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and error code. |
true |
|
true |
Connector:JAVADOC:6 |
void |
jakarta.resource.Referenceable.setReference
( Reference ) |
Sets the Reference
instance. This method is called by the deployment code to set the
Reference that can be later returned by the getReference method
(as defined in the javax.naming.Referenceable interface). |
true |
|
true |
Connector:JAVADOC:7 |
String |
jakarta.resource.ResourceException.getErrorCode
|
Get the error code.
|
true |
|
true |
Connector:JAVADOC:8 |
Exception |
jakarta.resource.ResourceException.getLinkedException
|
Get the exception
linked to this ResourceException |
true |
true |
true |
Connector:JAVADOC:9 |
String |
jakarta.resource.ResourceException.getMessage
|
Returns a detailed
message string describing this exception. |
true |
|
true |
Connector:JAVADOC:10 |
ResourceException |
jakarta.resource.ResourceException.ResourceException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:11 |
ResourceException |
jakarta.resource.ResourceException.ResourceException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:12 |
ResourceException |
jakarta.resource.ResourceException.ResourceException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:13 |
ResourceException |
jakarta.resource.ResourceException.ResourceException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:14 |
ResourceException |
jakarta.resource.ResourceException.ResourceException
( String ,
String ) |
Create a new
throwable with the specified message and error code. |
true |
|
true |
Connector:JAVADOC:15 |
void |
jakarta.resource.ResourceException.setErrorCode
( String ) |
Set the error code.
|
true |
|
true |
Connector:JAVADOC:16 |
void |
jakarta.resource.ResourceException.setLinkedException
( Exception ) |
Add a linked
Exception to this ResourceException. |
true |
true |
true |
Connector:JAVADOC:17 |
void |
jakarta.resource.cci.Connection.close
|
Initiates close of
the connection handle at the application level. A client should
not use a closed connection to interact with an EIS. |
true |
|
true |
Connector:JAVADOC:18 |
void |
jakarta.resource.cci.Connection.close
throws ResourceException
|
Exception thrown if
close on a connection handle fails. Any invalid connection close
invocation--example, calling close on a connection handle that is
already closed--should also throw this exception. |
true |
|
true |
Connector:JAVADOC:19 |
Interaction |
jakarta.resource.cci.Connection.createInteraction
|
Creates an
Interaction associated with this Connection. An Interaction
enables an application to execute EIS functions. |
true |
|
true |
Connector:JAVADOC:20 |
Interaction |
jakarta.resource.cci.Connection.createInteraction
throws ResourceException
|
Failed to create an
Interaction |
true |
|
true |
Connector:JAVADOC:21 |
LocalTransaction |
jakarta.resource.cci.Connection.getLocalTransaction
|
Returns an
LocalTransaction instance that enables a component to demarcate
resource manager local transactions on the Connection. If a
resource adapter does not allow a component to demarcate local
transactions on an Connection using LocalTransaction interface,
then the method getLocalTransaction should throw a
NotSupportedException. |
true |
|
true |
Connector:JAVADOC:22 |
LocalTransaction |
jakarta.resource.cci.Connection.getLocalTransaction
throws ResourceException
|
Failed to return a
LocalTransaction instance because of a resource adapter error |
true |
|
true |
Connector:JAVADOC:23 |
ConnectionMetaData |
jakarta.resource.cci.Connection.getMetaData
|
Gets the
information on the underlying EIS instance represented through an
active connection. |
true |
|
true |
Connector:JAVADOC:24 |
ConnectionMetaData |
jakarta.resource.cci.Connection.getMetaData
throws ResourceException
|
Failed to get
information about the connected EIS instance. Error can be
resource adapter-internal, EIS-specific or communication related. |
true |
|
true |
Connector:JAVADOC:25 |
ResultSetInfo |
jakarta.resource.cci.Connection.getResultSetInfo
|
Gets the
information on the ResultSet functionality supported by a
connected EIS instance. |
true |
|
true |
Connector:JAVADOC:26 |
ResultSetInfo |
jakarta.resource.cci.Connection.getResultSetInfo
throws ResourceException
|
Failed to get
ResultSet related information |
true |
|
true |
Connector:JAVADOC:27 |
Connection |
jakarta.resource.cci.ConnectionFactory.getConnection
|
Gets a connection
to an EIS instance. This getConnection variant should be used when
a component wants the container to manage EIS sign-on. This case
is termed container-managed sign-on. The component does not pass
any security information. |
true |
|
true |
Connector:JAVADOC:28 |
Connection |
jakarta.resource.cci.ConnectionFactory.getConnection
throws ResourceException
|
Failed to get a
connection to the EIS instance. Examples of error cases are:
Invalid configuration of ManagedConnectionFactory-- example:
invalid server name Application server-internal error--example:
connection pool related error Communication error EIS-specific
error--example: EIS not active Resource adapter-internal error
Security related error; example: invalid user Failure to allocate
system resources |
true |
|
true |
Connector:JAVADOC:29 |
Connection |
jakarta.resource.cci.ConnectionFactory.getConnection
( ConnectionSpec ) |
Gets a connection
to an EIS instance. A component should use the getConnection
variant with jakarta.resource.cci.ConnectionSpec parameter, if it
needs to pass any resource adapter specific security information
and connection parameters. In the component- managed sign-on case,
an application component passes security information (example:
username, password) through the ConnectionSpec instance. It is
important to note that the properties passed through the
getConnection method should be client-specific (example: username,
password, language) and not related to the configuration of a
target EIS instance (example: port number, server name). The
ManagedConnectionFactory instance is configured with complete set
of properties required for the creation of a connection to an EIS
instance. |
true |
|
true |
Connector:JAVADOC:30 |
Connection |
jakarta.resource.cci.ConnectionFactory.getConnection
( ConnectionSpec )
throws ResourceException
|
Failed to get a
connection to the EIS instance. Examples of error cases are:
Invalid specification of input parameters Invalid configuration of
ManagedConnectionFactory-- example: invalid server name
Application server-internal error--example: connection pool
related error Communication error EIS-specific error--example: EIS
not active Resource adapter-internal error Security related error;
example: invalid user Failure to allocate system resources |
true |
|
true |
Connector:JAVADOC:31 |
ResourceAdapterMetaData |
jakarta.resource.cci.ConnectionFactory.getMetaData
|
Gets metadata for
the Resource Adapter. Note that the metadata information is about
the ResourceAdapter and not the EIS instance. An invocation of
this method does not require that an active connection to an EIS
instance should have been established. |
true |
|
true |
Connector:JAVADOC:32 |
ResourceAdapterMetaData |
jakarta.resource.cci.ConnectionFactory.getMetaData
throws ResourceException
|
Failed to get
metadata information about the resource adapter |
true |
|
true |
Connector:JAVADOC:33 |
RecordFactory |
jakarta.resource.cci.ConnectionFactory.getRecordFactory
|
Gets a
RecordFactory instance. The RecordFactory is used for the creation
of generic Record instances. |
true |
|
true |
Connector:JAVADOC:34 |
RecordFactory |
jakarta.resource.cci.ConnectionFactory.getRecordFactory
throws ResourceException
|
Failed to create a
RecordFactory |
true |
|
true |
Connector:JAVADOC:35 |
String |
jakarta.resource.cci.ConnectionMetaData.getEISProductName
|
Returns product
name of the underlying EIS instance connected through the
Connection that produced this metadata. |
true |
|
true |
Connector:JAVADOC:36 |
String |
jakarta.resource.cci.ConnectionMetaData.getEISProductName
throws ResourceException
|
Failed to get the
information for the EIS instance |
true |
|
true |
Connector:JAVADOC:37 |
String |
jakarta.resource.cci.ConnectionMetaData.getEISProductVersion
|
Returns product
version of the underlying EIS instance. |
true |
|
true |
Connector:JAVADOC:38 |
String |
jakarta.resource.cci.ConnectionMetaData.getEISProductVersion
throws ResourceException
|
Failed to get the
information for the EIS instance |
true |
|
true |
Connector:JAVADOC:39 |
String |
jakarta.resource.cci.ConnectionMetaData.getUserName
|
Returns the user
name for an active connection as known to the underlying EIS
instance. The name corresponds the resource principal under whose
security context a connection to the EIS instance has been
established. |
true |
|
true |
Connector:JAVADOC:40 |
String |
jakarta.resource.cci.ConnectionMetaData.getUserName
throws ResourceException
|
Failed to get the
information for the EIS instance |
true |
|
true |
Connector:JAVADOC:41 |
void |
jakarta.resource.cci.Interaction.clearWarnings
|
Clears all the
warning reported by this Interaction instance. After a call to
this method, the method getWarnings will return null until a new
warning is reported for this Interaction. |
true |
|
true |
Connector:JAVADOC:42 |
void |
jakarta.resource.cci.Interaction.clearWarnings
throws ResourceException
|
Failed to clear
ResourceWarnings associated with Interaction |
true |
|
true |
Connector:JAVADOC:43 |
void |
jakarta.resource.cci.Interaction.close
|
Closes the current
Interaction and release all the resources held for this instance
by the resource adapter. The close of an Interaction instance does
not close the associated Connection instance. It is recommended
that Interaction instances be closed explicitly to free any held
resources. |
true |
|
true |
Connector:JAVADOC:44 |
void |
jakarta.resource.cci.Interaction.close
throws ResourceException
|
Failed to close the
Interaction instance. Invoking close on an already closed
Interaction should also throw this exception. |
true |
|
true |
Connector:JAVADOC:45 |
boolean |
jakarta.resource.cci.Interaction.execute
( InteractionSpec ,
Record ,
Record ) |
Executes an
interaction represented by the InteractionSpec. This form of
invocation takes an input Record and updates the output Record. |
true |
|
true |
Connector:JAVADOC:46 |
boolean |
jakarta.resource.cci.Interaction.execute
( InteractionSpec ,
Record ,
Record )
throws ResourceException
|
Exception if execute
operation fails. Examples of error cases are: Resource adapter
internal, EIS-specific or communication error Invalid
specification of an InteractionSpec, input or output record
structure Errors in use of input or output Record Invalid
connection associated with this Interaction |
true |
|
true |
Connector:JAVADOC:47 |
Record |
jakarta.resource.cci.Interaction.execute
( InteractionSpec ,
Record ) |
Executes an
interaction represented by the InteractionSpec. This form of
invocation takes an input Record and returns an output Record if
the execution of the Interaction has been successfull. |
true |
|
true |
Connector:JAVADOC:48 |
Record |
jakarta.resource.cci.Interaction.execute
( InteractionSpec ,
Record )
throws ResourceException
|
Exception if execute
operation fails. Examples of error cases are: Resource adapter
internal, EIS-specific or communication error Invalid
specification of an InteractionSpec or input record structure
Errors in use of input Record or creation of an output Record
Invalid connection associated with this Interaction |
true |
|
true |
Connector:JAVADOC:49 |
Connection |
jakarta.resource.cci.Interaction.getConnection
|
Gets the Connection
associated with the Interaction. |
true |
|
true |
Connector:JAVADOC:50 |
ResourceWarning |
jakarta.resource.cci.Interaction.getWarnings
|
Gets the first
ResourceWarning from the chain of warnings associated with this
Interaction instance. |
true |
|
true |
Connector:JAVADOC:51 |
ResourceWarning |
jakarta.resource.cci.Interaction.getWarnings
throws ResourceException
|
Failed to get
ResourceWarnings associated with Interaction |
true |
|
true |
Connector:JAVADOC:52 |
void |
jakarta.resource.cci.LocalTransaction.begin
|
Begins a local
transaction on an EIS instance. |
true |
|
true |
Connector:JAVADOC:53 |
void |
jakarta.resource.cci.LocalTransaction.begin
throws ResourceException
|
Failed to begin a
local transaction. Examples of error cases are: Resource adapter
internal or EIS-specific error Connection is already participating
in a local or JTA transaction |
true |
|
true |
Connector:JAVADOC:54 |
void |
jakarta.resource.cci.LocalTransaction.commit
|
Commits the current
local transaction and release all locks held by the underlying EIS
instance. |
true |
|
true |
Connector:JAVADOC:55 |
void |
jakarta.resource.cci.LocalTransaction.commit
throws ResourceException
|
Failed to commit a
local transaction. Examples of error cases are: Resource adapter
internal or EIS-specific error Violation of integrity constraints,
deadlock detection, communication failure during transaction
completion, or any retry requirement Connection is participating
in an active JTA transaction Invalid transaction context; commit
operation invoked without an active transaction context |
true |
|
true |
Connector:JAVADOC:56 |
void |
jakarta.resource.cci.LocalTransaction.rollback
|
Rollbacks the
current resource manager local transaction. |
true |
|
true |
Connector:JAVADOC:57 |
void |
jakarta.resource.cci.LocalTransaction.rollback
throws ResourceException
|
Failed to rollback a
local transaction. Examples of error cases are: Resource adapter
internal or EIS-specific error Connection is participating in an
active JTA transaction Invalid transaction context; rollback
operation invoked without an active transaction context |
true |
|
true |
Connector:JAVADOC:58 |
Record |
jakarta.resource.cci.MessageListener.onMessage
( Record ) |
This method allows
an EIS to call a message endpoint using a request-response style
communication. |
true |
|
true |
Connector:JAVADOC:59 |
Record |
jakarta.resource.cci.MessageListener.onMessage
( Record )
throws ResourceException
|
indicates an
exceptional condition. |
true |
|
true |
Connector:JAVADOC:60 |
Object |
jakarta.resource.cci.Record.clone
|
Creates and returns
a copy of this object. The precise meaning of "copy" may depend on
the class of the object. |
true |
|
true |
Connector:JAVADOC:61 |
Object |
jakarta.resource.cci.Record.clone
throws CloneNotSupportedException
|
If the object's
class does not support the Cloneable interface Subclasses that
override the clone method can also throw this exception to
indicate that an instance cannot be cloned. |
true |
|
true |
Connector:JAVADOC:62 |
boolean |
jakarta.resource.cci.Record.equals
( Object ) |
Check if this
instance is equal to another Record. |
true |
|
true |
Connector:JAVADOC:63 |
String |
jakarta.resource.cci.Record.getRecordName
|
Gets the name of
the Record. |
true |
|
true |
Connector:JAVADOC:64 |
String |
jakarta.resource.cci.Record.getRecordShortDescription
|
Gets a short
description string for the Record. This property is used primarily
by application development tools. |
true |
|
true |
Connector:JAVADOC:65 |
int |
jakarta.resource.cci.Record.hashCode
|
Returns the hash
code for the Record instance. |
true |
|
true |
Connector:JAVADOC:66 |
void |
jakarta.resource.cci.Record.setRecordName
( String ) |
Sets the name of
the Record. |
true |
|
true |
Connector:JAVADOC:67 |
void |
jakarta.resource.cci.Record.setRecordShortDescription
( String ) |
Sets a short
description string for the Record. This property is used primarily
by application development tools. |
true |
|
true |
Connector:JAVADOC:68 |
IndexedRecord |
jakarta.resource.cci.RecordFactory.createIndexedRecord
( String ) |
Creates a
IndexedRecord. The method takes the name of the record that is to
be created by the RecordFactory. The name of the record acts as a
pointer to the meta information (stored in the metadata
repository) for a specific record type. |
true |
|
true |
Connector:JAVADOC:69 |
IndexedRecord |
jakarta.resource.cci.RecordFactory.createIndexedRecord
( String )
throws ResourceException
|
Failed to create an
IndexedRecord. Example error cases are: Invalid specification of
record name Resource adapter internal error Failed to access
metadata repository |
true |
|
true |
Connector:JAVADOC:70 |
MappedRecord |
jakarta.resource.cci.RecordFactory.createMappedRecord
( String ) |
Creates a
MappedRecord. The method takes the name of the record that is to
be created by the RecordFactory. The name of the record acts as a
pointer to the meta information (stored in the metadata
repository) for a specific record type. |
true |
|
true |
Connector:JAVADOC:71 |
MappedRecord |
jakarta.resource.cci.RecordFactory.createMappedRecord
( String )
throws ResourceException
|
Failed to create a
MappedRecord. Example error cases are: Invalid specification of
record name Resource adapter internal error Failed to access
metadata repository |
true |
|
true |
Connector:JAVADOC:72 |
String |
jakarta.resource.cci.ResourceAdapterMetaData.getAdapterName
|
Gets a tool
displayable name of the resource adapter. |
true |
|
true |
Connector:JAVADOC:73 |
String |
jakarta.resource.cci.ResourceAdapterMetaData.getAdapterShortDescription
|
Gets a tool
displayable short desription of the resource adapter. |
true |
|
true |
Connector:JAVADOC:74 |
String |
jakarta.resource.cci.ResourceAdapterMetaData.getAdapterVendorName
|
Gets the name of
the vendor that has provided the resource adapter. |
true |
|
true |
Connector:JAVADOC:75 |
String |
jakarta.resource.cci.ResourceAdapterMetaData.getAdapterVersion
|
Gets the version of
the resource adapter. |
true |
|
true |
Connector:JAVADOC:76 |
String[] |
jakarta.resource.cci.ResourceAdapterMetaData.getInteractionSpecsSupported
|
Returns an array of
fully-qualified names of InteractionSpec types supported by the
CCI implementation for this resource adapter. Note that the
fully-qualified class name is for the implementation class of an
InteractionSpec. This method may be used by tools vendor to find
information on the supported InteractionSpec types. The method
should return an array of length 0 if the CCI implementation does
not define specific InteractionSpec types. |
true |
|
true |
Connector:JAVADOC:77 |
String |
jakarta.resource.cci.ResourceAdapterMetaData.getSpecVersion
|
Returns a string
representation of the version of the connector architecture
specification that is supported by the resource adapter. |
true |
|
true |
Connector:JAVADOC:78 |
boolean |
jakarta.resource.cci.ResourceAdapterMetaData.supportsExecuteWithInputAndOutputRecord
|
Returns true if the
implementation class for the Interaction interface implements
public boolean execute(InteractionSpec ispec, Record input, Record
output) method; otherwise the method returns false. |
true |
|
true |
Connector:JAVADOC:79 |
boolean |
jakarta.resource.cci.ResourceAdapterMetaData.supportsExecuteWithInputRecordOnly
|
Returns true if the
implementation class for the Interaction interface implements
public Record execute(InteractionSpec ispec, Record input) method;
otherwise the method returns false. |
true |
|
true |
Connector:JAVADOC:80 |
boolean |
jakarta.resource.cci.ResourceAdapterMetaData.supportsLocalTransactionDemarcation
|
Returns true if the
resource adapter implements the LocalTransaction interface and
supports local transaction demarcation on the underlying EIS
instance through the LocalTransaction interface. |
true |
|
true |
Connector:JAVADOC:81 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.getLinkedWarning
|
Retrieves the
warning chained to this ResourceWarning object. |
true |
true |
true |
Connector:JAVADOC:82 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.ResourceWarning
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:83 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.ResourceWarning
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:84 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.ResourceWarning
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:85 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.ResourceWarning
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:86 |
ResourceWarning |
jakarta.resource.cci.ResourceWarning.ResourceWarning
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:87 |
void |
jakarta.resource.cci.ResourceWarning.setLinkedWarning
( ResourceWarning ) |
Adds an
ResourceWarning object to the end of the chain. |
true |
true |
true |
Connector:JAVADOC:88 |
boolean |
jakarta.resource.cci.ResultSetInfo.deletesAreDetected
( int ) |
Indicates whether
or not a visible row delete can be detected by calling
ResultSet.rowDeleted. If deletesAreDetected returns false, then
deleted rows are removed from the ResultSet. |
true |
|
true |
Connector:JAVADOC:89 |
boolean |
jakarta.resource.cci.ResultSetInfo.deletesAreDetected
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:90 |
boolean |
jakarta.resource.cci.ResultSetInfo.insertsAreDetected
( int ) |
Indicates whether
or not a visible row insert can be detected by calling
ResultSet.rowInserted. |
true |
|
true |
Connector:JAVADOC:91 |
boolean |
jakarta.resource.cci.ResultSetInfo.insertsAreDetected
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:92 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersDeletesAreVisible
( int ) |
Indicates whether
deletes made by others are visible. |
true |
|
true |
Connector:JAVADOC:93 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersDeletesAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:94 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersInsertsAreVisible
( int ) |
Indicates whether
inserts made by others are visible. |
true |
|
true |
Connector:JAVADOC:95 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersInsertsAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:96 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersUpdatesAreVisible
( int ) |
Indicates whether
updates made by others are visible. |
true |
|
true |
Connector:JAVADOC:97 |
boolean |
jakarta.resource.cci.ResultSetInfo.othersUpdatesAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:98 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownDeletesAreVisible
( int ) |
Indicates whether a
ResultSet's own deletes are visible. |
true |
|
true |
Connector:JAVADOC:99 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownDeletesAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:100 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownInsertsAreVisible
( int ) |
Indicates whether a
ResultSet's own inserts are visible. |
true |
|
true |
Connector:JAVADOC:101 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownInsertsAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:102 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownUpdatesAreVisible
( int ) |
Indicates whether a
ResultSet's own updates are visible. |
true |
|
true |
Connector:JAVADOC:103 |
boolean |
jakarta.resource.cci.ResultSetInfo.ownUpdatesAreVisible
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:104 |
boolean |
jakarta.resource.cci.ResultSetInfo.supportsResultSetType
( int ) |
Indicates whether
or not a resource adapter supports a type of ResultSet. |
true |
|
true |
Connector:JAVADOC:105 |
boolean |
jakarta.resource.cci.ResultSetInfo.supportsResultSetType
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:106 |
boolean |
jakarta.resource.cci.ResultSetInfo.supportsResultTypeConcurrency
( int ,
int ) |
Indicates whether
or not a resource adapter supports the concurrency type in
combination with the given ResultSet type/ |
true |
|
true |
Connector:JAVADOC:107 |
boolean |
jakarta.resource.cci.ResultSetInfo.supportsResultTypeConcurrency
( int ,
int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:108 |
boolean |
jakarta.resource.cci.ResultSetInfo.updatesAreDetected
( int ) |
Indicates whether
or not a visible row update can be detected by calling the method
ResultSet.rowUpdated. |
true |
|
true |
Connector:JAVADOC:109 |
boolean |
jakarta.resource.cci.ResultSetInfo.updatesAreDetected
( int )
throws ResourceException
|
Failed to get the
information |
true |
|
true |
Connector:JAVADOC:110 |
void |
jakarta.resource.cci.Streamable.read
( InputStream ) |
Read data from an
InputStream and initialize fields of a Streamable object. |
true |
|
true |
Connector:JAVADOC:111 |
void |
jakarta.resource.cci.Streamable.read
( InputStream )
throws IOException
|
|
true |
|
true |
Connector:JAVADOC:112 |
void |
jakarta.resource.cci.Streamable.write
( OutputStream ) |
Write fields of a
Streamable object to an OutputStream |
true |
|
true |
Connector:JAVADOC:113 |
void |
jakarta.resource.cci.Streamable.write
( OutputStream )
throws IOException
|
|
true |
|
true |
Connector:JAVADOC:114 |
Class[] |
jakarta.resource.spi.Activation.messageListeners
|
Indicates the
message listener type(s) associated with this activation. |
true |
|
true |
Connector:JAVADOC:115 |
void |
jakarta.resource.spi.ActivationSpec.validate
|
This method may be
called by a deployment tool to validate the overall activation
configuration information provided by the endpoint deployer. This
helps to catch activation configuration errors earlier on without
having to wait until endpoint activation time for configuration
validation. The implementation of this self-validation check
behavior is optional. Note: Since Java EE Connector 1.6
specification, resource adapter implementations are recommended to
use the annotations or the XML validation deployment descriptor
facilities defined by the Bean Validation specification to express
their validation requirements of its configuration properties to
the application server. |
false |
|
true |
Connector:JAVADOC:116 |
void |
jakarta.resource.spi.ActivationSpec.validate
throws InvalidPropertyException
|
|
true |
|
true |
Connector:JAVADOC:117 |
Class[] |
jakarta.resource.spi.AdministeredObject.adminObjectInterfaces
|
Specifies the Java
type of the interface implemented by the administered object. |
true |
|
true |
Connector:JAVADOC:118 |
ApplicationServerInternalException |
jakarta.resource.spi.ApplicationServerInternalException.ApplicationServerInternalException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:119 |
ApplicationServerInternalException |
jakarta.resource.spi.ApplicationServerInternalException.ApplicationServerInternalException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:120 |
ApplicationServerInternalException |
jakarta.resource.spi.ApplicationServerInternalException.ApplicationServerInternalException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:121 |
ApplicationServerInternalException |
jakarta.resource.spi.ApplicationServerInternalException.ApplicationServerInternalException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:122 |
ApplicationServerInternalException |
jakarta.resource.spi.ApplicationServerInternalException.ApplicationServerInternalException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:123 |
String |
jakarta.resource.spi.AuthenticationMechanism.authMechanism
|
The
authentication-mechanismType specifies an authentication mechanism
supported by the resource adapter. Note that this support is for
the resource adapter and not for the underlying EIS instance. |
true |
|
true |
Connector:JAVADOC:124 |
CredentialInterface |
jakarta.resource.spi.AuthenticationMechanism.credentialInterface
|
Represents the
interface that the resource adapter implementation supports for
the representation of the credentials. Note that BasicPassword
mechanism type should support the
jakarta.resource.spi.security.PasswordCredential interface. The
Kerbv5 mechanism type should support the
org.ietf.jgss.GSSCredential interface or the deprecated
jakarta.resource.spi.security.GenericCredential interface. |
true |
|
true |
Connector:JAVADOC:125 |
String[] |
jakarta.resource.spi.AuthenticationMechanism.description
|
The optional
description specifies any resource adapter specific requirement
for the support of security contract and authentication mechanism.
|
true |
|
true |
Connector:JAVADOC:126 |
CredentialInterface |
jakarta.resource.spi.AuthenticationMechanism.CredentialInterface.valueOf
( String ) |
|
true |
|
true |
Connector:JAVADOC:127 |
CredentialInterface[] |
jakarta.resource.spi.AuthenticationMechanism.CredentialInterface.values
|
|
true |
|
true |
Connector:JAVADOC:128 |
Timer |
jakarta.resource.spi.BootstrapContext.createTimer
|
Creates a new
java.util.Timer instance. The Timer instance could be used to
perform periodic Work executions or other tasks. |
true |
|
true |
Connector:JAVADOC:129 |
Timer |
jakarta.resource.spi.BootstrapContext.createTimer
throws UnavailableException
|
indicates that a
Timer instance is not available. The request may be retried later. |
true |
|
true |
Connector:JAVADOC:130 |
TransactionSynchronizationRegistry |
jakarta.resource.spi.BootstrapContext.getTransactionSynchronizationRegistry
|
Provides a handle
to a TransactionSynchronization instance. The
TransactionSynchronizationRegistry instance could be used by a
resource adapter to register synchronization objects, get
transaction state and status etc. This interface is implemented by
the application server by a stateless service object. The same
object can be used by any number of resource adapter objects with
thread safety. |
true |
|
true |
Connector:JAVADOC:131 |
WorkManager |
jakarta.resource.spi.BootstrapContext.getWorkManager
|
Provides a handle
to a WorkManager instance. The WorkManager instance could be used
by a resource adapter to do its work by submitting Work instances
for execution. |
true |
|
true |
Connector:JAVADOC:132 |
XATerminator |
jakarta.resource.spi.BootstrapContext.getXATerminator
|
Provides a handle
to a XATerminator instance. The XATerminator instance could be
used by a resource adapter to flow-in transaction completion and
crash recovery calls from an EIS. |
true |
|
true |
Connector:JAVADOC:133 |
boolean |
jakarta.resource.spi.BootstrapContext.isContextSupported
( Class ) |
A resource adapter
can check an application server's support for a particular
WorkContext type through this method. This mechanism enables a
resource adapter developer to dynamically change the WorkContexts
submitted with a Work instance based on the support provided by
the application server. The application server must employ an
exact type equality check (that is
java.lang.Class.equals(java.lang.Class) check) in this method, to
check if it supports the WorkContext type provided by the resource
adapter. This method must be idempotent, that is all calls to this
method by a resource adapter for a particular WorkContext type
must return the same boolean value throughout the lifecycle of
that resource adapter instance. |
true |
|
true |
Connector:JAVADOC:134 |
CommException |
jakarta.resource.spi.CommException.CommException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:135 |
CommException |
jakarta.resource.spi.CommException.CommException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:136 |
CommException |
jakarta.resource.spi.CommException.CommException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:137 |
CommException |
jakarta.resource.spi.CommException.CommException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:138 |
CommException |
jakarta.resource.spi.CommException.CommException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:139 |
boolean |
jakarta.resource.spi.ConfigProperty.confidential
|
Indicates that the
configuration property is confidential and recommends application
server's configuration tools to use special visual aids for
editing them. |
true |
|
true |
Connector:JAVADOC:140 |
String |
jakarta.resource.spi.ConfigProperty.defaultValue
|
Inferred by the
container for field based annotations if possible. |
true |
|
true |
Connector:JAVADOC:141 |
String[] |
jakarta.resource.spi.ConfigProperty.description
|
Describes the
configuration property. |
true |
|
true |
Connector:JAVADOC:142 |
boolean |
jakarta.resource.spi.ConfigProperty.ignore
|
Indicates that the
configuration tools must ignore considering this Property during
auto-discovery of Configuration properties. |
true |
|
true |
Connector:JAVADOC:143 |
boolean |
jakarta.resource.spi.ConfigProperty.supportsDynamicUpdates
|
Indicates that the
configuration property supports dynamic updates to its value
during the lifetime of the JavaBean |
true |
|
true |
Connector:JAVADOC:144 |
Class |
jakarta.resource.spi.ConfigProperty.type
|
Inferred by the
container if unspecified. |
true |
|
true |
Connector:JAVADOC:145 |
Class |
jakarta.resource.spi.ConnectionDefinition.connection
|
Specifies the
Connection interface supported by the resource adapter. Example:
jakarta.resource.cci.Connection or com.wombat.Connection |
true |
|
true |
Connector:JAVADOC:146 |
Class |
jakarta.resource.spi.ConnectionDefinition.connectionFactory
|
Specifies the
ConnectionFactory interface supported by the resource adapter.
Example: jakarta.resource.cci.ConnectionFactory or
com.wombat.ConnectionFactory |
true |
|
true |
Connector:JAVADOC:147 |
Class |
jakarta.resource.spi.ConnectionDefinition.connectionFactoryImpl
|
Specifies the Class
provided by the resource adapter that implements the resource
adapter specific ConnectionFactory interface. Example:
com.wombat.ConnectionFactoryImpl |
true |
|
true |
Connector:JAVADOC:148 |
Class |
jakarta.resource.spi.ConnectionDefinition.connectionImpl
|
Specifies the class
provided by the resource adapter that implements the resource
adapter specific Connection interface. Example:
com.wombat.ConnectionImpl |
true |
|
true |
Connector:JAVADOC:149 |
ConnectionDefinition[] |
jakarta.resource.spi.ConnectionDefinitions.value
|
An array of
ConnectionDefinition ConnectionDefinitions associated with the
ManagedConectionFactory JavaBean. |
true |
|
true |
Connector:JAVADOC:150 |
ConnectionEvent |
jakarta.resource.spi.ConnectionEvent.ConnectionEvent
( ManagedConnection ,
int ) |
Construct a
ConnectionEvent object. Exception defaults to null. |
true |
|
true |
Connector:JAVADOC:151 |
ConnectionEvent |
jakarta.resource.spi.ConnectionEvent.ConnectionEvent
( ManagedConnection ,
int ,
Exception ) |
Construct a
ConnectionEvent object. |
true |
|
true |
Connector:JAVADOC:152 |
Object |
jakarta.resource.spi.ConnectionEvent.getConnectionHandle
|
Get the connection
handle associated with the Managed Connection instance. Used for
CONNECTION_CLOSED event. |
true |
|
true |
Connector:JAVADOC:153 |
Exception |
jakarta.resource.spi.ConnectionEvent.getException
|
Get the exception.
May be null. |
true |
|
true |
Connector:JAVADOC:154 |
int |
jakarta.resource.spi.ConnectionEvent.getId
|
Get the type of
event |
true |
|
true |
Connector:JAVADOC:155 |
void |
jakarta.resource.spi.ConnectionEvent.setConnectionHandle
( Object ) |
Set the connection
handle. Used for CONNECTION_CLOSED event |
true |
|
true |
Connector:JAVADOC:156 |
void |
jakarta.resource.spi.ConnectionEventListener.connectionClosed
( ConnectionEvent ) |
Notifies that an
application component has closed the connection. A
ManagedConnection instance notifies its registered set of
listeners by calling ConnectionEventListener.connectionClosed
method when an application component closes a connection handle.
The application server uses this connection close event to put the
ManagedConnection instance back in to the connection pool. |
true |
|
true |
Connector:JAVADOC:157 |
void |
jakarta.resource.spi.ConnectionEventListener.connectionErrorOccurred
( ConnectionEvent ) |
Notifies a
connection related error. The ManagedConnection instance calls the
method ConnectionEventListener.connectionErrorOccurred to notify
its registered listeners of the occurrence of a physical
connection-related error. The event notification happens just
before a resource adapter throws an exception to the application
component using the connection handle. The connectionErrorOccurred
method indicates that the associated ManagedConnection instance is
now invalid and unusable. The application server handles the
connection error event notification by initiating application
server-specific cleanup (for example, removing ManagedConnection
instance from the connection pool) and then calling
ManagedConnection.destroy method to destroy the physical
connection. |
true |
|
true |
Connector:JAVADOC:158 |
void |
jakarta.resource.spi.ConnectionEventListener.localTransactionCommitted
( ConnectionEvent ) |
Notifies that a
Resource Manager Local Transaction was committed on the
ManagedConnection instance. |
true |
|
true |
Connector:JAVADOC:159 |
void |
jakarta.resource.spi.ConnectionEventListener.localTransactionRolledback
( ConnectionEvent ) |
Notifies that a
Resource Manager Local Transaction was rolled back on the
ManagedConnection instance. |
true |
|
true |
Connector:JAVADOC:160 |
void |
jakarta.resource.spi.ConnectionEventListener.localTransactionStarted
( ConnectionEvent ) |
Notifies that a
Resource Manager Local Transaction was started on the
ManagedConnection instance. |
true |
|
true |
Connector:JAVADOC:161 |
Object |
jakarta.resource.spi.ConnectionManager.allocateConnection
( ManagedConnectionFactory ,
ConnectionRequestInfo ) |
The method
allocateConnection gets called by the resource adapter's
connection factory instance. This lets connection factory instance
(provided by the resource adapter) pass a connection request to
the ConnectionManager instance. The connectionRequestInfo
parameter represents information specific to the resource adapter
for handling of the connection request. |
true |
|
true |
Connector:JAVADOC:162 |
Object |
jakarta.resource.spi.ConnectionManager.allocateConnection
( ManagedConnectionFactory ,
ConnectionRequestInfo )
throws ResourceException
|
Generic exception |
true |
|
true |
Connector:JAVADOC:163 |
boolean |
jakarta.resource.spi.ConnectionRequestInfo.equals
( Object ) |
Checks whether this
instance is equal to another. Since connectionRequestInfo is
defined specific to a resource adapter, the resource adapter is
required to implement this method. The conditions for equality are
specific to the resource adapter. |
true |
|
true |
Connector:JAVADOC:164 |
int |
jakarta.resource.spi.ConnectionRequestInfo.hashCode
|
Returns the
hashCode of the ConnectionRequestInfo. |
true |
|
true |
Connector:JAVADOC:165 |
AuthenticationMechanism[] |
jakarta.resource.spi.Connector.authMechanisms
|
Specifies the
authentication mechanisms supported by the resource adapter. |
true |
|
true |
Connector:JAVADOC:166 |
String[] |
jakarta.resource.spi.Connector.description
|
Describes the
resource adapter module. |
true |
|
true |
Connector:JAVADOC:167 |
String[] |
jakarta.resource.spi.Connector.displayName
|
An optional short
name, providing information about the resource adapter module,
that is intended to be displayed by tools. |
true |
|
true |
Connector:JAVADOC:168 |
String |
jakarta.resource.spi.Connector.eisType
|
Contains
information about the type of EIS. For example, the type of an EIS
can be product name of the EIS independent of any version
info.This helps in identifying EIS instances that can be used with
this resource adapter. |
true |
|
true |
Connector:JAVADOC:169 |
String[] |
jakarta.resource.spi.Connector.largeIcon
|
Specifies the file
name for large GIF or JPEG icon images that are used to represent
the resource adapter in a GUI tool. Each smallIcon must be
associated with a largeIcon element and the application server
must use the ordinal value in their respective arrays to find the
related pairs of icons. |
true |
|
true |
Connector:JAVADOC:170 |
String[] |
jakarta.resource.spi.Connector.licenseDescription
|
Specifies licensing
requirements for the resource adapter module and an optional
description of the licensing terms . |
true |
|
true |
Connector:JAVADOC:171 |
boolean |
jakarta.resource.spi.Connector.licenseRequired
|
Specifies whether a
license is required to deploy and use this resource adapter |
true |
|
true |
Connector:JAVADOC:172 |
boolean |
jakarta.resource.spi.Connector.reauthenticationSupport
|
Specifies whether a
license is required to deploy and use this resource adapter |
true |
|
true |
Connector:JAVADOC:173 |
Class[] |
jakarta.resource.spi.Connector.requiredWorkContexts
|
Specifies a list of
fully qualified classes that implements the WorkContext
WorkContext interface that a resource adapter requires the
application server to support. |
true |
|
true |
Connector:JAVADOC:174 |
SecurityPermission[] |
jakarta.resource.spi.Connector.securityPermissions
|
Specifies the
extended security permissions required to be provided for the
operation of the resource adapter module |
true |
|
true |
Connector:JAVADOC:175 |
String[] |
jakarta.resource.spi.Connector.smallIcon
|
Specifies the file
name for small GIF or JPEG icon images that are used to represent
the resource adapter in a GUI tool. Each smallIcon must be
associated with a largeIcon element and the application server
must use the ordinal value in their respective arrays to find the
related pairs of icons. |
true |
|
true |
Connector:JAVADOC:176 |
TransactionSupportLevel |
jakarta.resource.spi.Connector.transactionSupport
|
Specifies the level
of transaction support provided by the resource adapter. |
true |
|
true |
Connector:JAVADOC:177 |
String |
jakarta.resource.spi.Connector.vendorName
|
Specifies the name
of the resource adapter provider vendor. |
true |
|
true |
Connector:JAVADOC:178 |
String |
jakarta.resource.spi.Connector.version
|
Specifies the
version of the resource adapter implementation. |
true |
|
true |
Connector:JAVADOC:179 |
void |
jakarta.resource.spi.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. |
true |
|
false |
Connector:JAVADOC:180 |
void |
jakarta.resource.spi.DissociatableManagedConnection.dissociateConnections
throws ResourceException
|
generic exception if
operation fails. |
true |
|
false |
Connector:JAVADOC:181 |
EISSystemException |
jakarta.resource.spi.EISSystemException.EISSystemException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:182 |
EISSystemException |
jakarta.resource.spi.EISSystemException.EISSystemException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:183 |
EISSystemException |
jakarta.resource.spi.EISSystemException.EISSystemException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:184 |
EISSystemException |
jakarta.resource.spi.EISSystemException.EISSystemException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:185 |
EISSystemException |
jakarta.resource.spi.EISSystemException.EISSystemException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:186 |
IllegalStateException |
jakarta.resource.spi.IllegalStateException.IllegalStateException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:187 |
IllegalStateException |
jakarta.resource.spi.IllegalStateException.IllegalStateException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:188 |
IllegalStateException |
jakarta.resource.spi.IllegalStateException.IllegalStateException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:189 |
IllegalStateException |
jakarta.resource.spi.IllegalStateException.IllegalStateException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:190 |
IllegalStateException |
jakarta.resource.spi.IllegalStateException.IllegalStateException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:191 |
PropertyDescriptor[] |
jakarta.resource.spi.InvalidPropertyException.getInvalidPropertyDescriptors
|
Get the list of
invalid properties. |
true |
|
true |
Connector:JAVADOC:192 |
InvalidPropertyException |
jakarta.resource.spi.InvalidPropertyException.InvalidPropertyException
|
Create a
InvalidPropertyException. |
true |
|
true |
Connector:JAVADOC:193 |
InvalidPropertyException |
jakarta.resource.spi.InvalidPropertyException.InvalidPropertyException
( String ) |
Create a
InvalidPropertyException. |
true |
|
true |
Connector:JAVADOC:194 |
InvalidPropertyException |
jakarta.resource.spi.InvalidPropertyException.InvalidPropertyException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:195 |
InvalidPropertyException |
jakarta.resource.spi.InvalidPropertyException.InvalidPropertyException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:196 |
InvalidPropertyException |
jakarta.resource.spi.InvalidPropertyException.InvalidPropertyException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:197 |
void |
jakarta.resource.spi.InvalidPropertyException.setInvalidPropertyDescriptors
( PropertyDescriptor[] ) |
Set a list of
invalid properties. |
true |
|
true |
Connector:JAVADOC:198 |
void |
jakarta.resource.spi.LazyAssociatableConnectionManager.associateConnection
( Object ,
ManagedConnectionFactory ,
ConnectionRequestInfo ) |
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. |
true |
|
false |
Connector:JAVADOC:199 |
void |
jakarta.resource.spi.LazyAssociatableConnectionManager.associateConnection
( Object ,
ManagedConnectionFactory ,
ConnectionRequestInfo )
throws ResourceException
|
Generic exception. |
true |
|
false |
Connector:JAVADOC:200 |
void |
jakarta.resource.spi.LazyAssociatableConnectionManager.inactiveConnectionClosed
( Object ,
ManagedConnectionFactory ) |
This method is
called by the resource adapter (that is capable of lazy connection
association optimization) in order to notify the application
server that a disassociated connection handle is closed. The
application server can then perform any cleanup operations related
to the disassociated connection handle in its connection pool. |
true |
|
false |
Connector:JAVADOC:201 |
void |
jakarta.resource.spi.LazyEnlistableConnectionManager.lazyEnlist
( ManagedConnection ) |
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. |
true |
|
false |
Connector:JAVADOC:202 |
void |
jakarta.resource.spi.LazyEnlistableConnectionManager.lazyEnlist
( ManagedConnection )
throws ResourceException
|
Generic exception. |
true |
|
false |
Connector:JAVADOC:203 |
void |
jakarta.resource.spi.LocalTransaction.begin
|
Begin a local
transaction |
true |
|
true |
Connector:JAVADOC:204 |
void |
jakarta.resource.spi.LocalTransaction.begin
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:205 |
void |
jakarta.resource.spi.LocalTransaction.commit
|
Commit a local
transaction |
true |
|
true |
Connector:JAVADOC:206 |
void |
jakarta.resource.spi.LocalTransaction.commit
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:207 |
void |
jakarta.resource.spi.LocalTransaction.rollback
|
Rollback a local
transaction |
true |
|
true |
Connector:JAVADOC:208 |
void |
jakarta.resource.spi.LocalTransaction.rollback
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:209 |
LocalTransactionException |
jakarta.resource.spi.LocalTransactionException.LocalTransactionException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:210 |
LocalTransactionException |
jakarta.resource.spi.LocalTransactionException.LocalTransactionException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:211 |
LocalTransactionException |
jakarta.resource.spi.LocalTransactionException.LocalTransactionException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:212 |
LocalTransactionException |
jakarta.resource.spi.LocalTransactionException.LocalTransactionException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:213 |
LocalTransactionException |
jakarta.resource.spi.LocalTransactionException.LocalTransactionException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:214 |
void |
jakarta.resource.spi.ManagedConnection.addConnectionEventListener
( ConnectionEventListener ) |
Adds a connection
event listener to the ManagedConnection instance. The registered
ConnectionEventListener instances are notified of connection close
and error events, also of local transaction related events on the
Managed Connection. |
true |
|
true |
Connector:JAVADOC:215 |
void |
jakarta.resource.spi.ManagedConnection.associateConnection
( Object ) |
Used typically by
the container to change the association of an application-level
connection handle with a ManagedConneciton instance. The container
should find the right ManagedConnection instance and call the
associateConnection method. In order to set a Connection Handle as
the active connection handle, the container may also use the
associateConnection method to set the same ManagedConnection
associated with the Connection handle. The resource adapter is
required to implement the associateConnection method. The method
implementation for a ManagedConnection should dissociate the
connection handle (passed as a parameter) from its currently
associated ManagedConnection and associate the new connection
handle with itself. |
true |
|
false |
Connector:JAVADOC:216 |
void |
jakarta.resource.spi.ManagedConnection.associateConnection
( Object )
throws ResourceException
|
Failed to associate
the connection handle with this ManagedConnection instance |
true |
|
true |
Connector:JAVADOC:217 |
void |
jakarta.resource.spi.ManagedConnection.cleanup
|
Application server
calls this method to force any cleanup on the ManagedConnection
instance. The method ManagedConnection.cleanup initiates a cleanup
of the any client-specific state as maintained by a
ManagedConnection instance. The cleanup should invalidate all
connection handles that had been created using this
ManagedConnection instance. Any attempt by an application
component to use the connection handle after cleanup of the
underlying ManagedConnection should result in an exception. The
cleanup of ManagedConnection is always driven by an application
server. An application server should not invoke
ManagedConnection.cleanup when there is an uncompleted transaction
(associated with a ManagedConnection instance) in progress. The
invocation of ManagedConnection.cleanup method on an already
cleaned-up connection should not throw an exception. The cleanup
of ManagedConnection instance resets its client specific state and
prepares the connection to be put back in to a connection pool.
The cleanup method should not cause resource adapter to close the
physical pipe and reclaim system resources associated with the
physical connection. |
true |
|
false |
Connector:JAVADOC:218 |
void |
jakarta.resource.spi.ManagedConnection.cleanup
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:219 |
void |
jakarta.resource.spi.ManagedConnection.destroy
|
Destroys the
physical connection to the underlying resource manager. To manage
the size of the connection pool, an application server can
explictly call ManagedConnection.destroy to destroy a physical
connection. A resource adapter should destroy all allocated system
resources for this ManagedConnection instance when the method
destroy is called. |
true |
|
false |
Connector:JAVADOC:220 |
void |
jakarta.resource.spi.ManagedConnection.destroy
throws ResourceException
|
generic exception if
operation failed |
true |
|
true |
Connector:JAVADOC:221 |
Object |
jakarta.resource.spi.ManagedConnection.getConnection
( Subject ,
ConnectionRequestInfo ) |
Creates a new
connection handle for the underlying physical connection
represented by the ManagedConnection instance. This connection
handle is used by the application code to refer to the underlying
physical connection. This connection handle is associated with its
ManagedConnection instance in a resource adapter implementation
specific way. The ManagedConnection uses the Subject and
additional ConnectionRequest Info (which is specific to resource
adapter and opaque to application server) to set the state of the
physical connection. |
true |
|
true |
Connector:JAVADOC:222 |
Object |
jakarta.resource.spi.ManagedConnection.getConnection
( Subject ,
ConnectionRequestInfo )
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:223 |
LocalTransaction |
jakarta.resource.spi.ManagedConnection.getLocalTransaction
|
Returns an
jakarta.resource.spi.LocalTransaction instance. The
LocalTransaction interface is used by the container to manage
local transactions for a RM instance. |
true |
|
true |
Connector:JAVADOC:224 |
LocalTransaction |
jakarta.resource.spi.ManagedConnection.getLocalTransaction
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:225 |
PrintWriter |
jakarta.resource.spi.ManagedConnection.getLogWriter
|
Gets the log writer
for this ManagedConnection instance. The log writer is a character
output stream to which all logging and tracing messages for this
ManagedConnection instance will be printed. ConnectionManager
manages the association of output stream with the
ManagedConnection instance based on the connection pooling
requirements. The Log writer associated with a ManagedConnection
instance can be one set as default from the
ManagedConnectionFactory (that created this connection) or one set
specifically for this instance by the application server. |
true |
|
true |
Connector:JAVADOC:226 |
PrintWriter |
jakarta.resource.spi.ManagedConnection.getLogWriter
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:227 |
ManagedConnectionMetaData |
jakarta.resource.spi.ManagedConnection.getMetaData
|
Gets the metadata
information for this connection's underlying EIS resource manager
instance. The ManagedConnectionMetaData interface provides
information about the underlying EIS instance associated with the
ManagedConenction instance. |
true |
|
true |
Connector:JAVADOC:228 |
ManagedConnectionMetaData |
jakarta.resource.spi.ManagedConnection.getMetaData
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:229 |
XAResource |
jakarta.resource.spi.ManagedConnection.getXAResource
|
Returns an
javax.transaction.xa.XAresource instance. An application server
enlists this XAResource instance with the Transaction Manager if
the ManagedConnection instance is being used in a JTA transaction
that is being coordinated by the Transaction Manager. |
true |
|
true |
Connector:JAVADOC:230 |
XAResource |
jakarta.resource.spi.ManagedConnection.getXAResource
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:231 |
void |
jakarta.resource.spi.ManagedConnection.removeConnectionEventListener
( ConnectionEventListener ) |
Removes an already
registered connection event listener from the ManagedConnection
instance. |
true |
|
true |
Connector:JAVADOC:232 |
void |
jakarta.resource.spi.ManagedConnection.setLogWriter
( PrintWriter ) |
Sets the log writer
for this ManagedConnection instance. The log writer is a character
output stream to which all logging and tracing messages for this
ManagedConnection instance will be printed. Application Server
manages the association of output stream with the
ManagedConnection instance based on the connection pooling
requirements. When a ManagedConnection object is initially
created, the default log writer associated with this instance is
obtained from the ManagedConnectionFactory. An application server
can set a log writer specific to this ManagedConnection to
log/trace this instance using setLogWriter method. |
true |
|
true |
Connector:JAVADOC:233 |
void |
jakarta.resource.spi.ManagedConnection.setLogWriter
( PrintWriter )
throws ResourceException
|
generic exception if
operation fails |
true |
|
true |
Connector:JAVADOC:234 |
Object |
jakarta.resource.spi.ManagedConnectionFactory.createConnectionFactory
( ConnectionManager ) |
Creates a
Connection Factory instance. The Connection Factory instance gets
initialized with the passed ConnectionManager. In the managed
scenario, ConnectionManager is provided by the application server.
|
true |
|
true |
Connector:JAVADOC:235 |
Object |
jakarta.resource.spi.ManagedConnectionFactory.createConnectionFactory
( ConnectionManager )
throws ResourceException
|
Generic exception |
true |
|
true |
Connector:JAVADOC:236 |
Object |
jakarta.resource.spi.ManagedConnectionFactory.createConnectionFactory
|
Creates a
Connection Factory instance. The Connection Factory instance gets
initialized with a default ConnectionManager provided by the
resource adapter. |
true |
|
true |
Connector:JAVADOC:237 |
Object |
jakarta.resource.spi.ManagedConnectionFactory.createConnectionFactory
throws ResourceException
|
Generic exception |
true |
|
true |
Connector:JAVADOC:238 |
ManagedConnection |
jakarta.resource.spi.ManagedConnectionFactory.createManagedConnection
( Subject ,
ConnectionRequestInfo ) |
Creates a new
physical connection to the underlying EIS resource manager.
ManagedConnectionFactory uses the security information (passed as
Subject) and additional ConnectionRequestInfo (which is specific
to ResourceAdapter and opaque to application server) to create
this new connection. |
true |
|
true |
Connector:JAVADOC:239 |
ManagedConnection |
jakarta.resource.spi.ManagedConnectionFactory.createManagedConnection
( Subject ,
ConnectionRequestInfo )
throws ResourceException
|
generic exception |
true |
|
true |
Connector:JAVADOC:240 |
boolean |
jakarta.resource.spi.ManagedConnectionFactory.equals
( Object ) |
Check if this
ManagedConnectionFactory is equal to another
ManagedConnectionFactory. |
true |
|
true |
Connector:JAVADOC:241 |
PrintWriter |
jakarta.resource.spi.ManagedConnectionFactory.getLogWriter
|
Get the log writer
for this ManagedConnectionFactory instance. The log writer is a
character output stream to which all logging and tracing messages
for this ManagedConnectionFactory instance will be printed
ApplicationServer manages the association of output stream with
the ManagedConnectionFactory. When a ManagedConnectionFactory
object is created the log writer is initially null, in other
words, logging is disabled. |
true |
|
true |
Connector:JAVADOC:242 |
PrintWriter |
jakarta.resource.spi.ManagedConnectionFactory.getLogWriter
throws ResourceException
|
generic exception |
true |
|
true |
Connector:JAVADOC:243 |
int |
jakarta.resource.spi.ManagedConnectionFactory.hashCode
|
Returns the hash
code for the ManagedConnectionFactory |
true |
|
true |
Connector:JAVADOC:244 |
ManagedConnection |
jakarta.resource.spi.ManagedConnectionFactory.matchManagedConnections
( Set ,
Subject ,
ConnectionRequestInfo ) |
Returns a matched
connection from the candidate set of connections.
ManagedConnectionFactory uses the security info (as in Subject)
and information provided through ConnectionRequestInfo and
additional Resource Adapter specific criteria to do matching. Note
that criteria used for matching is specific to a resource adapter
and is not prescribed by the Connector specification. This method
returns a ManagedConnection instance that is the best match for
handling the connection allocation request. |
true |
|
true |
Connector:JAVADOC:245 |
ManagedConnection |
jakarta.resource.spi.ManagedConnectionFactory.matchManagedConnections
( Set ,
Subject ,
ConnectionRequestInfo )
throws ResourceException
|
generic exception |
true |
|
true |
Connector:JAVADOC:246 |
void |
jakarta.resource.spi.ManagedConnectionFactory.setLogWriter
( PrintWriter ) |
Set the log writer
for this ManagedConnectionFactory instance. The log writer is a
character output stream to which all logging and tracing messages
for this ManagedConnectionfactory instance will be printed.
ApplicationServer manages the association of output stream with
the ManagedConnectionFactory. When a ManagedConnectionFactory
object is created the log writer is initially null, in other
words, logging is disabled. Once a log writer is associated with a
ManagedConnectionFactory, logging and tracing for
ManagedConnectionFactory instance is enabled. The
ManagedConnection instances created by ManagedConnectionFactory
"inherits" the log writer, which can be overridden by
ApplicationServer using ManagedConnection.setLogWriter to set
ManagedConnection specific logging and tracing. |
true |
|
true |
Connector:JAVADOC:247 |
void |
jakarta.resource.spi.ManagedConnectionFactory.setLogWriter
( PrintWriter )
throws ResourceException
|
generic exception |
true |
|
true |
Connector:JAVADOC:248 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getEISProductName
|
Returns Product
name of the underlying EIS instance connected through the
ManagedConnection. |
true |
|
true |
Connector:JAVADOC:249 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getEISProductName
throws ResourceException
|
|
true |
|
true |
Connector:JAVADOC:250 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getEISProductVersion
|
Returns product
version of the underlying EIS instance connected through the
ManagedConnection. |
true |
|
true |
Connector:JAVADOC:251 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getEISProductVersion
throws ResourceException
|
|
true |
|
true |
Connector:JAVADOC:252 |
int |
jakarta.resource.spi.ManagedConnectionMetaData.getMaxConnections
|
Returns maximum
limit on number of active concurrent connections that an EIS
instance can support across client processes. If an EIS instance
does not know about (or does not have) any such limit, it returns
a 0. |
true |
|
true |
Connector:JAVADOC:253 |
int |
jakarta.resource.spi.ManagedConnectionMetaData.getMaxConnections
throws ResourceException
|
|
true |
|
true |
Connector:JAVADOC:254 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getUserName
|
Returns name of the
user associated with the ManagedConnection instance. The name
corresponds to the resource principal under whose whose security
context, a connection to the EIS instance has been established. |
true |
|
true |
Connector:JAVADOC:255 |
String |
jakarta.resource.spi.ManagedConnectionMetaData.getUserName
throws ResourceException
|
|
true |
|
true |
Connector:JAVADOC:256 |
void |
jakarta.resource.spi.ResourceAdapter.endpointActivation
( MessageEndpointFactory ,
ActivationSpec ) |
This is called
during the activation of a message endpoint. This causes the
resource adapter instance to do the necessary setup (ie., setup
message delivery for the message endpoint with a message
provider). Note that message delivery to the message endpoint
might start even before this method returns. Endpoint activation
is deemed successful only when this method completes successfully
without throwing any exceptions. |
true |
|
true |
Connector:JAVADOC:257 |
void |
jakarta.resource.spi.ResourceAdapter.endpointActivation
( MessageEndpointFactory ,
ActivationSpec )
throws ResourceException
|
|
true |
|
true |
Connector:JAVADOC:258 |
void |
jakarta.resource.spi.ResourceAdapter.endpointDeactivation
( MessageEndpointFactory ,
ActivationSpec ) |
This is called when
a message endpoint is deactivated. The instances passed as
arguments to this method call should be identical to those passed
in for the corresponding 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. |
true |
|
true |
Connector:JAVADOC:259 |
XAResource[] |
jakarta.resource.spi.ResourceAdapter.getXAResources
( ActivationSpec[] ) |
This method is
called by the application server during crash recovery. This
method takes in an array of 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. |
true |
|
true |
Connector:JAVADOC:260 |
XAResource[] |
jakarta.resource.spi.ResourceAdapter.getXAResources
( ActivationSpec[] )
throws ResourceException
|
generic exception if
operation fails due to an error condition. |
true |
|
true |
Connector:JAVADOC:261 |
void |
jakarta.resource.spi.ResourceAdapter.start
( BootstrapContext ) |
This is called when
a resource adapter instance is bootstrapped. This may be during
resource adapter deployment or application server startup. This is
a startup notification from the application server, and this
method is called by an application server thread. The application
server thread executes in an unspecified context. 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. |
true |
|
true |
Connector:JAVADOC:262 |
void |
jakarta.resource.spi.ResourceAdapter.start
( BootstrapContext )
throws ResourceAdapterInternalException
|
indicates bootstrap
failure. The resource adapter instance is unusable and must be
discarded. |
true |
|
true |
Connector:JAVADOC:263 |
void |
jakarta.resource.spi.ResourceAdapter.stop
|
This is called when
a resource adapter instance is undeployed or during application
server shutdown. This is a shutdown notification from the
application server, and this method is called by an application
server thread. The application server thread executes in an
unspecified context. 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. |
true |
|
true |
Connector:JAVADOC:264 |
ResourceAdapter |
jakarta.resource.spi.ResourceAdapterAssociation.getResourceAdapter
|
Get the associated
ResourceAdapter object. |
true |
|
true |
Connector:JAVADOC:265 |
void |
jakarta.resource.spi.ResourceAdapterAssociation.setResourceAdapter
( ResourceAdapter ) |
Associate this
object with a ResourceAdapter object. Note, this method must be
called exactly once. That is, the association must not change
during the lifetime of this object. |
true |
|
true |
Connector:JAVADOC:266 |
void |
jakarta.resource.spi.ResourceAdapterAssociation.setResourceAdapter
( ResourceAdapter )
throws ResourceException
|
generic exception. |
true |
|
true |
Connector:JAVADOC:267 |
ResourceAdapterInternalException |
jakarta.resource.spi.ResourceAdapterInternalException.ResourceAdapterInternalException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:268 |
ResourceAdapterInternalException |
jakarta.resource.spi.ResourceAdapterInternalException.ResourceAdapterInternalException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:269 |
ResourceAdapterInternalException |
jakarta.resource.spi.ResourceAdapterInternalException.ResourceAdapterInternalException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:270 |
ResourceAdapterInternalException |
jakarta.resource.spi.ResourceAdapterInternalException.ResourceAdapterInternalException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:271 |
ResourceAdapterInternalException |
jakarta.resource.spi.ResourceAdapterInternalException.ResourceAdapterInternalException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:272 |
ResourceAllocationException |
jakarta.resource.spi.ResourceAllocationException.ResourceAllocationException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:273 |
ResourceAllocationException |
jakarta.resource.spi.ResourceAllocationException.ResourceAllocationException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:274 |
ResourceAllocationException |
jakarta.resource.spi.ResourceAllocationException.ResourceAllocationException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:275 |
ResourceAllocationException |
jakarta.resource.spi.ResourceAllocationException.ResourceAllocationException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:276 |
ResourceAllocationException |
jakarta.resource.spi.ResourceAllocationException.ResourceAllocationException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:277 |
RetryableUnavailableException |
jakarta.resource.spi.RetryableUnavailableException.RetryableUnavailableException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:278 |
RetryableUnavailableException |
jakarta.resource.spi.RetryableUnavailableException.RetryableUnavailableException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:279 |
RetryableUnavailableException |
jakarta.resource.spi.RetryableUnavailableException.RetryableUnavailableException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:280 |
RetryableUnavailableException |
jakarta.resource.spi.RetryableUnavailableException.RetryableUnavailableException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:281 |
RetryableUnavailableException |
jakarta.resource.spi.RetryableUnavailableException.RetryableUnavailableException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:282 |
SecurityException |
jakarta.resource.spi.SecurityException.SecurityException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:283 |
SecurityException |
jakarta.resource.spi.SecurityException.SecurityException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:284 |
SecurityException |
jakarta.resource.spi.SecurityException.SecurityException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:285 |
SecurityException |
jakarta.resource.spi.SecurityException.SecurityException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:286 |
SecurityException |
jakarta.resource.spi.SecurityException.SecurityException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:287 |
String[] |
jakarta.resource.spi.SecurityPermission.description
|
Specifies an
optional description to mention any specific reason that a
resource requires a given security permission. |
true |
|
true |
Connector:JAVADOC:288 |
String |
jakarta.resource.spi.SecurityPermission.permissionSpec
|
Specifies a
security permission based on the Security policy file syntax.
These security permissions are different from those required by
the default permission set as specified in the connector
specification. |
true |
|
true |
Connector:JAVADOC:289 |
SharingViolationException |
jakarta.resource.spi.SharingViolationException.SharingViolationException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:290 |
SharingViolationException |
jakarta.resource.spi.SharingViolationException.SharingViolationException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:291 |
SharingViolationException |
jakarta.resource.spi.SharingViolationException.SharingViolationException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:292 |
SharingViolationException |
jakarta.resource.spi.SharingViolationException.SharingViolationException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:293 |
SharingViolationException |
jakarta.resource.spi.SharingViolationException.SharingViolationException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and error code. |
true |
|
true |
Connector:JAVADOC:294 |
TransactionSupportLevel |
jakarta.resource.spi.TransactionSupport.getTransactionSupport
|
Get the level of
transaction support, supported by the ManagedConnectionFactory. A
resource adapter must always return a level of transaction support
whose ordinal value in TransactionSupportLevel enum is equal to or
lesser than the resource adapter's transaction support
classification. |
true |
|
true |
Connector:JAVADOC:295 |
TransactionSupportLevel |
jakarta.resource.spi.TransactionSupport.TransactionSupportLevel.valueOf
( String ) |
|
true |
|
true |
Connector:JAVADOC:296 |
TransactionSupportLevel[] |
jakarta.resource.spi.TransactionSupport.TransactionSupportLevel.values
|
|
true |
|
true |
Connector:JAVADOC:297 |
UnavailableException |
jakarta.resource.spi.UnavailableException.UnavailableException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:298 |
UnavailableException |
jakarta.resource.spi.UnavailableException.UnavailableException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:299 |
UnavailableException |
jakarta.resource.spi.UnavailableException.UnavailableException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:300 |
UnavailableException |
jakarta.resource.spi.UnavailableException.UnavailableException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:301 |
UnavailableException |
jakarta.resource.spi.UnavailableException.UnavailableException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:302 |
Set |
jakarta.resource.spi.ValidatingManagedConnectionFactory.getInvalidConnections
( Set ) |
This method returns
a set of invalid ManagedConnection objects chosen from a specified
set of ManagedConnection objects. |
true |
|
true |
Connector:JAVADOC:303 |
Set |
jakarta.resource.spi.ValidatingManagedConnectionFactory.getInvalidConnections
( Set )
throws ResourceException
|
generic exception. |
true |
|
true |
Connector:JAVADOC:304 |
void |
jakarta.resource.spi.XATerminator.commit
( Xid ,
boolean ) |
Commits the global
transaction specified by xid. |
true |
|
true |
Connector:JAVADOC:305 |
void |
jakarta.resource.spi.XATerminator.commit
( Xid ,
boolean )
throws XAException
|
An error has
occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM,
XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA,
XAER_INVAL, or XAER_PROTO. If the resource manager did not commit
the transaction and the parameter onePhase is set to true, the
resource manager may throw one of the XA_RB* exceptions. Upon
return, the resource manager has rolled back the branch's work and
has released all held resources. |
true |
|
true |
Connector:JAVADOC:306 |
void |
jakarta.resource.spi.XATerminator.forget
( Xid ) |
Tells the resource
manager to forget about a heuristically completed transaction
branch. |
true |
|
true |
Connector:JAVADOC:307 |
void |
jakarta.resource.spi.XATerminator.forget
( Xid )
throws XAException
|
An error has
occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL,
XAER_NOTA, XAER_INVAL, or XAER_PROTO. |
true |
|
true |
Connector:JAVADOC:308 |
int |
jakarta.resource.spi.XATerminator.prepare
( Xid ) |
Ask the resource
manager to prepare for a transaction commit of the transaction
specified in xid. |
true |
|
true |
Connector:JAVADOC:309 |
int |
jakarta.resource.spi.XATerminator.prepare
( Xid )
throws XAException
|
An error has
occurred. Possible exception values are: XA_RB*, XAER_RMERR,
XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. |
true |
|
true |
Connector:JAVADOC:310 |
Xid[] |
jakarta.resource.spi.XATerminator.recover
( int ) |
Obtains a list of
prepared transaction branches from a resource manager. The
transaction manager calls this method during recovery to obtain
the list of transaction branches that are currently in prepared or
heuristically completed states. |
true |
|
true |
Connector:JAVADOC:311 |
Xid[] |
jakarta.resource.spi.XATerminator.recover
( int )
throws XAException
|
An error has
occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL,
and XAER_PROTO. |
true |
|
true |
Connector:JAVADOC:312 |
void |
jakarta.resource.spi.XATerminator.rollback
( Xid ) |
Informs the
resource manager to roll back work done on behalf of a transaction
branch. |
true |
|
true |
Connector:JAVADOC:313 |
void |
jakarta.resource.spi.XATerminator.rollback
( Xid )
throws XAException
|
An error has
occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM,
XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA,
XAER_INVAL, or XAER_PROTO. If the transaction branch is already
marked rollback-only the resource manager may throw one of the
XA_RB* exceptions. Upon return, the resource manager has rolled
back the branch's work and has released all held resources. |
true |
|
true |
Connector:JAVADOC:314 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.afterDelivery
|
This is called by a
resource adapter after a message is delivered. |
true |
|
true |
Connector:JAVADOC:315 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.afterDelivery
throws ResourceException
|
generic exception. |
true |
|
true |
Connector:JAVADOC:316 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.beforeDelivery
( Method ) |
This is called by a
resource adapter before a message is delivered. |
true |
|
true |
Connector:JAVADOC:317 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.beforeDelivery
( Method )
throws NoSuchMethodException
|
indicates that the
specified method does not exist on the target endpoint. |
true |
|
true |
Connector:JAVADOC:318 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.beforeDelivery
( Method )
throws ResourceException
|
generic exception. |
true |
|
true |
Connector:JAVADOC:319 |
void |
jakarta.resource.spi.endpoint.MessageEndpoint.release
|
This method may be
called by the resource adapter to indicate that it no longer needs
a proxy endpoint instance. This hint may be used by the
application server for endpoint pooling decisions. |
true |
|
true |
Connector:JAVADOC:320 |
MessageEndpoint |
jakarta.resource.spi.endpoint.MessageEndpointFactory.createEndpoint
( XAResource ) |
This is used to
create a message endpoint. The message endpoint is expected to
implement the correct message listener type. |
true |
|
true |
Connector:JAVADOC:321 |
MessageEndpoint |
jakarta.resource.spi.endpoint.MessageEndpointFactory.createEndpoint
( XAResource )
throws UnavailableException
|
indicates a
transient failure in creating a message endpoint. Subsequent
attempts to create a message endpoint might succeed. |
true |
|
true |
Connector:JAVADOC:322 |
MessageEndpoint |
jakarta.resource.spi.endpoint.MessageEndpointFactory.createEndpoint
( XAResource ,
long ) |
This is used to
create a message endpoint. The message endpoint is expected to
implement the correct message listener type. |
true |
|
true |
Connector:JAVADOC:323 |
MessageEndpoint |
jakarta.resource.spi.endpoint.MessageEndpointFactory.createEndpoint
( XAResource ,
long )
throws UnavailableException
|
indicates a
transient failure in creating a message endpoint. Subsequent
attempts to create a message endpoint might succeed. |
true |
|
true |
Connector:JAVADOC:324 |
boolean |
jakarta.resource.spi.endpoint.MessageEndpointFactory.isDeliveryTransacted
( Method ) |
This is used to
find out whether message deliveries to a target method on a
message listener interface that is implemented by a message
endpoint will be transacted or not. The message endpoint may
indicate its transacted delivery preferences (at a per method
level) through its deployment descriptor. The message delivery
preferences must not change during the lifetime of a message
endpoint. |
true |
|
true |
Connector:JAVADOC:325 |
boolean |
jakarta.resource.spi.endpoint.MessageEndpointFactory.isDeliveryTransacted
( Method )
throws NoSuchMethodException
|
indicates that the
specified method does not exist on the target endpoint. |
true |
|
true |
Connector:JAVADOC:326 |
boolean |
jakarta.resource.spi.security.GenericCredential.equals
( Object ) |
Tests if this
GenericCredential instance refers to the same entity as the
supplied object. The two credentials must be acquired over the
same mechanisms and must refer to the same principal. Returns true
if the two GenericCredentials refer to the same entity; false
otherwise. |
true |
true |
true |
Connector:JAVADOC:327 |
byte[] |
jakarta.resource.spi.security.GenericCredential.getCredentialData
|
Gets security data
for a specific security mechanism represented by the
GenericCredential. An example is authentication data required for
establishing a secure association with an EIS instance on behalf
of the associated resource principal. The getCredentialData method
returns the credential representation as an array of bytes. Note
that the connector architecture does not define any standard
format for the returned credential data. |
true |
true |
true |
Connector:JAVADOC:328 |
byte[] |
jakarta.resource.spi.security.GenericCredential.getCredentialData
throws SecurityException
|
Failed operation due
to security related error condition |
true |
true |
true |
Connector:JAVADOC:329 |
String |
jakarta.resource.spi.security.GenericCredential.getMechType
|
Returns the
mechanism type for the GenericCredential instance. The mechanism
type definition for GenericCredential should be consistent with
the Object Identifier (OID) based representation specified in the
GSS specification. In the GenericCredential interface, the
mechanism type is returned as a stringified representation of the
OID specification. |
true |
true |
true |
Connector:JAVADOC:330 |
String |
jakarta.resource.spi.security.GenericCredential.getName
|
Returns the name of
the resource principal associated with a GenericCredential
instance. |
true |
true |
true |
Connector:JAVADOC:331 |
int |
jakarta.resource.spi.security.GenericCredential.hashCode
|
Returns the hash
code for this GenericCredential |
true |
true |
true |
Connector:JAVADOC:332 |
boolean |
jakarta.resource.spi.security.PasswordCredential.equals
( Object ) |
Compares this
PasswordCredential with the specified object for equality. The two
PasswordCredential instances are the same if they are equal in
username and password. |
true |
|
true |
Connector:JAVADOC:333 |
ManagedConnectionFactory |
jakarta.resource.spi.security.PasswordCredential.getManagedConnectionFactory
|
Gets the target
ManagedConnectionFactory for which the user name and password has
been set by the application server. A ManagedConnection- Factory
uses this field to find out whether PasswordCredential should be
used by it for sign-on to the target EIS instance. |
true |
|
true |
Connector:JAVADOC:334 |
char[] |
jakarta.resource.spi.security.PasswordCredential.getPassword
|
Returns the user
password. Note that this method returns a reference to the
password. It is the caller's responsibility to zero out the
password information after it is no longer needed. |
true |
|
true |
Connector:JAVADOC:335 |
String |
jakarta.resource.spi.security.PasswordCredential.getUserName
|
Returns the user
name. |
true |
|
true |
Connector:JAVADOC:336 |
int |
jakarta.resource.spi.security.PasswordCredential.hashCode
|
Returns the hash
code for this PasswordCredential |
true |
|
true |
Connector:JAVADOC:337 |
PasswordCredential |
jakarta.resource.spi.security.PasswordCredential.PasswordCredential
( String ,
char[] ) |
Creates a new
PasswordCredential object from the given user name and password.
Note that the given user password is cloned before it is stored in
the new PasswordCredential object. |
true |
|
true |
Connector:JAVADOC:338 |
void |
jakarta.resource.spi.security.PasswordCredential.setManagedConnectionFactory
( ManagedConnectionFactory ) |
Sets the target
ManagedConenctionFactory instance for which the user name and
password has been set by the application server. |
true |
|
true |
Connector:JAVADOC:339 |
ExecutionContext |
jakarta.resource.spi.work.ExecutionContext.ExecutionContext
|
|
true |
|
true |
Connector:JAVADOC:340 |
long |
jakarta.resource.spi.work.ExecutionContext.getTransactionTimeout
|
Get the transaction
timeout value for a imported transaction. |
true |
|
true |
Connector:JAVADOC:341 |
Xid |
jakarta.resource.spi.work.ExecutionContext.getXid
|
|
true |
|
true |
Connector:JAVADOC:342 |
void |
jakarta.resource.spi.work.ExecutionContext.setTransactionTimeout
( long ) |
Set the transaction
timeout value for a imported transaction. |
true |
|
true |
Connector:JAVADOC:343 |
void |
jakarta.resource.spi.work.ExecutionContext.setTransactionTimeout
( long )
throws NotSupportedException
|
thrown to indicate
an illegal timeout value. |
true |
|
true |
Connector:JAVADOC:344 |
void |
jakarta.resource.spi.work.ExecutionContext.setXid
( Xid ) |
set a transaction
context. |
true |
|
true |
Connector:JAVADOC:345 |
String |
jakarta.resource.spi.work.HintsContext.getDescription
|
|
true |
|
true |
Connector:JAVADOC:346 |
Map |
jakarta.resource.spi.work.HintsContext.getHints
|
|
true |
|
true |
Connector:JAVADOC:347 |
String |
jakarta.resource.spi.work.HintsContext.getName
|
|
true |
|
true |
Connector:JAVADOC:348 |
HintsContext |
jakarta.resource.spi.work.HintsContext.HintsContext
|
|
true |
|
true |
Connector:JAVADOC:349 |
void |
jakarta.resource.spi.work.HintsContext.setDescription
( String ) |
Set a brief
description of the role played by the instance of HintsContext and
any other related debugging information. This could be used by the
resource adapter and the WorkManager for logging and debugging
purposes. |
true |
|
true |
Connector:JAVADOC:350 |
void |
jakarta.resource.spi.work.HintsContext.setHint
( String ,
Serializable ) |
Set a Hint and a
related value. The hintName must be non-Null. Standard HintNames
are defined in the Connector specification. Use of
"jakarta.resource." prefixed hintNames are reserved for use by the
Connector specification. |
true |
|
true |
Connector:JAVADOC:351 |
void |
jakarta.resource.spi.work.HintsContext.setName
( String ) |
Set the associated
name of the HintsContext. This could be used by the resource
adapter and the WorkManager for logging and debugging purposes. |
true |
|
true |
Connector:JAVADOC:352 |
RetryableWorkRejectedException |
jakarta.resource.spi.work.RetryableWorkRejectedException.RetryableWorkRejectedException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:353 |
RetryableWorkRejectedException |
jakarta.resource.spi.work.RetryableWorkRejectedException.RetryableWorkRejectedException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:354 |
RetryableWorkRejectedException |
jakarta.resource.spi.work.RetryableWorkRejectedException.RetryableWorkRejectedException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:355 |
RetryableWorkRejectedException |
jakarta.resource.spi.work.RetryableWorkRejectedException.RetryableWorkRejectedException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:356 |
RetryableWorkRejectedException |
jakarta.resource.spi.work.RetryableWorkRejectedException.RetryableWorkRejectedException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:357 |
String |
jakarta.resource.spi.work.SecurityContext.getDescription
|
|
true |
|
true |
Connector:JAVADOC:358 |
String |
jakarta.resource.spi.work.SecurityContext.getName
|
|
true |
|
true |
Connector:JAVADOC:359 |
SecurityContext |
jakarta.resource.spi.work.SecurityContext.SecurityContext
|
|
true |
|
true |
Connector:JAVADOC:360 |
void |
jakarta.resource.spi.work.SecurityContext.setupSecurityContext
( CallbackHandler ,
Subject ,
Subject ) |
The container calls
this method to set up the security Context for the Work instance.
The handler argument must not be null, and the argument handler
and the CallbackHandler passed to this method must support the
following Callbacks defined in JSR 196: Java Authentication SPI
for Containers specification: CallerPrincipalCallback
GroupPrincipalCallback PasswordValidationCallback The following
Callbacks may be supported by the container. CertStoreCallback
PrivateKeyCallback SecretKeyCallback TrustStoreCallback A resource
adapter might use the CallerPrincipalCallback "to set the
container's representation of the caller principal. The
CallbackHandler must establish the argument Principal as the
caller principal associated with the invocation being processed by
the container. When the argument Principal is null, the handler
will establish the container's representation of the
unauthenticated caller principal." A resource adapter might use
the GroupPrincipalCallback "to establish the container's
representation of the corresponding group principals within the
Subject. When a null value is passed to the groups argument, the
handler will establish the container's representation of no group
principals within the Subject. Otherwise, the handler's processing
of this callback is additive, yielding the union (without
duplicates) of the principals existing within the Subject, and
those created with the names occurring within the argument array.
The CallbackHandler will define the type of the created
principals." A resource adapter might use the
PasswordValidationCallback "to employ the password validation
facilities of its containing runtime." The executionSubject
argument must be non-null and it must not be read-only. It is
expected that this method will populate this executionSubject with
principals and credentials that would be flown into the
application server. The serviceSubject argument must be non-null
and it must not be read-only. It represents the application server
and it may be used by the Work implementation to retrieve
Principals and credentials necessary to establish a connection to
the EIS (in the cause of mutual-auth like scenarios). If the
Subject is not null, the Work implementation may collect the
server credentials, as necessary, by using the callback handler
passed to them . When this method is called, the method
implementation identifies the security context that needs to be
flown-in to the application server to serve as the execution
context of the Work instance. populates the executionSubject with
the EIS Principals and Credentials that it wants to serve as the
security context for the Work instance to be executed in. adds
instances of the necessary Callbacks , usually a subset of the
ones listed above, to an array and invokes the handle() method in
the container's CallbackHandler implementation passing in the
array of Callback instances. on successful return from the
CallbackHandler.handle() method the setSecurityContext returns
after ensuring that the executionSubject is populated with the
valid Principals and Credentials that represent the execution
context of the Work instance |
true |
|
true |
Connector:JAVADOC:361 |
String |
jakarta.resource.spi.work.TransactionContext.getDescription
|
|
true |
|
true |
Connector:JAVADOC:362 |
String |
jakarta.resource.spi.work.TransactionContext.getName
|
|
true |
|
true |
Connector:JAVADOC:363 |
TransactionContext |
jakarta.resource.spi.work.TransactionContext.TransactionContext
|
|
true |
|
true |
Connector:JAVADOC:364 |
void |
jakarta.resource.spi.work.Work.release
|
The WorkManager
might call this method to hint the active Work instance to
complete execution as soon as possible. This would be called on a
separate thread other than the one currently executing the Work
instance. |
true |
|
true |
Connector:JAVADOC:365 |
void |
jakarta.resource.spi.work.WorkAdapter.workAccepted
( WorkEvent ) |
Invoked when a Work
instance has been accepted. |
true |
|
true |
Connector:JAVADOC:366 |
WorkAdapter |
jakarta.resource.spi.work.WorkAdapter.WorkAdapter
|
|
true |
|
true |
Connector:JAVADOC:367 |
void |
jakarta.resource.spi.work.WorkAdapter.workCompleted
( WorkEvent ) |
Invoked when a Work
instance has completed execution. |
true |
|
true |
Connector:JAVADOC:368 |
void |
jakarta.resource.spi.work.WorkAdapter.workRejected
( WorkEvent ) |
Invoked when a Work
instance has been rejected. |
true |
|
true |
Connector:JAVADOC:369 |
void |
jakarta.resource.spi.work.WorkAdapter.workStarted
( WorkEvent ) |
Invoked when a Work
instance has started execution. This only means that a thread has
been allocated. |
true |
|
true |
Connector:JAVADOC:370 |
WorkCompletedException |
jakarta.resource.spi.work.WorkCompletedException.WorkCompletedException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:371 |
WorkCompletedException |
jakarta.resource.spi.work.WorkCompletedException.WorkCompletedException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:372 |
WorkCompletedException |
jakarta.resource.spi.work.WorkCompletedException.WorkCompletedException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:373 |
WorkCompletedException |
jakarta.resource.spi.work.WorkCompletedException.WorkCompletedException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:374 |
WorkCompletedException |
jakarta.resource.spi.work.WorkCompletedException.WorkCompletedException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:375 |
String |
jakarta.resource.spi.work.WorkContext.getDescription
|
Get the brief
description of the role played by the WorkContext and any other
related debugging information. This could be used by the
WorkManager and the resource adapter for debugging purposes. |
true |
|
true |
Connector:JAVADOC:376 |
String |
jakarta.resource.spi.work.WorkContext.getName
|
Get the associated
name of the WorkContext. This could be used by the WorkManager and
the resource adapter for debugging purposes. |
true |
|
true |
Connector:JAVADOC:377 |
WorkContextErrorCodes |
jakarta.resource.spi.work.WorkContextErrorCodes.WorkContextErrorCodes
|
|
true |
|
true |
Connector:JAVADOC:378 |
void |
jakarta.resource.spi.work.WorkContextLifecycleListener.contextSetupComplete
|
Invoked when the
WorkContext instance was successfully set as the execution context
for the Work instance. |
true |
|
true |
Connector:JAVADOC:379 |
void |
jakarta.resource.spi.work.WorkContextLifecycleListener.contextSetupFailed
( String ) |
Invoked when the
WorkContext instance was set as the execution context for the Work
instance it was associated with. |
true |
|
true |
Connector:JAVADOC:380 |
List |
jakarta.resource.spi.work.WorkContextProvider.getWorkContexts
|
Gets an list of
WorkContexts that needs to be used by the WorkManager to set up
the execution context while executing a Work instance. |
true |
|
true |
Connector:JAVADOC:381 |
WorkException |
jakarta.resource.spi.work.WorkEvent.getException
|
Return the
WorkException. The actual WorkException subtype returned depends
on the type of the event. |
true |
|
true |
Connector:JAVADOC:382 |
long |
jakarta.resource.spi.work.WorkEvent.getStartDuration
|
Return the start
interval duration. |
true |
|
true |
Connector:JAVADOC:383 |
int |
jakarta.resource.spi.work.WorkEvent.getType
|
Return the type of
this event. |
true |
|
true |
Connector:JAVADOC:384 |
Work |
jakarta.resource.spi.work.WorkEvent.getWork
|
Return the Work
instance which is the cause of the event. |
true |
|
true |
Connector:JAVADOC:385 |
WorkEvent |
jakarta.resource.spi.work.WorkEvent.WorkEvent
( Object ,
int ,
Work ,
WorkException ) |
Constructor. |
true |
|
true |
Connector:JAVADOC:386 |
WorkEvent |
jakarta.resource.spi.work.WorkEvent.WorkEvent
( Object ,
int ,
Work ,
WorkException ,
long ) |
Constructor. |
true |
|
true |
Connector:JAVADOC:387 |
WorkException |
jakarta.resource.spi.work.WorkException.WorkException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:388 |
WorkException |
jakarta.resource.spi.work.WorkException.WorkException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:389 |
WorkException |
jakarta.resource.spi.work.WorkException.WorkException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:390 |
WorkException |
jakarta.resource.spi.work.WorkException.WorkException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:391 |
WorkException |
jakarta.resource.spi.work.WorkException.WorkException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |
Connector:JAVADOC:392 |
void |
jakarta.resource.spi.work.WorkListener.workAccepted
( WorkEvent ) |
Invoked when a Work
instance has been accepted. |
true |
|
true |
Connector:JAVADOC:393 |
void |
jakarta.resource.spi.work.WorkListener.workCompleted
( WorkEvent ) |
Invoked when a Work
instance has completed execution. |
true |
|
true |
Connector:JAVADOC:394 |
void |
jakarta.resource.spi.work.WorkListener.workRejected
( WorkEvent ) |
Invoked when a Work
instance has been rejected. |
true |
|
true |
Connector:JAVADOC:395 |
void |
jakarta.resource.spi.work.WorkListener.workStarted
( WorkEvent ) |
Invoked when a Work
instance has started execution. This only means that a thread has
been allocated. |
true |
|
true |
Connector:JAVADOC:396 |
void |
jakarta.resource.spi.work.WorkManager.doWork
( Work ) |
Accepts a Work
instance for processing. This call blocks until the Work instance
completes execution. There is no guarantee on when the accepted
Work instance would start execution ie., there is no time
constraint to start execution. (that is, startTimeout=INDEFINITE)
|
true |
|
true |
Connector:JAVADOC:397 |
void |
jakarta.resource.spi.work.WorkManager.doWork
( Work )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:398 |
void |
jakarta.resource.spi.work.WorkManager.doWork
( Work ,
long ,
ExecutionContext ,
WorkListener ) |
Accepts a Work
instance for processing. This call blocks until the Work instance
completes execution. |
true |
|
true |
Connector:JAVADOC:399 |
void |
jakarta.resource.spi.work.WorkManager.doWork
( Work ,
long ,
ExecutionContext ,
WorkListener )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:400 |
void |
jakarta.resource.spi.work.WorkManager.scheduleWork
( Work ) |
Accepts a Work
instance for processing. This call does not block and returns
immediately once a Work instance has been accepted for processing.
There is no guarantee on when the submitted Work instance would
start execution ie., there is no time constraint to start
execution. (that is, startTimeout=INDEFINITE). |
true |
|
true |
Connector:JAVADOC:401 |
void |
jakarta.resource.spi.work.WorkManager.scheduleWork
( Work )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:402 |
void |
jakarta.resource.spi.work.WorkManager.scheduleWork
( Work ,
long ,
ExecutionContext ,
WorkListener ) |
Accepts a Work
instance for processing. This call does not block and returns
immediately once a Work instance has been accepted for processing.
|
true |
|
true |
Connector:JAVADOC:403 |
void |
jakarta.resource.spi.work.WorkManager.scheduleWork
( Work ,
long ,
ExecutionContext ,
WorkListener )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:404 |
long |
jakarta.resource.spi.work.WorkManager.startWork
( Work ) |
Accepts a Work
instance for processing. This call blocks until the Work instance
starts execution but not until its completion. There is no
guarantee on when the accepted Work instance would start execution
ie., there is no time constraint to start execution. (that is,
startTimeout=INDEFINITE) |
true |
|
true |
Connector:JAVADOC:405 |
long |
jakarta.resource.spi.work.WorkManager.startWork
( Work )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:406 |
long |
jakarta.resource.spi.work.WorkManager.startWork
( Work ,
long ,
ExecutionContext ,
WorkListener ) |
Accepts a Work
instance for processing. This call blocks until the Work instance
starts execution but not until its completion. There is no
guarantee on when the accepted Work instance would start execution
ie., there is no time constraint to start execution. |
true |
|
true |
Connector:JAVADOC:407 |
long |
jakarta.resource.spi.work.WorkManager.startWork
( Work ,
long ,
ExecutionContext ,
WorkListener )
throws WorkException
|
|
true |
|
true |
Connector:JAVADOC:408 |
WorkRejectedException |
jakarta.resource.spi.work.WorkRejectedException.WorkRejectedException
|
Constructs a new
instance with null as its detail message. |
true |
|
true |
Connector:JAVADOC:409 |
WorkRejectedException |
jakarta.resource.spi.work.WorkRejectedException.WorkRejectedException
( String ) |
Constructs a new
instance with the specified detail message. |
true |
|
true |
Connector:JAVADOC:410 |
WorkRejectedException |
jakarta.resource.spi.work.WorkRejectedException.WorkRejectedException
( Throwable ) |
Constructs a new
throwable with the specified cause. |
true |
|
true |
Connector:JAVADOC:411 |
WorkRejectedException |
jakarta.resource.spi.work.WorkRejectedException.WorkRejectedException
( String ,
Throwable ) |
Constructs a new
throwable with the specified detail message and cause. |
true |
|
true |
Connector:JAVADOC:412 |
WorkRejectedException |
jakarta.resource.spi.work.WorkRejectedException.WorkRejectedException
( String ,
String ) |
Constructs a new
throwable with the specified detail message and an error code. |
true |
|
true |