Java > Open Source Codes > org > eclipse > osgi > framework > internal > core > Constants


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.osgi.framework.internal.core;
13
14 /**
15  * This interface contains the constants used by the eclipse
16  * OSGi implementation.
17  */
18
19 public class Constants implements org.osgi.framework.Constants {
20     /** Default framework version */
21     public static final String OSGI_FRAMEWORK_VERSION = "1.3"; //$NON-NLS-1$
22
23     /** Framework vendor */
24     public static final String OSGI_FRAMEWORK_VENDOR = "Eclipse"; //$NON-NLS-1$
25
26     /** Bundle manifest name */
27     public static final String OSGI_BUNDLE_MANIFEST = "META-INF/MANIFEST.MF"; //$NON-NLS-1$
28
29     /** OSGi framework package name. */
30     public static final String OSGI_FRAMEWORK_PACKAGE = "org.osgi.framework"; //$NON-NLS-1$
31
32     /** Bundle resource URL protocol */
33     public static final String OSGI_RESOURCE_URL_PROTOCOL = "bundleresource"; //$NON-NLS-1$
34
35     /** Bundle entry URL protocol */
36     public static final String OSGI_ENTRY_URL_PROTOCOL = "bundleentry"; //$NON-NLS-1$
37
38     /** Processor aliases resource */
39     public static final String OSGI_PROCESSOR_ALIASES = "processor.aliases"; //$NON-NLS-1$
40
41     /** OS name aliases resource */
42     public static final String OSGI_OSNAME_ALIASES = "osname.aliases"; //$NON-NLS-1$
43
44     /** Default permissions for bundles with no permission set
45      * and there are no default permissions set.
46      */
47     public static final String OSGI_DEFAULT_DEFAULT_PERMISSIONS = "default.permissions"; //$NON-NLS-1$
48
49     /** Base implied permissions for all bundles */
50     public static final String OSGI_BASE_IMPLIED_PERMISSIONS = "implied.permissions"; //$NON-NLS-1$
51
52     /** Name of OSGi LogService */
53     public static final String OSGI_LOGSERVICE_NAME = "org.osgi.service.log.LogService"; //$NON-NLS-1$
54
55     /** Name of OSGi PackageAdmin */
56     public static final String OSGI_PACKAGEADMIN_NAME = "org.osgi.service.packageadmin.PackageAdmin"; //$NON-NLS-1$
57
58     /** Name of OSGi PermissionAdmin */
59     public static final String OSGI_PERMISSIONADMIN_NAME = "org.osgi.service.permissionadmin.PermissionAdmin"; //$NON-NLS-1$
60
61     /** Name of OSGi StartLevel */
62     public static final String OSGI_STARTLEVEL_NAME = "org.osgi.service.startlevel.StartLevel"; //$NON-NLS-1$
63
64     /** JVM java.vm.name property name */
65     public static final String JVM_VM_NAME = "java.vm.name"; //$NON-NLS-1$
66
67     /** JVM os.arch property name */
68     public static final String JVM_OS_ARCH = "os.arch"; //$NON-NLS-1$
69
70     /** JVM os.name property name */
71     public static final String JVM_OS_NAME = "os.name"; //$NON-NLS-1$
72
73     /** JVM os.version property name */
74     public static final String JVM_OS_VERSION = "os.version"; //$NON-NLS-1$
75
76     /** JVM user.language property name */
77     public static final String JVM_USER_LANGUAGE = "user.language"; //$NON-NLS-1$
78
79     /** JVM user.region property name */
80     public static final String JVM_USER_REGION = "user.region"; //$NON-NLS-1$
81
82     /** J2ME configuration property name */
83     public static final String J2ME_MICROEDITION_CONFIGURATION = "microedition.configuration"; //$NON-NLS-1$
84
85     /** J2ME profile property name */
86     public static final String J2ME_MICROEDITION_PROFILES = "microedition.profiles"; //$NON-NLS-1$
87
88     /** Persistent start bundle status */
89     public static final int BUNDLE_STARTED = 0x00000001;
90     /** Lazy start flag bundle status */
91     public static final int BUNDLE_LAZY_START = 0x00000002;
92     public static final int BUNDLE_ACTIVATION_POLICY = 0x00000004;
93
94     /** Property file locations and default names. */
95     public static final String OSGI_PROPERTIES = "osgi.framework.properties"; //$NON-NLS-1$
96 public static final String DEFAULT_OSGI_PROPERTIES = "osgi.properties"; //$NON-NLS-1$
97
98     /** OSGI system package property */
99     public static final String OSGI_FRAMEWORK_SYSTEM_PACKAGES = "org.osgi.framework.system.packages"; //$NON-NLS-1$
100 public static final String OSGI_BOOTDELEGATION = "org.osgi.framework.bootdelegation"; //$NON-NLS-1$
101 public static final String OSGI_SYSTEM_BUNDLE = "system.bundle"; //$NON-NLS-1$
102 private static String INTERNAL_SYSTEM_BUNDLE = "org.eclipse.osgi"; //$NON-NLS-1$
103
104     public static String getInternalSymbolicName() {
105         return INTERNAL_SYSTEM_BUNDLE;
106     }
107
108     static void setInternalSymbolicName(String name) {
109         INTERNAL_SYSTEM_BUNDLE = name;
110     }
111
112     /** OSGI implementation version properties key */
113     public static final String OSGI_IMPL_VERSION_KEY = "osgi.framework.version"; //$NON-NLS-1$
114 /** OSGi java profile; used to give a URL to a java profile */
115     public static final String OSGI_JAVA_PROFILE = "osgi.java.profile"; //$NON-NLS-1$
116 public static final String OSGI_JAVA_PROFILE_NAME = "osgi.java.profile.name"; //$NON-NLS-1$
117 /**
118      * OSGi java profile bootdelegation; used to indicate how the org.osgi.framework.bootdelegation
119      * property defined in the java profile should be processed, (ingnore, override, none). default is ignore
120      */
121     public static final String OSGI_JAVA_PROFILE_BOOTDELEGATION = "osgi.java.profile.bootdelegation"; //$NON-NLS-1$
122 /** indicates that the org.osgi.framework.bootdelegation in the java profile should be ingored */
123     public static final String OSGI_BOOTDELEGATION_IGNORE = "ignore"; //$NON-NLS-1$
124 /** indicates that the org.osgi.framework.bootdelegation in the java profile should override the system property */
125     public static final String OSGI_BOOTDELEGATION_OVERRIDE = "override"; //$NON-NLS-1$
126 /** indicates that the org.osgi.framework.bootdelegation in the java profile AND the system properties should be ignored */
127     public static final String OSGI_BOOTDELEGATION_NONE = "none"; //$NON-NLS-1$
128 /** OSGi strict delegation **/
129     public static final String OSGI_RESOLVER_MODE = "osgi.resolverMode"; //$NON-NLS-1$
130 public static final String STRICT_MODE = "strict"; //$NON-NLS-1$
131 public static final String DEVELOPMENT_MODE = "development"; //$NON-NLS-1$
132
133     public static final String OSGI_FRAMEWORKBEGINNINGSTARTLEVEL = "osgi.framework.beginningstartlevel"; //$NON-NLS-1$
134
135     /** Properties defaults */
136     public static final String DEFAULT_STARTLEVEL = "1"; //$NON-NLS-1$
137
138     public static String ECLIPSE_EE_INSTALL_VERIFY = "eclipse.ee.install.verify"; //$NON-NLS-1$
139 public static String OSGI_COMPATIBILITY_BOOTDELEGATION = "osgi.compatibility.bootdelegation"; //$NON-NLS-1$
140
141     /** Eclipse-SystemBundle header */
142     public static final String ECLIPSE_SYSTEMBUNDLE = "Eclipse-SystemBundle"; //$NON-NLS-1$
143 public static final String ECLIPSE_PLATFORMFILTER = "Eclipse-PlatformFilter"; //$NON-NLS-1$
144 public static final String Eclipse_JREBUNDLE = "Eclipse-JREBundle"; //$NON-NLS-1$
145 /**
146      * Manifest Export-Package directive indicating that the exported package should only
147      * be made available when the resolver is not in strict mode.
148      */
149     public static final String INTERNAL_DIRECTIVE = "x-internal"; //$NON-NLS-1$
150
151     /**
152      * Manifest Export-Package directive indicating that the exported package should only
153      * be made available to friends of the exporting bundle.
154      */
155     public static final String FRIENDS_DIRECTIVE = "x-friends"; //$NON-NLS-1$
156
157     /**
158      * Manifest header (named "Provide-Package")
159      * identifying the packages name
160      * provided to other bundles which require the bundle.
161      *
162      * <p>
163      * NOTE: this is only used for backwards compatibility, bundles manifest using
164      * syntax version 2 will not recognize this header.
165      *
166      * <p>The attribute value may be retrieved from the
167      * <tt>Dictionary</tt> object returned by the <tt>Bundle.getHeaders</tt> method.
168      * @deprecated
169      */
170     public final static String PROVIDE_PACKAGE = "Provide-Package"; //$NON-NLS-1$
171
172     /**
173      * Manifest header attribute (named &quot;reprovide&quot;)
174      * for Require-Bundle
175      * identifying that any packages that are provided
176      * by the required bundle must be reprovided by the requiring bundle.
177      * The default value is <tt>false</tt>.
178      * <p>
179      * The attribute value is encoded in the Require-Bundle manifest
180      * header like:
181      * <pre>
182      * Require-Bundle: com.acme.module.test; reprovide="true"
183      * </pre>
184      * <p>
185      * NOTE: this is only used for backwards compatibility, bundles manifest using
186      * syntax version 2 will not recognize this attribute.
187      * @deprecated
188      */
189     public final static String REPROVIDE_ATTRIBUTE = "reprovide"; //$NON-NLS-1$
190
191     /**
192      * Manifest header attribute (named &quot;optional&quot;)
193      * for Require-Bundle
194      * identifying that a required bundle is optional and that
195      * the requiring bundle can be resolved if there is no
196      * suitable required bundle.
197      * The default value is <tt>false</tt>.
198      *
199      * <p>The attribute value is encoded in the Require-Bundle manifest
200      * header like:
201      * <pre>
202      * Require-Bundle: com.acme.module.test; optional="true"
203      * </pre>
204      * <p>
205      * NOTE: this is only used for backwards compatibility, bundles manifest using
206      * syntax version 2 will not recognize this attribute.
207      * @since 1.3 <b>EXPERIMENTAL</b>
208      * @deprecated
209      */
210     public final static String OPTIONAL_ATTRIBUTE = "optional"; //$NON-NLS-1$
211
212     /**
213      * Manifest header attribute (named &quot;require-packages&quot;)
214      * for Require-Bundle
215      * specifying the subset of packages that are accessible from
216      * the required bundle. If the require-packages parameter
217      * is not specified then all packages provided by the required bundle
218      * are accessible. The value of this parameter must be a quoted
219      * string. The syntax of the quoted string value is the same as
220      * that of the Provide-Package manifest header value.
221      *
222      * <p> The attribute value is encoded in the Require-Bundle
223      * manifest header like:
224      * <pre>
225      * Require-Bundle: org.osgi.test;
226      * require-packages="org.osgi.test.pkg1,org.osgi.test.pkg2"
227      * </pre>
228      * <p>
229      * NOTE: this is only used for backwards compatibility, bundles manifest using
230      * syntax version 2 will not recognize this attribute.
231      * @deprecated
232      */
233     public final static String REQUIRE_PACKAGES_ATTRIBUTE = "require-packages"; //$NON-NLS-1$
234
235      /**
236      * The key used to designate the buddy loader associated with a given bundle.
237      */
238      public final static String BUDDY_LOADER = "Eclipse-BuddyPolicy"; //$NON-NLS-1$
239
240      public final static String REGISTERED_POLICY = "Eclipse-RegisterBuddy"; //$NON-NLS-1$
241
242     /**
243      * Manifest header (named &quot;Reexport-Package&quot;) identifying the
244      * names of the packages that the bundle offers to the Framework for
245      * reexport.
246      *
247      * <p>
248      * The attribute value may be retrieved from the <code>Dictionary</code>
249      * object returned by the <code>Bundle.getHeaders</code> method.
250      *
251      * @deprecated
252      */
253      public final static String REEXPORT_PACKAGE = "Reexport-Package"; //$NON-NLS-1$
254
255     static public final String INTERNAL_HANDLER_PKGS = "equinox.interal.handler.pkgs"; //$NON-NLS-1$
256
257     // TODO rename it to Eclipse-PluginClass
258 public static final String PLUGIN_CLASS = "Plugin-Class"; //$NON-NLS-1$
259
260     /** Manifest header used to specify the lazy start properties of a bundle */
261     public static final String ECLIPSE_LAZYSTART = "Eclipse-LazyStart"; //$NON-NLS-1$
262
263     /** An Eclipse-LazyStart attribute used to specify exception classes for auto start */
264     public static final String ECLIPSE_LAZYSTART_EXCEPTIONS = "exceptions"; //$NON-NLS-1$
265
266     /**
267      * Manifest header used to specify the auto start properties of a bundle
268      * @deprecated use {@link #ECLIPSE_LAZYSTART}
269      */
270     public static final String ECLIPSE_AUTOSTART = "Eclipse-AutoStart"; //$NON-NLS-1$
271
272     /**
273      * @deprecated use {@link #ECLIPSE_LAZYSTART_EXCEPTIONS}
274      */
275     public static final String ECLIPSE_AUTOSTART_EXCEPTIONS = ECLIPSE_LAZYSTART_EXCEPTIONS;
276 }
277

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags