1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (c) OSGi Alliance (2011, 2013). 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.
*
* <p>
* The annotated class is the implementation class of the Component.
*
* <p>
* 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."
* @author $Id$
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface Component {
/**
* The name of this Component.
*
* <p>
* 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.
*
* <p>
* If no service should be registered, the empty value
* <code>{}</code> must be specified.
*
* <p>
* If not specified, the service types for this Component are all the
* <i>directly</i> 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* Allows the configuration PID for this Component to be different than the
* name of this Component.
*
* <p>
* 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 "";
}
|
