You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by gn...@apache.org on 2012/01/05 15:16:38 UTC
svn commit: r1227602 [8/10] - in /karaf/trunk: ./ admin/command/ admin/core/
admin/core/src/test/java/org/apache/karaf/jpm/ admin/management/
deployer/blueprint/ deployer/features/ deployer/kar/ deployer/spring/
deployer/wrap/ diagnostic/command/ diagn...
Added: karaf/trunk/main/src/main/java/org/osgi/framework/launch/FrameworkFactory.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/launch/FrameworkFactory.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/launch/FrameworkFactory.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/launch/FrameworkFactory.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,73 @@
+/*
+ * 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.launch;
+
+import java.util.Map;
+
+import org.osgi.framework.Bundle;
+
+/**
+ * A factory for creating {@link Framework} instances.
+ *
+ * <p>
+ * A framework implementation jar must contain the following resource:
+ *
+ * <pre>
+ * /META-INF/services/org.osgi.framework.launch.FrameworkFactory
+ * </pre>
+ *
+ * This UTF-8 encoded resource must contain the name of the framework
+ * implementation's FrameworkFactory implementation class. Space and tab
+ * characters, including blank lines, in the resource must be ignored. The
+ * number sign ('#' \u0023) and all characters following it on each line are
+ * a comment and must be ignored.
+ *
+ * <p>
+ * Launchers can find the name of the FrameworkFactory implementation class in
+ * the resource and then load and construct a FrameworkFactory object for the
+ * framework implementation. The FrameworkFactory implementation class must have
+ * a public, no-argument constructor. Java™ SE 6 introduced the
+ * {@code ServiceLoader} class which can create a FrameworkFactory instance
+ * from the resource.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: c370e19dba77231f0dbf1601218ad97b20391ea0 $
+ */
+public interface FrameworkFactory {
+
+ /**
+ * Create a new {@link Framework} instance.
+ *
+ * @param configuration The framework properties to configure the new
+ * framework instance. If framework properties are not provided by
+ * the configuration argument, the created framework instance must
+ * use some reasonable default configuration appropriate for the
+ * current VM. For example, the system packages for the current
+ * execution environment should be properly exported. The specified
+ * configuration argument may be {@code null}. The created
+ * framework instance must copy any information needed from the
+ * specified configuration argument since the configuration argument
+ * can be changed after the framework instance has been created.
+ * @return A new, configured {@link Framework} instance. The framework
+ * instance must be in the {@link Bundle#INSTALLED} state.
+ * @throws SecurityException If the caller does not have
+ * {@code AllPermission}, and the Java Runtime Environment
+ * supports permissions.
+ */
+ Framework newFramework(Map<String, String> configuration);
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/launch/package-info.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/launch/package-info.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/launch/package-info.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/launch/package-info.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) OSGi Alliance (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.
+ */
+
+/**
+ * Framework Launch Package Version 1.0.
+ *
+ * <p>
+ * Bundles wishing to use this package must list the package in the
+ * Import-Package header of the bundle's manifest.
+ *
+ * <p>
+ * Example import for consumers using the API in this package:
+ * <p>
+ * {@code Import-Package: org.osgi.framework.launch; version="[1.0,2.0)"}
+ *
+ * @version $Id: 4911f653268fd76aa6318f37f09f58e7ec43a733 $
+ */
+
+package org.osgi.framework.launch;
Added: karaf/trunk/main/src/main/java/org/osgi/framework/launch/packageinfo
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/launch/packageinfo?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/launch/packageinfo (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/launch/packageinfo Thu Jan 5 14:16:33 2012
@@ -0,0 +1 @@
+version 1.0
Added: karaf/trunk/main/src/main/java/org/osgi/framework/package-info.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/package-info.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/package-info.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/package-info.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) OSGi Alliance (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.
+ */
+
+/**
+ * Framework Package Version 1.6.
+ *
+ * <p>
+ * Bundles wishing to use this package must list the package in the
+ * Import-Package header of the bundle's manifest.
+ *
+ * <p>
+ * Example import for consumers using the API in this package:
+ * <p>
+ * {@code Import-Package: org.osgi.framework; version="[1.6,2.0)"}
+ *
+ * @version $Id: d5e6bdc8efa522dd450cb631b0a13e1157e4a104 $
+ */
+
+package org.osgi.framework;
Added: karaf/trunk/main/src/main/java/org/osgi/framework/packageinfo
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/packageinfo?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/packageinfo (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/packageinfo Thu Jan 5 14:16:33 2012
@@ -0,0 +1 @@
+version 1.6
Added: karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/BundleStartLevel.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/BundleStartLevel.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/BundleStartLevel.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/BundleStartLevel.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) OSGi Alliance (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.startlevel;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+
+/**
+ * Query and modify the start level information for a bundle. The start level
+ * object for a bundle can be obtained by calling {@link Bundle#adapt(Class)
+ * bundle.adapt(BundleStartLevel.class)} on the bundle.
+ *
+ * <p>
+ * The bundle associated with this BundleStartLevel object can be obtained by
+ * calling {@link BundleReference#getBundle()}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 9a000be191fe3cb4ae82535a30940db0340d5356 $
+ */
+public interface BundleStartLevel extends BundleReference {
+ /**
+ * Return the assigned start level value for the bundle.
+ *
+ * @return The start level value of the bundle.
+ * @see #setStartLevel(int)
+ * @throws IllegalStateException If the bundle has been uninstalled.
+ */
+ int getStartLevel();
+
+ /**
+ * Assign a start level value to the bundle.
+ *
+ * <p>
+ * The bundle will be assigned the specified start level. The start level
+ * value assigned to the bundle will be persistently recorded by the
+ * Framework.
+ * <p>
+ * If the new start level for the bundle is lower than or equal to the
+ * active start level of the Framework and the bundle's autostart setting
+ * indicates this bundle must be started, the Framework will start the
+ * bundle as described in the {@link Bundle#start(int)} method using the
+ * {@link Bundle#START_TRANSIENT} option. The
+ * {@link Bundle#START_ACTIVATION_POLICY} option must also be used if
+ * {@link #isActivationPolicyUsed()} returns {@code true}. The actual
+ * starting of the bundle must occur asynchronously.
+ * <p>
+ * If the new start level for the bundle is higher than the active start
+ * level of the Framework, the Framework will stop the bundle as described
+ * in the {@link Bundle#stop(int)} method using the
+ * {@link Bundle#STOP_TRANSIENT} option. The actual stopping of the bundle
+ * must occur asynchronously.
+ *
+ * @param startlevel The new start level for the bundle.
+ * @throws IllegalArgumentException If the specified start level is less
+ * than or equal to zero, or if the bundle is the system bundle.
+ * @throws IllegalStateException If the bundle has been uninstalled.
+ * @throws SecurityException If the caller does not have
+ * {@code AdminPermission[bundle,EXECUTE]} and the Java runtime
+ * environment supports permissions.
+ */
+ void setStartLevel(int startlevel);
+
+ /**
+ * Returns whether the bundle's autostart setting indicates it must be
+ * started.
+ * <p>
+ * The autostart setting of a bundle indicates whether the bundle is to be
+ * started when its start level is reached.
+ *
+ * @return {@code true} if the autostart setting of the bundle indicates it
+ * is to be started. {@code false} otherwise.
+ * @throws IllegalStateException If this bundle has been uninstalled.
+ * @see Bundle#START_TRANSIENT
+ */
+ boolean isPersistentlyStarted();
+
+ /**
+ * Returns whether the bundle's autostart setting indicates that the
+ * activation policy declared in the bundle manifest must be used.
+ * <p>
+ * The autostart setting of a bundle indicates whether the bundle's declared
+ * activation policy is to be used when the bundle is started.
+ *
+ * @return {@code true} if the bundle's autostart setting indicates the
+ * activation policy declared in the manifest must be used.
+ * {@code false} if the bundle must be eagerly activated.
+ * @throws IllegalStateException If the bundle has been uninstalled.
+ * @see Bundle#START_ACTIVATION_POLICY
+ */
+ boolean isActivationPolicyUsed();
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/FrameworkStartLevel.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/FrameworkStartLevel.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/FrameworkStartLevel.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/FrameworkStartLevel.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) OSGi Alliance (2002, 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.startlevel;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+import org.osgi.framework.FrameworkListener;
+
+/**
+ * Query and modify the start level information for the framework. The start
+ * level object for the framework can be obtained by calling
+ * {@link Bundle#adapt(Class) bundle.adapt(FrameworkStartLevel.class)} on the
+ * system bundle. Only the system bundle can be adapted to a FrameworkStartLevel
+ * object.
+ *
+ * <p>
+ * The system bundle associated with this FrameworkStartLevel object can be
+ * obtained by calling {@link BundleReference#getBundle()}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 2bca22671674ba50b8c6801d5d1df8e291fe2a9d $
+ */
+public interface FrameworkStartLevel extends BundleReference {
+ /**
+ * Return the active start level value of the Framework.
+ *
+ * If the Framework is in the process of changing the start level this
+ * method must return the active start level if this differs from the
+ * requested start level.
+ *
+ * @return The active start level value of the Framework.
+ */
+ int getStartLevel();
+
+ /**
+ * Modify the active start level of the Framework and notify when complete.
+ *
+ * <p>
+ * The Framework will move to the requested start level. This method will
+ * return immediately to the caller and the start level change will occur
+ * asynchronously on another thread. The specified {@code FrameworkListener}
+ * s are notified, in the order specified, when the start level change is
+ * complete. When the start level change completes normally, each specified
+ * {@code FrameworkListener} will be called with a Framework event of type
+ * {@code FrameworkEvent.STARTLEVEL_CHANGED}. If the start level change does
+ * not complete normally, each specified {@code FrameworkListener} will be
+ * called with a Framework event of type {@code FrameworkEvent.ERROR}.
+ *
+ * <p>
+ * If the specified start level is higher than the active start level, the
+ * Framework will continue to increase the start level until the Framework
+ * has reached the specified start level.
+ *
+ * At each intermediate start level value on the way to and including the
+ * target start level, the Framework must:
+ * <ol>
+ * <li>Change the active start level to the intermediate start level value.
+ * <li>Start bundles at the intermediate start level whose autostart setting
+ * indicate they must be started. They are started as described in the
+ * {@link Bundle#start(int)} method using the {@link Bundle#START_TRANSIENT}
+ * option. The {@link Bundle#START_ACTIVATION_POLICY} option must also be
+ * used if {@link BundleStartLevel#isActivationPolicyUsed()} returns
+ * {@code true} for the bundle.
+ * </ol>
+ * When this process completes after the specified start level is reached,
+ * the Framework will fire a Framework event of type
+ * {@code FrameworkEvent.STARTLEVEL_CHANGED} to announce it has moved to the
+ * specified start level.
+ *
+ * <p>
+ * If the specified start level is lower than the active start level, the
+ * Framework will continue to decrease the start level until the Framework
+ * has reached the specified start level.
+ *
+ * At each intermediate start level value on the way to and including the
+ * specified start level, the framework must:
+ * <ol>
+ * <li>Stop bundles at the intermediate start level as described in the
+ * {@link Bundle#stop(int)} method using the {@link Bundle#STOP_TRANSIENT}
+ * option.
+ * <li>Change the active start level to the intermediate start level value.
+ * </ol>
+ * When this process completes after the specified start level is reached,
+ * the Framework will fire a Framework event of type
+ * {@code FrameworkEvent.STARTLEVEL_CHANGED} to announce it has moved to the
+ * specified start level.
+ *
+ * <p>
+ * If the specified start level is equal to the active start level, then no
+ * bundles are started or stopped, however, the Framework must fire a
+ * Framework event of type {@code FrameworkEvent.STARTLEVEL_CHANGED} to
+ * announce it has finished moving to the specified start level. This event
+ * may arrive before this method returns.
+ *
+ * @param startlevel The requested start level for the Framework.
+ * @param listeners Zero or more listeners to be notified when the start
+ * level change 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 start level is less
+ * than or equal to zero.
+ * @throws SecurityException If the caller does not have
+ * {@code AdminPermission[System Bundle,STARTLEVEL]} and the Java
+ * runtime environment supports permissions.
+ */
+ void setStartLevel(int startlevel, FrameworkListener... listeners);
+
+ /**
+ * Return the initial start level value that is assigned to a Bundle when it
+ * is first installed.
+ *
+ * @return The initial start level value for Bundles.
+ * @see #setInitialBundleStartLevel
+ */
+ int getInitialBundleStartLevel();
+
+ /**
+ * Set the initial start level value that is assigned to a Bundle when it is
+ * first installed.
+ *
+ * <p>
+ * The initial bundle start level will be set to the specified start level.
+ * The initial bundle start level value will be persistently recorded by the
+ * Framework.
+ *
+ * <p>
+ * When a Bundle is installed via {@code BundleContext.installBundle}, it is
+ * assigned the initial bundle start level value.
+ *
+ * <p>
+ * The default initial bundle start level value is 1 unless this method has
+ * been called to assign a different initial bundle start level value.
+ *
+ * <p>
+ * This method does not change the start level values of installed bundles.
+ *
+ * @param startlevel The initial start level for newly installed bundles.
+ * @throws IllegalArgumentException If the specified start level is less
+ * than or equal to zero.
+ * @throws SecurityException If the caller does not have
+ * {@code AdminPermission[System Bundle,STARTLEVEL]} and the Java
+ * runtime environment supports permissions.
+ */
+ void setInitialBundleStartLevel(int startlevel);
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/package-info.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/package-info.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/package-info.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/package-info.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) OSGi Alliance (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.
+ */
+
+/**
+ * Framework Start Level Package Version 1.0.
+ *
+ * <p>
+ * The Framework Start Level package allows management agents to manage a start
+ * level assigned to each bundle and the active start level of the Framework.
+ * This package is a replacement for the now deprecated
+ * {@code org.osgi.service.startlevel} package.
+ *
+ * <p>
+ * A start level is defined to be a state of execution in which the Framework
+ * exists. Start level values are defined as unsigned integers with 0 (zero)
+ * being the state where the Framework is not launched. Progressively higher
+ * integral values represent progressively higher start levels. For example, 2
+ * is a higher start level than 1.
+ *
+ * <p>
+ * {@code AdminPermission} is required to modify start level information.
+ *
+ * <p>
+ * Start Level support in the Framework includes the ability to modify the
+ * active start level of the Framework and to assign a specific start level to a
+ * bundle. The beginning start level of a Framework is specified via the
+ * {@link org.osgi.framework.Constants#FRAMEWORK_BEGINNING_STARTLEVEL} framework
+ * property when configuring a framework.
+ *
+ * <p>
+ * When the Framework is first started it must be at start level zero. In this
+ * state, no bundles are running. This is the initial state of the Framework
+ * before it is launched. When the Framework is launched, the Framework will
+ * enter start level one and all bundles which are assigned to start level one
+ * and whose autostart setting indicates the bundle should be started are
+ * started as described in the {@link org.osgi.framework.Bundle#start(int)}
+ * method. The Framework will continue to increase the start level, starting
+ * bundles at each start level, until the Framework has reached a beginning
+ * start level. At this point the Framework has completed starting bundles and
+ * will then fire a Framework event of type
+ * {@link org.osgi.framework.FrameworkEvent#STARTED} to announce it has
+ * completed its launch.
+ *
+ * <p>
+ * Within a start level, bundles may be started in an order defined by the
+ * Framework implementation. This may be something like ascending
+ * {@link org.osgi.framework.Bundle#getBundleId()} order or an order based upon
+ * dependencies between bundles. A similar but reversed order may be used when
+ * stopping bundles within a start level.
+ *
+ * <p>
+ * The Framework Start Level package can be used by management bundles to alter
+ * the active start level of the framework.
+ *
+ * <p>
+ * Bundles wishing to use this package must list the package in the
+ * Import-Package header of the bundle's manifest. For example:
+ *
+ * <pre>
+ * Import-Package: org.osgi.framework.startlevel; version="[1.0,2.0)"
+ * </pre>
+ *
+ * @version $Id: 270a001c55674ef419794fa4574472b09130af9e $
+ */
+package org.osgi.framework.startlevel;
+
Added: karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/packageinfo
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/packageinfo?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/packageinfo (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/startlevel/packageinfo Thu Jan 5 14:16:33 2012
@@ -0,0 +1 @@
+version 1.0
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleCapability.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleCapability.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleCapability.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleCapability.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) OSGi Alliance (2010, 2011). 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.Map;
+
+/**
+ * A capability that has been declared from a {@link BundleRevision bundle
+ * revision}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 0fde13c3228af1aa97872b37ccf0aa6e23123b11 $
+ */
+public interface BundleCapability {
+ /**
+ * Returns the name space of this capability.
+ *
+ * @return The name space of this capability.
+ */
+ String getNamespace();
+
+ /**
+ * Returns the directives of this capability.
+ *
+ * @return An unmodifiable map of directive names to directive values for
+ * this capability, or an empty map if this capability has no
+ * directives.
+ */
+ Map<String, String> getDirectives();
+
+ /**
+ * Returns the attributes of this capability.
+ *
+ * @return An unmodifiable map of attribute names to attribute values for
+ * this capability, or an empty map if this capability has no
+ * attributes.
+ */
+ Map<String, Object> getAttributes();
+
+ /**
+ * Returns the bundle revision declaring this capability.
+ *
+ * @return The bundle revision declaring this capability.
+ */
+ BundleRevision getRevision();
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRequirement.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRequirement.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRequirement.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRequirement.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) OSGi Alliance (2010, 2011). 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.Map;
+
+/**
+ * A requirement that has been declared from a {@link BundleRevision bundle
+ * revision}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 659132c1fac7526240df377ead0e1bc8d4af2e77 $
+ */
+public interface BundleRequirement {
+ /**
+ * Returns the name space of this requirement.
+ *
+ * @return The name space of this requirement.
+ */
+ String getNamespace();
+
+ /**
+ * Returns the directives of this requirement.
+ *
+ * @return An unmodifiable map of directive names to directive values for
+ * this requirement, or an empty map if this requirement has no
+ * directives.
+ */
+ Map<String, String> getDirectives();
+
+ /**
+ * Returns the attributes of this requirement.
+ *
+ * @return An unmodifiable map of attribute names to attribute values for
+ * this requirement, or an empty map if this requirement has no
+ * attributes.
+ */
+ Map<String, Object> getAttributes();
+
+ /**
+ * Returns the bundle revision declaring this requirement.
+ *
+ * @return The bundle revision declaring this requirement.
+ */
+ BundleRevision getRevision();
+
+ /**
+ * Returns whether the specified capability matches this requirement.
+ *
+ * @param capability The capability to match to this requirement.
+ * @return {@code true} if the specified capability has the same
+ * {@link #getNamespace() name space} as this requirement and the
+ * filter for this requirement matches the
+ * {@link BundleCapability#getAttributes() attributes of the
+ * specified capability}; {@code false} otherwise.
+ */
+ boolean matches(BundleCapability capability);
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevision.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevision.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevision.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevision.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,255 @@
+/*
+ * Copyright (c) OSGi Alliance (2010, 2011). 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.List;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+import org.osgi.framework.Constants;
+import org.osgi.framework.Version;
+
+/**
+ * Bundle Revision. When a bundle is installed and each time a bundle is
+ * updated, a new bundle revision of the bundle is created. Since a bundle
+ * update can change the entries in a bundle, different bundle wirings for the
+ * same bundle can be associated with different bundle revisions.
+ *
+ * <p>
+ * For a bundle that has not been uninstalled, the most recent bundle revision
+ * is defined to be the current bundle revision. A bundle in the UNINSTALLED
+ * state does not have a current revision. The current bundle revision for a
+ * bundle can be obtained by calling {@link Bundle#adapt(Class) bundle.adapt}
+ * (BundleRevision.class). Since a bundle in the UNINSTALLED state does not have
+ * a current revision, adapting such a bundle returns {@code null}.
+ *
+ * <p>
+ * The framework defines name spaces for {@link #PACKAGE_NAMESPACE package},
+ * {@link #BUNDLE_NAMESPACE bundle} and {@link #HOST_NAMESPACE host}
+ * capabilities and requirements. These name spaces are defined only to express
+ * wiring information by the framework. They must not be used in
+ * {@link Constants#PROVIDE_CAPABILITY Provide-Capability} and
+ * {@link Constants#REQUIRE_CAPABILITY Require-Capability} manifest headers.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 139b3046ebd46c48b03dda8d36f2f9d79e2e616d $
+ */
+public interface BundleRevision extends BundleReference {
+ /**
+ * Returns the symbolic name for this bundle revision.
+ *
+ * @return The symbolic name for this bundle revision.
+ * @see Bundle#getSymbolicName()
+ */
+ String getSymbolicName();
+
+ /**
+ * Returns the version for this bundle revision.
+ *
+ * @return The version for this bundle revision, or
+ * {@link Version#emptyVersion} if this bundle revision has no
+ * version information.
+ * @see Bundle#getVersion()
+ */
+ Version getVersion();
+
+ /**
+ * Returns the capabilities declared by this bundle revision.
+ *
+ * @param namespace The name space of the declared capabilities to return or
+ * {@code null} to return the declared capabilities from all name
+ * spaces.
+ * @return A list containing a snapshot of the declared
+ * {@link BundleCapability}s, or an empty list if this bundle
+ * revision declares no capabilities in the specified name space.
+ * The list contains the declared capabilities in the order they are
+ * specified in the manifest.
+ */
+ List<BundleCapability> getDeclaredCapabilities(String namespace);
+
+ /**
+ * Returns the requirements declared by this bundle revision.
+ *
+ * @param namespace The name space of the declared requirements to return or
+ * {@code null} to return the declared requirements from all name
+ * spaces.
+ * @return A list containing a snapshot of the declared
+ * {@link BundleRequirement}s, or an empty list if this bundle
+ * revision declares no requirements in the specified name space.
+ * The list contains the declared requirements in the order they are
+ * specified in the manifest.
+ */
+ List<BundleRequirement> getDeclaredRequirements(String namespace);
+
+ /**
+ * Name space for package capabilities and requirements.
+ *
+ * <p>
+ * The name of the package is stored in the capability attribute of the same
+ * name as this name space (osgi.wiring.package). The other
+ * directives and attributes of the package, from the
+ * {@link Constants#EXPORT_PACKAGE Export-Package} manifest header, can be
+ * found in the cabability's {@link BundleCapability#getDirectives()
+ * directives} and {@link BundleCapability#getAttributes() attributes}. The
+ * {@link Constants#VERSION_ATTRIBUTE version} capability attribute must
+ * contain the {@link Version} of the package if one is specified or
+ * {@link Version#emptyVersion} if not specified. The
+ * {@link Constants#BUNDLE_SYMBOLICNAME_ATTRIBUTE bundle-symbolic-name}
+ * capability attribute must contain the
+ * {@link BundleRevision#getSymbolicName() symbolic name} of the provider if
+ * one is specified. The {@link Constants#BUNDLE_VERSION_ATTRIBUTE
+ * bundle-version} capability attribute must contain the
+ * {@link BundleRevision#getVersion() version} of the provider if one is
+ * specified or {@link Version#emptyVersion} if not specified.
+ *
+ * <p>
+ * The package capabilities provided by the system bundle, that is the
+ * bundle with id zero, must include the package specified by the
+ * {@link Constants#FRAMEWORK_SYSTEMPACKAGES} and
+ * {@link Constants#FRAMEWORK_SYSTEMPACKAGES_EXTRA} framework properties as
+ * well as any other package exported by the framework implementation.
+ *
+ * <p>
+ * A bundle revision {@link BundleRevision#getDeclaredCapabilities(String)
+ * declares} zero or more package capabilities (this is, exported packages)
+ * and {@link BundleRevision#getDeclaredRequirements(String) declares} zero
+ * or more package requirements.
+ * <p>
+ * A bundle wiring {@link BundleWiring#getCapabilities(String) provides}
+ * zero or more resolved package capabilities (that is, exported packages)
+ * and {@link BundleWiring#getRequiredWires(String) requires} zero or more
+ * resolved package requirements (that is, imported packages). The number of
+ * package wires required by a bundle wiring may change as the bundle wiring
+ * may dynamically import additional packages.
+ */
+ String PACKAGE_NAMESPACE = "osgi.wiring.package";
+
+ /**
+ * Name space for bundle capabilities and requirements.
+ *
+ * <p>
+ * The bundle symbolic name of the bundle is stored in the capability
+ * attribute of the same name as this name space (osgi.wiring.bundle).
+ * The other directives and attributes of the bundle, from the
+ * {@link Constants#BUNDLE_SYMBOLICNAME Bundle-SymbolicName} manifest
+ * header, can be found in the cabability's
+ * {@link BundleCapability#getDirectives() directives} and
+ * {@link BundleCapability#getAttributes() attributes}. The
+ * {@link Constants#BUNDLE_VERSION_ATTRIBUTE bundle-version} capability
+ * attribute must contain the {@link Version} of the bundle from the
+ * {@link Constants#BUNDLE_VERSION Bundle-Version} manifest header if one is
+ * specified or {@link Version#emptyVersion} if not specified.
+ *
+ * <p>
+ * A non-fragment revision
+ * {@link BundleRevision#getDeclaredCapabilities(String) declares} exactly
+ * one<sup>†</sup> bundle capability (that is, the bundle can be
+ * required by another bundle). A fragment revision must not declare a
+ * bundle capability.
+ *
+ * <p>
+ * A bundle wiring for a non-fragment revision
+ * {@link BundleWiring#getCapabilities(String) provides} exactly
+ * one<sup>†</sup> bundle capability (that is, the bundle can be
+ * required by another bundle) and
+ * {@link BundleWiring#getRequiredWires(String) requires} zero or more
+ * bundle capabilities (that is, requires other bundles).
+ *
+ * <p>
+ * † A bundle with no bundle symbolic name (that is, a bundle with
+ * {@link Constants#BUNDLE_MANIFESTVERSION Bundle-ManifestVersion}
+ * {@literal <} 2) must not provide a bundle capability.
+ */
+ String BUNDLE_NAMESPACE = "osgi.wiring.bundle";
+
+ /**
+ * Name space for host capabilities and requirements.
+ *
+ * <p>
+ * The bundle symbolic name of the bundle is stored in the capability
+ * attribute of the same name as this name space (osgi.wiring.host).
+ * The other directives and attributes of the bundle, from the
+ * {@link Constants#BUNDLE_SYMBOLICNAME Bundle-SymbolicName} manifest
+ * header, can be found in the cabability's
+ * {@link BundleCapability#getDirectives() directives} and
+ * {@link BundleCapability#getAttributes() attributes}. The
+ * {@link Constants#BUNDLE_VERSION_ATTRIBUTE bundle-version} capability
+ * attribute must contain the {@link Version} of the bundle from the
+ * {@link Constants#BUNDLE_VERSION Bundle-Version} manifest header if one is
+ * specified or {@link Version#emptyVersion} if not specified.
+ *
+ * <p>
+ * A non-fragment revision
+ * {@link BundleRevision#getDeclaredCapabilities(String) declares} zero or
+ * one<sup>†</sup> host capability if the bundle
+ * {@link Constants#FRAGMENT_ATTACHMENT_DIRECTIVE allows fragments to be
+ * attached}. A fragment revision must
+ * {@link BundleRevision#getDeclaredRequirements(String) declare} exactly
+ * one host requirement.
+ *
+ * <p>
+ * A bundle wiring for a non-fragment revision
+ * {@link BundleWiring#getCapabilities(String) provides} zero or
+ * one<sup>†</sup> host capability if the bundle
+ * {@link Constants#FRAGMENT_ATTACHMENT_DIRECTIVE allows fragments to be
+ * attached}. A bundle wiring for a fragment revision
+ * {@link BundleWiring#getRequiredWires(String) requires} a host capability
+ * for each host to which it is attached.
+ *
+ * <p>
+ * † A bundle with no bundle symbolic name (that is, a bundle with
+ * {@link Constants#BUNDLE_MANIFESTVERSION Bundle-ManifestVersion}
+ * {@literal <} 2) must not provide a host capability.
+ */
+ String HOST_NAMESPACE = "osgi.wiring.host";
+
+ /**
+ * Returns the special types of this bundle revision. The bundle revision
+ * type values are:
+ * <ul>
+ * <li>{@link #TYPE_FRAGMENT}
+ * </ul>
+ *
+ * A bundle revision may be more than one type at a time. A type code is
+ * used to identify the bundle revision type for future extendability.
+ *
+ * <p>
+ * If this bundle revision is not one or more of the defined types then 0 is
+ * returned.
+ *
+ * @return The special types of this bundle revision. The type values are
+ * ORed together.
+ */
+ int getTypes();
+
+ /**
+ * Bundle revision type indicating the bundle revision is a fragment.
+ *
+ * @see #getTypes()
+ */
+ int TYPE_FRAGMENT = 0x00000001;
+
+ /**
+ * Returns the bundle wiring which is using this bundle revision.
+ *
+ * @return The bundle wiring which is using this bundle revision or
+ * {@code null} if no bundle wiring is using this bundle revision.
+ * @see BundleWiring#getRevision()
+ */
+ BundleWiring getWiring();
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevisions.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevisions.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevisions.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleRevisions.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) OSGi Alliance (2011). 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.List;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+
+/**
+ * The {@link BundleRevision bundle revisions} of a bundle. When a bundle is
+ * installed and each time a bundle is updated, a new bundle revision of the
+ * bundle is created. For a bundle that has not been uninstalled, the most
+ * recent bundle revision is defined to be the current bundle revision. A bundle
+ * in the UNINSTALLED state does not have a current revision. An in use bundle
+ * revision is associated with an {@link BundleWiring#isInUse() in use}
+ * {@link BundleWiring}. The current bundle revision, if there is one, and all
+ * in use bundle revisions are returned.
+ *
+ * <p>
+ * The bundle revisions for a bundle can be obtained by calling
+ * {@link Bundle#adapt(Class) bundle.adapt}({@link BundleRevisions}.class).
+ * {@link #getRevisions()} on the bundle.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 1d95ad10f0f08b100f8ee2485bdd34120032c7af $
+ */
+public interface BundleRevisions extends BundleReference {
+ /**
+ * Return the bundle revisions for the {@link BundleReference#getBundle()
+ * referenced} bundle.
+ *
+ * <p>
+ * The result is a list containing the current bundle revision, if there is
+ * one, and all in use bundle revisions. The list may also contain
+ * intermediate bundle revisions which are not in use.
+ *
+ * <p>
+ * The list is ordered in reverse chronological order such that the first
+ * item is the most recent bundle revision and last item is the oldest
+ * bundle revision.
+ *
+ * <p>
+ * Generally the list will have at least one bundle revision for the bundle:
+ * the current bundle revision. However, for an uninstalled bundle with no
+ * in use bundle revisions, the list may be empty.
+ *
+ * @return A list containing a snapshot of the {@link BundleRevision}s for
+ * the referenced bundle.
+ */
+ List<BundleRevision> getRevisions();
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWire.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWire.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWire.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWire.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) OSGi Alliance (2011). 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;
+
+/**
+ * A wire connecting a {@link BundleCapability} to a {@link BundleRequirement}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 4f936a84065762ec3267a44f86ae01b0150e44ce $
+ */
+public interface BundleWire {
+ /**
+ * Returns the {@link BundleCapability} for this wire.
+ *
+ * @return The {@link BundleCapability} for this wire.
+ */
+ BundleCapability getCapability();
+
+ /**
+ * Return the {@link BundleRequirement} for this wire.
+ *
+ * @return The {@link BundleRequirement} for this wire.
+ */
+ BundleRequirement getRequirement();
+
+ /**
+ * Returns the bundle wiring {@link BundleWiring#getProvidedWires(String)
+ * providing} the {@link #getCapability() capability}.
+ *
+ * <p>
+ * The bundle revision referenced by the returned bundle wiring may differ
+ * from the bundle revision reference by the {@link #getCapability()
+ * capability}.
+ *
+ * @return The bundle wiring providing the capability. If the bundle wiring
+ * providing the capability is not {@link BundleWiring#isInUse() in
+ * use}, {@code null} will be returned.
+ */
+ BundleWiring getProviderWiring();
+
+ /**
+ * Returns the bundle wiring who
+ * {@link BundleWiring#getRequiredWires(String) requires} the
+ * {@link #getCapability() capability}.
+ *
+ * <p>
+ * The bundle revision referenced by the returned bundle wiring may differ
+ * from the bundle revision reference by the {@link #getRequirement()
+ * requirement}.
+ *
+ * @return The bundle wiring whose requirement is wired to the capability.
+ * If the bundle wiring requiring the capability is not
+ * {@link BundleWiring#isInUse() in use}, {@code null} will be
+ * returned.
+ */
+ BundleWiring getRequirerWiring();
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWiring.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWiring.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWiring.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/BundleWiring.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,344 @@
+/*
+ * Copyright (c) OSGi Alliance (2010, 2011). 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.net.URL;
+import java.util.Collection;
+import java.util.List;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleReference;
+
+/**
+ * A wiring for a bundle. Each time a bundle is resolved, a new bundle wiring
+ * for the bundle is created. A bundle wiring is associated with a bundle
+ * revision and represents the dependencies with other bundle wirings.
+ *
+ * <p>
+ * The bundle wiring for a bundle is the {@link #isCurrent() current} bundle
+ * wiring if it is the most recent bundle wiring for the current bundle
+ * revision. A bundle wiring is {@link #isInUse() in use} if it is the current
+ * bundle wiring or if some other in use bundle wiring is dependent upon it. For
+ * example, another bundle wiring is wired to a capability provided by the
+ * bundle wiring. An in use bundle wiring for a non-fragment bundle has a class
+ * loader. All bundles with non-current, in use bundle wirings are considered
+ * removal pending. Once a bundle wiring is no longer in use, it is considered
+ * stale and is discarded by the framework.
+ *
+ * <p>
+ * The current bundle wiring for a bundle can be obtained by calling
+ * {@link Bundle#adapt(Class) bundle.adapt}(BundleWiring.class). A bundle in the
+ * INSTALLED or UNINSTALLED state does not have a current wiring, adapting such
+ * a bundle returns {@code null}.
+ *
+ * @ThreadSafe
+ * @noimplement
+ * @version $Id: 58b8ec3bb9649387d4ccba1070f034f217d06ea2 $
+ */
+public interface BundleWiring extends BundleReference {
+ /**
+ * Returns {@code true} if this bundle wiring is the current bundle wiring.
+ * The bundle wiring for a bundle is the current bundle wiring if it is the
+ * most recent bundle wiring for the current bundle revision. All bundles
+ * with non-current, in use bundle wirings are considered
+ * {@link FrameworkWiring#getRemovalPendingBundles() removal pending}.
+ *
+ * @return {@code true} if this bundle wiring is the current bundle wiring;
+ * {@code false} otherwise.
+ */
+ boolean isCurrent();
+
+ /**
+ * Returns {@code true} if this bundle wiring is in use. A bundle wiring is
+ * in use if it is the {@link #isCurrent() current} wiring or if some other
+ * in use bundle wiring is dependent upon it. Once a bundle wiring is no
+ * longer in use, it is considered stale and is discarded by the framework.
+ *
+ * @return {@code true} if this bundle wiring is in use; {@code false}
+ * otherwise.
+ */
+ boolean isInUse();
+
+ /**
+ * Returns the capabilities provided by this bundle wiring.
+ *
+ * <p>
+ * A capability may not be required by any bundle wiring and thus there may
+ * be no {@link #getProvidedWires(String) wires} for the capability.
+ *
+ * <p>
+ * A bundle wiring for a non-fragment revision provides a subset of the
+ * declared capabilities from the bundle revision and all attached fragment
+ * revisions. Not all declared capabilities may be provided since some may
+ * be discarded. For example, if a package is declared to be exported and
+ * import, only one is selected and the other is discarded.
+ *
+ * @param namespace The name space of the capabilities to return or
+ * {@code null} to return the capabilities from all name spaces.
+ * @return A list containing a snapshot of the {@link BundleCapability}s, or
+ * an empty list if this bundle wiring provides no capabilities in
+ * the specified name space. If this bundle wiring is not
+ * {@link #isInUse() in use}, {@code null} will be returned. For a
+ * given name space, the list contains the wires in the order the
+ * capabilities were specified in the manifests of the
+ * {@link #getRevision() bundle revision} and the attached fragments
+ * of this bundle wiring. There is no ordering defined between
+ * capabilities in different name spaces.
+ */
+ List<BundleCapability> getCapabilities(String namespace);
+
+ /**
+ * Returns the requirements of this bundle wiring.
+ *
+ * <p>
+ * A bundle wiring for a non-fragment revision has a subset of the declared
+ * requirements from the bundle revision and all attached fragment
+ * revisions. Not all declared requirements may be present since some may be
+ * discarded. For example, if a package is declared to be optionally
+ * imported and is not actually imported, the requirement must be discarded.
+ *
+ * @param namespace The name space of the requirements to return or
+ * {@code null} to return the requirements from all name spaces.
+ * @return A list containing a snapshot of the {@link BundleRequirement}s,
+ * or an empty list if this bundle wiring uses no requirements in
+ * the specified name space. If this bundle wiring is not
+ * {@link #isInUse() in use}, {@code null} will be returned. For a
+ * given name space, the list contains the wires in the order the
+ * requirements were specified in the manifests of the
+ * {@link #getRevision() bundle revision} and the attached fragments
+ * of this bundle wiring. There is no ordering defined between
+ * requirements in different name spaces.
+ */
+ List<BundleRequirement> getRequirements(String namespace);
+
+ /**
+ * Returns the {@link BundleWire}s to the provided {@link BundleCapability
+ * capabilities} of this bundle wiring.
+ *
+ * @param namespace The name space of the capabilities for which to return
+ * wires or {@code null} to return the wires for the capabilities in
+ * all name spaces.
+ * @return A list containing a snapshot of the {@link BundleWire}s for the
+ * {@link BundleCapability capabilities} of this bundle wiring, or
+ * an empty list if this bundle wiring has no capabilities in the
+ * specified name space. If this bundle wiring is not
+ * {@link #isInUse() in use}, {@code null} will be returned. For a
+ * given name space, the list contains the wires in the order the
+ * capabilities were specified in the manifests of the
+ * {@link #getRevision() bundle revision} and the attached fragments
+ * of this bundle wiring. There is no ordering defined between
+ * capabilities in different name spaces.
+ */
+ List<BundleWire> getProvidedWires(String namespace);
+
+ /**
+ * Returns the {@link BundleWire}s to the {@link BundleRequirement
+ * requirements} in use by this bundle wiring.
+ *
+ * <p>
+ * This method may return different results if this bundle wiring adds wires
+ * to more requirements. For example, dynamically importing a package will
+ * establish a new wire to the dynamically imported package.
+ *
+ * @param namespace The name space of the requirements for which to return
+ * wires or {@code null} to return the wires for the requirements in
+ * all name spaces.
+ * @return A list containing a snapshot of the {@link BundleWire}s for the
+ * {@link BundleRequirement requirements} of this bundle wiring, or
+ * an empty list if this bundle wiring has no requirements in the
+ * specified name space. If this bundle wiring is not
+ * {@link #isInUse() in use}, {@code null} will be returned. For a
+ * given name space, the list contains the wires in the order the
+ * requirements were specified in the manifests of the
+ * {@link #getRevision() bundle revision} and the attached fragments
+ * of this bundle wiring. There is no ordering defined between
+ * requirements in different name spaces.
+ */
+ List<BundleWire> getRequiredWires(String namespace);
+
+ /**
+ * Returns the bundle revision for the bundle in this bundle wiring. Since a
+ * bundle update can change the entries in a bundle, different bundle
+ * wirings for the same bundle can have different bundle revisions.
+ *
+ * <p>
+ * The bundle object {@link BundleReference#getBundle() referenced} by the
+ * returned {@code BundleRevision} may return different information than the
+ * returned {@code BundleRevision} since the returned {@code BundleRevision}
+ * may refer to an older revision of the bundle.
+ *
+ * @return The bundle revision for this bundle wiring.
+ * @see BundleRevision#getWiring()
+ */
+ BundleRevision getRevision();
+
+ /**
+ * Returns the class loader for this bundle wiring. Since a bundle refresh
+ * creates a new bundle wiring for a bundle, different bundle wirings for
+ * the same bundle will have different class loaders.
+ *
+ * @return The class loader for this bundle wiring. If this bundle wiring is
+ * not {@link #isInUse() in use} or this bundle wiring is for a
+ * fragment revision, {@code null} will be returned.
+ * @throws SecurityException If the caller does not have the appropriate
+ * {@code RuntimePermission("getClassLoader")}, and the Java Runtime
+ * Environment supports permissions.
+ */
+ ClassLoader getClassLoader();
+
+ /**
+ * Returns entries in this bundle wiring's {@link #getRevision() bundle
+ * revision} and its attached fragment revisions. This bundle wiring's class
+ * loader is not used to search for entries. Only the contents of this
+ * bundle wiring's bundle revision and its attached fragment revisions are
+ * searched for the specified entries.
+ *
+ * <p>
+ * This method takes into account that the "contents" of this
+ * bundle wiring can have attached fragments. This "bundle space"
+ * is not a name space with unique members; the same entry name can be
+ * present multiple times. This method therefore returns a list 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.
+ *
+ * <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 wiring and may begin with
+ * "/". A path value of "/" indicates the root of
+ * this bundle wiring.
+ * @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 {@code null} is
+ * specified, this is equivalent to "*" and matches all
+ * files.
+ * @param options The options for listing resource names. See
+ * {@link #FINDENTRIES_RECURSE}. The method must ignore unrecognized
+ * options.
+ * @return An unmodifiable list of URL objects for each matching entry, or
+ * an empty list if no matching entry could be found, if this bundle
+ * wiring is for a fragment revision or if the caller does not have
+ * the appropriate {@code AdminPermission[bundle,RESOURCE]} and the
+ * Java Runtime Environment supports permissions. The list is
+ * ordered such that entries from the {@link #getRevision() bundle
+ * revision} are returned first followed by the entries from
+ * attached fragment revisions in attachment order. If this bundle
+ * wiring is not {@link #isInUse() in use}, {@code null} must be
+ * returned.
+ * @see Bundle#findEntries(String, String, boolean)
+ */
+ List<URL> findEntries(String path, String filePattern, int options);
+
+ /**
+ * The find entries operation must recurse into subdirectories.
+ *
+ * <p>
+ * This bit may be set when calling
+ * {@link #findEntries(String, String, int)} to specify the result must
+ * include the matching entries from the specified path and its
+ * subdirectories. If this bit is not set, then the result must only include
+ * matching entries from the specified path.
+ *
+ * @see #findEntries(String, String, int)
+ */
+ int FINDENTRIES_RECURSE = 0x00000001;
+
+ /**
+ * Returns the names of resources visible to this bundle wiring's
+ * {@link #getClassLoader() class loader}. The returned names can be used to
+ * access the resources via this bundle wiring's class loader.
+ *
+ * <ul>
+ * <li>Only the resource names for resources in bundle wirings will be
+ * returned. The names of resources visible to a bundle wiring's parent
+ * class loader, such as the bootstrap class loader, must not be included in
+ * the result.
+ * <li>Only established wires will be examined for resources. This method
+ * must not cause new wires for dynamic imports to be established.
+ * </ul>
+ *
+ * @param path The path name in which to look. The path is always relative
+ * to the root of this bundle wiring's class loader and may begin
+ * with "/". A path value of "/" indicates the
+ * root of this bundle wiring's class loader.
+ * @param filePattern The file name pattern for selecting resource names in
+ * the specified path. The pattern is only matched against the last
+ * element of the resource path. If the resource 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
+ * {@code null} is specified, this is equivalent to "*" and
+ * matches all files.
+ * @param options The options for listing resource names. See
+ * {@link #LISTRESOURCES_LOCAL} and {@link #LISTRESOURCES_RECURSE}.
+ * This method must ignore unrecognized options.
+ * @return An unmodifiable collection of resource names for each matching
+ * resource, or an empty collection if no matching resource could be
+ * found, if this bundle wiring is for a fragment revision or if the
+ * caller does not have the appropriate
+ * {@code AdminPermission[bundle,RESOURCE]} and the Java Runtime
+ * Environment supports permissions. The collection is unordered and
+ * must contain no duplicate resource names. If this bundle wiring
+ * is not {@link #isInUse() in use}, {@code null} must be returned.
+ */
+ Collection<String> listResources(String path, String filePattern,
+ int options);
+
+ /**
+ * The list resource names operation must recurse into subdirectories.
+ *
+ * <p>
+ * This bit may be set when calling
+ * {@link #listResources(String, String, int)} to specify the result must
+ * include the names of matching resources from the specified path and its
+ * subdirectories. If this bit is not set, then the result must only include
+ * names of matching resources from the specified path.
+ *
+ * @see #listResources(String, String, int)
+ */
+ int LISTRESOURCES_RECURSE = 0x00000001;
+
+ /**
+ * The list resource names operation must limit the result to the names of
+ * matching resources contained in this bundle wiring's
+ * {@link #getRevision() bundle revision} and its attached fragment
+ * revisions. The result must not include resource names for resources in
+ * {@link BundleRevision#PACKAGE_NAMESPACE package} names which are
+ * {@link #getRequiredWires(String) imported} by this wiring.
+ *
+ * <p>
+ * This bit may be set when calling
+ * {@link #listResources(String, String, int)} to specify the result must
+ * only include the names of matching resources contained in this bundle
+ * wiring's bundle revision and its attached fragment revisions. If this bit
+ * is not set, then the result must include the names of matching resources
+ * reachable from this bundle wiring's class loader which may include the
+ * names of matching resources contained in imported packages and required
+ * bundles.
+ *
+ * @see #listResources(String, String, int)
+ */
+ int LISTRESOURCES_LOCAL = 0x00000002;
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/FrameworkWiring.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,176 @@
+/*
+ * Copyright (c) OSGi Alliance (2001, 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.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: f9f3f89b5b8d369453d645a52a482a385a2bd520 $
+ */
+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);
+}
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/package-info.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/package-info.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/package-info.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/package-info.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) OSGi Alliance (2010, 2011). 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.
+ */
+
+/**
+ * Framework Wiring Package Version 1.0.
+ *
+ * <p>
+ * Bundles wishing to use this package must list the package in the
+ * Import-Package header of the bundle's manifest. For example:
+ *
+ * <pre>
+ * Import-Package: org.osgi.framework.wiring; version="[1.0,2.0)"
+ * </pre>
+ *
+ * @version $Id: 05eacf0e84a34e2b2e5ddbe4b3fee3acd0d07cc6 $
+ */
+package org.osgi.framework.wiring;
+
Added: karaf/trunk/main/src/main/java/org/osgi/framework/wiring/packageinfo
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/framework/wiring/packageinfo?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/framework/wiring/packageinfo (added)
+++ karaf/trunk/main/src/main/java/org/osgi/framework/wiring/packageinfo Thu Jan 5 14:16:33 2012
@@ -0,0 +1 @@
+version 1.0
Added: karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleLocationCondition.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleLocationCondition.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleLocationCondition.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleLocationCondition.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) OSGi Alliance (2005, 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.service.condpermadmin;
+
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+import java.util.Dictionary;
+import java.util.Hashtable;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.Filter;
+import org.osgi.framework.FrameworkUtil;
+import org.osgi.framework.InvalidSyntaxException;
+
+/**
+ * Condition to test if the location of a bundle matches or does not match a
+ * pattern. Since the bundle's location cannot be changed, this condition is
+ * immutable.
+ *
+ * <p>
+ * Pattern matching is done according to the filter string matching rules.
+ *
+ * @ThreadSafe
+ * @version $Id: 7b466c7103a708833c6ff1fa2a4c5cf21f757179 $
+ */
+public class BundleLocationCondition {
+ private static final String CONDITION_TYPE = "org.osgi.service.condpermadmin.BundleLocationCondition";
+
+ /**
+ * Constructs a condition that tries to match the passed Bundle's location
+ * to the location pattern.
+ *
+ * @param bundle The Bundle being evaluated.
+ * @param info The ConditionInfo from which to construct the condition. The
+ * ConditionInfo must specify one or two arguments. The first
+ * argument of the ConditionInfo specifies the location pattern
+ * against which to match the bundle location. Matching is done
+ * according to the filter string matching rules. Any '*' characters
+ * in the first argument are used as wildcards when matching bundle
+ * locations unless they are escaped with a '\' character. The
+ * Condition is satisfied if the bundle location matches the pattern.
+ * The second argument of the ConditionInfo is optional. If a second
+ * argument is present and equal to "!", then the satisfaction of the
+ * Condition is negated. That is, the Condition is satisfied if the
+ * bundle location does NOT match the pattern. If the second argument
+ * is present but does not equal "!", then the second argument is
+ * ignored.
+ * @return Condition object for the requested condition.
+ */
+ static public Condition getCondition(final Bundle bundle,
+ final ConditionInfo info) {
+ if (!CONDITION_TYPE.equals(info.getType()))
+ throw new IllegalArgumentException(
+ "ConditionInfo must be of type \"" + CONDITION_TYPE + "\"");
+ String[] args = info.getArgs();
+ if (args.length != 1 && args.length != 2)
+ throw new IllegalArgumentException("Illegal number of args: " + args.length);
+ String bundleLocation = AccessController
+ .doPrivileged(new PrivilegedAction<String>() {
+ public String run() {
+ return bundle.getLocation();
+ }
+ });
+ Filter filter = null;
+ try {
+ filter = FrameworkUtil.createFilter("(location="
+ + escapeLocation(args[0]) + ")");
+ }
+ catch (InvalidSyntaxException e) {
+ // this should never happen, but just in case
+ throw new RuntimeException("Invalid filter: " + e.getFilter(), e);
+ }
+ Dictionary<String, String> matchProps = new Hashtable<String, String>(2);
+ matchProps.put("location", bundleLocation);
+ boolean negate = (args.length == 2) ? "!".equals(args[1]) : false;
+ return (negate ^ filter.match(matchProps)) ? Condition.TRUE
+ : Condition.FALSE;
+ }
+
+ private BundleLocationCondition() {
+ // private constructor to prevent objects of this type
+ }
+
+ /**
+ * Escape the value string such that '(', ')' and '\' are escaped. The '\'
+ * char is only escaped if it is not followed by a '*'.
+ *
+ * @param value unescaped value string.
+ * @return escaped value string.
+ */
+ private static String escapeLocation(final String value) {
+ boolean escaped = false;
+ int inlen = value.length();
+ int outlen = inlen << 1; /* inlen * 2 */
+
+ char[] output = new char[outlen];
+ value.getChars(0, inlen, output, inlen);
+
+ int cursor = 0;
+ for (int i = inlen; i < outlen; i++) {
+ char c = output[i];
+ switch (c) {
+ case '\\' :
+ if (i + 1 < outlen && output[i + 1] == '*')
+ break;
+ case '(' :
+ case ')' :
+ output[cursor] = '\\';
+ cursor++;
+ escaped = true;
+ break;
+ }
+
+ output[cursor] = c;
+ cursor++;
+ }
+
+ return escaped ? new String(output, 0, cursor) : value;
+ }
+}
Added: karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleSignerCondition.java
URL: http://svn.apache.org/viewvc/karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleSignerCondition.java?rev=1227602&view=auto
==============================================================================
--- karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleSignerCondition.java (added)
+++ karaf/trunk/main/src/main/java/org/osgi/service/condpermadmin/BundleSignerCondition.java Thu Jan 5 14:16:33 2012
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) OSGi Alliance (2005, 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.service.condpermadmin;
+
+import java.security.cert.X509Certificate;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.FrameworkUtil;
+
+/**
+ * Condition to test if the signer of a bundle matches or does not match a
+ * pattern. Since the bundle's signer can only change when the bundle is
+ * updated, this condition is immutable.
+ * <p>
+ * The condition expressed using a single String that specifies a Distinguished
+ * Name (DN) chain to match bundle signers against. DN's are encoded using IETF
+ * RFC 2253. Usually signers use certificates that are issued by certificate
+ * authorities, which also have a corresponding DN and certificate. The
+ * certificate authorities can form a chain of trust where the last DN and
+ * certificate is known by the framework. The signer of a bundle is expressed as
+ * signers DN followed by the DN of its issuer followed by the DN of the next
+ * issuer until the DN of the root certificate authority. Each DN is separated
+ * by a semicolon.
+ * <p>
+ * A bundle can satisfy this condition if one of its signers has a DN chain that
+ * matches the DN chain used to construct this condition. Wildcards (`*') can be
+ * used to allow greater flexibility in specifying the DN chains. Wildcards can
+ * be used in place of DNs, RDNs, or the value in an RDN. If a wildcard is used
+ * for a value of an RDN, the value must be exactly "*" and will match any value
+ * for the corresponding type in that RDN. If a wildcard is used for a RDN, it
+ * must be the first RDN and will match any number of RDNs (including zero
+ * RDNs).
+ *
+ * @ThreadSafe
+ * @version $Id: 6e10febd6a8cfc31973ece0af29c352ed972b105 $
+ */
+public class BundleSignerCondition {
+ private static final String CONDITION_TYPE = "org.osgi.service.condpermadmin.BundleSignerCondition";
+
+ /**
+ * Constructs a Condition that tries to match the passed Bundle's location
+ * to the location pattern.
+ *
+ * @param bundle The Bundle being evaluated.
+ * @param info The ConditionInfo from which to construct the condition. The
+ * ConditionInfo must specify one or two arguments. The first
+ * argument of the ConditionInfo specifies the chain of distinguished
+ * names pattern to match against the signer of the bundle. The
+ * Condition is satisfied if the signer of the bundle matches the
+ * pattern. The second argument of the ConditionInfo is optional. If
+ * a second argument is present and equal to "!", then the
+ * satisfaction of the Condition is negated. That is, the Condition
+ * is satisfied if the signer of the bundle does NOT match the
+ * pattern. If the second argument is present but does not equal "!",
+ * then the second argument is ignored.
+ * @return A Condition which checks the signers of the specified bundle.
+ */
+ public static Condition getCondition(final Bundle bundle,
+ final ConditionInfo info) {
+ if (!CONDITION_TYPE.equals(info.getType()))
+ throw new IllegalArgumentException(
+ "ConditionInfo must be of type \"" + CONDITION_TYPE + "\"");
+ String[] args = info.getArgs();
+ if (args.length != 1 && args.length != 2)
+ throw new IllegalArgumentException("Illegal number of args: "
+ + args.length);
+
+ Map<X509Certificate, List<X509Certificate>> signers = bundle
+ .getSignerCertificates(Bundle.SIGNERS_TRUSTED);
+ boolean match = false;
+ for (List<X509Certificate> signerCerts : signers.values()) {
+ List<String> dnChain = new ArrayList<String>(signerCerts.size());
+ for (X509Certificate signer : signerCerts) {
+ dnChain.add(signer.getSubjectDN().getName());
+ }
+ if (FrameworkUtil.matchDistinguishedNameChain(args[0], dnChain)) {
+ match = true;
+ break;
+ }
+ }
+
+ boolean negate = (args.length == 2) ? "!".equals(args[1]) : false;
+ return negate ^ match ? Condition.TRUE : Condition.FALSE;
+ }
+
+ private BundleSignerCondition() {
+ // private constructor to prevent objects of this type
+ }
+}