Page History

Name

Default Value

Required

SCR

Metatype

Description

name

The name of constant

yes

property.name

AD.id

The name of the property. If this tag is defined on a field with an initialization expression, the value of that expression is used as the name if the field is of type String.

value

–

no

property.value

AD.default

The string value of the property. This can either be a single value or an array.

longValue

–

no

property.value

AD.default

The long value of the property. This can either be a single value or an array.

doubleValue

–

no

property.value

AD.default

The double value of the property. This can either be a single value or an array.

floatValue

–

no

property.value

AD.default

The float value of the property. This can either be a single value or an array.

intValue

–

no

property.value

AD.default

The int value of the property. This can either be a single value or an array.

byteValue

–

no

property.value

AD.default

The byte value of the property. This can either be a single value or an array.

charValue

–

no

property.value

AD.default

The char value of the property. This can either be a single value or an array.

boolValue

–

no

property.value

AD.default

The boolean value of the property. This can either be a single value or an array.

shortValue

–

no

property.value

AD.default

The short value of the property. This can either be a single value or an array.

label

%<name>.name

no

–

AD.name

The label to display in a form to configure this property. This name may be localized by prepending a % sign to the name.

description

%<name>.description

no

–

AD.description

A descriptive text to provide the client in a form to configure this property. This name may be localized by prepending a % sign to the name.

propertyPrivate

Depending on the name

no

–

See description

Boolean flag defining whether a metatype descriptor entry should be generated for this property or not. By default a metatype descriptor entry, i.e. an AD element, is generated except for the properties service.pid, service.description, service.id, service.ranking, service.vendor, service.bundlelocation and service.factoryPid. If a property should not be available for display in a configuration user interface, this parameter should be set to true.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="615d4ee94267c41f-839be7f0-409e475e-a4adb0eb-7848cbda90060dc2b4db893c"><ac:plain-text-body><![CDATA[

cardinality

Depends on property value(s)

no

–

AD.cardinality

Defines the cardinality of the property and its collection type. If the cardinality is negative, the property is expected to be stored in a java.util.Vector (primitive types such as boolean are boxed in the Wrapper class), if the cardinality is positive, the property is stored in an array (primitve types are unboxed, that is Boolean type values are stored in boolean[]). The actual value defines the maximum number of elements in the vector or array, where Integer.MIN_INT describes an unbounded Vector and Integer.MAX_INT describes an unbounded array. If the cardinality is zero, the property is a scalar value. If the defined value of the property is set in the value attribute, the cardinality defaults to 0 (zero for scalar value). If the property is defined in one or more properties starting with values, the cardinality defaults to Integer.MAX_INT, that is an unbounded array.

]]></ac:plain-text-body></ac:structured-macro>

options

–

no

–

See below

See below for a description of the options attribute.

Name

Default Value

Required

Descriptor

Description

name

Name of the field

yes

reference.name

The local name of the reference. If the Reference annotation is declared in the class comment, this parameter is required. If the annotation is declared on a field, the default value for the name parameter is the name of the field

interface interfaceReference

Type of the field

yes

reference.interface

The name of the service interface. This name is used by the Service Component Runtime to access the service on behalf of the component. If the Reference annotation is declared on a class level, this parameter is required. If the annoation is declared on a field, the default value for the interface interfaceReference parameter is the type of the field

cardinality

1..1

no

reference.cardinality

The cardinality of the service reference. This must be one of value from the enumeration ReferenceCardinality

policy

static

no

reference.policy

The dynamicity policy of the reference. If dynamic the service will be made available to the component as it comes and goes. If static the component will be deactivated and re-activated if the service comes and/or goes away. This must be one of static and dynamic

target

–

no

reference.target

A service target filter to select specific services to be made available. In order to be able to overwrite the value of this value by a configuration property, this parameter must be declared. If the parameter is not declared, the respective declaration attribute will not be generated

bind

See description

no

reference.bind

The name of the method to be called when the service is to be bound to the component. The default value is the name created by appending the reference name to the string bind. The method must be declared public or protected and take single argument which is declared with the service interface type

unbind

See description

no

reference.unbind

The name of the method to be called when the service is to be unbound from the component. The default value is the name created by appending the reference name to the string unbind. The method must be declared public or protected and take single argument which is declared with the service interface type

strategy

event

no

The strategy used for this reference, one of event or lookup