Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.osgi.service.blueprint.reflect
Interface ServiceMetadata

All Superinterfaces:
  ComponentMetadata, Metadata, NonNullMetadata

    public interface ServiceMetadata

extends ComponentMetadata

Metadata for a service to be registered by the Blueprint Container when enabled.

This is specified by the `service` element.

Version:
  $Revision: 7563 $

Field Summary
`static int` | `AUTO_EXPORT_ALL_CLASSES` Advertise all Java classes and interfaces in the component instance type as service interfaces.
`static int` | `AUTO_EXPORT_CLASS_HIERARCHY` Advertise all Java classes in the hierarchy of the component instance type as service interfaces.
`static int` | `AUTO_EXPORT_DISABLED` Do not auto-detect types for advertised service interfaces
`static int` | `AUTO_EXPORT_INTERFACES` 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
`int` | `getAutoExport()` Return the auto-export mode for the service.
`List` | `getInterfaces()` Return the type names of the interfaces that the service should be advertised as supporting.
`int` | `getRanking()` Return the ranking value to use when advertising the service.
`Collection` | `getRegistrationListeners()` Return the registration listeners to be notified when the service is registered and unregistered with the framework.
`Target` | `getServiceComponent()` Return the Metadata for the component to be exported as a service.
`List` | `getServiceProperties()` 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 Detail

### AUTO_EXPORT_DISABLED

    static final int AUTO_EXPORT_DISABLED

  Do not auto-detect types for advertised service interfaces

  See Also:
    `getAutoExport()`, Constant Field Values

### AUTO_EXPORT_INTERFACES

    static final int AUTO_EXPORT_INTERFACES

  Advertise all Java interfaces implemented by the component instance type as service interfaces.

  See Also:
    `getAutoExport()`, Constant Field Values

### AUTO_EXPORT_CLASS_HIERARCHY

    static final int AUTO_EXPORT_CLASS_HIERARCHY

  Advertise all Java classes in the hierarchy of the component instance type as service interfaces.

  See Also:
    `getAutoExport()`, Constant Field Values

### AUTO_EXPORT_ALL_CLASSES

    static final int AUTO_EXPORT_ALL_CLASSES

  Advertise all Java classes and interfaces in the component instance type as service interfaces.

  See Also:
    `getAutoExport()`, Constant Field Values

Method Detail

### getServiceComponent

    Target getServiceComponent()

  Return the Metadata for the component to be exported as a service. This is specified inline or via the `ref` attribute of the service.

  Returns:
    The Metadata for the component to be exported as a service.

### getInterfaces

    List getInterfaces()

  Return the type names of the interfaces that the service should be advertised as supporting. This is specified in the `interface` attribute or child `interfaces` 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 using `auto-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 the `auto-export` attribute of the service.

  Returns:
    The auto-export mode for the service.
  See Also:
    `AUTO_EXPORT_DISABLED`, `AUTO_EXPORT_INTERFACES`, `AUTO_EXPORT_CLASS_HIERARCHY`, `AUTO_EXPORT_ALL_CLASSES`

### getServiceProperties

    List getServiceProperties()

  Return the user declared properties to be advertised with the service. This is specified by the `service-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 a `service.ranking` service property. This is specified by the `ranking` attribute of the service.

  Returns:
    The ranking value to use when advertising the service.

### getRegistrationListeners

    Collection getRegistrationListeners()

  Return the registration listeners to be notified when the service is registered and unregistered with the framework. This is specified by the `registration-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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006-2012. All Rights Reserved.