|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=TYPE) @Retention(value=SOURCE) public @interface Component
The Component
annotation is the only required annotation. If
this annotation is not declared in a Java class, the class is not declared as
a component.
This annotation 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 Component
annotation.
Optional Element Summary | |
---|---|
boolean |
componentAbstract
This marks an abstract service description which is not added to the descriptor but intended for reuse through inheritance. |
boolean |
configurationFactory
Set the metatype factory pid property (only for non factory components). |
boolean |
createPid
Generated service.pid property by default, if none declared
explicitly. |
String |
description
This is generally used as a description for the object described by the meta type. |
boolean |
ds
Whether Declarative Services descriptor is generated or not. |
boolean |
enabled
Whether the component is enabled when the bundle starts. |
String |
factory
Whether the component is a factory component. |
boolean |
getConfigurationFactory
Deprecated. Use configurationFactory() |
boolean |
immediate
Whether the component is immediately activated. |
boolean |
inherit
Whether any service, property and reference declarations from base classes should be inherited by this class. |
String |
label
This is generally used as a title for the object described by the meta type. |
boolean |
metatype
Whether Metatype Service data is generated or not. |
String |
name
Defines the Component name also used as the PID for the Configuration Admin Service. |
ConfigurationPolicy |
policy
The configuration policy |
String |
specVersion
The version of the Declarative Services specification against which the component is written. |
public abstract String name
public abstract String label
public abstract String description
public abstract boolean enabled
public abstract String factory
public abstract boolean immediate
public abstract boolean inherit
public abstract boolean metatype
metatype.xml
file for this component. Otherwise no Metatype
Service data is generated for this component.
public abstract boolean componentAbstract
public abstract boolean ds
public abstract String specVersion
Valid values currently are 1.0
and 1.1
. If
an unsupported value is declared, a descriptor failure results.
public abstract boolean createPid
service.pid
property by default, if none declared
explicitly.
public abstract boolean getConfigurationFactory
configurationFactory()
public abstract boolean configurationFactory
public abstract ConfigurationPolicy policy
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |