Module jakarta.resource

Package jakarta.resource.spi

Annotation Interface Connector

@Documented
@Retention(RUNTIME)
@Target(TYPE)
public @interface Connector

The Connector annotation is a component-defining annotation and it can be used by the resource adapter developer to specify that the JavaBean is a resource adapter JavaBean. The Connector annotation is applied to the JavaBean class.

Since:

1.6

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
AuthenticationMechanism[]	authMechanisms	Specifies the authentication mechanisms supported by the resource adapter.
String[]	description	Describes the resource adapter module.
String[]	displayName	An optional short name, providing information about the resource adapter module, that is intended to be displayed by tools.
String	eisType	Contains information about the type of EIS.
String[]	largeIcon	Specifies the file name for large GIF or JPEG icon images that are used to represent the resource adapter in a GUI tool.
String[]	licenseDescription	Specifies licensing requirements for the resource adapter module and an optional description of the licensing terms.
boolean	licenseRequired	Specifies whether a license is required to deploy and use this resource adapter
boolean	reauthenticationSupport	Specifies whether reauthentication is supported
Class<? extends WorkContext>[]	requiredWorkContexts	Specifies a list of fully qualified classes that implements the WorkContext interface that a resource adapter requires the application server to support.
SecurityPermission[]	securityPermissions	Specifies the extended security permissions required to be provided for the operation of the resource adapter module
String[]	smallIcon	Specifies the file name for small GIF or JPEG icon images that are used to represent the resource adapter in a GUI tool.
TransactionSupport.TransactionSupportLevel	transactionSupport	Specifies the level of transaction support provided by the resource adapter.
String	vendorName	Specifies the name of the resource adapter provider vendor.
String	version	Specifies the version of the resource adapter implementation.

Element Details

description

String[] description

Describes the resource adapter module.

Returns:

description

Default:

{}

displayName

String[] displayName

An optional short name, providing information about the resource adapter module, that is intended to be displayed by tools.

Returns:

display name

Default:

{}

smallIcon

String[] 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.

Returns:

small icon file name

Default:

{}

largeIcon

String[] 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.

Returns:

large icon file name

Default:

{}

vendorName

String vendorName

Specifies the name of the resource adapter provider vendor.

Returns:

vendor name

Default:

""

eisType

String 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.

Returns:

type of EIS

Default:

""

version

String version

Specifies the version of the resource adapter implementation.

Returns:

resource adapter version

Default:

""

licenseDescription

String[] licenseDescription

Specifies licensing requirements for the resource adapter module and an optional description of the licensing terms.

Returns:

licensing requirements

Default:

{}

licenseRequired

boolean licenseRequired

Specifies whether a license is required to deploy and use this resource adapter

Returns:

true if licensed required

Default:

false

authMechanisms

AuthenticationMechanism[] authMechanisms

Specifies the authentication mechanisms supported by the resource adapter.

Returns:

Supported Authentication Mechanisms

See Also:

• AuthenticationMechanism

Default:

{}

reauthenticationSupport

boolean reauthenticationSupport

Specifies whether reauthentication is supported

Returns:

true if reauthentication is supported

Default:

false

securityPermissions

SecurityPermission[] securityPermissions

Specifies the extended security permissions required to be provided for the operation of the resource adapter module

Returns:

the extended security permissions

See Also:

• SecurityPermission

Default:

{}

transactionSupport

TransactionSupport.TransactionSupportLevel transactionSupport

Specifies the level of transaction support provided by the resource adapter.

Returns:

level of transaction support

See Also:

• TransactionSupport.TransactionSupportLevel

Default:

NoTransaction

requiredWorkContexts

Class<? extends WorkContext>[] requiredWorkContexts

Specifies a list of fully qualified classes that implements the WorkContext interface that a resource adapter requires the application server to support.

Returns:

list of class names that implement the work context interface

Default:

{}