ConnectionFactory

ConnectionFactory

This type is a class for model objects.

Settings used when creating connections to resources, such as authentication preferences and pool settings.
Package: resources
Supertype: J2EEResourceFactory

Known subtypes:
    CMPConnectorFactory
    MQTopicConnectionFactory
    MQQueueConnectionFactory
    WASTopicConnectionFactory
    MQConnectionFactory
    JMSConnectionFactory
    DataSource
    WASQueueConnectionFactory
    J2CConnectionFactory
    GenericJMSConnectionFactory

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Attributes Summary

authMechanismPreference : AuthMechanismType The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. For example, if two authentication mechanism entries have been defined for a resource adapter, KerbV5 and Basic Password, this will specify one of those two types. If the authentication mechanism preference specified is not an available authentication mechanism on the corresponding resource adapter, it is ignored. Default=BASIC PASSWORD.

authDataAlias : EString An alias to an AuthDataEntry (Specified by name). It is an alias into the AuthDataEntries list in security.xml.

manageCachedHandles : EBoolean Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.

logMissingTransactionContext : EBoolean The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.

xaRecoveryAuthAlias : EString This optional field will be used to specify the authentication alias that should be used during XA Recovery processing. If the ResourceAdapter does not support XA transactions, then this field should not be prompted for and, if it is specified, will be ignored. The default value will come from the authDataAlias (if specified).

diagnoseConnectionUsage : EBoolean Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.

connectionPool : ConnectionPool @ An optional set of connection pool settings.

preTestConfig : ConnectionTest @ Reference to ConnectionTest, for connection pretest options associated with this ConnectionFactory.

mapping : MappingModule @ Deprecated. Reference to MappingModule for specifying container managed authentication data associated with this ConnectionFactory. The preferred way to specify container-managed authentication data is on each resource reference.

properties : Property * * No description is available *

Attribute Details

authMechanismPreference  -  The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. For example, if two authentication mechanism entries have been defined for a resource adapter, KerbV5 and Basic Password, this will specify one of those two types. If the authentication mechanism preference specified is not an available authentication mechanism on the corresponding resource adapter, it is ignored. Default=BASIC PASSWORD.
    Data Type: AuthMechanismType
    Default value:  unspecified
    Allowed values:
        0 - BASIC_PASSWORD
        1 - KERBEROS
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

authDataAlias  -  An alias to an AuthDataEntry (Specified by name). It is an alias into the AuthDataEntries list in security.xml.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

manageCachedHandles  -  Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

logMissingTransactionContext  -  The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

xaRecoveryAuthAlias  -  This optional field will be used to specify the authentication alias that should be used during XA Recovery processing. If the ResourceAdapter does not support XA transactions, then this field should not be prompted for and, if it is specified, will be ignored. The default value will come from the authDataAlias (if specified).
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diagnoseConnectionUsage  -  Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
    Data Type: EBoolean
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

connectionPool  -  An optional set of connection pool settings.
    Reference Type: ConnectionPool @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

preTestConfig  -  Reference to ConnectionTest, for connection pretest options associated with this ConnectionFactory.
    Reference Type: ConnectionTest @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

mapping  -  Deprecated. Reference to MappingModule for specifying container managed authentication data associated with this ConnectionFactory. The preferred way to specify container-managed authentication data is on each resource reference.
    Reference Type: MappingModule @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

properties  -  * No description is available *
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
authMechanismPreference : AuthMechanismType	The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. For example, if two authentication mechanism entries have been defined for a resource adapter, KerbV5 and Basic Password, this will specify one of those two types. If the authentication mechanism preference specified is not an available authentication mechanism on the corresponding resource adapter, it is ignored. Default=BASIC PASSWORD.
authDataAlias : EString	An alias to an AuthDataEntry (Specified by name). It is an alias into the AuthDataEntries list in security.xml.
manageCachedHandles : EBoolean	Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
logMissingTransactionContext : EBoolean	The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
xaRecoveryAuthAlias : EString	This optional field will be used to specify the authentication alias that should be used during XA Recovery processing. If the ResourceAdapter does not support XA transactions, then this field should not be prompted for and, if it is specified, will be ignored. The default value will come from the authDataAlias (if specified).
diagnoseConnectionUsage : EBoolean	Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
connectionPool : ConnectionPool @	An optional set of connection pool settings.
preTestConfig : ConnectionTest @	Reference to ConnectionTest, for connection pretest options associated with this ConnectionFactory.
mapping : MappingModule @	Deprecated. Reference to MappingModule for specifying container managed authentication data associated with this ConnectionFactory. The preferred way to specify container-managed authentication data is on each resource reference.
properties : Property *	* No description is available *