aQute.bnd.annotation.spi

Annotation Type ServiceProvider

@Retention(value=CLASS)
 @Target(value=TYPE)
 @Repeatable(value=ServiceProviders.class)
 @Capability(name="${#value}",
            namespace="osgi.serviceloader",
            attribute={"register:=${@class}","${if;${size;${#uses}};uses:=\'${#uses}\'}","${sjoin;\\;;${#attribute}}"})
 @Requirement(name="osgi.serviceloader.registrar",
             namespace="osgi.extender",
             version="1.0.0",
             attribute={"${if;${size;${#effective}};effective:=${#effective}}","${if;${is;${#resolution};default};;resolution:=${#resolution}}"})
public @interface ServiceProvider

Annotation used to generate requirements and capabilities necessary for supporting the provider side of the Service Loader Mediator specification.

Also results in the automatic generation of service descriptor files (a.k.a. META-INF/services).

See Also:

Service Loader Mediator

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	value The service type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	attribute A list of attribute or directive names and values.
String	effective The effective time of the osgi.extender requirement.
Resolution	resolution The resolution policy of the osgi.extender requirement.
Class<?>[]	uses A list of classes whose packages are inspected to calculate the uses directive for this capability.

Element Detail

value

public abstract Class<?> value

The service type.

Returns:

the service type

effective

public abstract String effective

The effective time of the osgi.extender requirement.

Specifies the time the osgi.extender requirements are available. The OSGi framework resolver only considers requirements without an effective directive or effective:=resolve. Requirements with other values for the effective directive can be considered by an external agent.

If not specified, the effective directive is omitted from the requirement clause.

Default:

""

uses

public abstract Class<?>[] uses

A list of classes whose packages are inspected to calculate the uses directive for this capability.

If not specified, the uses directive is omitted from the capability clause.

Default:

{}

attribute

public abstract String[] attribute

A list of attribute or directive names and values.

Each string should be specified in the form:

• "name=value" for attributes.
• "name:type=value" for typed attributes.
• "name:=value" for directives.

These are added, separated by semicolons, to the osgi.serviceloader capability. Non-standard osgi.serviceloader attributes will be included as service properties to the published service.

Default:

{}

resolution

public abstract Resolution resolution

The resolution policy of the osgi.extender requirement.

A mandatory requirement forbids the bundle to resolve when this requirement is not satisfied; an optional requirement allows a bundle to resolve even if this requirement is not satisfied.

If not specified, the resolution directive is omitted from the requirement clause.

Default:

aQute.bnd.annotation.Resolution.DEFAULT