KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > osgi > service > component > ComponentConstants


1 /*
2  * $Header: /cvshome/build/org.osgi.service.component/src/org/osgi/service/component/ComponentConstants.java,v 1.14 2006/06/16 16:31:26 hargrave Exp $
3  *
4  * Copyright (c) OSGi Alliance (2004, 2006). All Rights Reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 package org.osgi.service.component;
20
21 /**
22  * Defines standard names for Service Component constants.
23  *
24  * @version $Revision: 1.14 $
25  */
26 public interface ComponentConstants {
27     /**
28      * Manifest header (named "Service-Component") specifying the XML
29      * documents within a bundle that contain the bundle's Service Component
30      * descriptions.
31      * <p>
32      * The attribute value may be retrieved from the <code>Dictionary</code>
33      * object returned by the <code>Bundle.getHeaders</code> method.
34      */
35     public static final String JavaDoc SERVICE_COMPONENT = "Service-Component";
36
37     /**
38      * A component property for a component configuration that contains the name
39      * of the component as specified in the <code>name</code> attribute of the
40      * <code>component</code> element. The type of this property must be
41      * <code>String</code>.
42      */
43     public final static String JavaDoc COMPONENT_NAME = "component.name";
44
45     /**
46      * A component property that contains the generated id for a component
47      * configuration. The type of this property must be <code>Long</code>.
48      *
49      * <p>
50      * The value of this property is assigned by the Service Component Runtime
51      * when a component configuration is created. The Service Component Runtime
52      * assigns a unique value that is larger than all previously assigned values
53      * since the Service Component Runtime was started. These values are NOT
54      * persistent across restarts of the Service Component Runtime.
55      */
56     public final static String JavaDoc COMPONENT_ID = "component.id";
57
58     /**
59      * A service registration property for a Component Factory that contains the
60      * value of the <code>factory</code> attribute. The type of this property
61      * must be <code>String</code>.
62      */
63     public final static String JavaDoc COMPONENT_FACTORY = "component.factory";
64
65     /**
66      * The suffix for reference target properties. These properties contain the
67      * filter to select the target services for a reference. The type of this
68      * property must be <code>String</code>.
69      */
70     public final static String JavaDoc REFERENCE_TARGET_SUFFIX = ".target";
71 }
72
Popular Tags