aQute.bnd.annotation.spi.ServiceProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of biz.aQute.bndlib Show documentation
bndlib: A Swiss Army Knife for OSGi
The newest version!
package aQute.bnd.annotation.spi;

import static aQute.bnd.annotation.Constants.EFFECTIVE_MACRO;
import static aQute.bnd.annotation.Constants.RESOLUTION_MACRO;
import static aQute.bnd.annotation.Constants.USES_MACRO;
import static aQute.bnd.annotation.spi.Constants.ATTRIBUTE_MACRO;
import static aQute.bnd.annotation.spi.Constants.REGISTER_MACRO;
import static aQute.bnd.annotation.spi.Constants.SERVICELOADER_REGISTRAR;
import static aQute.bnd.annotation.spi.Constants.SERVICELOADER_VERSION;
import static aQute.bnd.annotation.spi.Constants.SERVICE_MACRO;
import static aQute.bnd.annotation.spi.Constants.VALUE_MACRO;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;
import static org.osgi.namespace.extender.ExtenderNamespace.EXTENDER_NAMESPACE;
import static org.osgi.namespace.service.ServiceNamespace.SERVICE_NAMESPACE;
import static org.osgi.resource.Namespace.EFFECTIVE_ACTIVE;
import static org.osgi.service.serviceloader.ServiceLoaderNamespace.SERVICELOADER_NAMESPACE;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.osgi.annotation.bundle.Capability;
import org.osgi.annotation.bundle.Requirement;

import aQute.bnd.annotation.Resolution;

/**
 * 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.
 * {@code META-INF/services}).
 *
 * @see Service
 *      Loader Mediator
 */
@Retention(CLASS)
@Target({
	PACKAGE, TYPE
})
@Repeatable(ServiceProviders.class)
@Capability(name = VALUE_MACRO, namespace = SERVICELOADER_NAMESPACE, attribute = {
	REGISTER_MACRO, USES_MACRO, ATTRIBUTE_MACRO
})
@Capability(namespace = SERVICE_NAMESPACE, attribute = {
	SERVICE_MACRO, USES_MACRO, ATTRIBUTE_MACRO
}, effective = EFFECTIVE_ACTIVE)
@Requirement(name = SERVICELOADER_REGISTRAR, namespace = EXTENDER_NAMESPACE, version = SERVICELOADER_VERSION, attribute = {
	EFFECTIVE_MACRO, RESOLUTION_MACRO
})
public @interface ServiceProvider {
	/**
	 * The service type.
	 *
	 * @return the service type
	 */
	Class value();

	/**
	 * The effective time of the {@code osgi.extender} requirement.
	 * 

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

	 * If not specified, the {@code effective} directive is omitted from the
	 * requirement clause.
	 */
	String effective() default "";

	/**
	 * A list of classes whose packages are inspected to calculate the
	 * {@code uses} directive for this capability.
	 * 

	 * If not specified, the {@code uses} directive is omitted from the
	 * capability clause.
	 */
	Class[] uses() default {};

	/**
	 * A list of attribute or directive names and values.
	 * 

	 * Each string should be specified in the form:
	 * 

	 * {@code "name=value"} for attributes.
	 * {@code "name:type=value"} for typed attributes.
	 * {@code "name:=value"} for directives.
	 * 
	 * These are added, separated by semicolons, to the
	 * {@code osgi.serviceloader} capability. Non-standard
	 * {@code osgi.serviceloader} attributes will be included as service
	 * properties to the published service.
	 */
	String[] attribute() default {};

	/**
	 * The resolution policy of the {@code 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 {@code resolution} directive is omitted from the
	 * requirement clause.
	 */
	String resolution() default Resolution.DEFAULT;

	/**
	 * The type to register as the provider.
	 * 

	 * If the annotation used on a package, then {@link #register()} must be
	 * set. It is optional when used on a type using the type as the value.
	 * 
	 * The {@code register} directive is omitted from the requirement clause.
	 */
	Class register() default Target.class;

}