Jakarta EE 11.0.0 · jakarta.resource.spi.Connector · APIdia, the JavaDoc alternative

Method Summary

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

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

authMechanisms back to summary

authMechanisms	back to summary
public AuthenticationMechanism[] authMechanisms() Specifies the authentication mechanisms supported by the resource adapter. Returns:AuthenticationMechanism[] Supported Authentication Mechanisms See Also `AuthenticationMechanism`

public AuthenticationMechanism[] authMechanisms()

Specifies the authentication mechanisms supported by the resource adapter.

Returns:AuthenticationMechanism[]: Supported Authentication Mechanisms
See Also: AuthenticationMechanism

description	back to summary
public String[] description() Describes the resource adapter module. Returns:String[] description

description

back to summary

public String[] description()

Describes the resource adapter module.

Returns:String[]: description

displayName	back to summary
public String[] displayName() An optional short name, providing information about the resource adapter module, that is intended to be displayed by tools. Returns:String[] display name

displayName

back to summary

public String[] displayName()

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

Returns:String[]: display name

eisType	back to summary
public 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:String type of EIS

eisType

back to summary

public 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:String: type of EIS

largeIcon	back to summary
public 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:String[] large icon file name

largeIcon

back to summary

public 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:String[]: large icon file name

licenseDescription	back to summary
public String[] licenseDescription() Specifies licensing requirements for the resource adapter module and an optional description of the licensing terms. Returns:String[] licensing requirements

licenseDescription

back to summary

public String[] licenseDescription()

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

Returns:String[]: licensing requirements

licenseRequired	back to summary
public boolean licenseRequired() Specifies whether a license is required to deploy and use this resource adapter Returns:boolean true if licensed required

licenseRequired

back to summary

public boolean licenseRequired()

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

Returns:boolean: true if licensed required

reauthenticationSupport	back to summary
public boolean reauthenticationSupport() Specifies whether reauthentication is supported Returns:boolean true if reauthentication is supported

reauthenticationSupport

back to summary

public boolean reauthenticationSupport()

Specifies whether reauthentication is supported

Returns:boolean: true if reauthentication is supported

requiredWorkContexts back to summary

requiredWorkContexts	back to summary
public 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:Class<? extends WorkContext>[] list of class names that implement the work context interface

public 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:Class<? extends WorkContext>[]: list of class names that implement the work context interface

securityPermissions back to summary

securityPermissions	back to summary
public SecurityPermission[] securityPermissions() Specifies the extended security permissions required to be provided for the operation of the resource adapter module Returns:SecurityPermission[] the extended security permissions See Also `SecurityPermission`

public SecurityPermission[] securityPermissions()

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

Returns:SecurityPermission[]: the extended security permissions
See Also: SecurityPermission

smallIcon	back to summary
public 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:String[] small icon file name

smallIcon

back to summary

public 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:String[]: small icon file name

transactionSupport back to summary

transactionSupport	back to summary
public TransactionSupport.TransactionSupportLevel transactionSupport() Specifies the level of transaction support provided by the resource adapter. Returns:TransactionSupport.TransactionSupportLevel level of transaction support See Also `TransactionSupport.TransactionSupportLevel`

public TransactionSupport.TransactionSupportLevel transactionSupport()

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