Top Description Methods
aQute.bnd.annotation.spi

public @Interface ServiceProvider

extends Annotation
Annotations
@Retention:CLASS
@Target:PACKAGE, TYPE
@Repeatable:ServiceProviders
@Capabilities:@org.osgi.annotation.bundle.Capability(name="${#value}", namespace="osgi.serviceloader", attribute={"register:=${#register}", "${if;${size;${#uses}};uses:=\'${#uses}\'}", "${sjoin;\\\\;;${#attribute}}"}), @org.osgi.annotation.bundle.Capability(namespace="osgi.service", attribute={"objectClass:List=\\"${#value}\\"", "${if;${size;${#uses}};uses:=\'${#uses}\'}", "${sjoin;\\\\;;${#attribute}}"}, effective="active")
@Requirement
name:osgi.serviceloader.registrar
namespace:osgi.extender
version:1.0.0
attribute:${if;${size;${#effective}};effective:=${#effective}}, ${if;${is;${#resolution};default};;resolution:=${#resolution}}
Static Imports
aQute.bnd.annotation.Constants.EFFECTIVE_MACRO, .Constants.RESOLUTION_MACRO, .Constants.USES_MACRO, aQute.bnd.annotation.spi.Constants.ATTRIBUTE_MACRO, .Constants.REGISTER_MACRO, .Constants.SERVICELOADER_REGISTRAR, .Constants.SERVICELOADER_VERSION, .Constants.SERVICE_MACRO, .Constants.VALUE_MACRO, java.lang.annotation.ElementType.PACKAGE, .ElementType.TYPE, .RetentionPolicy.CLASS, org.osgi.namespace.extender.ExtenderNamespace.EXTENDER_NAMESPACE, org.osgi.namespace.service.ServiceNamespace.SERVICE_NAMESPACE, org.osgi.resource.Namespace.EFFECTIVE_ACTIVE, org.osgi.service.serviceloader.ServiceLoaderNamespace.SERVICELOADER_NAMESPACE
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

Method Summary

Modifier and TypeMethod and Description
public String[]
attribute()

A list of attribute or directive names and values.

public String
effective()

The effective time of the osgi.extender requirement.

public Class<?>
register()

The type to register as the provider.

public String
resolution()

The resolution policy of the osgi.extender requirement.

public Class<?>[]
uses()

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

public Class<?>

Returns:

the service type
value()

The service type.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

attributeback to summary
public 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.
effectiveback to summary
public 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.

registerback to summary
public Class<?> register()

The type to register as the provider.

If the annotation used on a package, then register() must be set. It is optional when used on a type using the type as the value.

The register directive is omitted from the requirement clause.

resolutionback to summary
public String 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.

usesback to summary
public 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.

valueback to summary
public Class<?> value()

The service type.

Returns:Class<?>

the service type