Interface ServiceReferenceMetadata

All Superinterfaces:
ComponentMetadata, Metadata, NonNullMetadata
All Known Subinterfaces:
ReferenceListMetadata, ReferenceMetadata

@ConsumerType public interface ServiceReferenceMetadata extends ComponentMetadata
Metadata for a reference to an OSGi service. This is the base type for ReferenceListMetadata and ReferenceMetadata.
  • Field Details

  • Method Details

    • getAvailability

      int getAvailability()
      Return whether or not a matching service is required at all times. This is specified in the availability attribute of the service reference.
      Returns:
      Whether or not a matching service is required at all times.
      See Also:
    • getInterface

      String getInterface()
      Return the name of the interface type that a matching service must support. This is specified in the interface attribute of the service reference.
      Returns:
      The name of the interface type that a matching service must support or null when no interface name is specified.
    • getComponentName

      String getComponentName()
      Return the value of the component-name attribute of the service reference. This specifies the id of a component that is registered in the service registry. This will create an automatic filter, appended with the filter if set, to select this component based on its automatic id attribute.
      Returns:
      The value of the component-name attribute of the service reference or null if the attribute is not specified.
    • getFilter

      String getFilter()
      Return the filter expression that a matching service must match. This is specified by the filter attribute of the service reference.
      Returns:
      The filter expression that a matching service must match or null if a filter is not specified.
    • getReferenceListeners

      Collection<ReferenceListener> getReferenceListeners()
      Return the reference listeners to receive bind and unbind events. This is specified by the reference-listener elements of the service reference.
      Returns:
      An immutable Collection of ReferenceListener objects to receive bind and unbind events. The Collection is empty if no reference listeners are specified for the service reference.