org.osgi.service.component.annotations.Component Maven / Gradle / Ivy
Show all versions of bnd Show documentation
/*
* Copyright (c) OSGi Alliance (2011). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.osgi.service.component.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Identify the annotated class as a Service Component.
*
*
* The annotated class is the implementation class of the Component.
*
*
* This annotation is not processed at runtime by a Service Component Runtime
* implementation. It must be processed by tools and used to add a Component
* Description to the bundle.
*
* @see "The component element of a Component Description."
* @version $Id: 9cf2483b3adc4407a22aeb299e547e59393323ee $
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface Component {
/**
* The name of this Component.
*
*
* If not specified, the name of this Component is the fully qualified type
* name of the class being annotated.
*
* @see "The name attribute of the component element of a Component Description."
*/
String name() default "";
/**
* The types under which to register this Component as a service.
*
*
* If no service should be registered, the empty value
* {} must be specified.
*
*
* If not specified, the service types for this Component are all the
* directly implemented interfaces of the class being annotated.
*
* @see "The service element of a Component Description."
*/
Class< ? >[] service() default {};
/**
* The factory identifier of this Component. Specifying a factory identifier
* makes this Component a Factory Component.
*
*
* If not specified, the default is that this Component is not a Factory
* Component.
*
* @see "The factory attribute of the component element of a Component Description."
*/
String factory() default "";
/**
* Declares whether this Component uses the OSGi ServiceFactory concept and
* each bundle using this Component's service will receive a different
* component instance.
*
*
* If {@code true}, this Component uses the OSGi ServiceFactory concept. If
* {@code false} or not specified, this Component does not use the OSGi
* ServiceFactory concept.
*
* @see "The servicefactory attribute of the service element of a Component Description."
*/
boolean servicefactory() default false;
/**
* Declares whether this Component is enabled when the bundle containing it
* is started.
*
*
* If {@code true}, this Component is enabled. If {@code false} or not
* specified, this Component is disabled.
*
* @see "The enabled attribute of the component element of a Component Description."
*/
boolean enabled() default true;
/**
* Declares whether this Component must be immediately activated upon
* becoming satisfied or whether activation should be delayed.
*
*
* If {@code true}, this Component must be immediately activated upon
* becoming satisfied. If {@code false}, activation of this Component is
* delayed. If this property is specified, its value must be {@code false}
* if the {@link #factory} property is also specified or must be
* {@code true} if the {@link #service} property is specified with an empty
* value.
*
*
* If not specified, the default is {@code false} if the {@link #factory}
* property is specified or the {@link #service} property is not specified
* or specified with a non-empty value and {@code true} otherwise.
*
* @see "The immediate attribute of the component element of a Component Description."
*/
boolean immediate() default false;
/**
* Properties for this Component.
*
*
* Each property string is specified as {@code "key=value"}. The type of the
* property value can be specified in the key as {@code key:type=value}. The
* type must be one of the property types supported by the type attribute of
* the property element of a Component Description.
*
*
* To specify a property with multiple values, use multiple key, value
* pairs. For example, {@code "foo=bar", "foo=baz"}.
*
* @see "The property element of a Component Description."
*/
String[] property() default {};
/**
* Property entries for this Component.
*
*
* Specifies the name of an entry in the bundle whose contents conform to a
* standard Java Properties File. The entry is read and processed to obtain
* the properties and their values.
*
* @see "The properties element of a Component Description."
*/
String[] properties() default {};
/**
* The XML name space of the Component Description for this Component.
*
*
* If not specified, the XML name space of the Component Description for
* this Component should be the lowest Declarative Services XML name space
* which supports all the specification features used by this Component.
*
* @see "The XML name space specified for a Component Description."
*/
String xmlns() default "";
/**
* The configuration policy of this Component.
*
*
* Controls whether component configurations must be satisfied depending on
* the presence of a corresponding Configuration object in the OSGi
* Configuration Admin service. A corresponding configuration is a
* Configuration object where the PID equals the name of the component.
*
*
* If not specified, the {@link ConfigurationPolicy#OPTIONAL OPTIONAL}
* configuration policy is used.
*
* @see "The configuration-policy attribute of the component element of a Component Description."
* @since 1.1
*/
ConfigurationPolicy configurationPolicy() default ConfigurationPolicy.OPTIONAL;
/**
* The configuration PID for the configuration of this Component.
*
*
* Allows the configuration PID for this Component to be different than the
* name of this Component.
*
*
* If not specified, the name of this Component is used as the configuration
* PID of this Component.
*
* @see "The configuration-pid attribute of the component element of a Component Description."
* @since 1.2
*/
String configurationPid() default "";
}