You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2012/10/04 18:50:07 UTC
svn commit: r1394154 - in /sling/trunk/installer/core: ./
src/main/java/org/apache/sling/installer/core/impl/tasks/
src/main/java/org/apache/sling/installer/core/impl/util/
src/main/java/org/osgi/ src/main/java/org/osgi/framework/
src/main/java/org/osg...
Author: cziegeler
Date: Thu Oct 4 16:50:07 2012
New Revision: 1394154
URL: http://svn.apache.org/viewvc?rev=1394154&view=rev
Log:
SLING-2570 : Use Wiring API to check whether Installer Core bundle is affect by a bundle update
Added:
sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java (with props)
sling/trunk/installer/core/src/main/java/org/osgi/
sling/trunk/installer/core/src/main/java/org/osgi/framework/
sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java (with props)
sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java (with props)
sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/
sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java (with props)
Removed:
sling/trunk/installer/core/src/test/java/org/apache/sling/installer/api/
Modified:
sling/trunk/installer/core/pom.xml
sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/tasks/TaskSupport.java
sling/trunk/installer/core/src/test/java/org/apache/sling/installer/core/impl/MockBundleContext.java
Modified: sling/trunk/installer/core/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/pom.xml?rev=1394154&r1=1394153&r2=1394154&view=diff
==============================================================================
--- sling/trunk/installer/core/pom.xml (original)
+++ sling/trunk/installer/core/pom.xml Thu Oct 4 16:50:07 2012
@@ -57,6 +57,17 @@
<Private-Package>
org.apache.sling.installer.core.impl.*
</Private-Package>
+ <!--
+ As we make use of optional features from 4.3 if they
+ are available, we have to add the framework imports
+ by hand:
+ -->
+ <Import-Package>
+ org.osgi.framework;version="[1.4,2]",
+ org.osgi.framework.wiring;resolution:=optional,
+ *
+ </Import-Package>
+ <Export-Package>!*</Export-Package>
<Embed-Dependency>
org.apache.felix.configadmin;inline="org/apache/felix/cm/file/ConfigurationHandler.*",
org.osgi.compendium;inline="org/osgi/util/tracker/*",
@@ -116,6 +127,7 @@
<dependency>
<groupId>org.osgi</groupId>
<artifactId>org.osgi.core</artifactId>
+ <version>4.1.0</version>
</dependency>
<dependency>
<groupId>org.osgi</groupId>
Modified: sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/tasks/TaskSupport.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/tasks/TaskSupport.java?rev=1394154&r1=1394153&r2=1394154&view=diff
==============================================================================
--- sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/tasks/TaskSupport.java (original)
+++ sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/tasks/TaskSupport.java Thu Oct 4 16:50:07 2012
@@ -20,7 +20,9 @@ package org.apache.sling.installer.core.
import org.apache.sling.installer.core.impl.util.BundleRefresher;
import org.apache.sling.installer.core.impl.util.PABundleRefresher;
+import org.apache.sling.installer.core.impl.util.WABundleRefresher;
import org.osgi.framework.BundleContext;
+import org.osgi.framework.wiring.FrameworkWiring;
import org.osgi.service.packageadmin.PackageAdmin;
import org.osgi.service.startlevel.StartLevel;
import org.osgi.util.tracker.ServiceTracker;
@@ -45,6 +47,9 @@ public class TaskSupport {
/** The bundle context. */
private final BundleContext bundleContext;
+ /** Checked for wire admin? */
+ private Boolean checkedWireAdmin;
+
public TaskSupport(final BundleContext bc) {
this.bundleContext = bc;
@@ -76,8 +81,21 @@ public class TaskSupport {
}
public BundleRefresher getBundleRefresher() {
- return new PABundleRefresher((PackageAdmin) this.packageAdminTracker.getService(),
- this.bundleContext);
+ if ( checkedWireAdmin == null ) {
+ try {
+ this.bundleContext.getBundle(0).adapt(FrameworkWiring.class);
+ checkedWireAdmin = true;
+ } catch (final Throwable t) {
+ checkedWireAdmin = false;
+ }
+ }
+ if ( checkedWireAdmin ) {
+ return new PABundleRefresher((PackageAdmin) this.packageAdminTracker.getService(),
+ this.bundleContext);
+ } else {
+ return new WABundleRefresher(this.bundleContext.getBundle(0).adapt(FrameworkWiring.class),
+ this.bundleContext);
+ }
}
}
Added: sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java?rev=1394154&view=auto
==============================================================================
--- sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java (added)
+++ sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java Thu Oct 4 16:50:07 2012
@@ -0,0 +1,122 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.apache.sling.installer.core.impl.util;
+
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.sling.installer.api.tasks.InstallationContext;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.FrameworkEvent;
+import org.osgi.framework.FrameworkListener;
+import org.osgi.framework.wiring.FrameworkWiring;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Implementation of the bundle refresher based on framework wiring.
+ */
+public class WABundleRefresher implements BundleRefresher, FrameworkListener {
+
+ private final FrameworkWiring frameworkWiring;
+
+ private final Logger logger = LoggerFactory.getLogger(this.getClass());
+
+ /** Max time allowed to refresh packages */
+ private static final int MAX_REFRESH_PACKAGES_WAIT_SECONDS = 90;
+
+ /** Counter for package refresh events. */
+ private volatile long refreshEventCount;
+
+ /** Lock object for syncing. */
+ private final Object lock = new Object();
+
+ private final BundleContext bundleContext;
+
+ public WABundleRefresher(final FrameworkWiring wiring, final BundleContext bundleContext) {
+ this.frameworkWiring = wiring;
+ this.bundleContext = bundleContext;
+ }
+
+ /**
+ * @see org.apache.sling.installer.core.impl.util.BundleRefresher#refreshBundles(org.apache.sling.installer.api.tasks.InstallationContext, java.util.List, boolean)
+ */
+ public void refreshBundles(final InstallationContext ctx,
+ final List<Bundle> bundles,
+ final boolean wait) {
+ if ( bundles.size() > 0 ) {
+ ctx.log("Refreshing {} bundles: {}", bundles.size(), bundles);
+ if ( !wait ) {
+ this.frameworkWiring.refreshBundles(bundles);
+ } else {
+ this.refreshEventCount = 0;
+ this.frameworkWiring.refreshBundles(bundles, this);
+ final long end = System.currentTimeMillis() + (MAX_REFRESH_PACKAGES_WAIT_SECONDS * 1000);
+ do {
+ synchronized ( this.lock ) {
+ final long waitTime = end - System.currentTimeMillis();
+ if ( this.refreshEventCount < 1 && waitTime > 0 ) {
+ try {
+ ctx.log("Waiting up to {} seconds for bundles refresh", MAX_REFRESH_PACKAGES_WAIT_SECONDS);
+ this.lock.wait(waitTime);
+ } catch (final InterruptedException ignore) {
+ // ignore
+ }
+ if ( end <= System.currentTimeMillis() && this.refreshEventCount < 1 ) {
+ logger.warn("No FrameworkEvent.PACKAGES_REFRESHED event received within {}"
+ + " seconds after refresh, aborting wait.",
+ MAX_REFRESH_PACKAGES_WAIT_SECONDS);
+ this.refreshEventCount++;
+ }
+ }
+ }
+ } while ( this.refreshEventCount < 1);
+ }
+ ctx.log("Done refreshing {} bundles", bundles.size());
+ }
+ }
+
+ /**
+ * @see org.apache.sling.installer.core.impl.util.BundleRefresher#isInstallerBundleAffected(java.util.List)
+ */
+ public boolean isInstallerBundleAffected(final List<Bundle> bundles) {
+ final long installerId = this.bundleContext.getBundle().getBundleId();
+ final Collection<Bundle> dependencyClosure = this.frameworkWiring.getDependencyClosure(bundles);
+ for(final Bundle b : dependencyClosure) {
+ if ( b.getBundleId() == installerId ) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * @see org.osgi.framework.FrameworkListener#frameworkEvent(org.osgi.framework.FrameworkEvent)
+ */
+ public void frameworkEvent(final FrameworkEvent event) {
+ if (event.getType() == FrameworkEvent.PACKAGES_REFRESHED) {
+ logger.debug("FrameworkEvent.PACKAGES_REFRESHED");
+ synchronized (this.lock) {
+ this.refreshEventCount++;
+ this.lock.notify();
+ }
+ }
+ }
+}
Propchange: sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java
------------------------------------------------------------------------------
svn:keywords = author date id revision rev url
Propchange: sling/trunk/installer/core/src/main/java/org/apache/sling/installer/core/impl/util/WABundleRefresher.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java?rev=1394154&view=auto
==============================================================================
--- sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java (added)
+++ sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java Thu Oct 4 16:50:07 2012
@@ -0,0 +1,1215 @@
+/*
+ * Copyright (c) OSGi Alliance (2000, 2009). 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.framework;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.util.Dictionary;
+import java.util.Enumeration;
+import java.util.Map;
+
+/**
+ * An installed bundle in the Framework.
+ *
+ * <p>
+ * A <code>Bundle</code> object is the access point to define the lifecycle of
+ * an installed bundle. Each bundle installed in the OSGi environment must have
+ * an associated <code>Bundle</code> object.
+ *
+ * <p>
+ * A bundle must have a unique identity, a <code>long</code>, chosen by the
+ * Framework. This identity must not change during the lifecycle of a bundle,
+ * even when the bundle is updated. Uninstalling and then reinstalling the
+ * bundle must create a new unique identity.
+ *
+ * <p>
+ * A bundle can be in one of six states:
+ * <ul>
+ * <li>{@link #UNINSTALLED}
+ * <li>{@link #INSTALLED}
+ * <li>{@link #RESOLVED}
+ * <li>{@link #STARTING}
+ * <li>{@link #STOPPING}
+ * <li>{@link #ACTIVE}
+ * </ul>
+ * <p>
+ * Values assigned to these states have no specified ordering; they represent
+ * bit values that may be ORed together to determine if a bundle is in one of
+ * the valid states.
+ *
+ * <p>
+ * A bundle should only execute code when its state is one of
+ * <code>STARTING</code>,<code>ACTIVE</code>, or <code>STOPPING</code>.
+ * An <code>UNINSTALLED</code> bundle can not be set to another state; it is a
+ * zombie and can only be reached because references are kept somewhere.
+ *
+ * <p>
+ * The Framework is the only entity that is allowed to create
+ * <code>Bundle</code> objects, and these objects are only valid within the
+ * Framework that created them.
+ *
+ * @ThreadSafe
+ * @version $Revision$
+ */
+public interface Bundle {
+ /**
+ * The bundle is uninstalled and may not be used.
+ *
+ * <p>
+ * The <code>UNINSTALLED</code> state is only visible after a bundle is
+ * uninstalled; the bundle is in an unusable state but references to the
+ * <code>Bundle</code> object may still be available and used for
+ * introspection.
+ * <p>
+ * The value of <code>UNINSTALLED</code> is 0x00000001.
+ */
+ public static final int UNINSTALLED = 0x00000001;
+
+ /**
+ * The bundle is installed but not yet resolved.
+ *
+ * <p>
+ * A bundle is in the <code>INSTALLED</code> state when it has been
+ * installed in the Framework but is not or cannot be resolved.
+ * <p>
+ * This state is visible if the bundle's code dependencies are not resolved.
+ * The Framework may attempt to resolve an <code>INSTALLED</code> bundle's
+ * code dependencies and move the bundle to the <code>RESOLVED</code>
+ * state.
+ * <p>
+ * The value of <code>INSTALLED</code> is 0x00000002.
+ */
+ public static final int INSTALLED = 0x00000002;
+
+ /**
+ * The bundle is resolved and is able to be started.
+ *
+ * <p>
+ * A bundle is in the <code>RESOLVED</code> state when the Framework has
+ * successfully resolved the bundle's code dependencies. These dependencies
+ * include:
+ * <ul>
+ * <li>The bundle's class path from its {@link Constants#BUNDLE_CLASSPATH}
+ * Manifest header.
+ * <li>The bundle's package dependencies from its
+ * {@link Constants#EXPORT_PACKAGE} and {@link Constants#IMPORT_PACKAGE}
+ * Manifest headers.
+ * <li>The bundle's required bundle dependencies from its
+ * {@link Constants#REQUIRE_BUNDLE} Manifest header.
+ * <li>A fragment bundle's host dependency from its
+ * {@link Constants#FRAGMENT_HOST} Manifest header.
+ * </ul>
+ * <p>
+ * Note that the bundle is not active yet. A bundle must be put in the
+ * <code>RESOLVED</code> state before it can be started. The Framework may
+ * attempt to resolve a bundle at any time.
+ * <p>
+ * The value of <code>RESOLVED</code> is 0x00000004.
+ */
+ public static final int RESOLVED = 0x00000004;
+
+ /**
+ * The bundle is in the process of starting.
+ *
+ * <p>
+ * A bundle is in the <code>STARTING</code> state when its
+ * {@link #start(int) start} method is active. A bundle must be in this
+ * state when the bundle's {@link BundleActivator#start} is called. If the
+ * <code>BundleActivator.start</code> method completes without exception,
+ * then the bundle has successfully started and must move to the
+ * <code>ACTIVE</code> state.
+ * <p>
+ * If the bundle has a
+ * {@link Constants#ACTIVATION_LAZY lazy activation policy}, then the
+ * bundle may remain in this state for some time until the activation is
+ * triggered.
+ * <p>
+ * The value of <code>STARTING</code> is 0x00000008.
+ */
+ public static final int STARTING = 0x00000008;
+
+ /**
+ * The bundle is in the process of stopping.
+ *
+ * <p>
+ * A bundle is in the <code>STOPPING</code> state when its
+ * {@link #stop(int) stop} method is active. A bundle must be in this state
+ * when the bundle's {@link BundleActivator#stop} method is called. When the
+ * <code>BundleActivator.stop</code> method completes the bundle is
+ * stopped and must move to the <code>RESOLVED</code> state.
+ * <p>
+ * The value of <code>STOPPING</code> is 0x00000010.
+ */
+ public static final int STOPPING = 0x00000010;
+
+ /**
+ * The bundle is now running.
+ *
+ * <p>
+ * A bundle is in the <code>ACTIVE</code> state when it has been
+ * successfully started and activated.
+ * <p>
+ * The value of <code>ACTIVE</code> is 0x00000020.
+ */
+ public static final int ACTIVE = 0x00000020;
+
+ /**
+ * The bundle start operation is transient and the persistent autostart
+ * setting of the bundle is not modified.
+ *
+ * <p>
+ * This bit may be set when calling {@link #start(int)} to notify the
+ * framework that the autostart setting of the bundle must not be modified.
+ * If this bit is not set, then the autostart setting of the bundle is
+ * modified.
+ *
+ * @since 1.4
+ * @see #start(int)
+ */
+ public static final int START_TRANSIENT = 0x00000001;
+
+ /**
+ * The bundle start operation must activate the bundle according to the
+ * bundle's declared
+ * {@link Constants#BUNDLE_ACTIVATIONPOLICY activation policy}.
+ *
+ * <p>
+ * This bit may be set when calling {@link #start(int)} to notify the
+ * framework that the bundle must be activated using the bundle's declared
+ * activation policy.
+ *
+ * @since 1.4
+ * @see Constants#BUNDLE_ACTIVATIONPOLICY
+ * @see #start(int)
+ */
+ public static final int START_ACTIVATION_POLICY = 0x00000002;
+
+ /**
+ * The bundle stop is transient and the persistent autostart setting of the
+ * bundle is not modified.
+ *
+ * <p>
+ * This bit may be set when calling {@link #stop(int)} to notify the
+ * framework that the autostart setting of the bundle must not be modified.
+ * If this bit is not set, then the autostart setting of the bundle is
+ * modified.
+ *
+ * @since 1.4
+ * @see #stop(int)
+ */
+ public static final int STOP_TRANSIENT = 0x00000001;
+
+ /**
+ * Request that all certificates used to sign the bundle be returned.
+ *
+ * @since 1.5
+ * @see #getSignerCertificates(int)
+ */
+ public final static int SIGNERS_ALL = 1;
+
+ /**
+ * Request that only certificates used to sign the bundle that are trusted
+ * by the framework be returned.
+ *
+ * @since 1.5
+ * @see #getSignerCertificates(int)
+ */
+ public final static int SIGNERS_TRUSTED = 2;
+
+ /**
+ * Returns this bundle's current state.
+ *
+ * <p>
+ * A bundle can be in only one state at any time.
+ *
+ * @return An element of <code>UNINSTALLED</code>,<code>INSTALLED</code>,
+ * <code>RESOLVED</code>,<code>STARTING</code>,
+ * <code>STOPPING</code>,<code>ACTIVE</code>.
+ */
+ public int getState();
+
+ /**
+ * Starts this bundle.
+ *
+ * <p>
+ * If this bundle's state is <code>UNINSTALLED</code> then an
+ * <code>IllegalStateException</code> is thrown.
+ * <p>
+ * If the Framework implements the optional Start Level service and the
+ * current start level is less than this bundle's start level:
+ * <ul>
+ * <li>If the {@link #START_TRANSIENT} option is set, then a
+ * <code>BundleException</code> is thrown indicating this bundle cannot be
+ * started due to the Framework's current start level.
+ *
+ * <li>Otherwise, the Framework must set this bundle's persistent autostart
+ * setting to <em>Started with declared activation</em> if the
+ * {@link #START_ACTIVATION_POLICY} option is set or
+ * <em>Started with eager activation</em> if not set.
+ * </ul>
+ * <p>
+ * When the Framework's current start level becomes equal to or more than
+ * this bundle's start level, this bundle will be started.
+ * <p>
+ * Otherwise, the following steps are required to start this bundle:
+ * <ol>
+ * <li>If this bundle is in the process of being activated or deactivated
+ * then this method must wait for activation or deactivation to complete
+ * before continuing. If this does not occur in a reasonable time, a
+ * <code>BundleException</code> is thrown to indicate this bundle was unable
+ * to be started.
+ *
+ * <li>If this bundle's state is <code>ACTIVE</code> then this method
+ * returns immediately.
+ *
+ * <li>If the {@link #START_TRANSIENT} option is not set then set this
+ * bundle's autostart setting to <em>Started with declared activation</em>
+ * if the {@link #START_ACTIVATION_POLICY} option is set or
+ * <em>Started with eager activation</em> if not set. When the Framework is
+ * restarted and this bundle's autostart setting is not <em>Stopped</em>,
+ * this bundle must be automatically started.
+ *
+ * <li>If this bundle's state is not <code>RESOLVED</code>, an attempt is
+ * made to resolve this bundle. If the Framework cannot resolve this bundle,
+ * a <code>BundleException</code> is thrown.
+ *
+ * <li>If the {@link #START_ACTIVATION_POLICY} option is set and this
+ * bundle's declared activation policy is {@link Constants#ACTIVATION_LAZY
+ * lazy} then:
+ * <ul>
+ * <li>If this bundle's state is <code>STARTING</code> then this method
+ * returns immediately.
+ * <li>This bundle's state is set to <code>STARTING</code>.
+ * <li>A bundle event of type {@link BundleEvent#LAZY_ACTIVATION} is fired.
+ * <li>This method returns immediately and the remaining steps will be
+ * followed when this bundle's activation is later triggered.
+ * </ul>
+ * <i></i>
+ * <li>This bundle's state is set to <code>STARTING</code>.
+ *
+ * <li>A bundle event of type {@link BundleEvent#STARTING} is fired.
+ *
+ * <li>The {@link BundleActivator#start} method of this bundle's
+ * <code>BundleActivator</code>, if one is specified, is called. If the
+ * <code>BundleActivator</code> is invalid or throws an exception then:
+ * <ul>
+ * <li>This bundle's state is set to <code>STOPPING</code>.
+ * <li>A bundle event of type {@link BundleEvent#STOPPING} is fired.
+ * <li>Any services registered by this bundle must be unregistered.
+ * <li>Any services used by this bundle must be released.
+ * <li>Any listeners registered by this bundle must be removed.
+ * <li>This bundle's state is set to <code>RESOLVED</code>.
+ * <li>A bundle event of type {@link BundleEvent#STOPPED} is fired.
+ * <li>A <code>BundleException</code> is then thrown.
+ * </ul>
+ * <i></i>
+ * <li>If this bundle's state is <code>UNINSTALLED</code>, because this
+ * bundle was uninstalled while the <code>BundleActivator.start</code>
+ * method was running, a <code>BundleException</code> is thrown.
+ *
+ * <li>This bundle's state is set to <code>ACTIVE</code>.
+ *
+ * <li>A bundle event of type {@link BundleEvent#STARTED} is fired.
+ * </ol>
+ *
+ * <b>Preconditions </b>
+ * <ul>
+ * <li><code>getState()</code> in { <code>INSTALLED</code>,
+ * <code>RESOLVED</code> } or { <code>INSTALLED</code>,
+ * <code>RESOLVED</code>, <code>STARTING</code> } if this bundle has
+ * a lazy activation policy.
+ * </ul>
+ * <b>Postconditions, no exceptions thrown </b>
+ * <ul>
+ * <li>Bundle autostart setting is modified unless the
+ * {@link #START_TRANSIENT} option was set.
+ * <li><code>getState()</code> in { <code>ACTIVE</code> }
+ * unless the lazy activation policy was used.
+ * <li><code>BundleActivator.start()</code> has been called and did not
+ * throw an exception unless the lazy activation policy was used.
+ * </ul>
+ * <b>Postconditions, when an exception is thrown </b>
+ * <ul>
+ * <li>Depending on when the exception occurred, bundle autostart setting is
+ * modified unless the {@link #START_TRANSIENT} option was set.
+ * <li><code>getState()</code> not in { <code>STARTING</code>,
+ * <code>ACTIVE</code> }.
+ * </ul>
+ *
+ * @param options The options for starting this bundle. See
+ * {@link #START_TRANSIENT} and {@link #START_ACTIVATION_POLICY}. The
+ * Framework must ignore unrecognized options.
+ * @throws BundleException If this bundle could not be started. This could
+ * be because a code dependency could not be resolved or the
+ * specified <code>BundleActivator</code> could not be loaded or
+ * threw an exception or this bundle is a fragment.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws SecurityException If the caller does not have the appropriate
+ * <code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
+ * Environment supports permissions.
+ * @since 1.4
+ */
+ public void start(int options) throws BundleException;
+
+ /**
+ * Starts this bundle with no options.
+ *
+ * <p>
+ * This method performs the same function as calling <code>start(0)</code>.
+ *
+ * @throws BundleException If this bundle could not be started. This could
+ * be because a code dependency could not be resolved or the
+ * specified <code>BundleActivator</code> could not be loaded or
+ * threw an exception or this bundle is a fragment.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws SecurityException If the caller does not have the appropriate
+ * <code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
+ * Environment supports permissions.
+ * @see #start(int)
+ */
+ public void start() throws BundleException;
+
+ /**
+ * Stops this bundle.
+ *
+ * <p>
+ * The following steps are required to stop a bundle:
+ * <ol>
+ * <li>If this bundle's state is <code>UNINSTALLED</code> then an
+ * <code>IllegalStateException</code> is thrown.
+ *
+ * <li>If this bundle is in the process of being activated or deactivated
+ * then this method must wait for activation or deactivation to complete
+ * before continuing. If this does not occur in a reasonable time, a
+ * <code>BundleException</code> is thrown to indicate this bundle was unable
+ * to be stopped.
+ * <li>If the {@link #STOP_TRANSIENT} option is not set then then set this
+ * bundle's persistent autostart setting to to <em>Stopped</em>. When the
+ * Framework is restarted and this bundle's autostart setting is
+ * <em>Stopped</em>, this bundle must not be automatically started.
+ *
+ * <li>If this bundle's state is not <code>STARTING</code> or
+ * <code>ACTIVE</code> then this method returns immediately.
+ *
+ * <li>This bundle's state is set to <code>STOPPING</code>.
+ *
+ * <li>A bundle event of type {@link BundleEvent#STOPPING} is fired.
+ *
+ * <li>If this bundle's state was <code>ACTIVE</code> prior to setting the
+ * state to <code>STOPPING</code>, the {@link BundleActivator#stop} method
+ * of this bundle's <code>BundleActivator</code>, if one is specified, is
+ * called. If that method throws an exception, this method must continue to
+ * stop this bundle and a <code>BundleException</code> must be thrown after
+ * completion of the remaining steps.
+ *
+ * <li>Any services registered by this bundle must be unregistered.
+ * <li>Any services used by this bundle must be released.
+ * <li>Any listeners registered by this bundle must be removed.
+ *
+ * <li>If this bundle's state is <code>UNINSTALLED</code>, because this
+ * bundle was uninstalled while the <code>BundleActivator.stop</code> method
+ * was running, a <code>BundleException</code> must be thrown.
+ *
+ * <li>This bundle's state is set to <code>RESOLVED</code>.
+ *
+ * <li>A bundle event of type {@link BundleEvent#STOPPED} is fired.
+ * </ol>
+ *
+ * <b>Preconditions </b>
+ * <ul>
+ * <li><code>getState()</code> in { <code>ACTIVE</code> }.
+ * </ul>
+ * <b>Postconditions, no exceptions thrown </b>
+ * <ul>
+ * <li>Bundle autostart setting is modified unless the
+ * {@link #STOP_TRANSIENT} option was set.
+ * <li><code>getState()</code> not in { <code>ACTIVE</code>,
+ * <code>STOPPING</code> }.
+ * <li><code>BundleActivator.stop</code> has been called and did not throw
+ * an exception.
+ * </ul>
+ * <b>Postconditions, when an exception is thrown </b>
+ * <ul>
+ * <li>Bundle autostart setting is modified unless the
+ * {@link #STOP_TRANSIENT} option was set.
+ * </ul>
+ *
+ * @param options The options for stoping this bundle. See
+ * {@link #STOP_TRANSIENT}. The Framework must ignore unrecognized
+ * options.
+ * @throws BundleException If this bundle's <code>BundleActivator</code>
+ * threw an exception or this bundle is a fragment.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws SecurityException If the caller does not have the appropriate
+ * <code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
+ * Environment supports permissions.
+ * @since 1.4
+ */
+ public void stop(int options) throws BundleException;
+
+ /**
+ * Stops this bundle with no options.
+ *
+ * <p>
+ * This method performs the same function as calling <code>stop(0)</code>.
+ *
+ * @throws BundleException If this bundle's <code>BundleActivator</code>
+ * threw an exception or this bundle is a fragment.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws SecurityException If the caller does not have the appropriate
+ * <code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
+ * Environment supports permissions.
+ * @see #start(int)
+ */
+ public void stop() throws BundleException;
+
+ /**
+ * Updates this bundle from an <code>InputStream</code>.
+ *
+ * <p>
+ * If the specified <code>InputStream</code> is <code>null</code>, the
+ * Framework must create the <code>InputStream</code> from which to read the
+ * updated bundle by interpreting, in an implementation dependent manner,
+ * this bundle's {@link Constants#BUNDLE_UPDATELOCATION
+ * Bundle-UpdateLocation} Manifest header, if present, or this bundle's
+ * original location.
+ *
+ * <p>
+ * If this bundle's state is <code>ACTIVE</code>, it must be stopped before
+ * the update and started after the update successfully completes.
+ *
+ * <p>
+ * If this bundle has exported any packages that are imported by another
+ * bundle, these packages must not be updated. Instead, the previous package
+ * version must remain exported until the
+ * <code>PackageAdmin.refreshPackages</code> method has been has been called
+ * or the Framework is relaunched.
+ *
+ * <p>
+ * The following steps are required to update 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, the exception is rethrown terminating the update.
+ *
+ * <li>The updated version of this bundle is read from the input stream and
+ * installed. If the Framework is unable to install the updated version of
+ * this bundle, the original version of this bundle must be restored and a
+ * <code>BundleException</code> must be thrown after completion of the
+ * remaining steps.
+ *
+ * <li>This bundle's state is set to <code>INSTALLED</code>.
+ *
+ * <li>If the updated version of this bundle was successfully installed, a
+ * bundle event of type {@link BundleEvent#UPDATED} is fired.
+ *
+ * <li>If this bundle's state was originally <code>ACTIVE</code>, the
+ * updated bundle is started as described in the <code>Bundle.start</code>
+ * method. If <code>Bundle.start</code> throws an exception, a Framework
+ * event of type {@link FrameworkEvent#ERROR} is fired containing the
+ * exception.
+ * </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>INSTALLED</code>,
+ * <code>RESOLVED</code>, <code>ACTIVE</code> }.
+ * <li>This bundle has been updated.
+ * </ul>
+ * <b>Postconditions, when an exception is thrown </b>
+ * <ul>
+ * <li><code>getState()</code> in { <code>INSTALLED</code>,
+ * <code>RESOLVED</code>, <code>ACTIVE</code> }.
+ * <li>Original bundle is still used; no update occurred.
+ * </ul>
+ *
+ * @param input The <code>InputStream</code> from which to read the new
+ * bundle or <code>null</code> to indicate the Framework must create
+ * the input stream from this bundle's
+ * {@link Constants#BUNDLE_UPDATELOCATION Bundle-UpdateLocation}
+ * Manifest header, if present, or this bundle's original location.
+ * The input stream must always be closed when this method completes,
+ * even if an exception is thrown.
+ * @throws BundleException If the input stream cannot be read or the update
+ * fails.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws 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 #stop()
+ * @see #start()
+ */
+ public void update(InputStream input) throws BundleException;
+
+ /**
+ * Updates this bundle.
+ *
+ * <p>
+ * This method performs the same function as calling
+ * {@link #update(InputStream)} with a <code>null</code> InputStream.
+ *
+ * @throws BundleException If the update fails.
+ * @throws IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws 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(InputStream)
+ */
+ public void update() throws BundleException;
+
+ /**
+ * 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 IllegalStateException If this bundle has been uninstalled or this
+ * bundle tries to change its own state.
+ * @throws 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() throws BundleException;
+
+ /**
+ * 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. If no localization is found
+ * for a header value, the header value without the leading "%" is
+ * returned.
+ *
+ * <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 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/* <String,String> */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 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 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 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 IllegalStateException If this bundle has been
+ * uninstalled.
+ */
+ public boolean hasPermission(Object permission);
+
+ /**
+ * Find the specified resource from this bundle's class loader.
+ *
+ * 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.
+ * <p>
+ * Note: Jar and zip files are not required to include directory entries.
+ * URLs to directory entries will not be returned if the bundle contents do
+ * not contain directory entries.
+ *
+ * @param name The name of the resource. See
+ * <code>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.
+ * @throws IllegalStateException If this bundle has been uninstalled.
+ * @see #getEntry
+ * @see #findEntries
+ * @since 1.1
+ */
+ 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. If no localization is found for
+ * a header value, the header value without the leading "%" is
+ * 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 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/* <String,String> */getHeaders(String locale);
+
+ /**
+ * Returns the symbolic name of this bundle as specified by its
+ * <code>Bundle-SymbolicName</code> manifest header. The bundle symbolic
+ * name together with a version must identify a unique bundle. The bundle
+ * symbolic name should be based on the reverse domain name naming
+ * convention like that used for java packages.
+ *
+ * <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 or <code>null</code> if this
+ * bundle does not have a symbolic name.
+ * @since 1.3
+ */
+ public String getSymbolicName();
+
+ /**
+ * Loads the specified class using this bundle's class loader.
+ *
+ * <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 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 IllegalStateException If this bundle has been
+ * uninstalled.
+ * @since 1.3
+ */
+ public Class loadClass(String name) throws ClassNotFoundException;
+
+ /**
+ * Find the specified resources from this bundle's class loader.
+ *
+ * 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.
+ * <p>
+ * Note: Jar and zip files are not required to include directory entries.
+ * URLs to directory entries will not be returned if the bundle contents do
+ * not contain directory entries.
+ *
+ * @param name The name of the resource. See
+ * <code>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.
+ * @throws IllegalStateException If this bundle has been uninstalled.
+ * @throws IOException If there is an I/O error.
+ * @since 1.3
+ */
+ public Enumeration/* <URL> */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 class loader 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 "/".
+ * <p>
+ * Note: Jar and zip files are not required to include directory entries.
+ * Paths to directory entries will not be returned if the bundle contents do
+ * not contain directory entries.
+ *
+ * @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 IllegalStateException If this bundle has been
+ * uninstalled.
+ * @since 1.3
+ */
+ public Enumeration/* <String> */getEntryPaths(String path);
+
+ /**
+ * Returns a URL to the entry at the specified path in this bundle. This
+ * bundle's class loader 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.
+ * <p>
+ * Note: Jar and zip files are not required to include directory entries.
+ * URLs to directory entries will not be returned if the bundle contents do
+ * not contain directory entries.
+ *
+ * @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 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
+ * class loader 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>
+ *
+ * <p>
+ * Note: Jar and zip files are not required to include directory entries.
+ * URLs to directory entries will not be returned if the bundle contents do
+ * not contain directory entries.
+ *
+ * @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. If the entry is a directory then the
+ * trailing "/" is not used for pattern matching. Substring
+ * matching is supported, 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.
+ * @throws IllegalStateException If this bundle has been uninstalled.
+ * @since 1.3
+ */
+ public Enumeration/* <URL> */findEntries(String path, String filePattern,
+ boolean 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 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();
+
+ /**
+ * Return the certificates for the signers of this bundle and the
+ * certificate chains for those signers.
+ *
+ * @param signersType If {@link #SIGNERS_ALL} is specified, then information
+ * on all signers of this bundle is returned. If
+ * {@link #SIGNERS_TRUSTED} is specified, then only information on
+ * the signers of this bundle trusted by the framework is returned.
+ * @return The <code>X509Certificate</code>s for the signers of this bundle
+ * and the <code>X509Certificate</code> chains for those signers.
+ * The keys of the <code>Map</code> are the
+ * <code>X509Certificate</code>s of the signers of this bundle. The
+ * value for a key is a <code>List</code> containing the
+ * <code>X509Certificate</code> chain for the signer. The first item
+ * in the <code>List</code> is the signer's
+ * <code>X509Certificate</code> which is then followed by the rest
+ * of the <code>X509Certificate</code> chain. The returned
+ * <code>Map</code> will be empty if there are no signers. The
+ * returned <code>Map</code> is the property of the caller who is
+ * free to modify it.
+ * @throws IllegalArgumentException If the specified
+ * <code>signersType</code> is not {@link #SIGNERS_ALL} or
+ * {@link #SIGNERS_TRUSTED}.
+ * @since 1.5
+ */
+ public Map/* <X509Certificate, List<X509Certificate>> */getSignerCertificates(
+ int signersType);
+
+ /**
+ * Returns the version of this bundle as specified by its
+ * <code>Bundle-Version</code> manifest header. If this bundle does not have a
+ * specified version then {@link Version#emptyVersion} is returned.
+ *
+ * <p>
+ * This method must continue to return this bundle's version while
+ * this bundle is in the <code>UNINSTALLED</code> state.
+ *
+ * @return The version of this bundle.
+ * @since 1.5
+ */
+ public Version getVersion();
+
+ /**
+ * Adapt this bundle to the specified type.
+ *
+ * <p>
+ * Adapting this bundle to the specified type may require certain checks,
+ * including security checks, to succeed. If a check does not succeed, then
+ * this bundle cannot be adapted and {@code null} is returned.
+ *
+ * @param <A> The type to which this bundle is to be adapted.
+ * @param type Class object for the type to which this bundle is to be
+ * adapted.
+ * @return The object, of the specified type, to which this bundle has been
+ * adapted or {@code null} if this bundle cannot be adapted to the
+ * specified type.
+ * @throws SecurityException If the caller does not have the appropriate
+ * {@code AdaptPermission[type,this,ADAPT]}, and the Java Runtime
+ * Environment supports permissions.
+ * @since 1.6
+ */
+ <A> A adapt(Class<A> type);
+}
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java
------------------------------------------------------------------------------
svn:keywords = author date id revision rev url
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/Bundle.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java?rev=1394154&view=auto
==============================================================================
--- sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java (added)
+++ sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java Thu Oct 4 16:50:07 2012
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) OSGi Alliance (2009, 2010). 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.framework;
+
+/**
+ * A reference to a Bundle.
+ *
+ * @since 1.5
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id$
+ */
+public interface BundleReference {
+ /**
+ * Returns the {@code Bundle} object associated with this
+ * {@code BundleReference}.
+ *
+ * @return The {@code Bundle} object associated with this
+ * {@code BundleReference}.
+ */
+ public Bundle getBundle();
+}
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java
------------------------------------------------------------------------------
svn:keywords = author date id revision rev url
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/BundleReference.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java?rev=1394154&view=auto
==============================================================================
--- sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java (added)
+++ sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java Thu Oct 4 16:50:07 2012
@@ -0,0 +1,174 @@
+/*
+ * Copyright (c) OSGi Alliance (2001, 2012). 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.framework.wiring;
+
+import java.util.Collection;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+import org.osgi.framework.FrameworkListener;
+
+/**
+ * Query and modify wiring information for the framework. The framework wiring
+ * object for the framework can be obtained by calling
+ * {@link Bundle#adapt(Class) bundle.adapt(FrameworkWiring.class)} on the system
+ * bundle. Only the system bundle can be adapted to a FrameworkWiring object.
+ *
+ * <p>
+ * The system bundle associated with this FrameworkWiring object can be obtained
+ * by calling {@link BundleReference#getBundle()}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id$
+ */
+public interface FrameworkWiring extends BundleReference {
+ /**
+ * Refreshes the specified bundles. This forces the update (replacement) or
+ * removal of packages exported by the specified bundles.
+ *
+ * <p>
+ * The technique by which the framework refreshes bundles may vary among
+ * different framework implementations. A permissible implementation is to
+ * stop and restart the framework.
+ *
+ * <p>
+ * This method returns to the caller immediately and then performs the
+ * following steps on a separate thread:
+ *
+ * <ol>
+ * <li>Compute the {@link #getDependencyClosure(Collection) dependency
+ * closure} of the specified bundles. If no bundles are specified, compute
+ * the dependency closure of the {@link #getRemovalPendingBundles() removal
+ * pending} bundles.
+ *
+ * <li>Each bundle in the dependency closure that is in the {@code ACTIVE}
+ * state will be stopped as described in the {@code Bundle.stop} method.
+ *
+ * <li>Each bundle in the dependency closure that is in the {@code RESOLVED}
+ * state is unresolved and thus moved to the {@code INSTALLED} state. The
+ * effect of this step is that bundles in the dependency closure are no
+ * longer {@code RESOLVED}.
+ *
+ * <li>Each bundle in the dependency closure that is in the
+ * {@code UNINSTALLED} state is removed from the dependency closure and is
+ * now completely removed from the Framework.
+ *
+ * <li>Each bundle in the dependency closure that was in the {@code ACTIVE}
+ * state prior to Step 2 is started as described in the {@code Bundle.start}
+ * method, causing all bundles required for the restart to be resolved. It
+ * is possible that, as a result of the previous steps, packages that were
+ * previously exported no longer are. Therefore, some bundles may be
+ * unresolvable until bundles satisfying the dependencies have been
+ * installed in the Framework.
+ * </ol>
+ *
+ * <p>
+ * For any exceptions that are thrown during any of these steps, a framework
+ * event of type {@code FrameworkEvent.ERROR} is fired containing the
+ * exception. The source bundle for these events should be the specific
+ * bundle to which the exception is related. If no specific bundle can be
+ * associated with the exception then the System Bundle must be used as the
+ * source bundle for the event. All framework events fired by this method
+ * are also delivered to the specified {@code FrameworkListener}s in the
+ * order they are specified.
+ *
+ * <p>
+ * When this process completes after the bundles are refreshed, the
+ * Framework will fire a Framework event of type
+ * {@code FrameworkEvent.PACKAGES_REFRESHED} to announce it has completed
+ * the bundle refresh. The specified {@code FrameworkListener}s are notified
+ * in the order specified. Each specified {@code FrameworkListener} will be
+ * called with a Framework event of type
+ * {@code FrameworkEvent.PACKAGES_REFRESHED}.
+ *
+ * @param bundles The bundles to be refreshed, or {@code null} to refresh
+ * the {@link #getRemovalPendingBundles() removal pending} bundles.
+ * @param listeners Zero or more listeners to be notified when the bundle
+ * refresh has been completed. The specified listeners do not need to
+ * be otherwise registered with the framework. If a specified
+ * listener is already registered with the framework, it will be
+ * notified twice.
+ * @throws IllegalArgumentException If the specified {@code Bundle}s were
+ * not created by the same framework instance associated with this
+ * FrameworkWiring.
+ * @throws SecurityException If the caller does not have
+ * {@code AdminPermission[System Bundle,RESOLVE]} and the Java
+ * runtime environment supports permissions.
+ */
+ void refreshBundles(Collection<Bundle> bundles, FrameworkListener... listeners);
+
+ /**
+ * Resolves the specified bundles. The Framework must attempt to resolve the
+ * specified bundles that are unresolved. Additional bundles that are not
+ * included in the specified bundles may be resolved as a result of calling
+ * this method. A permissible implementation of this method is to attempt to
+ * resolve all unresolved bundles installed in the framework.
+ *
+ * <p>
+ * If no bundles are specified, then the Framework will attempt to resolve
+ * all unresolved bundles. This method must not cause any bundle to be
+ * refreshed, stopped, or started. This method will not return until the
+ * operation has completed.
+ *
+ * @param bundles The bundles to resolve or {@code null} to resolve all
+ * unresolved bundles installed in the Framework.
+ * @return {@code true} if all specified bundles are resolved; {@code false}
+ * otherwise.
+ * @throws IllegalArgumentException If the specified {@code Bundle}s were
+ * not created by the same framework instance associated with this
+ * FrameworkWiring.
+ * @throws SecurityException If the caller does not have
+ * {@code AdminPermission[System Bundle,RESOLVE]} and the Java
+ * runtime environment supports permissions.
+ */
+ boolean resolveBundles(Collection<Bundle> bundles);
+
+ /**
+ * Returns the bundles that have {@link BundleWiring#isCurrent()
+ * non-current}, {@link BundleWiring#isInUse() in use} bundle wirings. This
+ * is typically the bundles which have been updated or uninstalled since the
+ * last call to {@link #refreshBundles(Collection, FrameworkListener...)}.
+ *
+ * @return A collection containing a snapshot of the {@code Bundle}s which
+ * have non-current, in use {@code BundleWiring}s, or an empty
+ * collection if there are no such bundles.
+ */
+ Collection<Bundle> getRemovalPendingBundles();
+
+ /**
+ * Returns the dependency closure for the specified bundles.
+ *
+ * <p>
+ * A graph of bundles is computed starting with the specified bundles. The
+ * graph is expanded by adding any bundle that is either wired to a package
+ * that is currently exported by a bundle in the graph or requires a bundle
+ * in the graph. The graph is fully constructed when there is no bundle
+ * outside the graph that is wired to a bundle in the graph. The graph may
+ * contain {@code UNINSTALLED} bundles that are
+ * {@link #getRemovalPendingBundles() removal pending}.
+ *
+ * @param bundles The initial bundles for which to generate the dependency
+ * closure.
+ * @return A collection containing a snapshot of the dependency closure of
+ * the specified bundles, or an empty collection if there were no
+ * specified bundles.
+ * @throws IllegalArgumentException If the specified {@code Bundle}s were
+ * not created by the same framework instance associated with this
+ * FrameworkWiring.
+ */
+ Collection<Bundle> getDependencyClosure(Collection<Bundle> bundles);
+}
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java
------------------------------------------------------------------------------
svn:keywords = author date id revision rev url
Propchange: sling/trunk/installer/core/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: sling/trunk/installer/core/src/test/java/org/apache/sling/installer/core/impl/MockBundleContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/installer/core/src/test/java/org/apache/sling/installer/core/impl/MockBundleContext.java?rev=1394154&r1=1394153&r2=1394154&view=diff
==============================================================================
--- sling/trunk/installer/core/src/test/java/org/apache/sling/installer/core/impl/MockBundleContext.java (original)
+++ sling/trunk/installer/core/src/test/java/org/apache/sling/installer/core/impl/MockBundleContext.java Thu Oct 4 16:50:07 2012
@@ -269,6 +269,11 @@ public class MockBundleContext implement
// TODO Auto-generated method stub
return null;
}
+
+ public <A> A adapt(Class<A> type) {
+ // TODO Auto-generated method stub
+ return null;
+ }
};
}