THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Name | Default Value | Required | SCR | Metatype | Description |
name | Fully qualified name of the Java class | no | | | Defines the Component name also used as the PID for the Configuration Admin Service |
ds | | no | Whether Declarative Services descriptor is generated or not. If this parameter is not set or set to | ||
abstract componentAbstract | see description | no | This marks an abstract service description which is not added to the descriptor but intended for reuse through inheritance. This attribute defaults to | ||
enabled | | no | | Whether the component is enabled when the bundle starts | |
factory | no | | Whether the component is a factory component | ||
immediate | no | | Whether the component is immediately activated | ||
inherit | | no | Whether any service, property and reference declarations from base classes should be inherited by this class. | ||
metatype | | no | Whether Metatype Service data is generated or not. If this parameter is not set or set to | ||
label | | no | | This is generally used as a title for the object described by the meta type. This name may be localized by prepending a | |
description | | no | | This is generally used as a description for the object described by the meta type. This name may be localized by prepending a |
JavaDoc tags
The scr goal of the maven-scr-plugin looks for the following JavaDoc tags when building component descriptors:
...
Abstract Service Descriptions
If the Component annotations contains the attribute componentAbstract with a value of true, the containing class is regarded as an abstract class. It is not added to the service descriptor and the tags are not validated. The information about this class is added to the bundle. Classes from other bundles (or the same) can extends this abstract class and do not need to specify the references of the abstract class if they set the inherit parameter on the scr.component tag to true.
This allows to create abstract classes which already provide some valuable functionality without having to deal with the details like reference definitions in each and every subclass.
| Anchor | ||||
|---|---|---|---|---|
|
Service
The Service annotation defines whether and which service interfaces are provided by the component. This is a class annotation
...
scr.component
The scr.component tag is the only required tag. If this tag is not declared in the Java class comment, the class is not declared as a component.
This tag is used to declare the <component> element <service> and <provide> elements of the component declaration. See section 112.4.36, Component ElementService Elements, in the OSGi Service Platform Service Compendium Specification for more information. The required <implementation> element is automatically generated with the fully qualified name of the class containing the scr.component tag.
Supported parametersattributes:
Name | Default Value | Required | SCR Descriptor | Metatype | Description | |||||||||||||||||||||||||||||||||||||||||
value | All implemented interfaces | name | Fully qualified name of the Java class | no |
| | Defines the Component name also used as the PID for the Configuration Admin Service | ds | | no | Whether Declarative Services descriptor is generated or not. If this parameter is not set or set to | abstract | see description | no | This marks an abstract service description which is not added to the descriptor but intended for reuse through inheritance. This attribute defaults to | enabled | | no | | Whether the component is enabled when the bundle starts | factory | no | | Whether the component is a factory component | immediate | no | | Whether the component is immediately activated | inherit | | no | Whether any service, property and reference declarations from base classes should be inherited by this class. | metatype | | no | Whether Metatype Service data is generated or not. If this parameter is not set or set to | label | | no | | This is generally used as a title for the object described by the meta type. This name may be localized by prepending a | description | | no | | This is generally used as a description for the object described by the meta type. This name may be localized by prepending a |
...
| The name of the service interface provided by the component. This can either be the fully qualified name or just the interface class name if the interface is either in the same package or is imported. If this property is not set | |||
serviceFactory | | no | | Whether the component is registered as a |
Omitting the Service annotation will just define (and activate if required) the component but not register it as a service. Multiple Service annotations may be declared each with its own value. These annotations need to be wrapped into a Services anotation. The component is registered as a ServiceFactory if at least on Service annotations declares the serviceFactory attribute as true.
| Anchor | ||||
|---|---|---|---|---|
|
Property
The Property annotation defines properties which are made available to the component through the ComponentContext.getProperties() method. These tags are not strictly required but may be used by components to defined initial configuration. Additionally properties may be set here to identify the component if it is registered as a service, for example the service.description and service.vendor properties.
This tag may be defined in the Java Class comment of the component or in a coment to a field defining a constant with the name of the property.
This tag is used to declare <property> elements of the component declaration. See section 112.4.5, Properties and Property Elements, in the OSGi Service Platform Service Compendium Specification for more information.
Supported parameters:
Name | Default Value | Required | SCR | Metatype | Description |
name | The name of constant | yes | | | 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 |
value | no | | | The value of the property. If the property type is not | |
type | | no | | | The type of the property value. This must be one of |
label | | no | | The label to display in a form to configure this property. This name may be localized by prepending a | |
description | | no | | A descriptive text to provide the client in a form to configure this property. This name may be localized by prepending a | |
private | 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 | |
cardinality | Depends on property value(s) | no | | Defines the cardinality of the property and its collection type. If the cardinality is negative, the property is expected to be stored in a | |
options | no | See below | See below for a description of the | ||
values* | no | See below | See below for a description of parameters starting with | ||
valueRef | no | | A constant containing the value for this property. The constant can either be declared in the same class as this property or in any class that is imported. The type of the property is derived from the constant. | ||
valueRefs | no | See below | Same as the |
Notes:
- Generating
<properties>elements referring to bundle entries is not currently supported.
Naming the Property
It is important to carefully define the name of properties. By using a constant of the form
| No Format |
|---|
/** @scr.property value="default value" */
static final String CONSTANT_NAME = "property.name";
|
and defining the scr.property tag on this constant, the name of the property is taken from the constant value. Thus it may easily be ensured, that both the property in the descriptor files and the property used by the implementation are actually the same.
The options Parameter
Some properties may only be set to a set of possible values. To support user interfaces which provide a selection list of values or a list of checkboxes the option values and labels may be defined as parameters to the scr.property tag. All parameters in the form of name-value pairs occurring after the options parameter are used to build the list of available value options. The parameter name is used as the value while the parameter value is used as the label in the user interface. This label may be prepended with a % sign to localize the string.
The options are written to the metatype.xml file as Option elements inside the AD element defining the property. The name of the parameter will be used for the Option.value attribute while the value of the parameter defines the Option.label attribute.
Please note, that all parameters of the scr.property tag occurring after the options parameter are used to build the options list. Hence no non-option value parameters should actually follow the options parameter.
Multivalue Properties
Generally the value of a property is scalar, that is a property has a single value such as true, 5 or "This is a String". Such scalar values are defined with the value parameter of the scr.property tag. In the case of a scalar property value, the cardinality parameter value is assumed to be 0 (zero) unless of course set otherwise.
There may be properties, which have a list of values, such as a list of possible URL mappings for an URL Mapper. Such multiple values are defined in one more parameters whose name starts with values. Each parameter must of course have a unique name which is not in any except to differentiate the parameters.
If the cardinality of the property is not explicilty set with the cardinality property, it defaults to Integer.MAX_INT, i.e. unbound array, if multiple values with a series of values parameters are defined. Otherwise the cardinality parameter may be set for example to a negative value to store the values in a java.util.Vector instead.
| Anchor | ||||
|---|---|---|---|---|
|
Reference
The Reference annotation defines references to other services made available to the component by the Service Component Runtime. This tag
This tag may be declared in the java Class comment or any Java Field to which it might apply. Depending on where the tag is declared, the parameters may have different default values.
This tag is used to declare <reference> elements of the component declaration. See section 112.4.7, Reference Element, in the OSGi Service Platform Service Compendium Specification for more information.
Supported parameters:
Name | Default Value | Required | Descriptor | Description |
name | Name of the field | yes | | The local name of the reference. If the |
interface | Type of the field | yes | | 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 |
cardinality | | no | | The cardinality of the service reference. This must be one of |
policy | | no | | The dynamicity policy of the reference. If |
target | no | | 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 | | 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 |
unbind | See description | no | | 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 |
Notes:
- If you define a reference on a field and there is no bind or unbind method, the plugin will create the necessary methods.
JavaDoc tags
The scr goal of the maven-scr-plugin looks for the following JavaDoc tags when building component descriptors:
| Anchor | ||||
|---|---|---|---|---|
|
scr.component
The scr.component tag is the only required tag. If this tag is not declared in the Java class comment, the class is not declared as a component.
This tag is used to declare the <component> element of the component declaration. See section 112.4.3, Component Element, in the OSGi Service Platform Service Compendium Specification for more information. The required <implementation> element is automatically generated with the fully qualified name of the class containing the scr.component tag.
Supported parameters:
Name | Default Value | Required | SCR | Metatype | Description |
name | Fully qualified name of the Java class | no | | | Defines the Component name also used as the PID for the Configuration Admin Service |
ds | | no | Whether Declarative Services descriptor is generated or not. If this parameter is not set or set to | ||
abstract | see description | no | This marks an abstract service description which is not added to the descriptor but intended for reuse through inheritance. This attribute defaults to | ||
enabled | | no | | Whether the component is enabled when the bundle starts | |
factory | no | | Whether the component is a factory component | ||
immediate | no | | Whether the component is immediately activated | ||
inherit | | no | Whether any service, property and reference declarations from base classes should be inherited by this class. | ||
metatype | | no | Whether Metatype Service data is generated or not. If this parameter is not set or set to | ||
label | | no | | This is generally used as a title for the object described by the meta type. This name may be localized by prepending a | |
description | | no | | This is generally used as a description for the object described by the meta type. This name may be localized by prepending a |
Abstract Service Descriptions
If the scr.component tag contains the parameter abstract with a value of true, the containing class is regarded as an abstract class. It is not added to the service descriptor and the tags are not validated. The information about this class is added to the bundle. Classes from other bundles (or the same) can extends this abstract class and do not need to specify the references of the abstract class if they set the inherit parameter on the scr.component tag to true.
This allows to create abstract classes which already provide some valuable functionality without having to deal with the details like reference definitions in each and every subclass.
| Anchor | ||||
|---|---|---|---|---|
|
scr.property
The scr.property tag defines properties which are made available to the component through the ComponentContext.getProperties() method. These tags are not strictly required but may be used by components to defined initial configuration. Additionally properties may be set here to identify the component if it is registered as a service, for example the service.description and service.vendor properties.
This tag may be defined in the Java Class comment of the component or in a coment to a field defining a constant with the name of the property.
This tag is used to declare <property> elements of the component declaration. See section 112.4.5, Properties and Property Elements, in the OSGi Service Platform Service Compendium Specification for more information.
Supported parameters:
Name | Default Value | Required | SCR | Metatype | Description |
name | The name of constant | yes | | | 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 |
value | no | | | The value of the property. If the property type is not | |
type | | no | | | The type of the property value. This must be one of |
label | | no | | The label to display in a form to configure this property. This name may be localized by prepending a | |
description | | no | | A descriptive text to provide the client in a form to configure this property. This name may be localized by prepending a | |
private | 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 |
...
scr.property
The scr.property tag defines properties which are made available to the component through the ComponentContext.getProperties() method. These tags are not strictly required but may be used by components to defined initial configuration. Additionally properties may be set here to identify the component if it is registered as a service, for example the service.description and service.vendor properties.
This tag may be defined in the Java Class comment of the component or in a coment to a field defining a constant with the name of the property.
This tag is used to declare <property> elements of the component declaration. See section 112.4.5, Properties and Property Elements, in the OSGi Service Platform Service Compendium Specification for more information.
Supported parameters:
Name | Default Value | Required | SCR | Metatype | Description | |||||||||
name | The name of constant | yes | | | 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 | value | no | | | The value of the property. If the property type is not | ||||
type | | no | | | The type of the property value. This must be one of | |||||||||
label | | no | | The label to display in a form to configure this property. This name may be localized by prepending a | description | | no | | A descriptive text to provide the client in a form to configure this property. This name may be localized by prepending a | private | 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 |
cardinality | Depends on property value(s) | no | | Defines the cardinality of the property and its collection type. If the cardinality is negative, the property is expected to be stored in a | ||||||||||
options | no | See below | See below for a description of the | |||||||||||
values* | no | See below | See below for a description of parameters starting with | |||||||||||
valueRef | no | | A constant containing the value for this property. The constant can either be declared in the same class as this property or in any class that is imported. The type of the property is derived from the constant. | |||||||||||
valueRefs | no | See below | Same as the |
...
- Generating
<properties>elements referring to bundle entries is not currently supported.
Naming the property
It is important to carefully define the name of properties. By using a constant of the form
...
and defining the scr.property tag on this constant, the name of the property is taken from the constant value. Thus it may easily be ensured, that both the property in the descriptor files and the property used by the implementation are actually the same.
The options parameter
Some properties may only be set to a set of possible values. To support user interfaces which provide a selection list of values or a list of checkboxes the option values and labels may be defined as parameters to the scr.property tag. All parameters in the form of name-value pairs occurring after the options parameter are used to build the list of available value options. The parameter name is used as the value while the parameter value is used as the label in the user interface. This label may be prepended with a % sign to localize the string.
...
Please note, that all parameters of the scr.property tag occurring after the options parameter are used to build the options list. Hence no non-option value parameters should actually follow the options parameter.
Multivalue properties
Generally the value of a property is scalar, that is a property has a single value such as true, 5 or "This is a String". Such scalar values are defined with the value parameter of the scr.property tag. In the case of a scalar property value, the cardinality parameter value is assumed to be 0 (zero) unless of course set otherwise.
...
| Anchor | ||||
|---|---|---|---|---|
|
scr.service
The scr.service tag defines whether and which service interfaces are provided by the component.
...
| Anchor | ||||
|---|---|---|---|---|
|
scr.reference
The scr.reference tag defines references to other services made available to the component by the Service Component Runtime. This tag
...
- If you define a reference on a field and there is no bind or unbind method, the plugin will create the necessary methods.
Abstract Service Descriptions
If the scr.component tag contains the parameter abstract with a value of true, the containing class is regarded as an abstract class. It is not added to the service descriptor and the tags are not validated. The information about this class is added to the bundle. Classes from other bundles (or the same) can extends this abstract class and do not need to specify the references of the abstract class if they set the inherit parameter on the scr.component tag to true.
...
- and there is no bind or unbind method, the plugin will create the necessary methods.
.h2 Differences between JavaDoc tags and annotations
In general both mechanisms provide the same functionality. There are some subtle difference which are listed in this section:
- While the
metatypeflag is turned on by default for the JavaDoc tags, the default for the annotations is to generate no metadata. The reason for this is, that it turned out that services with metadata are less often used.