Mercurial > projects > dwt2
diff org.eclipse.osgi/osgi/src/org/osgi/framework/Bundle.d @ 105:bbe49769ec18
...
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Sun, 08 Nov 2009 12:42:30 +0100 |
| parents | 0628aaa2996c |
| children |
line wrap: on
line diff
--- a/org.eclipse.osgi/osgi/src/org/osgi/framework/Bundle.d Sat May 02 11:27:24 2009 +0200 +++ b/org.eclipse.osgi/osgi/src/org/osgi/framework/Bundle.d Sun Nov 08 12:42:30 2009 +0100 @@ -16,15 +16,21 @@ * limitations under the License. */ +// Port to the D programming language: +// Frank Benoit <benoit@tionex.de> module org.osgi.framework.Bundle; import java.lang.all; -// import java.io.IOException; -// import java.io.InputStream; -// import java.net.URL; -// import java.util.Dictionary; -// import java.util.Enumeration; +import org.osgi.framework.BundleException; // packageimport +import org.osgi.framework.ServiceReference; // packageimport +import org.osgi.framework.BundleContext; // packageimport + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.Dictionary; +import java.util.Enumeration; /** * An installed bundle in the Framework. @@ -81,7 +87,7 @@ * <p> * The value of <code>UNINSTALLED</code> is 0x00000001. */ - public static const int UNINSTALLED = 0x00000001; + public static final int UNINSTALLED = 0x00000001; /** * The bundle is installed but not yet resolved. @@ -97,7 +103,7 @@ * <p> * The value of <code>INSTALLED</code> is 0x00000002. */ - public static const int INSTALLED = 0x00000002; + public static final int INSTALLED = 0x00000002; /** * The bundle is resolved and is able to be started. @@ -124,7 +130,7 @@ * <p> * The value of <code>RESOLVED</code> is 0x00000004. */ - public static const int RESOLVED = 0x00000004; + public static final int RESOLVED = 0x00000004; /** * The bundle is in the process of starting. @@ -144,7 +150,7 @@ * <p> * The value of <code>STARTING</code> is 0x00000008. */ - public static const int STARTING = 0x00000008; + public static final int STARTING = 0x00000008; /** * The bundle is in the process of stopping. @@ -158,7 +164,7 @@ * <p> * The value of <code>STOPPING</code> is 0x00000010. */ - public static const int STOPPING = 0x00000010; + public static final int STOPPING = 0x00000010; /** * The bundle is now running. @@ -169,7 +175,7 @@ * <p> * The value of <code>ACTIVE</code> is 0x00000020. */ - public static const int ACTIVE = 0x00000020; + public static final int ACTIVE = 0x00000020; /** * The bundle start operation is transient and the persistent autostart @@ -184,7 +190,7 @@ * @since 1.4 * @see #start(int) */ - public static const int START_TRANSIENT = 0x00000001; + public static final int START_TRANSIENT = 0x00000001; /** * The bundle start operation must activate the bundle according to the @@ -200,7 +206,7 @@ * @see Constants#BUNDLE_ACTIVATIONPOLICY * @see #start(int) */ - public static const int START_ACTIVATION_POLICY = 0x00000002; + public static final int START_ACTIVATION_POLICY = 0x00000002; /** * The bundle stop is transient and the persistent autostart setting of the @@ -351,7 +357,7 @@ * the Java Runtime Environment supports permissions. * @since 1.4 */ - public void start(int options); + public void start(int options) ; /** * Starts this bundle with no options. @@ -370,7 +376,7 @@ * the Java Runtime Environment supports permissions. * @see #start(int) */ - public void start(); + public void start() ; /** * Stops this bundle. @@ -448,7 +454,7 @@ * the Java Runtime Environment supports permissions. * @since 1.4 */ - public void stop(int options); + public void stop(int options) ; /** * Stops this bundle with no options. @@ -465,7 +471,7 @@ * the Java Runtime Environment supports permissions. * @see #start(int) */ - public void stop(); + public void stop() ; /** * Updates this bundle. @@ -552,571 +558,571 @@ * @see #stop() * @see #start() */ - public void update(); + public void update() ; + + /** + * Updates this bundle from an <code>InputStream</code>. + * + * <p> + * This method performs all the steps listed in <code>Bundle.update()</code>, + * except the new version of this bundle must be read from the supplied + * <code>InputStream</code>, rather than a <code>URL</code>. + * <p> + * This method must always close the <code>InputStream</code> when it is + * done, even if an exception is thrown. + * + * @param in The <code>InputStream</code> from which to read the new + * bundle. + * @throws BundleException If the provided stream cannot be read or the + * update fails. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled or this bundle tries to change its own state. + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,LIFECYCLE]</code> for + * both the current bundle and the updated bundle, and the Java + * Runtime Environment supports permissions. + * @see #update() + */ + public void update(InputStream in_) ; + + /** + * Uninstalls this bundle. + * + * <p> + * This method causes the Framework to notify other bundles that this bundle + * is being uninstalled, and then puts this bundle into the + * <code>UNINSTALLED</code> state. The Framework must remove any resources + * related to this bundle that it is able to remove. + * + * <p> + * If this bundle has exported any packages, the Framework must continue to + * make these packages available to their importing bundles until the + * <code>PackageAdmin.refreshPackages</code> method has been called or the + * Framework is relaunched. + * + * <p> + * The following steps are required to uninstall a bundle: + * <ol> + * <li>If this bundle's state is <code>UNINSTALLED</code> then an + * <code>IllegalStateException</code> is thrown. + * + * <li>If this bundle's state is <code>ACTIVE</code>, + * <code>STARTING</code> or <code>STOPPING</code>, this bundle is + * stopped as described in the <code>Bundle.stop</code> method. If + * <code>Bundle.stop</code> throws an exception, a Framework event of type + * {@link FrameworkEvent#ERROR} is fired containing the exception. + * + * <li>This bundle's state is set to <code>UNINSTALLED</code>. + * + * <li>A bundle event of type {@link BundleEvent#UNINSTALLED} is fired. + * + * <li>This bundle and any persistent storage area provided for this bundle + * by the Framework are removed. + * </ol> + * + * <b>Preconditions </b> + * <ul> + * <li><code>getState()</code> not in {<code>UNINSTALLED</code>}. + * </ul> + * <b>Postconditions, no exceptions thrown </b> + * <ul> + * <li><code>getState()</code> in {<code>UNINSTALLED</code>}. + * <li>This bundle has been uninstalled. + * </ul> + * <b>Postconditions, when an exception is thrown </b> + * <ul> + * <li><code>getState()</code> not in {<code>UNINSTALLED</code>}. + * <li>This Bundle has not been uninstalled. + * </ul> + * + * @throws BundleException If the uninstall failed. This can occur if + * another thread is attempting to change this bundle's state and + * does not complete in a timely manner. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled or this bundle tries to change its own state. + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,LIFECYCLE]</code>, and + * the Java Runtime Environment supports permissions. + * @see #stop() + */ + public void uninstall() ; + + /** + * Returns this bundle's Manifest headers and values. This method returns + * all the Manifest headers and values from the main section of this + * bundle's Manifest file; that is, all lines prior to the first blank line. + * + * <p> + * Manifest header names are case-insensitive. The methods of the returned + * <code>Dictionary</code> object must operate on header names in a + * case-insensitive manner. + * + * If a Manifest header value starts with "%", it must be + * localized according to the default locale. + * + * <p> + * For example, the following Manifest headers and values are included if + * they are present in the Manifest file: + * + * <pre> + * Bundle-Name + * Bundle-Vendor + * Bundle-Version + * Bundle-Description + * Bundle-DocURL + * Bundle-ContactAddress + * </pre> + * + * <p> + * This method must continue to return Manifest header information while + * this bundle is in the <code>UNINSTALLED</code> state. + * + * @return A <code>Dictionary</code> object containing this bundle's + * Manifest headers and values. + * + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,METADATA]</code>, and + * the Java Runtime Environment supports permissions. + * + * @see Constants#BUNDLE_LOCALIZATION + */ + public Dictionary getHeaders(); + + /** + * Returns this bundle's unique identifier. This bundle is assigned a unique + * identifier by the Framework when it was installed in the OSGi + * environment. + * + * <p> + * A bundle's unique identifier has the following attributes: + * <ul> + * <li>Is unique and persistent. + * <li>Is a <code>long</code>. + * <li>Its value is not reused for another bundle, even after a bundle is + * uninstalled. + * <li>Does not change while a bundle remains installed. + * <li>Does not change when a bundle is updated. + * </ul> + * + * <p> + * This method must continue to return this bundle's unique identifier while + * this bundle is in the <code>UNINSTALLED</code> state. + * + * @return The unique identifier of this bundle. + */ + public long getBundleId(); + + /** + * Returns this bundle's location identifier. + * + * <p> + * The location identifier is the location passed to + * <code>BundleContext.installBundle</code> when a bundle is installed. + * The location identifier does not change while this bundle remains + * installed, even if this bundle is updated. + * + * <p> + * This method must continue to return this bundle's location identifier + * while this bundle is in the <code>UNINSTALLED</code> state. + * + * @return The string representation of this bundle's location identifier. + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,METADATA]</code>, and + * the Java Runtime Environment supports permissions. + */ + public String getLocation(); + + /** + * Returns this bundle's <code>ServiceReference</code> list for all + * services it has registered or <code>null</code> if this bundle has no + * registered services. + * + * <p> + * If the Java runtime supports permissions, a <code>ServiceReference</code> + * object to a service is included in the returned list only if the caller + * has the <code>ServicePermission</code> to get the service using at + * least one of the named classes the service was registered under. + * + * <p> + * The list is valid at the time of the call to this method, however, as the + * Framework is a very dynamic environment, services can be modified or + * unregistered at anytime. + * + * @return An array of <code>ServiceReference</code> objects or + * <code>null</code>. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @see ServiceRegistration + * @see ServiceReference + * @see ServicePermission + */ + public ServiceReference[] getRegisteredServices(); + + /** + * Returns this bundle's <code>ServiceReference</code> list for all + * services it is using or returns <code>null</code> if this bundle is not + * using any services. A bundle is considered to be using a service if its + * use count for that service is greater than zero. + * + * <p> + * If the Java Runtime Environment supports permissions, a + * <code>ServiceReference</code> object to a service is included in the + * returned list only if the caller has the <code>ServicePermission</code> + * to get the service using at least one of the named classes the service + * was registered under. + * <p> + * The list is valid at the time of the call to this method, however, as the + * Framework is a very dynamic environment, services can be modified or + * unregistered at anytime. + * + * @return An array of <code>ServiceReference</code> objects or + * <code>null</code>. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @see ServiceReference + * @see ServicePermission + */ + public ServiceReference[] getServicesInUse(); + + /** + * Determines if this bundle has the specified permissions. + * + * <p> + * If the Java Runtime Environment does not support permissions, this method + * always returns <code>true</code>. + * <p> + * <code>permission</code> is of type <code>Object</code> to avoid + * referencing the <code>java.security.Permission</code> class directly. + * This is to allow the Framework to be implemented in Java environments + * which do not support permissions. + * + * <p> + * If the Java Runtime Environment does support permissions, this bundle and + * all its resources including embedded JAR files, belong to the same + * <code>java.security.ProtectionDomain</code>; that is, they must share + * the same set of permissions. + * + * @param permission The permission to verify. + * + * @return <code>true</code> if this bundle has the specified permission + * or the permissions possessed by this bundle imply the specified + * permission; <code>false</code> if this bundle does not have the + * specified permission or <code>permission</code> is not an + * <code>instanceof</code> <code>java.security.Permission</code>. + * + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + */ + public bool hasPermission(Object permission); -// /** -// * Updates this bundle from an <code>InputStream</code>. -// * -// * <p> -// * This method performs all the steps listed in <code>Bundle.update()</code>, -// * except the new version of this bundle must be read from the supplied -// * <code>InputStream</code>, rather than a <code>URL</code>. -// * <p> -// * This method must always close the <code>InputStream</code> when it is -// * done, even if an exception is thrown. -// * -// * @param in The <code>InputStream</code> from which to read the new -// * bundle. -// * @throws BundleException If the provided stream cannot be read or the -// * update fails. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled or this bundle tries to change its own state. -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,LIFECYCLE]</code> for -// * both the current bundle and the updated bundle, and the Java -// * Runtime Environment supports permissions. -// * @see #update() -// */ -// public void update(InputStream in_); -// -// /** -// * Uninstalls this bundle. -// * -// * <p> -// * This method causes the Framework to notify other bundles that this bundle -// * is being uninstalled, and then puts this bundle into the -// * <code>UNINSTALLED</code> state. The Framework must remove any resources -// * related to this bundle that it is able to remove. -// * -// * <p> -// * If this bundle has exported any packages, the Framework must continue to -// * make these packages available to their importing bundles until the -// * <code>PackageAdmin.refreshPackages</code> method has been called or the -// * Framework is relaunched. -// * -// * <p> -// * The following steps are required to uninstall a bundle: -// * <ol> -// * <li>If this bundle's state is <code>UNINSTALLED</code> then an -// * <code>IllegalStateException</code> is thrown. -// * -// * <li>If this bundle's state is <code>ACTIVE</code>, -// * <code>STARTING</code> or <code>STOPPING</code>, this bundle is -// * stopped as described in the <code>Bundle.stop</code> method. If -// * <code>Bundle.stop</code> throws an exception, a Framework event of type -// * {@link FrameworkEvent#ERROR} is fired containing the exception. -// * -// * <li>This bundle's state is set to <code>UNINSTALLED</code>. -// * -// * <li>A bundle event of type {@link BundleEvent#UNINSTALLED} is fired. -// * -// * <li>This bundle and any persistent storage area provided for this bundle -// * by the Framework are removed. -// * </ol> -// * -// * <b>Preconditions </b> -// * <ul> -// * <li><code>getState()</code> not in {<code>UNINSTALLED</code>}. -// * </ul> -// * <b>Postconditions, no exceptions thrown </b> -// * <ul> -// * <li><code>getState()</code> in {<code>UNINSTALLED</code>}. -// * <li>This bundle has been uninstalled. -// * </ul> -// * <b>Postconditions, when an exception is thrown </b> -// * <ul> -// * <li><code>getState()</code> not in {<code>UNINSTALLED</code>}. -// * <li>This Bundle has not been uninstalled. -// * </ul> -// * -// * @throws BundleException If the uninstall failed. This can occur if -// * another thread is attempting to change this bundle's state and -// * does not complete in a timely manner. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled or this bundle tries to change its own state. -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,LIFECYCLE]</code>, and -// * the Java Runtime Environment supports permissions. -// * @see #stop() -// */ -// public void uninstall(); -// -// /** -// * Returns this bundle's Manifest headers and values. This method returns -// * all the Manifest headers and values from the main section of this -// * bundle's Manifest file; that is, all lines prior to the first blank line. -// * -// * <p> -// * Manifest header names are case-insensitive. The methods of the returned -// * <code>Dictionary</code> object must operate on header names in a -// * case-insensitive manner. -// * -// * If a Manifest header value starts with "%", it must be -// * localized according to the default locale. -// * -// * <p> -// * For example, the following Manifest headers and values are included if -// * they are present in the Manifest file: -// * -// * <pre> -// * Bundle-Name -// * Bundle-Vendor -// * Bundle-Version -// * Bundle-Description -// * Bundle-DocURL -// * Bundle-ContactAddress -// * </pre> -// * -// * <p> -// * This method must continue to return Manifest header information while -// * this bundle is in the <code>UNINSTALLED</code> state. -// * -// * @return A <code>Dictionary</code> object containing this bundle's -// * Manifest headers and values. -// * -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,METADATA]</code>, and -// * the Java Runtime Environment supports permissions. -// * -// * @see Constants#BUNDLE_LOCALIZATION -// */ -// public Dictionary getHeaders(); -// -// /** -// * Returns this bundle's unique identifier. This bundle is assigned a unique -// * identifier by the Framework when it was installed in the OSGi -// * environment. -// * -// * <p> -// * A bundle's unique identifier has the following attributes: -// * <ul> -// * <li>Is unique and persistent. -// * <li>Is a <code>long</code>. -// * <li>Its value is not reused for another bundle, even after a bundle is -// * uninstalled. -// * <li>Does not change while a bundle remains installed. -// * <li>Does not change when a bundle is updated. -// * </ul> -// * -// * <p> -// * This method must continue to return this bundle's unique identifier while -// * this bundle is in the <code>UNINSTALLED</code> state. -// * -// * @return The unique identifier of this bundle. -// */ -// public long getBundleId(); -// -// /** -// * Returns this bundle's location identifier. -// * -// * <p> -// * The location identifier is the location passed to -// * <code>BundleContext.installBundle</code> when a bundle is installed. -// * The location identifier does not change while this bundle remains -// * installed, even if this bundle is updated. -// * -// * <p> -// * This method must continue to return this bundle's location identifier -// * while this bundle is in the <code>UNINSTALLED</code> state. -// * -// * @return The string representation of this bundle's location identifier. -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,METADATA]</code>, and -// * the Java Runtime Environment supports permissions. -// */ -// public String getLocation(); -// -// /** -// * Returns this bundle's <code>ServiceReference</code> list for all -// * services it has registered or <code>null</code> if this bundle has no -// * registered services. -// * -// * <p> -// * If the Java runtime supports permissions, a <code>ServiceReference</code> -// * object to a service is included in the returned list only if the caller -// * has the <code>ServicePermission</code> to get the service using at -// * least one of the named classes the service was registered under. -// * -// * <p> -// * The list is valid at the time of the call to this method, however, as the -// * Framework is a very dynamic environment, services can be modified or -// * unregistered at anytime. -// * -// * @return An array of <code>ServiceReference</code> objects or -// * <code>null</code>. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @see ServiceRegistration -// * @see ServiceReference -// * @see ServicePermission -// */ -// public ServiceReference[] getRegisteredServices(); -// -// /** -// * Returns this bundle's <code>ServiceReference</code> list for all -// * services it is using or returns <code>null</code> if this bundle is not -// * using any services. A bundle is considered to be using a service if its -// * use count for that service is greater than zero. -// * -// * <p> -// * If the Java Runtime Environment supports permissions, a -// * <code>ServiceReference</code> object to a service is included in the -// * returned list only if the caller has the <code>ServicePermission</code> -// * to get the service using at least one of the named classes the service -// * was registered under. -// * <p> -// * The list is valid at the time of the call to this method, however, as the -// * Framework is a very dynamic environment, services can be modified or -// * unregistered at anytime. -// * -// * @return An array of <code>ServiceReference</code> objects or -// * <code>null</code>. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @see ServiceReference -// * @see ServicePermission -// */ -// public ServiceReference[] getServicesInUse(); -// -// /** -// * Determines if this bundle has the specified permissions. -// * -// * <p> -// * If the Java Runtime Environment does not support permissions, this method -// * always returns <code>true</code>. -// * <p> -// * <code>permission</code> is of type <code>Object</code> to avoid -// * referencing the <code>java.security.Permission</code> class directly. -// * This is to allow the Framework to be implemented in Java environments -// * which do not support permissions. -// * -// * <p> -// * If the Java Runtime Environment does support permissions, this bundle and -// * all its resources including embedded JAR files, belong to the same -// * <code>java.security.ProtectionDomain</code>; that is, they must share -// * the same set of permissions. -// * -// * @param permission The permission to verify. -// * -// * @return <code>true</code> if this bundle has the specified permission -// * or the permissions possessed by this bundle imply the specified -// * permission; <code>false</code> if this bundle does not have the -// * specified permission or <code>permission</code> is not an -// * <code>instanceof</code> <code>java.security.Permission</code>. -// * -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// */ -// public bool hasPermission(Object permission); -// -// /** -// * Find the specified resource from this bundle. -// * -// * This bundle's class loader is called to search for the specified -// * resource. If this bundle's state is <code>INSTALLED</code>, this -// * method must attempt to resolve this bundle before attempting to get the -// * specified resource. If this bundle cannot be resolved, then only this -// * bundle must be searched for the specified resource. Imported packages -// * cannot be searched when this bundle has not been resolved. If this bundle -// * is a fragment bundle then <code>null</code> is returned. -// * -// * @param name The name of the resource. See -// * <code>java.lang.ClassLoader.getResource</code> for a description -// * of the format of a resource name. -// * @return A URL to the named resource, or <code>null</code> if the -// * resource could not be found or if this bundle is a fragment -// * bundle or if the caller does not have the appropriate -// * <code>AdminPermission[this,RESOURCE]</code>, and the Java -// * Runtime Environment supports permissions. -// * -// * @since 1.1 -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @see #getEntry -// * @see #findEntries -// */ -// public URL getResource(String name); -// -// /** -// * Returns this bundle's Manifest headers and values localized to the -// * specified locale. -// * -// * <p> -// * This method performs the same function as -// * <code>Bundle.getHeaders()</code> except the manifest header values are -// * localized to the specified locale. -// * -// * <p> -// * If a Manifest header value starts with "%", it must be -// * localized according to the specified locale. If a locale is specified and -// * cannot be found, then the header values must be returned using the -// * default locale. Localizations are searched for in the following order: -// * -// * <pre> -// * bn + "_" + Ls + "_" + Cs + "_" + Vs -// * bn + "_" + Ls + "_" + Cs -// * bn + "_" + Ls -// * bn + "_" + Ld + "_" + Cd + "_" + Vd -// * bn + "_" + Ld + "_" + Cd -// * bn + "_" + Ld -// * bn -// * </pre> -// * -// * Where <code>bn</code> is this bundle's localization basename, -// * <code>Ls</code>, <code>Cs</code> and <code>Vs</code> are the -// * specified locale (language, country, variant) and <code>Ld</code>, -// * <code>Cd</code> and <code>Vd</code> are the default locale (language, -// * country, variant). -// * -// * If <code>null</code> is specified as the locale string, the header -// * values must be localized using the default locale. If the empty string -// * ("") is specified as the locale string, the header values must -// * not be localized and the raw (unlocalized) header values, including any -// * leading "%", must be returned. -// * -// * <p> -// * This method must continue to return Manifest header information while -// * this bundle is in the <code>UNINSTALLED</code> state, however the -// * header values must only be available in the raw and default locale -// * values. -// * -// * @param locale The locale name into which the header values are to be -// * localized. If the specified locale is <code>null</code> then the -// * locale returned by <code>java.util.Locale.getDefault</code> is -// * used. If the specified locale is the empty string, this method -// * will return the raw (unlocalized) manifest headers including any -// * leading "%". -// * @return A <code>Dictionary</code> object containing this bundle's -// * Manifest headers and values. -// * -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,METADATA]</code>, and -// * the Java Runtime Environment supports permissions. -// * -// * @see #getHeaders() -// * @see Constants#BUNDLE_LOCALIZATION -// * @since 1.3 -// */ -// public Dictionary getHeaders(String locale); -// -// /** -// * Returns the symbolic name of this bundle as specified by its -// * <code>Bundle-SymbolicName</code> manifest header. The name must be -// * unique, it is recommended to use a reverse domain name naming convention -// * like that used for java packages. If this bundle does not have a -// * specified symbolic name then <code>null</code> is returned. -// * -// * <p> -// * This method must continue to return this bundle's symbolic name while -// * this bundle is in the <code>UNINSTALLED</code> state. -// * -// * @return The symbolic name of this bundle. -// * @since 1.3 -// */ -// public String getSymbolicName(); -// -// /** -// * Loads the specified class using this bundle's classloader. -// * -// * <p> -// * If this bundle is a fragment bundle then this method must throw a -// * <code>ClassNotFoundException</code>. -// * -// * <p> -// * If this bundle's state is <code>INSTALLED</code>, this method must -// * attempt to resolve this bundle before attempting to load the class. -// * -// * <p> -// * If this bundle cannot be resolved, a Framework event of type -// * {@link FrameworkEvent#ERROR} is fired containing a -// * <code>BundleException</code> with details of the reason this bundle -// * could not be resolved. This method must then throw a -// * <code>ClassNotFoundException</code>. -// * -// * <p> -// * If this bundle's state is <code>UNINSTALLED</code>, then an -// * <code>IllegalStateException</code> is thrown. -// * -// * @param name The name of the class to load. -// * @return The Class object for the requested class. -// * @throws java.lang.ClassNotFoundException If no such class can be found or -// * if this bundle is a fragment bundle or if the caller does not -// * have the appropriate <code>AdminPermission[this,CLASS]</code>, -// * and the Java Runtime Environment supports permissions. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @since 1.3 -// */ -// public Class loadClass(String name) throws ClassNotFoundException; -// -// /** -// * Find the specified resources from this bundle. -// * -// * This bundle's class loader is called to search for the specified -// * resources. If this bundle's state is <code>INSTALLED</code>, this -// * method must attempt to resolve this bundle before attempting to get the -// * specified resources. If this bundle cannot be resolved, then only this -// * bundle must be searched for the specified resources. Imported packages -// * cannot be searched when a bundle has not been resolved. If this bundle is -// * a fragment bundle then <code>null</code> is returned. -// * -// * @param name The name of the resource. See -// * <code>java.lang.ClassLoader.getResources</code> for a -// * description of the format of a resource name. -// * @return An enumeration of URLs to the named resources, or -// * <code>null</code> if the resource could not be found or if this -// * bundle is a fragment bundle or if the caller does not have the -// * appropriate <code>AdminPermission[this,RESOURCE]</code>, and -// * the Java Runtime Environment supports permissions. -// * -// * @since 1.3 -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @throws java.io.IOException If there is an I/O error. -// */ -// public Enumeration getResources(String name) throws IOException; -// -// /** -// * Returns an Enumeration of all the paths (<code>String</code> objects) -// * to entries within this bundle whose longest sub-path matches the -// * specified path. This bundle's classloader is not used to search for -// * entries. Only the contents of this bundle are searched. -// * <p> -// * The specified path is always relative to the root of this bundle and may -// * begin with a "/". A path value of "/" indicates the -// * root of this bundle. -// * <p> -// * Returned paths indicating subdirectory paths end with a "/". -// * The returned paths are all relative to the root of this bundle and must -// * not begin with "/". -// * -// * @param path The path name for which to return entry paths. -// * @return An Enumeration of the entry paths (<code>String</code> -// * objects) or <code>null</code> if no entry could be found or if -// * the caller does not have the appropriate -// * <code>AdminPermission[this,RESOURCE]</code> and the Java -// * Runtime Environment supports permissions. -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @since 1.3 -// */ -// public Enumeration getEntryPaths(String path); -// -// /** -// * Returns a URL to the entry at the specified path in this bundle. This -// * bundle's classloader is not used to search for the entry. Only the -// * contents of this bundle are searched for the entry. -// * <p> -// * The specified path is always relative to the root of this bundle and may -// * begin with "/". A path value of "/" indicates the -// * root of this bundle. -// * -// * @param path The path name of the entry. -// * @return A URL to the entry, or <code>null</code> if no entry could be -// * found or if the caller does not have the appropriate -// * <code>AdminPermission[this,RESOURCE]</code> and the Java -// * Runtime Environment supports permissions. -// * -// * @throws java.lang.IllegalStateException If this bundle has been -// * uninstalled. -// * @since 1.3 -// */ -// public URL getEntry(String path); -// -// /** -// * Returns the time when this bundle was last modified. A bundle is -// * considered to be modified when it is installed, updated or uninstalled. -// * -// * <p> -// * The time value is the number of milliseconds since January 1, 1970, -// * 00:00:00 GMT. -// * -// * @return The time when this bundle was last modified. -// * @since 1.3 -// */ -// public long getLastModified(); -// -// /** -// * Returns entries in this bundle and its attached fragments. This bundle's -// * classloader is not used to search for entries. Only the contents of this -// * bundle and its attached fragments are searched for the specified entries. -// * -// * If this bundle's state is <code>INSTALLED</code>, this method must -// * attempt to resolve this bundle before attempting to find entries. -// * -// * <p> -// * This method is intended to be used to obtain configuration, setup, -// * localization and other information from this bundle. This method takes -// * into account that the "contents" of this bundle can be extended -// * with fragments. This "bundle space" is not a namespace with -// * unique members; the same entry name can be present multiple times. This -// * method therefore returns an enumeration of URL objects. These URLs can -// * come from different JARs but have the same path name. This method can -// * either return only entries in the specified path or recurse into -// * subdirectories returning entries in the directory tree beginning at the -// * specified path. Fragments can be attached after this bundle is resolved, -// * possibly changing the set of URLs returned by this method. If this bundle -// * is not resolved, only the entries in the JAR file of this bundle are -// * returned. -// * <p> -// * Examples: -// * -// * <pre> -// * // List all XML files in the OSGI-INF directory and below -// * Enumeration e = b.findEntries("OSGI-INF", "*.xml", true); -// * -// * // Find a specific localization file -// * Enumeration e = b.findEntries("OSGI-INF/l10n", -// * "bundle_nl_DU.properties", -// * false); -// * if (e.hasMoreElements()) -// * return (URL) e.nextElement(); -// * </pre> -// * -// * @param path The path name in which to look. The path is always relative -// * to the root of this bundle and may begin with "/". A -// * path value of "/" indicates the root of this bundle. -// * @param filePattern The file name pattern for selecting entries in the -// * specified path. The pattern is only matched against the last -// * element of the entry path and it supports substring matching, as -// * specified in the Filter specification, using the wildcard -// * character ("*"). If null is specified, this is -// * equivalent to "*" and matches all files. -// * @param recurse If <code>true</code>, recurse into subdirectories. -// * Otherwise only return entries from the specified path. -// * @return An enumeration of URL objects for each matching entry, or -// * <code>null</code> if an entry could not be found or if the -// * caller does not have the appropriate -// * <code>AdminPermission[this,RESOURCE]</code>, and the Java -// * Runtime Environment supports permissions. The URLs are sorted -// * such that entries from this bundle are returned first followed by -// * the entries from attached fragments in ascending bundle id order. -// * If this bundle is a fragment, then only matching entries in this -// * fragment are returned. -// * @since 1.3 -// */ -// public Enumeration findEntries(String path, String filePattern, -// bool recurse); -// -// /** -// * Returns this bundle's {@link BundleContext}. The returned -// * <code>BundleContext</code> can be used by the caller to act on behalf -// * of this bundle. -// * -// * <p> -// * If this bundle is not in the {@link #STARTING}, {@link #ACTIVE}, or -// * {@link #STOPPING} states or this bundle is a fragment bundle, then this -// * bundle has no valid <code>BundleContext</code>. This method will -// * return <code>null</code> if this bundle has no valid -// * <code>BundleContext</code>. -// * -// * @return A <code>BundleContext</code> for this bundle or -// * <code>null</code> if this bundle has no valid -// * <code>BundleContext</code>. -// * @throws java.lang.SecurityException If the caller does not have the -// * appropriate <code>AdminPermission[this,CONTEXT]</code>, and -// * the Java Runtime Environment supports permissions. -// * @since 1.4 -// */ -// public BundleContext getBundleContext(); + /** + * Find the specified resource from this bundle. + * + * This bundle's class loader is called to search for the specified + * resource. If this bundle's state is <code>INSTALLED</code>, this + * method must attempt to resolve this bundle before attempting to get the + * specified resource. If this bundle cannot be resolved, then only this + * bundle must be searched for the specified resource. Imported packages + * cannot be searched when this bundle has not been resolved. If this bundle + * is a fragment bundle then <code>null</code> is returned. + * + * @param name The name of the resource. See + * <code>java.lang.ClassLoader.getResource</code> for a description + * of the format of a resource name. + * @return A URL to the named resource, or <code>null</code> if the + * resource could not be found or if this bundle is a fragment + * bundle or if the caller does not have the appropriate + * <code>AdminPermission[this,RESOURCE]</code>, and the Java + * Runtime Environment supports permissions. + * + * @since 1.1 + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @see #getEntry + * @see #findEntries + */ + public URL getResource(String name); + + /** + * Returns this bundle's Manifest headers and values localized to the + * specified locale. + * + * <p> + * This method performs the same function as + * <code>Bundle.getHeaders()</code> except the manifest header values are + * localized to the specified locale. + * + * <p> + * If a Manifest header value starts with "%", it must be + * localized according to the specified locale. If a locale is specified and + * cannot be found, then the header values must be returned using the + * default locale. Localizations are searched for in the following order: + * + * <pre> + * bn + "_" + Ls + "_" + Cs + "_" + Vs + * bn + "_" + Ls + "_" + Cs + * bn + "_" + Ls + * bn + "_" + Ld + "_" + Cd + "_" + Vd + * bn + "_" + Ld + "_" + Cd + * bn + "_" + Ld + * bn + * </pre> + * + * Where <code>bn</code> is this bundle's localization basename, + * <code>Ls</code>, <code>Cs</code> and <code>Vs</code> are the + * specified locale (language, country, variant) and <code>Ld</code>, + * <code>Cd</code> and <code>Vd</code> are the default locale (language, + * country, variant). + * + * If <code>null</code> is specified as the locale string, the header + * values must be localized using the default locale. If the empty string + * ("") is specified as the locale string, the header values must + * not be localized and the raw (unlocalized) header values, including any + * leading "%", must be returned. + * + * <p> + * This method must continue to return Manifest header information while + * this bundle is in the <code>UNINSTALLED</code> state, however the + * header values must only be available in the raw and default locale + * values. + * + * @param locale The locale name into which the header values are to be + * localized. If the specified locale is <code>null</code> then the + * locale returned by <code>java.util.Locale.getDefault</code> is + * used. If the specified locale is the empty string, this method + * will return the raw (unlocalized) manifest headers including any + * leading "%". + * @return A <code>Dictionary</code> object containing this bundle's + * Manifest headers and values. + * + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,METADATA]</code>, and + * the Java Runtime Environment supports permissions. + * + * @see #getHeaders() + * @see Constants#BUNDLE_LOCALIZATION + * @since 1.3 + */ + public Dictionary getHeaders(String locale); + + /** + * Returns the symbolic name of this bundle as specified by its + * <code>Bundle-SymbolicName</code> manifest header. The name must be + * unique, it is recommended to use a reverse domain name naming convention + * like that used for java packages. If this bundle does not have a + * specified symbolic name then <code>null</code> is returned. + * + * <p> + * This method must continue to return this bundle's symbolic name while + * this bundle is in the <code>UNINSTALLED</code> state. + * + * @return The symbolic name of this bundle. + * @since 1.3 + */ + public String getSymbolicName(); + + /** + * Loads the specified class using this bundle's classloader. + * + * <p> + * If this bundle is a fragment bundle then this method must throw a + * <code>ClassNotFoundException</code>. + * + * <p> + * If this bundle's state is <code>INSTALLED</code>, this method must + * attempt to resolve this bundle before attempting to load the class. + * + * <p> + * If this bundle cannot be resolved, a Framework event of type + * {@link FrameworkEvent#ERROR} is fired containing a + * <code>BundleException</code> with details of the reason this bundle + * could not be resolved. This method must then throw a + * <code>ClassNotFoundException</code>. + * + * <p> + * If this bundle's state is <code>UNINSTALLED</code>, then an + * <code>IllegalStateException</code> is thrown. + * + * @param name The name of the class to load. + * @return The Class object for the requested class. + * @throws java.lang.ClassNotFoundException If no such class can be found or + * if this bundle is a fragment bundle or if the caller does not + * have the appropriate <code>AdminPermission[this,CLASS]</code>, + * and the Java Runtime Environment supports permissions. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @since 1.3 + */ + public Class loadClass(String name) ; + + /** + * Find the specified resources from this bundle. + * + * This bundle's class loader is called to search for the specified + * resources. If this bundle's state is <code>INSTALLED</code>, this + * method must attempt to resolve this bundle before attempting to get the + * specified resources. If this bundle cannot be resolved, then only this + * bundle must be searched for the specified resources. Imported packages + * cannot be searched when a bundle has not been resolved. If this bundle is + * a fragment bundle then <code>null</code> is returned. + * + * @param name The name of the resource. See + * <code>java.lang.ClassLoader.getResources</code> for a + * description of the format of a resource name. + * @return An enumeration of URLs to the named resources, or + * <code>null</code> if the resource could not be found or if this + * bundle is a fragment bundle or if the caller does not have the + * appropriate <code>AdminPermission[this,RESOURCE]</code>, and + * the Java Runtime Environment supports permissions. + * + * @since 1.3 + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @throws java.io.IOException If there is an I/O error. + */ + public Enumeration getResources(String name) ; + + /** + * Returns an Enumeration of all the paths (<code>String</code> objects) + * to entries within this bundle whose longest sub-path matches the + * specified path. This bundle's classloader is not used to search for + * entries. Only the contents of this bundle are searched. + * <p> + * The specified path is always relative to the root of this bundle and may + * begin with a "/". A path value of "/" indicates the + * root of this bundle. + * <p> + * Returned paths indicating subdirectory paths end with a "/". + * The returned paths are all relative to the root of this bundle and must + * not begin with "/". + * + * @param path The path name for which to return entry paths. + * @return An Enumeration of the entry paths (<code>String</code> + * objects) or <code>null</code> if no entry could be found or if + * the caller does not have the appropriate + * <code>AdminPermission[this,RESOURCE]</code> and the Java + * Runtime Environment supports permissions. + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @since 1.3 + */ + public Enumeration getEntryPaths(String path); + + /** + * Returns a URL to the entry at the specified path in this bundle. This + * bundle's classloader is not used to search for the entry. Only the + * contents of this bundle are searched for the entry. + * <p> + * The specified path is always relative to the root of this bundle and may + * begin with "/". A path value of "/" indicates the + * root of this bundle. + * + * @param path The path name of the entry. + * @return A URL to the entry, or <code>null</code> if no entry could be + * found or if the caller does not have the appropriate + * <code>AdminPermission[this,RESOURCE]</code> and the Java + * Runtime Environment supports permissions. + * + * @throws java.lang.IllegalStateException If this bundle has been + * uninstalled. + * @since 1.3 + */ + public URL getEntry(String path); + + /** + * Returns the time when this bundle was last modified. A bundle is + * considered to be modified when it is installed, updated or uninstalled. + * + * <p> + * The time value is the number of milliseconds since January 1, 1970, + * 00:00:00 GMT. + * + * @return The time when this bundle was last modified. + * @since 1.3 + */ + public long getLastModified(); + + /** + * Returns entries in this bundle and its attached fragments. This bundle's + * classloader is not used to search for entries. Only the contents of this + * bundle and its attached fragments are searched for the specified entries. + * + * If this bundle's state is <code>INSTALLED</code>, this method must + * attempt to resolve this bundle before attempting to find entries. + * + * <p> + * This method is intended to be used to obtain configuration, setup, + * localization and other information from this bundle. This method takes + * into account that the "contents" of this bundle can be extended + * with fragments. This "bundle space" is not a namespace with + * unique members; the same entry name can be present multiple times. This + * method therefore returns an enumeration of URL objects. These URLs can + * come from different JARs but have the same path name. This method can + * either return only entries in the specified path or recurse into + * subdirectories returning entries in the directory tree beginning at the + * specified path. Fragments can be attached after this bundle is resolved, + * possibly changing the set of URLs returned by this method. If this bundle + * is not resolved, only the entries in the JAR file of this bundle are + * returned. + * <p> + * Examples: + * + * <pre> + * // List all XML files in the OSGI-INF directory and below + * Enumeration e = b.findEntries("OSGI-INF", "*.xml", true); + * + * // Find a specific localization file + * Enumeration e = b.findEntries("OSGI-INF/l10n", + * "bundle_nl_DU.properties", + * false); + * if (e.hasMoreElements()) + * return (URL) e.nextElement(); + * </pre> + * + * @param path The path name in which to look. The path is always relative + * to the root of this bundle and may begin with "/". A + * path value of "/" indicates the root of this bundle. + * @param filePattern The file name pattern for selecting entries in the + * specified path. The pattern is only matched against the last + * element of the entry path and it supports substring matching, as + * specified in the Filter specification, using the wildcard + * character ("*"). If null is specified, this is + * equivalent to "*" and matches all files. + * @param recurse If <code>true</code>, recurse into subdirectories. + * Otherwise only return entries from the specified path. + * @return An enumeration of URL objects for each matching entry, or + * <code>null</code> if an entry could not be found or if the + * caller does not have the appropriate + * <code>AdminPermission[this,RESOURCE]</code>, and the Java + * Runtime Environment supports permissions. The URLs are sorted + * such that entries from this bundle are returned first followed by + * the entries from attached fragments in ascending bundle id order. + * If this bundle is a fragment, then only matching entries in this + * fragment are returned. + * @since 1.3 + */ + public Enumeration findEntries(String path, String filePattern, + bool recurse); + + /** + * Returns this bundle's {@link BundleContext}. The returned + * <code>BundleContext</code> can be used by the caller to act on behalf + * of this bundle. + * + * <p> + * If this bundle is not in the {@link #STARTING}, {@link #ACTIVE}, or + * {@link #STOPPING} states or this bundle is a fragment bundle, then this + * bundle has no valid <code>BundleContext</code>. This method will + * return <code>null</code> if this bundle has no valid + * <code>BundleContext</code>. + * + * @return A <code>BundleContext</code> for this bundle or + * <code>null</code> if this bundle has no valid + * <code>BundleContext</code>. + * @throws java.lang.SecurityException If the caller does not have the + * appropriate <code>AdminPermission[this,CONTEXT]</code>, and + * the Java Runtime Environment supports permissions. + * @since 1.4 + */ + public BundleContext getBundleContext(); }