Top Description Methods
jakarta.resource

public @Interface ConnectionFactoryDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Repeatable:ConnectionFactoryDefinitions
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME, jakarta.resource.spi.TransactionSupport.TransactionSupportLevel

Annotation used to define a Connector Connection Factory resource to be registered in JNDI. Once defined, a resource may be referenced by a component using the lookup element of the Resource annotation.
Since
1.7
Version
1.7
See Also
jakarta.annotation.Resource

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

description
description
()

Description of the resource.

public String

Returns:

fully qualified name of the connection factory interface
interfaceName
()

The fully qualified name of the connection factory interface class.

public int

Returns:

The maximum number of connections that should be allocated for a connection pool
maxPoolSize
()

The maximum number of connections that should be allocated for a connection pool that backs this connnection factory resource.

public int

Returns:

The minimum number of connections that should be allocated for a connection pool
minPoolSize
()

The minimum number of connections that should be allocated for a connection pool that backs this connnection factory resource.

public String

Returns:

name
name
()

JNDI name of the connection factory resource being defined.

public String[]

Returns:

properties
properties
()

Properties of the Connection Factory.

public String

Returns:

name of the resource adapter
resourceAdapter
()

The name of the resource adapter that the administered object must be created from.

public TransactionSupport.TransactionSupportLevel

Returns:

The level of transaction support the connection factory resource needs to support.
transactionSupport
()

The level of transaction support the connection factory resource needs to support.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public String description()

Description of the resource.

Returns:String

description

interfaceNameback to summary
public String interfaceName()

The fully qualified name of the connection factory interface class.

Returns:String

fully qualified name of the connection factory interface

maxPoolSizeback to summary
public int maxPoolSize()

The maximum number of connections that should be allocated for a connection pool that backs this connnection factory resource. The default for this attribute is vendor specific.

Returns:int

The maximum number of connections that should be allocated for a connection pool

minPoolSizeback to summary
public int minPoolSize()

The minimum number of connections that should be allocated for a connection pool that backs this connnection factory resource. The default for this attribute is vendor specific.

Returns:int

The minimum number of connections that should be allocated for a connection pool

nameback to summary
public String name()

JNDI name of the connection factory resource being defined.

Returns:String

name

propertiesback to summary
public String[] properties()

Properties of the Connection Factory. These properties may be vendor-specific properties. Vendor-specific properties may be combined with or used to override the connection factory properties defined using this annotation. Connection Factory properties that are specified and are not supported in a given resource adapter or cannot be mapped to a vendor specific configuration property may be ignored.

Returns:String[]

properties

resourceAdapterback to summary
public String resourceAdapter()

The name of the resource adapter that the administered object must be created from. The resource adapter is required to be available at deployment time.

Returns:String

name of the resource adapter

transactionSupportback to summary
public TransactionSupport.TransactionSupportLevel transactionSupport()

The level of transaction support the connection factory resource needs to support. If a transaction support specification is specified, it must be a level of transaction support whose ordinal value in the TransactionSupport.TransactionSupportLevel enum is equal to or lesser than the resource adapter's transaction support classification.

Returns:TransactionSupport.TransactionSupportLevel

The level of transaction support the connection factory resource needs to support.