jakarta.resource.spi

Annotation Type ConfigProperty

@Documented
 @Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface ConfigProperty

Designates a JavaBean property as a configuration property

Since:

1.6

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	confidential Indicates that the configuration property is confidential and recommends application server's configuration tools to use special visual aids for editing them.
String	defaultValue Inferred by the container for field based annotations if possible.
String[]	description Describes the configuration property.
boolean	ignore Indicates that the configuration tools must ignore considering this Property during auto-discovery of Configuration properties.
boolean	supportsDynamicUpdates Indicates that the configuration property supports dynamic updates to its value during the lifetime of the JavaBean
Class	type Inferred by the container if unspecified.

Element Detail

type

public abstract Class type

Inferred by the container if unspecified.

Returns:

property type

Default:

java.lang.Object.class

description

public abstract String[] description

Describes the configuration property.

Returns:

property description

Default:

{}

defaultValue

public abstract String defaultValue

Inferred by the container for field based annotations if possible.

Returns:

default value

Default:

""

ignore

public abstract boolean ignore

Indicates that the configuration tools must ignore considering this Property during auto-discovery of Configuration properties.

Returns:

true if configuration tools must ignore considering this Property during auto-discovery of Configuration properties

Default:

false

supportsDynamicUpdates

public abstract boolean supportsDynamicUpdates

Indicates that the configuration property supports dynamic updates to its value during the lifetime of the JavaBean

Returns:

true if the configuration property supports dynamic updates

Default:

false

confidential

public abstract boolean confidential

Indicates that the configuration property is confidential and recommends application server's configuration tools to use special visual aids for editing them.

Returns:

true if the configuration property is confidential

Default:

false