Top Description Methods
jakarta.resource

public @Interface AdministeredObjectDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Repeatable:AdministeredObjectDefinitions
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME

Annotation used to define a Connector administered object to be registered in JNDI. Once defined, an administered object 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:

className
className
()

Fully qualified name of the administered object’s class

public String

Returns:

description
description
()

Description of the administered object.

public String

Returns:

fully qualified name
interfaceName
()

Fully qualified name of the administered object’s interface

public String

Returns:

name
name
()

JNDI name of the administered object being defined.

public String[]

Returns:

properties of the administered object.
properties
()

Properties of the administered object.

public String

Returns:

resource adapter
resourceAdapter
()

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

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

classNameback to summary
public String className()

Fully qualified name of the administered object’s class

Returns:String

className

descriptionback to summary
public String description()

Description of the administered object.

Returns:String

description

interfaceNameback to summary
public String interfaceName()

Fully qualified name of the administered object’s interface

Returns:String

fully qualified name

nameback to summary
public String name()

JNDI name of the administered object being defined.

Returns:String

name

propertiesback to summary
public String[] properties()

Properties of the administered object. These properties may be vendor-specific properties. Vendor-specific properties may be combined with or used to override the administered object properties defined using this annotation. Administered Object 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 of the administered object.

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

resource adapter