Interface ServiceMetadata
- All Superinterfaces:
ComponentMetadata
,Metadata
,NonNullMetadata
Metadata for a service to be registered by the Blueprint Container when
enabled.
This is specified by the service
element.
- Author:
- $Id: 8c4ddb6239c2247906ceeb2b61226be64dfc24ab $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Advertise all Java classes and interfaces in the component instance type as service interfaces.static final int
Advertise all Java classes in the hierarchy of the component instance type as service interfaces.static final int
Do not auto-detect types for advertised service interfacesstatic final int
Advertise all Java interfaces implemented by the component instance type as service interfaces.Fields inherited from interface org.osgi.service.blueprint.reflect.ComponentMetadata
ACTIVATION_EAGER, ACTIVATION_LAZY
-
Method Summary
Modifier and TypeMethodDescriptionint
Return the auto-export mode for the service.Return the type names of the interfaces that the service should be advertised as supporting.int
Return the ranking value to use when advertising the service.Return the registration listeners to be notified when the service is registered and unregistered with the framework.Return the Metadata for the component to be exported as a service.Return the user declared properties to be advertised with the service.Methods inherited from interface org.osgi.service.blueprint.reflect.ComponentMetadata
getActivation, getDependsOn, getId
-
Field Details
-
AUTO_EXPORT_DISABLED
static final int AUTO_EXPORT_DISABLEDDo not auto-detect types for advertised service interfaces- See Also:
-
AUTO_EXPORT_INTERFACES
static final int AUTO_EXPORT_INTERFACESAdvertise all Java interfaces implemented by the component instance type as service interfaces.- See Also:
-
AUTO_EXPORT_CLASS_HIERARCHY
static final int AUTO_EXPORT_CLASS_HIERARCHYAdvertise all Java classes in the hierarchy of the component instance type as service interfaces.- See Also:
-
AUTO_EXPORT_ALL_CLASSES
static final int AUTO_EXPORT_ALL_CLASSESAdvertise all Java classes and interfaces in the component instance type as service interfaces.- See Also:
-
-
Method Details
-
getServiceComponent
Target getServiceComponent()Return the Metadata for the component to be exported as a service. This is specified inline or via theref
attribute of the service.- Returns:
- The Metadata for the component to be exported as a service.
-
getInterfaces
Return the type names of the interfaces that the service should be advertised as supporting. This is specified in theinterface
attribute or childinterfaces
element of the service.- Returns:
- An immutable List of
String
for the type names of the interfaces that the service should be advertised as supporting. The List is empty if usingauto-export
or no interface names are specified for the service.
-
getAutoExport
int getAutoExport()Return the auto-export mode for the service. This is specified by theauto-export
attribute of the service.- Returns:
- The auto-export mode for the service.
- See Also:
-
getServiceProperties
Return the user declared properties to be advertised with the service. This is specified by theservice-properties
element of the service.- Returns:
- An immutable List of
MapEntry
objects for the user declared properties to be advertised with the service. The List is empty if no service properties are specified for the service.
-
getRanking
int getRanking()Return the ranking value to use when advertising the service. If the ranking value is zero, the service must be registered without aservice.ranking
service property. This is specified by theranking
attribute of the service.- Returns:
- The ranking value to use when advertising the service.
-
getRegistrationListeners
Collection<RegistrationListener> getRegistrationListeners()Return the registration listeners to be notified when the service is registered and unregistered with the framework. This is specified by theregistration-listener
elements of the service.- Returns:
- An immutable Collection of
RegistrationListener
objects to be notified when the service is registered and unregistered with the framework. The Collection is empty if no registration listeners are specified for the service.
-