public abstract class WmManagedConnectionFactory extends java.lang.Object implements javax.resource.spi.ManagedConnectionFactory, com.wm.app.b2b.server.jca.LogDescriptor, com.wm.pkg.art.metadata.BaseTemplate, WmAdapterUIResourceDomainLookUp
WmManagedConnectionFactory
contains the properties of the connection type
and the metadata that describes those properties, and also provides the interfaces that are needed by the
Integration Server to create the connections to the resource.
For each connection type supported by an adapter, the adapter writer must extend
WmManagedConnectionFactory
.WmManagedConnection
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected WmAdapter |
_adapter |
protected javax.resource.cci.ResourceAdapterMetaData |
adapterMetaData |
static int |
LOCAL_TRANSACTION_SUPPORT
Flag indicating that this connection type supports local transactions.
|
protected java.io.PrintWriter |
logWriter |
protected java.lang.Class |
managedConnectionClass |
static int |
NO_TRANSACTION_SUPPORT
Flag indicating that this connection type supports no transactions.
|
static int |
UNKNOWN_TRANSACTION_SUPPORT
Flag indicating that the transaction types supported by this connection are not known.
|
static int |
XA_ONE_PHASE_TRANSACTION_SUPPORT
Flag indicating that this connection type supports XA_Transactions with one-phase commit.
|
static int |
XA_TWO_PHASE_TRANSACTION_SUPPORT
Flag indicating that this connection type supports XA_Transactions with two-phase commit.
|
Constructor and Description |
---|
WmManagedConnectionFactory()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
WmAdapter |
_getWmAdapter()
Retrieve the reference to the WmAdapter instance object
This should only be used internally by IRT
|
void |
_setWmAdapter(WmAdapter adapter)
Set a reference to the WmAdapter instance object.
|
java.lang.Object |
createConnectionFactory()
By default, a ConnectionManager on the local adapter is unsupported
|
java.lang.Object |
createConnectionFactory(javax.resource.spi.ConnectionManager mgr)
Called by Deployer to create a CCI ConnectionFactory corresponding to this
ManagedConnectionFactory
|
javax.resource.spi.ManagedConnection |
createManagedConnection(javax.security.auth.Subject subject,
javax.resource.spi.ConnectionRequestInfo cxRequestInfo)
Creates a new physical connection to the underlying EIS resource manager,
|
abstract WmManagedConnection |
createManagedConnectionObject(javax.security.auth.Subject subject,
javax.resource.spi.ConnectionRequestInfo cxRequestInfo)
Returns a connection to the resource.
|
void |
deleteCallBack()
This method is called when the configuration of the connection node associated
with this class is deleted.
|
void |
disableCallBack()
This method is called when the connection node associated with this class
moves from enabled to disabled.
|
void |
enableCallBack()
This method is called when the connection node associated with this class moves
from a disabled to enabled.
|
abstract void |
fillResourceAdapterMetadataInfo(ResourceAdapterMetadataInfo info,
java.util.Locale locale)
Registers adapter service templates that this connection supports.
|
abstract void |
fillWmDescriptor(WmDescriptor d,
java.util.Locale l)
Populates the metadata object that describes this connection type and its properties.
|
void |
fillWmUIDescriptor(WmUIDescriptor d,
java.util.Locale l)
Populates the metadata object that describes UI properties of this connection type and its properties.
|
javax.resource.cci.ResourceAdapterMetaData |
getAdapterMetaData() |
javax.resource.spi.ConnectionRequestInfo |
getConnectionRequestInfo(javax.resource.cci.ConnectionSpec spec)
Part of the Webm-Specific Connection pool partition imlementation.
|
java.lang.String |
getLoggableName()
Returns loggable name for use by connection manager.
|
java.io.PrintWriter |
getLogWriter()
Returns the log writer, which an adapter writer can use to print debug messages.
|
java.lang.String |
getNodeName()
Added 10/29/03 (SAA)to make connection (node) name available in the factory
|
void |
initCallBack()
This method is called when the connection node associated with this class is
created.
|
javax.resource.spi.ManagedConnection |
matchManagedConnections(java.util.Set connectionSet,
javax.security.auth.Subject subject,
javax.resource.spi.ConnectionRequestInfo cxRequestInfo)
Returns a matched connection from the candidate set of connections.
|
int |
queryTransactionSupportLevel()
queryTransactionSupportLevel returns the types of transactions
supported by connections created by this factory.
|
LookUpResult |
resourceDomainLookup(java.lang.String lookUpKey,
java.lang.String lookUpValue,
java.lang.String[][] values)
Looks up values for a resourceDomain's dependents.
|
void |
setLogWriter(java.io.PrintWriter out)
Set the log writer for this ManagedConnectionFactory instance.
|
void |
setNodeName(java.lang.String nodeName)
Added 10/29/03 (SAA)to make connection (node) name available in the factory
|
void |
shutdownCallBack()
This method is called when the connection node associated with this class is
about to be shutdown.
|
void |
startupCallBack()
This method is called when the connection node associated with this class is
about to be started.
|
void |
updateCallBack()
This method is called when the configuration of the connection node associated
with this class is updated.
|
protected WmAdapter _adapter
protected javax.resource.cci.ResourceAdapterMetaData adapterMetaData
public static final int LOCAL_TRANSACTION_SUPPORT
protected java.io.PrintWriter logWriter
protected java.lang.Class managedConnectionClass
public static final int NO_TRANSACTION_SUPPORT
public static final int UNKNOWN_TRANSACTION_SUPPORT
public static final int XA_ONE_PHASE_TRANSACTION_SUPPORT
public static final int XA_TWO_PHASE_TRANSACTION_SUPPORT
public WmManagedConnectionFactory()
WmManagedConnectionFactory
should have a default constructor that calls this constructor.public WmAdapter _getWmAdapter()
public void _setWmAdapter(WmAdapter adapter)
adapter
- : WmAdapter instance object that this connection factory is associated withpublic java.lang.Object createConnectionFactory() throws javax.resource.ResourceException
createConnectionFactory
in interface javax.resource.spi.ManagedConnectionFactory
javax.resource.ResourceException
public java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager mgr) throws javax.resource.ResourceException
createConnectionFactory
in interface javax.resource.spi.ManagedConnectionFactory
javax.resource.ResourceException
public javax.resource.spi.ManagedConnection createManagedConnection(javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cxRequestInfo) throws javax.resource.ResourceException
createManagedConnection
in interface javax.resource.spi.ManagedConnectionFactory
javax.resource.ResourceException
public abstract WmManagedConnection createManagedConnectionObject(javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cxRequestInfo) throws javax.resource.ResourceException
WmManagedConnectionFactory
must implement this method to create and return a connection to the resource.subject
- in this release, this property is not usedcxRequestInfo
- in this release, this property is not used.WmManagedConnection
that represents a connection to the resource.
Adapter writers must create a subclass of WmManagedConnection
and return an instance of that subclass.javax.resource.ResourceException
- an instance of AdapterException
or one of its subclasses if an error occurred while creating a connection to the resource.WmManagedConnection
,
AdapterException
public void deleteCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic void disableCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic void enableCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic abstract void fillResourceAdapterMetadataInfo(ResourceAdapterMetadataInfo info, java.util.Locale locale) throws AdapterException
info
- the metadata object that adapter writers use to register adapter service
templates supported by this connection.locale
- currently, this parameter is not used.AdapterException
- if an error occurred while
registering the adapter service templates.ResourceAdapterMetadataInfo
,
AdapterException
public abstract void fillWmDescriptor(WmDescriptor d, java.util.Locale l) throws AdapterException
ManagedConnectionFactory
.
Adapter writers must implement this method to add metadata information that
describes this connection and its associated properties.fillWmDescriptor
in interface com.wm.pkg.art.metadata.BaseTemplate
d
- the metadata object used to describe this connection type and its properties.l
- the Locale that all Locale-specific metadata fields must be set in.AdapterException
- an instance of AdapterException
or one of its subclasses if an error was encountered while populating the metadata.WmDescriptor
public void fillWmUIDescriptor(WmUIDescriptor d, java.util.Locale l) throws AdapterException
ManagedConnectionFactory
.
Adapter writers must implement this method to add metadata information that
describes UI properties of this connection and its associated properties.d
- the metadata object used to describe UI properties of this connection type and its properties.l
- the Locale that all Locale-specific metadata fields must be set in.AdapterException
- an instance of AdapterException
or one of its subclasses if an error was encountered while populating the metadata.WmUIDescriptor
public javax.resource.cci.ResourceAdapterMetaData getAdapterMetaData() throws javax.resource.ResourceException
javax.resource.ResourceException
public javax.resource.spi.ConnectionRequestInfo getConnectionRequestInfo(javax.resource.cci.ConnectionSpec spec)
spec
- WmConnectionSpec
,
WmConnectionRequestInfo
public java.lang.String getLoggableName()
getLoggableName
in interface com.wm.app.b2b.server.jca.LogDescriptor
public java.io.PrintWriter getLogWriter()
getLogWriter
in interface javax.resource.spi.ManagedConnectionFactory
public final java.lang.String getNodeName()
public void initCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic javax.resource.spi.ManagedConnection matchManagedConnections(java.util.Set connectionSet, javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cxRequestInfo)
matchManagedConnections
in interface javax.resource.spi.ManagedConnectionFactory
public int queryTransactionSupportLevel()
AdapterType.getTransactionSupportLevel(ManagedConnectionFactory)
public LookUpResult resourceDomainLookup(java.lang.String lookUpKey, java.lang.String lookUpValue, java.lang.String[][] values) throws AdapterException
WmAdapterUIResourceDomainLookUp
ResourceDomainValues
class with the proper
data. Returns multiple objects if you are using tuples.resourceDomainLookup
in interface WmAdapterUIResourceDomainLookUp
lookUpKey
- the system name of the lookUpKeylookUpValue
- the value of the lookUpKeyvalues
- the values for the UI parametersAdapterException
- if it encounters an error.public void setLogWriter(java.io.PrintWriter out)
setLogWriter
in interface javax.resource.spi.ManagedConnectionFactory
public final void setNodeName(java.lang.String nodeName)
public void shutdownCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic void startupCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occuredpublic void updateCallBack() throws javax.resource.ResourceException
javax.resource.ResourceException
- if a processing error has occured
Copyright © 2003 - 2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.