* Deprecated. * This package is deprecated and has been replaced by the * {@code org.osgi.framework.startlevel} package. * *
* Bundles wishing to use this package must list the package in the * Import-Package header of the bundle's manifest. * *
* Example import for consumers using the API in this package: *
* {@code Import-Package: org.osgi.service.startlevel; version="[1.1,2.0)"} * * @version $Id: 6e311e6e404688d5f5f88cde403ca2066de7c20b $ */ package org.osgi.service.startlevel; osgi-core-4.3.0/src/org/osgi/service/startlevel/StartLevel.java 0000644 0001750 0001750 00000027605 11527234116 024411 0 ustar drazzib drazzib /* * 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.service.startlevel; import org.osgi.framework.Bundle; /** * The StartLevel service allows management agents to manage a start level * assigned to each bundle and the active start level of the Framework. There is * at most one StartLevel service present in the OSGi environment. * *
* A start level is defined to be a state of execution in which the Framework * exists. StartLevel 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. e.g. 2 is a * higher start level than 1. *
* Access to the StartLevel service is protected by corresponding * {@code ServicePermission}. In addition {@code AdminPermission} * is required to actually modify start level information. *
* Start Level support in the Framework includes the ability to control the * beginning start level of the Framework, to modify the active start level of * the Framework and to assign a specific start level to a bundle. How the * beginning start level of a Framework is specified is implementation * dependent. It may be a command line argument when invoking the Framework * implementation. *
* 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 * {@code Bundle.start} 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 * {@code FrameworkEvent.STARTED} to announce it has completed its * launch. * *
* Within a start level, bundles may be started in an order defined by the * Framework implementation. This may be something like ascending * {@code 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. * *
* The StartLevel service can be used by management bundles to alter the active
* start level of the framework.
*
* @ThreadSafe
* @noimplement
* @version $Id: bf1b71ed6c9f9d75785b26dccb34362017d93f4a $
* @deprecated This service has been replaced by the
* org.osgi.framework.startlevel package.
*/
public interface StartLevel {
/**
* 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.
*/
public int getStartLevel();
/**
* Modify the active start level of the Framework.
*
*
* 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. * *
* 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: *
* 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: *
* 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 return. * * @param startlevel The requested start level for the Framework. * @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. */ public void setStartLevel(int startlevel); /** * Return the assigned start level value for the specified Bundle. * * @param bundle The target bundle. * @return The start level value of the specified Bundle. * @throws java.lang.IllegalArgumentException If the specified bundle has * been uninstalled or if the specified bundle was not created by * the same framework instance that registered this * {@code StartLevel} service. */ public int getBundleStartLevel(Bundle bundle); /** * Assign a start level value to the specified Bundle. * *
* The specified bundle will be assigned the specified start level. The * start level value assigned to the bundle will be persistently recorded by * the Framework. *
* 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 the bundle must be started, the Framework will start the * specified 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 #isBundleActivationPolicyUsed(Bundle)} returns {@code true} * for the bundle. The actual starting of this bundle must occur * asynchronously. *
* If the new start level for the bundle is higher than the active start * level of the Framework, the Framework will stop the specified bundle as * described in the {@link Bundle#stop(int)} method using the * {@link Bundle#STOP_TRANSIENT} option. The actual stopping of this bundle * must occur asynchronously. * * @param bundle The target bundle. * @param startlevel The new start level for the specified Bundle. * @throws IllegalArgumentException If the specified bundle has been * uninstalled, or if the specified start level is less than or * equal to zero, or if the specified bundle is the system bundle, * or if the specified bundle was not created by the same framework * instance that registered this {@code StartLevel} service. * @throws SecurityException If the caller does not have * {@code AdminPermission[bundle,EXECUTE]} and the Java runtime * environment supports permissions. */ public void setBundleStartLevel(Bundle bundle, int startlevel); /** * 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 */ public int getInitialBundleStartLevel(); /** * Set the initial start level value that is assigned to a Bundle when it is * first installed. * *
* 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. * *
* When a Bundle is installed via {@code BundleContext.installBundle}, * it is assigned the initial bundle start level value. * *
* The default initial bundle start level value is 1 unless this method has * been called to assign a different initial bundle start level value. * *
* 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. */ public void setInitialBundleStartLevel(int startlevel); /** * Returns whether the specified bundle's autostart setting indicates the * bundle must be started. *
* The autostart setting of a bundle indicates whether the bundle is to be * started when its start level is reached. * * @param bundle The bundle whose autostart setting is to be examined. * @return {@code true} if the autostart setting of the bundle * indicates the bundle is to be started. {@code false} * otherwise. * @throws java.lang.IllegalArgumentException If the specified bundle has * been uninstalled or if the specified bundle was not created by * the same framework instance that registered this * {@code StartLevel} service. * @see Bundle#START_TRANSIENT */ public boolean isBundlePersistentlyStarted(Bundle bundle); /** * Returns whether the specified bundle's autostart setting indicates that * the activation policy declared in the bundle's manifest must be used. *
* The autostart setting of a bundle indicates whether the bundle's declared * activation policy is to be used when the bundle is started. * * @param bundle The bundle whose autostart setting is to be examined. * @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 java.lang.IllegalArgumentException If the specified bundle has * been uninstalled or if the specified bundle was not created by * the same framework instance that registered this * {@code StartLevel} service. * @since 1.1 * @see Bundle#START_ACTIVATION_POLICY */ public boolean isBundleActivationPolicyUsed(Bundle bundle); } osgi-core-4.3.0/src/org/osgi/service/startlevel/packageinfo 0000644 0001750 0001750 00000000014 11527234116 023634 0 ustar drazzib drazzib version 1.1 osgi-core-4.3.0/src/org/osgi/service/permissionadmin/ 0000755 0001750 0001750 00000000000 11527234164 022466 5 ustar drazzib drazzib osgi-core-4.3.0/src/org/osgi/service/permissionadmin/package-info.java 0000644 0001750 0001750 00000002065 11527234116 025655 0 ustar drazzib drazzib /* * 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. */ /** * Permission Admin Package Version 1.2. * *
* Bundles wishing to use this package must list the package in the * Import-Package header of the bundle's manifest. * *
* Example import for consumers using the API in this package: *
* {@code Import-Package: org.osgi.service.permissionadmin; version="[1.2,2.0)"} * * @version $Id: 4e7435396ab10ff2d4f5cce1edbffc3b0ccd5e84 $ */ package org.osgi.service.permissionadmin; osgi-core-4.3.0/src/org/osgi/service/permissionadmin/PermissionAdmin.java 0000644 0001750 0001750 00000011130 11527234116 026423 0 ustar drazzib drazzib /* * 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.service.permissionadmin; /** * The Permission Admin service allows management agents to manage the * permissions of bundles. There is at most one Permission Admin service present * in the OSGi environment. *
* Access to the Permission Admin service is protected by corresponding * {@code ServicePermission}. In addition {@code AdminPermission} * is required to actually set permissions. * *
* Bundle permissions are managed using a permission table. A bundle's location * serves as the key into this permission table. The value of a table entry is * the set of permissions (of type {@code PermissionInfo}) granted to * the bundle named by the given location. A bundle may have an entry in the * permission table prior to being installed in the Framework. * *
* The permissions specified in {@code setDefaultPermissions} are used as * the default permissions which are granted to all bundles that do not have an * entry in the permission table. * *
* Any changes to a bundle's permissions in the permission table will take * effect no later than when bundle's * {@code java.security.ProtectionDomain} is next involved in a * permission check, and will be made persistent. * *
* Only permission classes on the system classpath or from an exported package * are considered during a permission check. Additionally, only permission * classes that are subclasses of {@code java.security.Permission} and * define a 2-argument constructor that takes a name string and an * actions string can be used. *
* Permissions implicitly granted by the Framework (for example, a bundle's * permission to access its persistent storage area) cannot be changed, and are * not reflected in the permissions returned by {@code getPermissions} * and {@code getDefaultPermissions}. * * @ThreadSafe * @noimplement * @version $Id: 91132d707097c085fdb3fb7241c9599335427082 $ */ public interface PermissionAdmin { /** * Gets the permissions assigned to the bundle with the specified location. * * @param location The location of the bundle whose permissions are to be * returned. * * @return The permissions assigned to the bundle with the specified * location, or {@code null} if that bundle has not been * assigned any permissions. */ PermissionInfo[] getPermissions(String location); /** * Assigns the specified permissions to the bundle with the specified * location. * * @param location The location of the bundle that will be assigned the * permissions. * @param permissions The permissions to be assigned, or {@code null} * if the specified location is to be removed from the permission * table. * @throws SecurityException If the caller does not have * {@code AllPermission}. */ void setPermissions(String location, PermissionInfo[] permissions); /** * Returns the bundle locations that have permissions assigned to them, that * is, bundle locations for which an entry exists in the permission table. * * @return The locations of bundles that have been assigned any permissions, * or {@code null} if the permission table is empty. */ String[] getLocations(); /** * Gets the default permissions. * *
* These are the permissions granted to any bundle that does not have * permissions assigned to its location. * * @return The default permissions, or {@code null} if no default * permissions are set. */ PermissionInfo[] getDefaultPermissions(); /** * Sets the default permissions. * *
* These are the permissions granted to any bundle that does not have * permissions assigned to its location. * * @param permissions The default permissions, or {@code null} if the * default permissions are to be removed from the permission table. * @throws SecurityException If the caller does not have * {@code AllPermission}. */ void setDefaultPermissions(PermissionInfo[] permissions); } osgi-core-4.3.0/src/org/osgi/service/permissionadmin/packageinfo 0000644 0001750 0001750 00000000014 11527234116 024650 0 ustar drazzib drazzib version 1.2 osgi-core-4.3.0/src/org/osgi/service/permissionadmin/PermissionInfo.java 0000644 0001750 0001750 00000026115 11527234116 026277 0 ustar drazzib drazzib /* * 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.service.permissionadmin; /** * Permission representation used by the Permission Admin service. * *
* This class encapsulates three pieces of information: a Permission type * (class name), which must be a subclass of * {@code java.security.Permission}, and the name and actions * arguments passed to its constructor. * *
* In order for a permission represented by a {@code PermissionInfo} to be * instantiated and considered during a permission check, its Permission class * must be available from the system classpath or an exported package. This * means that the instantiation of a permission represented by a * {@code PermissionInfo} may be delayed until the package containing its * Permission class has been exported by a bundle. * * @Immutable * @version $Id: b9516d07ada162fb8fc750f09e1e3a686189c46b $ */ public class PermissionInfo { private final String type; private final String name; private final String actions; /** * Constructs a {@code PermissionInfo} from the specified type, name, * and actions. * * @param type The fully qualified class name of the permission represented * by this {@code PermissionInfo}. The class must be a subclass * of {@code java.security.Permission} and must define a * 2-argument constructor that takes a name string and an * actions string. * * @param name The permission name that will be passed as the first argument * to the constructor of the {@code Permission} class identified * by {@code type}. * * @param actions The permission actions that will be passed as the second * argument to the constructor of the {@code Permission} class * identified by {@code type}. * * @throws NullPointerException If {@code type} is {@code null}. * @throws IllegalArgumentException If {@code action} is not * {@code null} and {@code name} is {@code null}. */ public PermissionInfo(String type, String name, String actions) { this.type = type; this.name = name; this.actions = actions; if (type == null) { throw new NullPointerException("type is null"); } if ((name == null) && (actions != null)) { throw new IllegalArgumentException("name missing"); } } /** * Constructs a {@code PermissionInfo} object from the specified * encoded {@code PermissionInfo} string. White space in the encoded * {@code PermissionInfo} string is ignored. * * * @param encodedPermission The encoded {@code PermissionInfo}. * @see #getEncoded * @throws IllegalArgumentException If the specified * {@code encodedPermission} is not properly formatted. */ public PermissionInfo(String encodedPermission) { if (encodedPermission == null) { throw new NullPointerException("missing encoded permission"); } if (encodedPermission.length() == 0) { throw new IllegalArgumentException("empty encoded permission"); } String parsedType = null; String parsedName = null; String parsedActions = null; try { char[] encoded = encodedPermission.toCharArray(); int length = encoded.length; int pos = 0; /* skip whitespace */ while (Character.isWhitespace(encoded[pos])) { pos++; } /* the first character must be '(' */ if (encoded[pos] != '(') { throw new IllegalArgumentException("expecting open parenthesis"); } pos++; /* skip whitespace */ while (Character.isWhitespace(encoded[pos])) { pos++; } /* type is not quoted or encoded */ int begin = pos; while (!Character.isWhitespace(encoded[pos]) && (encoded[pos] != ')')) { pos++; } if (pos == begin || encoded[begin] == '"') { throw new IllegalArgumentException("expecting type"); } parsedType = new String(encoded, begin, pos - begin); /* skip whitespace */ while (Character.isWhitespace(encoded[pos])) { pos++; } /* type may be followed by name which is quoted and encoded */ if (encoded[pos] == '"') { pos++; begin = pos; while (encoded[pos] != '"') { if (encoded[pos] == '\\') { pos++; } pos++; } parsedName = unescapeString(encoded, begin, pos); pos++; if (Character.isWhitespace(encoded[pos])) { /* skip whitespace */ while (Character.isWhitespace(encoded[pos])) { pos++; } /* * name may be followed by actions which is quoted and * encoded */ if (encoded[pos] == '"') { pos++; begin = pos; while (encoded[pos] != '"') { if (encoded[pos] == '\\') { pos++; } pos++; } parsedActions = unescapeString(encoded, begin, pos); pos++; /* skip whitespace */ while (Character.isWhitespace(encoded[pos])) { pos++; } } } } /* the final character must be ')' */ char c = encoded[pos]; pos++; while ((pos < length) && Character.isWhitespace(encoded[pos])) { pos++; } if ((c != ')') || (pos != length)) { throw new IllegalArgumentException( "expecting close parenthesis"); } } catch (ArrayIndexOutOfBoundsException e) { throw new IllegalArgumentException("parsing terminated abruptly"); } type = parsedType; name = parsedName; actions = parsedActions; } /** * Returns the string encoding of this {@code PermissionInfo} in a form * suitable for restoring this {@code PermissionInfo}. * *
* The encoded format is: * *
* (type) ** * or * *
* (type "name") ** * or * *
* (type "name" "actions") ** * where name and actions are strings that must be encoded for * proper parsing. Specifically, the {@code "},{@code \}, * carriage return, and line feed characters must be escaped using * {@code \"}, {@code \\},{@code \r}, and * {@code \n}, respectively. * *
* The encoded string contains no leading or trailing whitespace characters. * A single space character is used between type and * "name" and between "name" and * "actions". * * @return The string encoding of this {@code PermissionInfo}. */ public final String getEncoded() { StringBuffer output = new StringBuffer( 8 + type.length() + ((((name == null) ? 0 : name.length()) + ((actions == null) ? 0 : actions.length())) << 1)); output.append('('); output.append(type); if (name != null) { output.append(" \""); escapeString(name, output); if (actions != null) { output.append("\" \""); escapeString(actions, output); } output.append('\"'); } output.append(')'); return output.toString(); } /** * Returns the string representation of this {@code PermissionInfo}. * The string is created by calling the {@code getEncoded} method on * this {@code PermissionInfo}. * * @return The string representation of this {@code PermissionInfo}. */ public String toString() { return getEncoded(); } /** * Returns the fully qualified class name of the permission represented by * this {@code PermissionInfo}. * * @return The fully qualified class name of the permission represented by * this {@code PermissionInfo}. */ public final String getType() { return type; } /** * Returns the name of the permission represented by this * {@code PermissionInfo}. * * @return The name of the permission represented by this * {@code PermissionInfo}, or {@code null} if the * permission does not have a name. */ public final String getName() { return name; } /** * Returns the actions of the permission represented by this * {@code PermissionInfo}. * * @return The actions of the permission represented by this * {@code PermissionInfo}, or {@code null} if the * permission does not have any actions associated with it. */ public final String getActions() { return actions; } /** * Determines the equality of two {@code PermissionInfo} objects. * * This method checks that specified object has the same type, name and * actions as this {@code PermissionInfo} object. * * @param obj The object to test for equality with this * {@code PermissionInfo} object. * @return {@code true} if {@code obj} is a * {@code PermissionInfo}, and has the same type, name and * actions as this {@code PermissionInfo} object; * {@code false} otherwise. */ public boolean equals(Object obj) { if (obj == this) { return true; } if (!(obj instanceof PermissionInfo)) { return false; } PermissionInfo other = (PermissionInfo) obj; if (!type.equals(other.type) || ((name == null) ^ (other.name == null)) || ((actions == null) ^ (other.actions == null))) { return false; } if (name != null) { if (actions != null) { return name.equals(other.name) && actions.equals(other.actions); } else { return name.equals(other.name); } } else { return true; } } /** * Returns the hash code value for this object. * * @return A hash code value for this object. */ public int hashCode() { int h = 31 * 17 + type.hashCode(); if (name != null) { h = 31 * h + name.hashCode(); if (actions != null) { h = 31 * h + actions.hashCode(); } } return h; } /** * This escapes the quotes, backslashes, \n, and \r in the string using a * backslash and appends the newly escaped string to a StringBuffer. */ private static void escapeString(String str, StringBuffer output) { int len = str.length(); for (int i = 0; i < len; i++) { char c = str.charAt(i); switch (c) { case '"' : case '\\' : output.append('\\'); output.append(c); break; case '\r' : output.append("\\r"); break; case '\n' : output.append("\\n"); break; default : output.append(c); break; } } } /** * Takes an encoded character array and decodes it into a new String. */ private static String unescapeString(char[] str, int begin, int end) { StringBuffer output = new StringBuffer(end - begin); for (int i = begin; i < end; i++) { char c = str[i]; if (c == '\\') { i++; if (i < end) { c = str[i]; switch (c) { case '"' : case '\\' : break; case 'r' : c = '\r'; break; case 'n' : c = '\n'; break; default : c = '\\'; i--; break; } } } output.append(c); } return output.toString(); } } osgi-core-4.3.0/src/org/osgi/service/condpermadmin/ 0000755 0001750 0001750 00000000000 11527234164 022105 5 ustar drazzib drazzib osgi-core-4.3.0/src/org/osgi/service/condpermadmin/package-info.java 0000644 0001750 0001750 00000002075 11527234116 025275 0 ustar drazzib drazzib /* * 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. */ /** * Conditional Permission Admin Package Version 1.1. * *
* Bundles wishing to use this package must list the package in the * Import-Package header of the bundle's manifest. * *
* Example import for consumers using the API in this package: *
* {@code Import-Package: org.osgi.service.condpermadmin; version="[1.1,2.0)"} * * @version $Id: cb84fc1342d7f8863ec8eae2dd244843246b2fc1 $ */ package org.osgi.service.condpermadmin; osgi-core-4.3.0/src/org/osgi/service/condpermadmin/ConditionalPermissionAdmin.java 0000644 0001750 0001750 00000025364 11527234116 030244 0 ustar drazzib drazzib /* * 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.AccessControlContext; import java.util.Enumeration; import org.osgi.service.permissionadmin.PermissionInfo; /** * Framework service to administer Conditional Permissions. Conditional * Permissions can be added to, retrieved from, and removed from the framework. * Conditional Permissions are conceptually managed in an ordered table called * the Conditional Permission Table. * * @ThreadSafe * @noimplement * @version $Id: 887450b65e453145d57197e2db75db0bb2918ef4 $ */ public interface ConditionalPermissionAdmin { /** * Create a new Conditional Permission Info in the Conditional Permission * Table. *
* The Conditional Permission Info will be given a unique, never reused * name. This entry will be added at the beginning of the Conditional * Permission Table with an access decision of * {@link ConditionalPermissionInfo#ALLOW ALLOW}. *
* Since this method changes the Conditional Permission Table any * {@link ConditionalPermissionUpdate}s that were created prior to calling * this method can no longer be committed. * * @param conditions The conditions that need to be satisfied to enable the * specified permissions. This argument can be {@code null} or * an empty array indicating the specified permissions are not * guarded by any conditions. * @param permissions The permissions that are enabled when the specified * conditions, if any, are satisfied. This argument must not be * {@code null} and must specify at least one permission. * @return The ConditionalPermissionInfo for the specified Conditions and * Permissions. * @throws IllegalArgumentException If no permissions are specified. * @throws SecurityException If the caller does not have * {@code AllPermission}. * @deprecated Since 1.1. Use {@link #newConditionalPermissionUpdate()} * instead. */ ConditionalPermissionInfo addConditionalPermissionInfo( ConditionInfo conditions[], PermissionInfo permissions[]); /** * Set or create a Conditional Permission Info with a specified name in the * Conditional Permission Table. *
* If the specified name is {@code null}, a new Conditional Permission * Info must be created and will be given a unique, never reused name. If * there is currently no Conditional Permission Info with the specified * name, a new Conditional Permission Info must be created with the * specified name. Otherwise, the Conditional Permission Info with the * specified name must be updated with the specified Conditions and * Permissions. If a new entry was created in the Conditional Permission * Table it will be added at the beginning of the table with an access * decision of {@link ConditionalPermissionInfo#ALLOW ALLOW}. *
* Since this method changes the underlying permission table any * {@link ConditionalPermissionUpdate}s that were created prior to calling * this method can no longer be committed. * * @param name The name of the Conditional Permission Info, or * {@code null}. * @param conditions The conditions that need to be satisfied to enable the * specified permissions. This argument can be {@code null} or * an empty array indicating the specified permissions are not * guarded by any conditions. * @param permissions The permissions that are enabled when the specified * conditions, if any, are satisfied. This argument must not be * {@code null} and must specify at least one permission. * @return The ConditionalPermissionInfo for the specified name, Conditions * and Permissions. * @throws IllegalArgumentException If no permissions are specified. * @throws SecurityException If the caller does not have * {@code AllPermission}. * @deprecated Since 1.1. Use {@link #newConditionalPermissionUpdate()} * instead. */ ConditionalPermissionInfo setConditionalPermissionInfo(String name, ConditionInfo conditions[], PermissionInfo permissions[]); /** * Returns the Conditional Permission Infos from the Conditional Permission * Table. *
* The returned Enumeration will return elements in the order they are kept * in the Conditional Permission Table. *
* The Enumeration returned is based on a copy of the Conditional Permission
* Table and therefore will not throw exceptions if the Conditional
* Permission Table is changed during the course of reading elements from
* the Enumeration.
*
* @return An enumeration of the Conditional Permission Infos that are
* currently in the Conditional Permission Table.
* @deprecated Since 1.1. Use {@link #newConditionalPermissionUpdate()}
* instead.
*/
Enumeration
* 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.
*
* 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
* The {@link ConditionalPermissionInfo#delete delete} method of the
* ConditionalPermissionInfos in the list must throw
* UnsupportedOperationException.
*
* The list returned by this method is ordered and the most significant
* table entry is the first entry in the list.
*
* @return A {@code List} of the {@link ConditionalPermissionInfo}s
* which represent the Conditional Permissions maintained by this
* update. Modifications to this list will not affect the
* Conditional Permission Table until successfully committed. The
* list may be empty if the Conditional Permission Table was empty
* when this update was created.
*/
List
* If any of the {@link ConditionalPermissionInfo}s in the update list has
* {@code null} as a name it will be replaced with a new
* {@link ConditionalPermissionInfo} object that has a generated name which
* is unique within the list.
*
* No two entries in this update's Conditional Permissions may have the same
* name. Other consistency checks may also be performed. If this update's
* Conditional Permissions are determined to be inconsistent in some way
* then an {@code IllegalStateException} will be thrown.
*
* This method returns {@code false} if the commit did not occur
* because the Conditional Permission Table has been modified since the
* creation of this update.
*
* @return {@code true} if the commit was successful.
* {@code false} if the commit did not occur because the
* Conditional Permission Table has been modified since the creation
* of this update.
* @throws SecurityException If the caller does not have
* {@code AllPermission}.
* @throws IllegalStateException If this update's Conditional Permissions
* are not valid or inconsistent. For example, this update has two
* Conditional Permissions in it with the same name.
*/
boolean commit();
}
osgi-core-4.3.0/src/org/osgi/service/condpermadmin/BundleLocationCondition.java 0000644 0001750 0001750 00000011240 11527234116 027514 0 ustar drazzib drazzib /*
* 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.
*
*
* 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
* This class encapsulates two pieces of information: a Condition type
* (class name), which must implement {@code Condition}, and the
* arguments passed to its constructor.
*
*
* In order for a Condition represented by a {@code ConditionInfo} to be
* instantiated and considered during a permission check, its Condition class
* must be available from the system classpath.
*
*
* The Condition class must either:
*
* The encoded format is:
*
*
* The encoded string contains no leading or trailing whitespace characters.
* A single space character is used between type and "arg0"
* and between the arguments.
*
* @return The string encoding of this {@code ConditionInfo}.
*/
public final String getEncoded() {
StringBuffer output = new StringBuffer();
output.append('[');
output.append(type);
for (int i = 0; i < args.length; i++) {
output.append(" \"");
escapeString(args[i], output);
output.append('\"');
}
output.append(']');
return output.toString();
}
/**
* Returns the string representation of this {@code ConditionInfo}.
* The string is created by calling the {@code getEncoded} method on
* this {@code ConditionInfo}.
*
* @return The string representation of this {@code ConditionInfo}.
*/
public String toString() {
return getEncoded();
}
/**
* Returns the fully qualified class name of the condition represented by
* this {@code ConditionInfo}.
*
* @return The fully qualified class name of the condition represented by
* this {@code ConditionInfo}.
*/
public final String getType() {
return type;
}
/**
* Returns arguments of this {@code ConditionInfo}.
*
* @return The arguments of this {@code ConditionInfo}. An empty
* array is returned if the {@code ConditionInfo} has no
* arguments.
*/
public final String[] getArgs() {
return args.clone();
}
/**
* Determines the equality of two {@code ConditionInfo} objects.
*
* This method checks that specified object has the same type and args as
* this {@code ConditionInfo} object.
*
* @param obj The object to test for equality with this
* {@code ConditionInfo} object.
* @return {@code true} if {@code obj} is a
* {@code ConditionInfo}, and has the same type and args as
* this {@code ConditionInfo} object; {@code false}
* otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof ConditionInfo)) {
return false;
}
ConditionInfo other = (ConditionInfo) obj;
if (!type.equals(other.type) || args.length != other.args.length)
return false;
for (int i = 0; i < args.length; i++) {
if (!args[i].equals(other.args[i]))
return false;
}
return true;
}
/**
* Returns the hash code value for this object.
*
* @return A hash code value for this object.
*/
public int hashCode() {
int h = 31 * 17 + type.hashCode();
for (int i = 0; i < args.length; i++) {
h = 31 * h + args[i].hashCode();
}
return h;
}
/**
* This escapes the quotes, backslashes, \n, and \r in the string using a
* backslash and appends the newly escaped string to a StringBuffer.
*/
private static void escapeString(String str, StringBuffer output) {
int len = str.length();
for (int i = 0; i < len; i++) {
char c = str.charAt(i);
switch (c) {
case '"' :
case '\\' :
output.append('\\');
output.append(c);
break;
case '\r' :
output.append("\\r");
break;
case '\n' :
output.append("\\n");
break;
default :
output.append(c);
break;
}
}
}
/**
* Takes an encoded character array and decodes it into a new String.
*/
private static String unescapeString(char[] str, int begin, int end) {
StringBuffer output = new StringBuffer(end - begin);
for (int i = begin; i < end; i++) {
char c = str[i];
if (c == '\\') {
i++;
if (i < end) {
c = str[i];
switch (c) {
case '"' :
case '\\' :
break;
case 'r' :
c = '\r';
break;
case 'n' :
c = '\n';
break;
default :
c = '\\';
i--;
break;
}
}
}
output.append(c);
}
return output.toString();
}
}
osgi-core-4.3.0/src/org/osgi/service/condpermadmin/ConditionalPermissionInfo.java 0000644 0001750 0001750 00000014466 11527234116 030110 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2004, 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 org.osgi.service.permissionadmin.PermissionInfo;
/**
* A list of Permissions guarded by a list of conditions with an access
* decision. Instances of this interface are obtained from the Conditional
* Permission Admin service.
*
* @Immutable
* @noimplement
* @version $Id: ca51e4dd6dfa350959bb2a2e420bdb2c996323e9 $
*/
public interface ConditionalPermissionInfo {
/**
* This string is used to indicate that a row in the Conditional Permission
* Table should return an access decision of "allow" if the
* conditions are all satisfied and at least one of the permissions is
* implied.
*
* @since 1.1
*/
public final static String ALLOW = "allow";
/**
* This string is used to indicate that a row in the Conditional Permission
* Table should return an access decision of "deny" if the
* conditions are all satisfied and at least one of the permissions is
* implied.
*
* @since 1.1
*/
public final static String DENY = "deny";
/**
* Returns the Condition Infos for the Conditions that must be satisfied to
* enable the Permissions.
*
* @return The Condition Infos for the Conditions in this Conditional
* Permission Info.
*/
ConditionInfo[] getConditionInfos();
/**
* Returns the Permission Infos for the Permissions in this Conditional
* Permission Info.
*
* @return The Permission Infos for the Permissions in this Conditional
* Permission Info.
*/
PermissionInfo[] getPermissionInfos();
/**
* Removes this Conditional Permission Info from the Conditional Permission
* Table.
*
* Since this method changes the underlying permission table, any
* {@link ConditionalPermissionUpdate}s that were created prior to calling
* this method can no longer be committed.
*
* @throws UnsupportedOperationException If this object was created by
* {@link ConditionalPermissionAdmin#newConditionalPermissionInfo}
* or obtained from a {@link ConditionalPermissionUpdate}. This
* method only functions if this object was obtained from one of the
* {@link ConditionalPermissionAdmin} methods deprecated in version
* 1.1.
* @throws SecurityException If the caller does not have
* {@code AllPermission}.
* @deprecated Since 1.1. Use
* {@link ConditionalPermissionAdmin#newConditionalPermissionUpdate()}
* instead to manage the Conditional Permissions.
*/
void delete();
/**
* Returns the name of this Conditional Permission Info.
*
* @return The name of this Conditional Permission Info. This can be
* {@code null} if this Conditional Permission Info was created
* without a name.
*/
String getName();
/**
* Returns the access decision for this Conditional Permission Info.
*
* @return One of the following values:
*
* The encoded format is:
*
*
* name is optional. If name is present in the encoded string,
* it must quoted, beginning and ending with {@code "}. The name
* value must be encoded for proper parsing. Specifically, the
* {@code "}, {@code \}, carriage return, and line feed characters must
* be escaped using {@code \"}, {@code \\}, {@code \r}, and {@code \n},
* respectively.
*
*
* The encoded string contains no leading or trailing whitespace characters.
* A single space character is used between access and
* Deprecated.
* This package is deprecated and has been replaced by the
* {@code org.osgi.framework.wiring} package.
*
*
* Bundles wishing to use this package must list the package in the
* Import-Package header of the bundle's manifest.
*
*
* Example import for consumers using the API in this package:
*
* {@code Import-Package: org.osgi.service.packageadmin; version="[1.2,2.0)"}
*
* @version $Id: b1c7db22b9c84e48d3c6c711f0ed976e825053c9 $
*/
package org.osgi.service.packageadmin;
osgi-core-4.3.0/src/org/osgi/service/packageadmin/RequiredBundle.java 0000644 0001750 0001750 00000006656 11527234116 025460 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2004, 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.packageadmin;
import org.osgi.framework.Bundle;
import org.osgi.framework.Version;
/**
* A required bundle.
*
* Objects implementing this interface are created by the Package Admin service.
*
*
* The term required bundle refers to a resolved bundle that has a bundle
* symbolic name and is not a fragment. That is, a bundle that may be required
* by other bundles. This bundle may or may not be currently required by other
* bundles.
*
*
* The information about a required bundle provided by this object may change. A
* {@code RequiredBundle} object becomes stale if an exported package of
* the bundle it references has been updated or removed as a result of calling
* {@code PackageAdmin.refreshPackages()}).
*
* If this object becomes stale, its {@code getSymbolicName()} and
* {@code getVersion()} methods continue to return their original values,
* {@code isRemovalPending()} returns true, and {@code getBundle()}
* and {@code getRequiringBundles()} return {@code null}.
*
* @since 1.2
* @ThreadSafe
* @noimplement
* @deprecated The PackageAdmin service has been replaced by the
*
* If this required bundle is required and then re-exported by another
* bundle then all the requiring bundles of the re-exporting bundle are
* included in the returned array.
*
* @return An array of bundles currently requiring this required bundle, or
* {@code null} if this {@code RequiredBundle} object
* has become stale. The array will be empty if no bundles require
* this required package.
*/
public Bundle[] getRequiringBundles();
/**
* Returns the version of this required bundle.
*
* @return The version of this required bundle, or
* {@link Version#emptyVersion} if no version information is
* available.
*/
public Version getVersion();
/**
* Returns {@code true} if the bundle associated with this
* {@code RequiredBundle} object has been updated or uninstalled.
*
* @return {@code true} if the required bundle has been updated or
* uninstalled, or if the {@code RequiredBundle} object has
* become stale; {@code false} otherwise.
*/
public boolean isRemovalPending();
}
osgi-core-4.3.0/src/org/osgi/service/packageadmin/PackageAdmin.java 0000644 0001750 0001750 00000030622 11527234116 025040 0 ustar drazzib drazzib /*
* 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.service.packageadmin;
import org.osgi.framework.Bundle;
/**
* Framework service which allows bundle programmers to inspect the package
* wiring state of bundles in the Framework as well as other functions related
* to the class loader network among bundles.
*
*
* If present, there will only be a single instance of this service registered
* with the Framework.
*
* @ThreadSafe
* @noimplement
* @version $Id: a268c3bdc986080fa16bdb2f56ba1d3800d030dd $
* @deprecated This service has been replaced by the
*
* If there are multiple exported packages with specified name, the exported
* package with the highest version will be returned.
*
* @param name The name of the exported package to be returned.
*
* @return The exported package, or {@code null} if no exported
* package with the specified name exists.
* @see #getExportedPackages(String)
*/
public ExportedPackage getExportedPackage(String name);
/**
* Forces the update (replacement) or removal of packages exported by the
* specified bundles.
*
*
* If no bundles are specified, this method will update or remove any
* packages exported by any bundles that were previously updated or
* uninstalled since the last call to this method. The technique by which
* this is accomplished may vary among different Framework implementations.
* One permissible implementation is to stop and restart the Framework.
*
*
* This method returns to the caller immediately and then performs the
* following steps on a separate thread:
*
*
* For any exceptions that are thrown during any of these steps, a
* {@code FrameworkEvent} of type {@code 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.
*
* @param bundles The bundles whose exported packages are to be updated or
* removed, or {@code null} for all bundles updated or
* uninstalled since the last call to this method.
* @throws SecurityException If the caller does not have
* {@code AdminPermission[System Bundle,RESOLVE]} and the Java
* runtime environment supports permissions.
* @throws IllegalArgumentException If the specified {@code Bundle}s
* were not created by the same framework instance that registered
* this {@code PackageAdmin} service.
*/
public void refreshPackages(Bundle[] bundles);
/**
* Resolve 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.
*
*
* If {@code null} is 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;
* @throws SecurityException If the caller does not have
* {@code AdminPermission[System Bundle,RESOLVE]} and the Java
* runtime environment supports permissions.
* @throws IllegalArgumentException If the specified {@code Bundle}s
* were not created by the same framework instance that registered
* this {@code PackageAdmin} service.
* @since 1.2
*/
public boolean resolveBundles(Bundle[] bundles);
/**
* Returns an array of required bundles having the specified symbolic name.
*
*
* If {@code null} is specified, then all required bundles will be
* returned.
*
* @param symbolicName The bundle symbolic name or {@code null} for
* all required bundles.
* @return An array of required bundles or {@code null} if no
* required bundles exist for the specified symbolic name.
* @since 1.2
*/
public RequiredBundle[] getRequiredBundles(String symbolicName);
/**
* Returns the bundles with the specified symbolic name whose bundle version
* is within the specified version range. If no bundles are installed that
* have the specified symbolic name, then {@code null} is returned.
* If a version range is specified, then only the bundles that have the
* specified symbolic name and whose bundle versions belong to the specified
* version range are returned. The returned bundles are ordered by version
* in descending version order so that the first element of the array
* contains the bundle with the highest version.
*
* @see org.osgi.framework.Constants#BUNDLE_VERSION_ATTRIBUTE
* @param symbolicName The symbolic name of the desired bundles.
* @param versionRange The version range of the desired bundles, or
* {@code null} if all versions are desired.
* @return An array of bundles with the specified name belonging to the
* specified version range ordered in descending version order, or
* {@code null} if no bundles are found.
* @since 1.2
*/
public Bundle[] getBundles(String symbolicName, String versionRange);
/**
* Returns an array of attached fragment bundles for the specified bundle.
* If the specified bundle is a fragment then {@code null} is returned.
* If no fragments are attached to the specified bundle then
* {@code null} is returned.
*
* This method does not attempt to resolve the specified bundle. If the
* specified bundle is not resolved then {@code null} is returned.
*
* @param bundle The bundle whose attached fragment bundles are to be
* returned.
* @return An array of fragment bundles or {@code null} if the bundle
* does not have any attached fragment bundles or the bundle is not
* resolved.
* @throws IllegalArgumentException If the specified {@code Bundle} was
* not created by the same framework instance that registered this
* {@code PackageAdmin} service.
* @since 1.2
*/
public Bundle[] getFragments(Bundle bundle);
/**
* Returns the host bundles to which the specified fragment bundle is
* attached.
*
* @param bundle The fragment bundle whose host bundles are to be returned.
* @return An array containing the host bundles to which the specified
* fragment is attached or {@code null} if the specified bundle
* is not a fragment or is not attached to any host bundles.
* @throws IllegalArgumentException If the specified {@code Bundle} was
* not created by the same framework instance that registered this
* {@code PackageAdmin} service.
* @since 1.2
*/
public Bundle[] getHosts(Bundle bundle);
/**
* Returns the bundle from which the specified class is loaded. The class
* loader of the returned bundle must have been used to load the specified
* class. If the class was not loaded by a bundle class loader then
* {@code null} is returned.
*
* @param clazz The class object from which to locate the bundle.
* @return The bundle from which the specified class is loaded or
* {@code null} if the class was not loaded by a bundle class
* loader created by the same framework instance that registered
* this {@code PackageAdmin} service.
* @since 1.2
*/
public Bundle getBundle(Class clazz);
/**
* Bundle type indicating the bundle is a fragment bundle.
*
*
* The value of {@code BUNDLE_TYPE_FRAGMENT} is 0x00000001.
*
* @since 1.2
*/
public static final int BUNDLE_TYPE_FRAGMENT = 0x00000001;
/**
* Returns the special type of the specified bundle. The bundle type values
* are:
*
* If a bundle is not one or more of the defined types then 0x00000000 is
* returned.
*
* @param bundle The bundle for which to return the special type.
* @return The special type of the bundle.
* @throws IllegalArgumentException If the specified {@code Bundle} was
* not created by the same framework instance that registered this
* {@code PackageAdmin} service.
* @since 1.2
*/
public int getBundleType(Bundle bundle);
}
osgi-core-4.3.0/src/org/osgi/service/packageadmin/ExportedPackage.java 0000644 0001750 0001750 00000007543 11527234116 025610 0 ustar drazzib drazzib /*
* 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.service.packageadmin;
import org.osgi.framework.Bundle;
import org.osgi.framework.Version;
/**
* An exported package.
*
* Objects implementing this interface are created by the Package Admin service.
*
*
* The term exported package refers to a package that has been exported
* from a resolved bundle. This package may or may not be currently wired to
* other bundles.
*
*
* The information about an exported package provided by this object may change.
* An {@code ExportedPackage} object becomes stale if the package it
* references has been updated or removed as a result of calling
* {@code PackageAdmin.refreshPackages()}.
*
* If this object becomes stale, its {@code getName()} and
* {@code getVersion()} methods continue to return their original values,
* {@code isRemovalPending()} returns {@code true}, and
* {@code getExportingBundle()} and {@code getImportingBundles()}
* return {@code null}.
*
* @ThreadSafe
* @noimplement
* @deprecated The PackageAdmin service has been replaced by the
*
* Bundles which require the exporting bundle associated with this exported
* package are considered to be wired to this exported package are included
* in the returned array. See {@link RequiredBundle#getRequiringBundles()}.
*
* @return The array of resolved bundles currently wired to this exported
* package, or {@code null} if this
* {@code ExportedPackage} object has become stale. The array
* will be empty if no bundles are wired to this exported package.
*/
public Bundle[] getImportingBundles();
/**
* Returns the version of this exported package.
*
* @return The version of this exported package, or {@code null} if
* no version information is available.
* @deprecated As of 1.2, replaced by {@link #getVersion}.
*/
public String getSpecificationVersion();
/**
* Returns the version of this exported package.
*
* @return The version of this exported package, or
* {@link Version#emptyVersion} if no version information is
* available.
* @since 1.2
*/
public Version getVersion();
/**
* Returns {@code true} if the package associated with this
* {@code ExportedPackage} object has been exported by a bundle that
* has been updated or uninstalled.
*
* @return {@code true} if the associated package is being exported
* by a bundle that has been updated or uninstalled, or if this
* {@code ExportedPackage} object has become stale;
* {@code false} otherwise.
*/
public boolean isRemovalPending();
}
osgi-core-4.3.0/src/org/osgi/service/packageadmin/packageinfo 0000644 0001750 0001750 00000000014 11527234116 024053 0 ustar drazzib drazzib version 1.2
osgi-core-4.3.0/src/org/osgi/service/url/ 0000755 0001750 0001750 00000000000 11527234164 020067 5 ustar drazzib drazzib osgi-core-4.3.0/src/org/osgi/service/url/package-info.java 0000644 0001750 0001750 00000002054 11527234116 023254 0 ustar drazzib drazzib /*
* 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.
*/
/**
* URL Stream and Content Handlers Package Version 1.0.
*
*
* Bundles wishing to use this package must list the package in the
* Import-Package header of the bundle's manifest.
*
*
* Example import for consumers using the API in this package:
*
* {@code Import-Package: org.osgi.service.url; version="[1.0,2.0)"}
*
* @version $Id: 5eaeb551c53ee18d53480e5c03d2b7771f3e6aea $
*/
package org.osgi.service.url;
osgi-core-4.3.0/src/org/osgi/service/url/URLStreamHandlerSetter.java 0000644 0001750 0001750 00000003514 11527234116 025235 0 ustar drazzib drazzib /*
* 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.service.url;
import java.net.URL;
/**
* Interface used by {@code URLStreamHandlerService} objects to call the
* {@code setURL} method on the proxy {@code URLStreamHandler}
* object.
*
*
* Objects of this type are passed to the
* {@link URLStreamHandlerService#parseURL} method. Invoking the
* {@code setURL} method on the {@code URLStreamHandlerSetter}
* object will invoke the {@code setURL} method on the proxy
* {@code URLStreamHandler} object that is actually registered with
* {@code java.net.URL} for the protocol.
*
* @ThreadSafe
* @version $Id: f55d4c29678503c244f56dcb2b5621b3be11cc8d $
*/
public interface URLStreamHandlerSetter {
/**
* @see "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String)"
*
* @deprecated This method is only for compatibility with handlers written
* for JDK 1.1.
*/
public void setURL(URL u, String protocol, String host, int port,
String file, String ref);
/**
* @see "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String,String,String)"
*/
public void setURL(URL u, String protocol, String host, int port,
String authority, String userInfo, String path, String query,
String ref);
}
osgi-core-4.3.0/src/org/osgi/service/url/URLConstants.java 0000644 0001750 0001750 00000003040 11527234116 023263 0 ustar drazzib drazzib /*
* 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.service.url;
/**
* Defines standard names for property keys associated with
* {@link URLStreamHandlerService} and {@code java.net.ContentHandler}
* services.
*
*
* The values associated with these keys are of type
* {@code java.lang.String[]} or {@code java.lang.String}, unless
* otherwise indicated.
*
* @noimplement
* @version $Id: 5ec8db316249f4b956fe083b986c11153d0fa8fe $
*/
public interface URLConstants {
/**
* Service property naming the protocols serviced by a
* URLStreamHandlerService. The property's value is a protocol name or an
* array of protocol names.
*/
public static final String URL_HANDLER_PROTOCOL = "url.handler.protocol";
/**
* Service property naming the MIME types serviced by a
* java.net.ContentHandler. The property's value is a MIME type or an array
* of MIME types.
*/
public static final String URL_CONTENT_MIMETYPE = "url.content.mimetype";
}
osgi-core-4.3.0/src/org/osgi/service/url/URLStreamHandlerService.java 0000644 0001750 0001750 00000005307 11527234116 025371 0 ustar drazzib drazzib /*
* 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.service.url;
import java.net.*;
/**
* Service interface with public versions of the protected
* {@code java.net.URLStreamHandler} methods.
*
* The important differences between this interface and the
* {@code URLStreamHandler} class are that the {@code setURL}
* method is absent and the {@code parseURL} method takes a
* {@link URLStreamHandlerSetter} object as the first argument. Classes
* implementing this interface must call the {@code setURL} method on the
* {@code URLStreamHandlerSetter} object received in the
* {@code parseURL} method instead of
* {@code URLStreamHandler.setURL} to avoid a
* {@code SecurityException}.
*
* @see AbstractURLStreamHandlerService
*
* @ThreadSafe
* @version $Id: 4982ef5b407669975afe2856a9702246d2d9c2ba $
*/
public interface URLStreamHandlerService {
/**
* @see "java.net.URLStreamHandler.openConnection"
*/
public URLConnection openConnection(URL u) throws java.io.IOException;
/**
* Parse a URL. This method is called by the {@code URLStreamHandler}
* proxy, instead of {@code java.net.URLStreamHandler.parseURL},
* passing a {@code URLStreamHandlerSetter} object.
*
* @param realHandler The object on which {@code setURL} must be
* invoked for this URL.
* @see "java.net.URLStreamHandler.parseURL"
*/
public void parseURL(URLStreamHandlerSetter realHandler, URL u,
String spec, int start, int limit);
/**
* @see "java.net.URLStreamHandler.toExternalForm"
*/
public String toExternalForm(URL u);
/**
* @see "java.net.URLStreamHandler.equals(URL, URL)"
*/
public boolean equals(URL u1, URL u2);
/**
* @see "java.net.URLStreamHandler.getDefaultPort"
*/
public int getDefaultPort();
/**
* @see "java.net.URLStreamHandler.getHostAddress"
*/
public InetAddress getHostAddress(URL u);
/**
* @see "java.net.URLStreamHandler.hashCode(URL)"
*/
public int hashCode(URL u);
/**
* @see "java.net.URLStreamHandler.hostsEqual"
*/
public boolean hostsEqual(URL u1, URL u2);
/**
* @see "java.net.URLStreamHandler.sameFile"
*/
public boolean sameFile(URL u1, URL u2);
}
osgi-core-4.3.0/src/org/osgi/service/url/AbstractURLStreamHandlerService.java 0000644 0001750 0001750 00000010515 11527234116 027052 0 ustar drazzib drazzib /*
* 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.service.url;
import java.net.*;
/**
* Abstract implementation of the {@code URLStreamHandlerService}
* interface. All the methods simply invoke the corresponding methods on
* {@code java.net.URLStreamHandler} except for {@code parseURL}
* and {@code setURL}, which use the {@code URLStreamHandlerSetter}
* parameter. Subclasses of this abstract class should not need to override the
* {@code setURL} and {@code parseURL(URLStreamHandlerSetter,...)}
* methods.
*
* @ThreadSafe
* @version $Id: 465a0ed86f5d49b338ffc6a13bb68f60f04e54d6 $
*/
public abstract class AbstractURLStreamHandlerService extends URLStreamHandler
implements URLStreamHandlerService {
/**
* @see "java.net.URLStreamHandler.openConnection"
*/
public abstract URLConnection openConnection(URL u)
throws java.io.IOException;
/**
* The {@code URLStreamHandlerSetter} object passed to the parseURL
* method.
*/
protected volatile URLStreamHandlerSetter realHandler;
/**
* Parse a URL using the {@code URLStreamHandlerSetter} object. This
* method sets the {@code realHandler} field with the specified
* {@code URLStreamHandlerSetter} object and then calls
* {@code parseURL(URL,String,int,int)}.
*
* @param realHandler The object on which the {@code setURL} method
* must be invoked for the specified URL.
* @see "java.net.URLStreamHandler.parseURL"
*/
public void parseURL(URLStreamHandlerSetter realHandler, URL u,
String spec, int start, int limit) {
this.realHandler = realHandler;
parseURL(u, spec, start, limit);
}
/**
* This method calls {@code super.toExternalForm}.
*
* @see "java.net.URLStreamHandler.toExternalForm"
*/
public String toExternalForm(URL u) {
return super.toExternalForm(u);
}
/**
* This method calls {@code super.equals(URL,URL)}.
*
* @see "java.net.URLStreamHandler.equals(URL,URL)"
*/
public boolean equals(URL u1, URL u2) {
return super.equals(u1, u2);
}
/**
* This method calls {@code super.getDefaultPort}.
*
* @see "java.net.URLStreamHandler.getDefaultPort"
*/
public int getDefaultPort() {
return super.getDefaultPort();
}
/**
* This method calls {@code super.getHostAddress}.
*
* @see "java.net.URLStreamHandler.getHostAddress"
*/
public InetAddress getHostAddress(URL u) {
return super.getHostAddress(u);
}
/**
* This method calls {@code super.hashCode(URL)}.
*
* @see "java.net.URLStreamHandler.hashCode(URL)"
*/
public int hashCode(URL u) {
return super.hashCode(u);
}
/**
* This method calls {@code super.hostsEqual}.
*
* @see "java.net.URLStreamHandler.hostsEqual"
*/
public boolean hostsEqual(URL u1, URL u2) {
return super.hostsEqual(u1, u2);
}
/**
* This method calls {@code super.sameFile}.
*
* @see "java.net.URLStreamHandler.sameFile"
*/
public boolean sameFile(URL u1, URL u2) {
return super.sameFile(u1, u2);
}
/**
* This method calls
* {@code realHandler.setURL(URL,String,String,int,String,String)}.
*
* @see "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String)"
* @deprecated This method is only for compatibility with handlers written
* for JDK 1.1.
*/
protected void setURL(URL u, String proto, String host, int port,
String file, String ref) {
realHandler.setURL(u, proto, host, port, file, ref);
}
/**
* This method calls
* {@code realHandler.setURL(URL,String,String,int,String,String,String,String)}.
*
* @see "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String,String,String)"
*/
protected void setURL(URL u, String proto, String host, int port,
String auth, String user, String path, String query, String ref) {
realHandler.setURL(u, proto, host, port, auth, user, path, query, ref);
}
}
osgi-core-4.3.0/src/org/osgi/service/url/packageinfo 0000644 0001750 0001750 00000000014 11527234116 022251 0 ustar drazzib drazzib version 1.0
osgi-core-4.3.0/src/org/osgi/framework/ 0000755 0001750 0001750 00000000000 11527234164 017622 5 ustar drazzib drazzib osgi-core-4.3.0/src/org/osgi/framework/BundleException.java 0000644 0001750 0001750 00000013664 11527234116 023564 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2000, 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 Framework exception used to indicate that a bundle lifecycle problem
* occurred.
*
*
* A {@code BundleException} object is created by the Framework to denote
* an exception condition in the lifecycle of a bundle.
* {@code BundleException}s should not be created by bundle developers.
* A type code is used to identify the exception type for future extendability.
*
*
* OSGi Alliance reserves the right to extend the set of types.
*
*
* This exception conforms to the general purpose exception chaining mechanism.
*
* @version $Id: 9e117ec9667b040f7752e342aa07d6c7d5bf0275 $
*/
public class BundleException extends Exception {
static final long serialVersionUID = 3571095144220455665L;
/**
* Type of bundle exception.
*
* @since 1.5
*/
private final int type;
/**
* No exception type is specified.
*
* @since 1.5
*/
public static final int UNSPECIFIED = 0;
/**
* The operation was unsupported. This type can be used anywhere a
* BundleException can be thrown.
*
* @since 1.5
*/
public static final int UNSUPPORTED_OPERATION = 1;
/**
* The operation was invalid.
*
* @since 1.5
*/
public static final int INVALID_OPERATION = 2;
/**
* The bundle manifest was in error.
*
* @since 1.5
*/
public static final int MANIFEST_ERROR = 3;
/**
* The bundle was not resolved.
*
* @since 1.5
*/
public static final int RESOLVE_ERROR = 4;
/**
* The bundle activator was in error.
*
* @since 1.5
*/
public static final int ACTIVATOR_ERROR = 5;
/**
* The operation failed due to insufficient permissions.
*
* @since 1.5
*/
public static final int SECURITY_ERROR = 6;
/**
* The operation failed to complete the requested lifecycle state change.
*
* @since 1.5
*/
public static final int STATECHANGE_ERROR = 7;
/**
* The bundle could not be resolved due to an error with the
* Bundle-NativeCode header.
*
* @since 1.5
*/
public static final int NATIVECODE_ERROR = 8;
/**
* The install or update operation failed because another already installed
* bundle has the same symbolic name and version. This exception type will
* only occur if the framework is configured to only allow a single bundle
* to be installed for a given symbolic name and version.
*
* @see Constants#FRAMEWORK_BSNVERSION
* @since 1.5
*/
public static final int DUPLICATE_BUNDLE_ERROR = 9;
/**
* The start transient operation failed because the start level of the
* bundle is greater than the current framework start level
*
* @since 1.5
*/
public static final int START_TRANSIENT_ERROR = 10;
/**
* The framework received an error while reading the input stream for a
* bundle.
*
* @since 1.6
*/
public static final int READ_ERROR = 11;
/**
* A framework hook rejected the operation.
*
* @since 1.6
*/
public static final int REJECTED_BY_HOOK = 12;
/**
* Creates a {@code BundleException} with the specified message and
* exception cause.
*
* @param msg The associated message.
* @param cause The cause of this exception.
*/
public BundleException(String msg, Throwable cause) {
this(msg, UNSPECIFIED, cause);
}
/**
* Creates a {@code BundleException} with the specified message.
*
* @param msg The message.
*/
public BundleException(String msg) {
this(msg, UNSPECIFIED);
}
/**
* Creates a {@code BundleException} with the specified message, type
* and exception cause.
*
* @param msg The associated message.
* @param type The type for this exception.
* @param cause The cause of this exception.
* @since 1.5
*/
public BundleException(String msg, int type, Throwable cause) {
super(msg, cause);
this.type = type;
}
/**
* Creates a {@code BundleException} with the specified message and
* type.
*
* @param msg The message.
* @param type The type for this exception.
* @since 1.5
*/
public BundleException(String msg, int type) {
super(msg);
this.type = type;
}
/**
* Returns the cause of this exception or {@code null} if no cause was
* specified when this exception was created.
*
*
* This method predates the general purpose exception chaining mechanism.
* The {@code getCause()} method is now the preferred means of
* obtaining this information.
*
* @return The result of calling {@code getCause()}.
*/
public Throwable getNestedException() {
return getCause();
}
/**
* Returns the cause of this exception or {@code null} if no cause was
* set.
*
* @return The cause of this exception or {@code null} if no cause was
* set.
* @since 1.3
*/
public Throwable getCause() {
return super.getCause();
}
/**
* Initializes the cause of this exception to the specified value.
*
* @param cause The cause of this exception.
* @return This exception.
* @throws IllegalArgumentException If the specified cause is this
* exception.
* @throws IllegalStateException If the cause of this exception has already
* been set.
* @since 1.3
*/
public Throwable initCause(Throwable cause) {
return super.initCause(cause);
}
/**
* Returns the type for this exception or {@code UNSPECIFIED} if the
* type was unspecified or unknown.
*
* @return The type of this exception.
* @since 1.5
*/
public int getType() {
return type;
}
}
osgi-core-4.3.0/src/org/osgi/framework/BundlePermission.java 0000644 0001750 0001750 00000042067 11527234116 023755 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2004, 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;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamField;
import java.security.BasicPermission;
import java.security.Permission;
import java.security.PermissionCollection;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
/**
* A bundle's authority to require or provide a bundle or to receive or attach
* fragments.
*
*
* A bundle symbolic name defines a unique fully qualified name. Wildcards may
* be used.
*
*
* {@code BundlePermission} has four actions: {@code provide},
* {@code require},{@code host}, and {@code fragment}. The
* {@code provide} action implies the {@code require} action.
*
* @since 1.3
* @ThreadSafe
* @version $Id: d30c9c987cc13007ed19d3a9fdd11b00739591c0 $
*/
public final class BundlePermission extends BasicPermission {
private static final long serialVersionUID = 3257846601685873716L;
/**
* The action string {@code provide}. The {@code provide} action
* implies the {@code require} action.
*/
public final static String PROVIDE = "provide";
/**
* The action string {@code require}. The {@code require} action
* is implied by the {@code provide} action.
*/
public final static String REQUIRE = "require";
/**
* The action string {@code host}.
*/
public final static String HOST = "host";
/**
* The action string {@code fragment}.
*/
public final static String FRAGMENT = "fragment";
private final static int ACTION_PROVIDE = 0x00000001;
private final static int ACTION_REQUIRE = 0x00000002;
private final static int ACTION_HOST = 0x00000004;
private final static int ACTION_FRAGMENT = 0x00000008;
private final static int ACTION_ALL = ACTION_PROVIDE
| ACTION_REQUIRE
| ACTION_HOST
| ACTION_FRAGMENT;
final static int ACTION_NONE = 0;
/**
* The actions mask.
*/
private transient int action_mask;
/**
* The actions in canonical form.
*
* @serial
*/
private volatile String actions = null;
/**
* Defines the authority to provide and/or require and or specify a host
* fragment symbolic name within the OSGi environment.
*
* Bundle Permissions are granted over all possible versions of a bundle.
*
* A bundle that needs to provide a bundle must have the appropriate
* {@code BundlePermission} for the symbolic name; a bundle that
* requires a bundle must have the appropriate {@code BundlePermssion}
* for that symbolic name; a bundle that specifies a fragment host must have
* the appropriate {@code BundlePermission} for that symbolic name.
*
* @param symbolicName The bundle symbolic name.
* @param actions {@code provide},{@code require},
* {@code host},{@code fragment} (canonical order).
*/
public BundlePermission(String symbolicName, String actions) {
this(symbolicName, parseActions(actions));
}
/**
* Package private constructor used by BundlePermissionCollection.
*
* @param symbolicName the bundle symbolic name
* @param mask the action mask
*/
BundlePermission(String symbolicName, int mask) {
super(symbolicName);
setTransients(mask);
}
/**
* Called by constructors and when deserialized.
*
* @param mask
*/
private synchronized void setTransients(int mask) {
if ((mask == ACTION_NONE) || ((mask & ACTION_ALL) != mask)) {
throw new IllegalArgumentException("invalid action string");
}
action_mask = mask;
}
/**
* Returns the current action mask.
*
* Used by the BundlePermissionCollection class.
*
* @return Current action mask.
*/
synchronized int getActionsMask() {
return action_mask;
}
/**
* Parse action string into action mask.
*
* @param actions Action string.
* @return action mask.
*/
private static int parseActions(String actions) {
boolean seencomma = false;
int mask = ACTION_NONE;
if (actions == null) {
return mask;
}
char[] a = actions.toCharArray();
int i = a.length - 1;
if (i < 0)
return mask;
while (i != -1) {
char c;
// skip whitespace
while ((i != -1)
&& ((c = a[i]) == ' ' || c == '\r' || c == '\n'
|| c == '\f' || c == '\t'))
i--;
// check for the known strings
int matchlen;
if (i >= 6 && (a[i - 6] == 'p' || a[i - 6] == 'P')
&& (a[i - 5] == 'r' || a[i - 5] == 'R')
&& (a[i - 4] == 'o' || a[i - 4] == 'O')
&& (a[i - 3] == 'v' || a[i - 3] == 'V')
&& (a[i - 2] == 'i' || a[i - 2] == 'I')
&& (a[i - 1] == 'd' || a[i - 1] == 'D')
&& (a[i] == 'e' || a[i] == 'E')) {
matchlen = 7;
mask |= ACTION_PROVIDE | ACTION_REQUIRE;
}
else
if (i >= 6 && (a[i - 6] == 'r' || a[i - 6] == 'R')
&& (a[i - 5] == 'e' || a[i - 5] == 'E')
&& (a[i - 4] == 'q' || a[i - 4] == 'Q')
&& (a[i - 3] == 'u' || a[i - 3] == 'U')
&& (a[i - 2] == 'i' || a[i - 2] == 'I')
&& (a[i - 1] == 'r' || a[i - 1] == 'R')
&& (a[i] == 'e' || a[i] == 'E')) {
matchlen = 7;
mask |= ACTION_REQUIRE;
}
else
if (i >= 3 && (a[i - 3] == 'h' || a[i - 3] == 'H')
&& (a[i - 2] == 'o' || a[i - 2] == 'O')
&& (a[i - 1] == 's' || a[i - 1] == 'S')
&& (a[i] == 't' || a[i] == 'T')) {
matchlen = 4;
mask |= ACTION_HOST;
}
else
if (i >= 7 && (a[i - 7] == 'f' || a[i - 7] == 'F')
&& (a[i - 6] == 'r' || a[i - 6] == 'R')
&& (a[i - 5] == 'a' || a[i - 5] == 'A')
&& (a[i - 4] == 'g' || a[i - 4] == 'G')
&& (a[i - 3] == 'm' || a[i - 3] == 'M')
&& (a[i - 2] == 'e' || a[i - 2] == 'E')
&& (a[i - 1] == 'n' || a[i - 1] == 'N')
&& (a[i] == 't' || a[i] == 'T')) {
matchlen = 8;
mask |= ACTION_FRAGMENT;
}
else {
// parse error
throw new IllegalArgumentException(
"invalid permission: " + actions);
}
// make sure we didn't just match the tail of a word
// like "ackbarfrequire". Also, skip to the comma.
seencomma = false;
while (i >= matchlen && !seencomma) {
switch (a[i - matchlen]) {
case ',' :
seencomma = true;
/* FALLTHROUGH */
case ' ' :
case '\r' :
case '\n' :
case '\f' :
case '\t' :
break;
default :
throw new IllegalArgumentException(
"invalid permission: " + actions);
}
i--;
}
// point i at the location of the comma minus one (or -1).
i -= matchlen;
}
if (seencomma) {
throw new IllegalArgumentException("invalid permission: " + actions);
}
return mask;
}
/**
* Determines if the specified permission is implied by this object.
*
*
* This method checks that the symbolic name of the target is implied by the
* symbolic name of this object. The list of {@code BundlePermission}
* actions must either match or allow for the list of the target object to
* imply the target {@code BundlePermission} action.
*
* The permission to provide a bundle implies the permission to require the
* named symbolic name.
*
*
* Always returns present {@code BundlePermission} actions in the
* following order: {@code provide}, {@code require},
* {@code host}, {@code fragment}.
*
* @return Canonical string representation of the {@code BundlePermission
* } actions.
*/
public String getActions() {
String result = actions;
if (result == null) {
StringBuffer sb = new StringBuffer();
boolean comma = false;
if ((action_mask & ACTION_PROVIDE) == ACTION_PROVIDE) {
sb.append(PROVIDE);
comma = true;
}
if ((action_mask & ACTION_REQUIRE) == ACTION_REQUIRE) {
if (comma)
sb.append(',');
sb.append(REQUIRE);
comma = true;
}
if ((action_mask & ACTION_HOST) == ACTION_HOST) {
if (comma)
sb.append(',');
sb.append(HOST);
comma = true;
}
if ((action_mask & ACTION_FRAGMENT) == ACTION_FRAGMENT) {
if (comma)
sb.append(',');
sb.append(FRAGMENT);
}
actions = result = sb.toString();
}
return result;
}
/**
* Returns a new {@code PermissionCollection} object suitable for
* storing {@code BundlePermission} objects.
*
* @return A new {@code PermissionCollection} object.
*/
public PermissionCollection newPermissionCollection() {
return new BundlePermissionCollection();
}
/**
* Determines the equality of two {@code BundlePermission} objects.
*
* This method checks that specified bundle has the same bundle symbolic
* name and {@code BundlePermission} actions as this
* {@code BundlePermission} object.
*
* @param obj The object to test for equality with this
* {@code BundlePermission} object.
* @return {@code true} if {@code obj} is a
* {@code BundlePermission}, and has the same bundle symbolic
* name and actions as this {@code BundlePermission} object;
* {@code false} otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof BundlePermission)) {
return false;
}
BundlePermission bp = (BundlePermission) obj;
return (getActionsMask() == bp.getActionsMask())
&& getName().equals(bp.getName());
}
/**
* Returns the hash code value for this object.
*
* @return A hash code value for this object.
*/
public int hashCode() {
int h = 31 * 17 + getName().hashCode();
h = 31 * h + getActions().hashCode();
return h;
}
/**
* WriteObject is called to save the state of the
* {@code BundlePermission} object to a stream. The actions are
* serialized, and the superclass takes care of the name.
*/
private synchronized void writeObject(java.io.ObjectOutputStream s)
throws IOException {
// Write out the actions. The superclass takes care of the name
// call getActions to make sure actions field is initialized
if (actions == null)
getActions();
s.defaultWriteObject();
}
/**
* readObject is called to restore the state of the BundlePermission from a
* stream.
*/
private synchronized void readObject(java.io.ObjectInputStream s)
throws IOException, ClassNotFoundException {
// Read in the action, then initialize the rest
s.defaultReadObject();
setTransients(parseActions(actions));
}
}
/**
* Stores a set of {@code BundlePermission} permissions.
*
* @see java.security.Permission
* @see java.security.Permissions
* @see java.security.PermissionCollection
*/
final class BundlePermissionCollection extends PermissionCollection {
private static final long serialVersionUID = 3258407326846433079L;
/**
* Table of permissions.
*
* @GuardedBy this
*/
private transient Map
* 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.
*
*
* 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.
*
*
* {@code AdminPermission} is required to modify start level information.
*
*
* 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.
*
*
* 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.
*
*
* 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.
*
*
* The Framework Start Level package can be used by management bundles to alter
* the active start level of the framework.
*
*
* Bundles wishing to use this package must list the package in the
* Import-Package header of the bundle's manifest. For example:
*
*
* 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.
*
*
* 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}.
*
*
* 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:
*
* 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:
*
* 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.
*
*
* 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.
*
*
* When a Bundle is installed via {@code BundleContext.installBundle}, it is
* assigned the initial bundle start level value.
*
*
* The default initial bundle start level value is 1 unless this method has
* been called to assign a different initial bundle start level value.
*
*
* 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);
}
osgi-core-4.3.0/src/org/osgi/framework/startlevel/BundleStartLevel.java 0000644 0001750 0001750 00000010226 11527234116 026067 0 ustar drazzib drazzib /*
* 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.
*
*
* 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.
*
*
* The bundle will be assigned the specified start level. The start level
* value assigned to the bundle will be persistently recorded by the
* Framework.
*
* 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.
*
* 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.
*
* 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.
*
* 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();
}
osgi-core-4.3.0/src/org/osgi/framework/package-info.java 0000644 0001750 0001750 00000002022 11527234116 023002 0 ustar drazzib drazzib /*
* 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.
*
*
* Bundles wishing to use this package must list the package in the
* Import-Package header of the bundle's manifest.
*
*
* Example import for consumers using the API in this package:
*
* {@code Import-Package: org.osgi.framework; version="[1.6,2.0)"}
*
* @version $Id: d5e6bdc8efa522dd450cb631b0a13e1157e4a104 $
*/
package org.osgi.framework;
osgi-core-4.3.0/src/org/osgi/framework/CapabilityPermission.java 0000644 0001750 0001750 00000056430 11527234116 024624 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2000, 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;
import java.io.IOException;
import java.io.NotSerializableException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamField;
import java.security.AccessController;
import java.security.BasicPermission;
import java.security.Permission;
import java.security.PermissionCollection;
import java.security.PrivilegedAction;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* A bundle's authority to provide or require a capability.
*
* The name is specified as a dot-separated string. Wildcards may be used.
*
*
* There are two possible actions: {@code require} and {@code provide}. The
* {@code require} permission allows the owner of this permission to require
* a capability matching the attributes. The {@code provide} permission
* allows the bundle to provide a capability in the specified capability
* name space.
*
* @param name The capability name space or a filter over the attributes.
* @param actions {@code require},{@code provide} (canonical order)
* @throws IllegalArgumentException If the specified name is a filter
* expression and either the specified action is not {@code require}
* or the filter has an invalid syntax.
*/
public CapabilityPermission(String name, String actions) {
this(name, parseActions(actions));
if ((this.filter != null)
&& ((action_mask & ACTION_ALL) != ACTION_REQUIRE)) {
throw new IllegalArgumentException(
"invalid action string for filter expression");
}
}
/**
* Creates a new requested {@code CapabilityPermission} object to be used by
* code that must perform {@code checkPermission} for the {@code require}
* action. {@code CapabilityPermission} objects created with this
* constructor cannot be added to a {@code CapabilityPermission} permission
* collection.
*
* @param namespace The requested capability name space.
* @param attributes The requested capability attributes.
* @param providingBundle The bundle providing the requested capability.
* @param actions The action {@code require}.
* @throws IllegalArgumentException If the specified action is not
* {@code require} or attributes or providingBundle are {@code null}
* .
*/
public CapabilityPermission(String namespace, Map
*
* @param signers The signers for which to return an Access Control Context.
* @return An {@code AccessControlContext} that has the Permissions
* associated with the signer.
*/
AccessControlContext getAccessControlContext(String[] signers);
/**
* Creates a new update for the Conditional Permission Table. The update is
* a working copy of the current Conditional Permission Table. If the
* running Conditional Permission Table is modified before commit is called
* on the returned update, then the call to commit on the returned update
* will fail. That is, the commit method will return false and no change
* will be made to the running Conditional Permission Table. There is no
* requirement that commit is eventually called on the returned update.
*
* @return A new update for the Conditional Permission Table.
* @since 1.1
*/
ConditionalPermissionUpdate newConditionalPermissionUpdate();
/**
* Creates a new ConditionalPermissionInfo with the specified fields
* suitable for insertion into a {@link ConditionalPermissionUpdate}. The
* {@code delete} method on {@code ConditionalPermissionInfo}
* objects created with this method must throw
* UnsupportedOperationException.
*
* @param name The name of the created
* {@code ConditionalPermissionInfo} or {@code null} to
* have a unique name generated when the returned
* {@code ConditionalPermissionInfo} is committed in an update
* to the Conditional Permission Table.
* @param conditions The conditions that need to be satisfied to enable the
* specified permissions. This argument can be {@code null} or
* an empty array indicating the specified permissions are not
* guarded by any conditions.
* @param permissions The permissions that are enabled when the specified
* conditions, if any, are satisfied. This argument must not be
* {@code null} and must specify at least one permission.
* @param access Access decision. Must be one of the following values:
*
*
* The specified access decision value must be evaluated case
* insensitively.
* @return A {@code ConditionalPermissionInfo} object suitable for
* insertion into a {@link ConditionalPermissionUpdate}.
* @throws IllegalArgumentException If no permissions are specified or if
* the specified access decision is not a valid value.
* @since 1.1
*/
ConditionalPermissionInfo newConditionalPermissionInfo(String name,
ConditionInfo conditions[], PermissionInfo permissions[],
String access);
/**
* Creates a new {@code ConditionalPermissionInfo} from the specified
* encoded {@code ConditionalPermissionInfo} string suitable for
* insertion into a {@link ConditionalPermissionUpdate}. The
* {@code delete} method on {@code ConditionalPermissionInfo}
* objects created with this method must throw
* UnsupportedOperationException.
*
* @param encodedConditionalPermissionInfo The encoded
* {@code ConditionalPermissionInfo}. White space in the encoded
* {@code ConditionalPermissionInfo} is ignored. The access
* decision value in the encoded
* {@code ConditionalPermissionInfo} must be evaluated case
* insensitively. If the encoded
* {@code ConditionalPermissionInfo} does not contain the
* optional name, {@code null} must be used for the name and a
* unique name will be generated when the returned
* {@code ConditionalPermissionInfo} is committed in an update
* to the Conditional Permission Table.
* @return A {@code ConditionalPermissionInfo} object suitable for
* insertion into a {@link ConditionalPermissionUpdate}.
* @throws IllegalArgumentException If the specified
* {@code encodedConditionalPermissionInfo} is not properly
* formatted.
* @see ConditionalPermissionInfo#getEncoded
* @since 1.1
*/
ConditionalPermissionInfo newConditionalPermissionInfo(
String encodedConditionalPermissionInfo);
}
osgi-core-4.3.0/src/org/osgi/service/condpermadmin/Condition.java 0000644 0001750 0001750 00000011734 11527234116 024701 0 ustar drazzib drazzib /*
* Copyright (c) OSGi Alliance (2004, 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.util.Dictionary;
/**
* The interface implemented by a Condition. Conditions are bound to Permissions
* using Conditional Permission Info. The Permissions of a ConditionalPermission
* Info can only be used if the associated Conditions are satisfied.
*
* @ThreadSafe
* @version $Id: 7e80cf578718db713c347568e7d3232010beac0a $
*/
public interface Condition {
/**
* A Condition object that will always evaluate to true and that is never
* postponed.
*/
public final static Condition TRUE = new BooleanCondition(true);
/**
* A Condition object that will always evaluate to false and that is never
* postponed.
*/
public final static Condition FALSE = new BooleanCondition(false);
/**
* Returns whether the evaluation must be postponed until the end of the
* permission check. If this method returns {@code false} (or this
* Condition is immutable), then this Condition must be able to directly
* answer the {@link #isSatisfied()} method. In other words, isSatisfied()
* will return very quickly since no external sources, such as for example
* users or networks, need to be consulted.
* This method must always return the same value whenever it is called so
* that the Conditional Permission Admin can cache its result.
*
* @return {@code true} to indicate the evaluation must be postponed.
* Otherwise, {@code false} if the evaluation can be performed
* immediately.
*/
boolean isPostponed();
/**
* Returns whether the Condition is satisfied. This method is only called
* for immediate Condition objects or immutable postponed conditions, and
* must always be called inside a permission check. Mutable postponed
* Condition objects will be called with the grouped version
* {@link #isSatisfied(Condition[],Dictionary)} at the end of the permission
* check.
*
* @return {@code true} to indicate the Conditions is satisfied.
* Otherwise, {@code false} if the Condition is not satisfied.
*/
boolean isSatisfied();
/**
* Returns whether the Condition is mutable. A Condition can go from mutable
* ({@code true}) to immutable ({@code false}) over time but never
* from immutable ({@code false}) to mutable ({@code true}).
*
* @return {@code true} {@link #isSatisfied()} can change. Otherwise,
* {@code false} if the value returned by
* {@link #isSatisfied()} will not change for this condition.
*/
boolean isMutable();
/**
* Returns whether the specified set of Condition objects are satisfied.
* Although this method is not static, it must be implemented as if it
* were static. All of the passed Condition objects will be of the same
* type and will correspond to the class type of the object on which this
* method is invoked. This method must be called inside a permission check
* only.
*
* @param conditions The array of Condition objects, which must all be of
* the same class and mutable. The receiver must be one of those
* Condition objects.
* @param context A Dictionary object that implementors can use to track
* state. If this method is invoked multiple times in the same
* permission check, the same Dictionary will be passed multiple
* times. The SecurityManager treats this Dictionary as an opaque
* object and simply creates an empty dictionary and passes it to
* subsequent invocations if multiple invocations are needed.
* @return {@code true} if all the Condition objects are satisfied.
* Otherwise, {@code false} if one of the Condition objects is
* not satisfied.
*/
boolean isSatisfied(Condition conditions[],
Dictionary
*
*
* @Immutable
* @version $Id: dd1d84aa3175b2a2dfec879d04c93887f05161be $
*/
public class ConditionInfo {
private final String type;
private final String[] args;
/**
* Constructs a {@code ConditionInfo} from the specified type and args.
*
* @param type The fully qualified class name of the Condition represented
* by this {@code ConditionInfo}.
* @param args The arguments for the Condition. These arguments are
* available to the newly created Condition by calling the
* {@link #getArgs()} method.
* @throws NullPointerException If {@code type} is {@code null}.
*/
public ConditionInfo(String type, String[] args) {
this.type = type;
this.args = (args != null) ? args.clone() : new String[0];
if (type == null) {
throw new NullPointerException("type is null");
}
}
/**
* Constructs a {@code ConditionInfo} object from the specified encoded
* {@code ConditionInfo} string. White space in the encoded
* {@code ConditionInfo} string is ignored.
*
* @param encodedCondition The encoded {@code ConditionInfo}.
* @see #getEncoded
* @throws IllegalArgumentException If the specified
* {@code encodedCondition} is not properly formatted.
*/
public ConditionInfo(String encodedCondition) {
if (encodedCondition == null) {
throw new NullPointerException("missing encoded condition");
}
if (encodedCondition.length() == 0) {
throw new IllegalArgumentException("empty encoded condition");
}
try {
char[] encoded = encodedCondition.toCharArray();
int length = encoded.length;
int pos = 0;
/* skip whitespace */
while (Character.isWhitespace(encoded[pos])) {
pos++;
}
/* the first character must be '[' */
if (encoded[pos] != '[') {
throw new IllegalArgumentException("expecting open bracket");
}
pos++;
/* skip whitespace */
while (Character.isWhitespace(encoded[pos])) {
pos++;
}
/* type is not quoted or encoded */
int begin = pos;
while (!Character.isWhitespace(encoded[pos])
&& (encoded[pos] != ']')) {
pos++;
}
if (pos == begin || encoded[begin] == '"') {
throw new IllegalArgumentException("expecting type");
}
this.type = new String(encoded, begin, pos - begin);
/* skip whitespace */
while (Character.isWhitespace(encoded[pos])) {
pos++;
}
/* type may be followed by args which are quoted and encoded */
List
* [type "arg0" "arg1" ...]
*
*
* where argN are strings that must be encoded for proper parsing.
* Specifically, the {@code "}, {@code \}, carriage return,
* and line feed characters must be escaped using {@code \"},
* {@code \\}, {@code \r}, and {@code \n}, respectively.
*
*
*
* @since 1.1
*/
String getAccessDecision();
/**
* Returns the string encoding of this {@code ConditionalPermissionInfo} in
* a form suitable for restoring this {@code ConditionalPermissionInfo}.
*
*
* access {conditions permissions} name
*
*
* where access is the access decision, conditions is zero or
* more {@link ConditionInfo#getEncoded() encoded conditions},
* permissions is one or more {@link PermissionInfo#getEncoded()
* encoded permissions} and name is the name of the
* {@code ConditionalPermissionInfo}.
*
* {
* and between } and name, if name is present.
* All encoded conditions and permissions are separated by a single space
* character.
*
* @return The string encoding of this {@code ConditionalPermissionInfo}.
* @since 1.1
*/
String getEncoded();
/**
* Returns the string representation of this
* {@code ConditionalPermissionInfo}. The string is created by calling
* the {@code getEncoded} method on this
* {@code ConditionalPermissionInfo}.
*
* @return The string representation of this
* {@code ConditionalPermissionInfo}.
* @since 1.1
*/
String toString();
/**
* Determines the equality of two {@code ConditionalPermissionInfo}
* objects.
*
* This method checks that specified object has the same access decision,
* conditions, permissions and name as this
* {@code ConditionalPermissionInfo} object.
*
* @param obj The object to test for equality with this
* {@code ConditionalPermissionInfo} object.
* @return {@code true} if {@code obj} is a
* {@code ConditionalPermissionInfo}, and has the same access
* decision, conditions, permissions and name as this
* {@code ConditionalPermissionInfo} object; {@code false}
* otherwise.
* @since 1.1
*/
boolean equals(Object obj);
/**
* Returns the hash code value for this object.
*
* @return A hash code value for this object.
* @since 1.1
*/
int hashCode();
}
osgi-core-4.3.0/src/org/osgi/service/packageadmin/ 0000755 0001750 0001750 00000000000 11527234164 021671 5 ustar drazzib drazzib osgi-core-4.3.0/src/org/osgi/service/packageadmin/package-info.java 0000644 0001750 0001750 00000002274 11527234116 025062 0 ustar drazzib drazzib /*
* 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 Admin Package Version 1.2.
*
* org.osgi.framework.wiring package.
* @version $Id: 1606b0422cae6769b7eedc2d565df61841da1e22 $
*/
public interface RequiredBundle {
/**
* Returns the symbolic name of this required bundle.
*
* @return The symbolic name of this required bundle.
*/
public String getSymbolicName();
/**
* Returns the bundle associated with this required bundle.
*
* @return The bundle, or {@code null} if this
* {@code RequiredBundle} object has become stale.
*/
public Bundle getBundle();
/**
* Returns the bundles that currently require this required bundle.
*
* org.osgi.framework.wiring package.
* @see org.osgi.service.packageadmin.ExportedPackage
* @see org.osgi.service.packageadmin.RequiredBundle
*/
public interface PackageAdmin {
/**
* Gets the exported packages for the specified bundle.
*
* @param bundle The bundle whose exported packages are to be returned, or
* {@code null} if all exported packages are to be returned. If
* the specified bundle is the system bundle (that is, the bundle
* with id zero), this method returns all the packages known to be
* exported by the system bundle. This will include the package
* specified by the {@code org.osgi.framework.system.packages}
* system property as well as any other package exported by the
* framework implementation.
*
* @return An array of exported packages, or {@code null} if the
* specified bundle has no exported packages.
* @throws IllegalArgumentException If the specified {@code Bundle} was
* not created by the same framework instance that registered this
* {@code PackageAdmin} service.
*/
public ExportedPackage[] getExportedPackages(Bundle bundle);
/**
* Gets the exported packages for the specified package name.
*
* @param name The name of the exported packages to be returned.
*
* @return An array of the exported packages, or {@code null} if no
* exported packages with the specified name exists.
* @since 1.2
*/
public ExportedPackage[] getExportedPackages(String name);
/**
* Gets the exported package for the specified package name.
*
*
*
*
*
*
*
* A bundle may be more than one type at a time. A type code is used to
* identify the bundle type for future extendability.
*
* org.osgi.framework.wiring package.
* @version $Id: c56b99465e3f62a9808297a47de8cb7edb802119 $
*/
public interface ExportedPackage {
/**
* Returns the name of the package associated with this exported package.
*
* @return The name of this exported package.
*/
public String getName();
/**
* Returns the bundle exporting the package associated with this exported
* package.
*
* @return The exporting bundle, or {@code null} if this
* {@code ExportedPackage} object has become stale.
*/
public Bundle getExportingBundle();
/**
* Returns the resolved bundles that are currently wired to this exported
* package.
*
*
* name ::= <symbolic name> | <symbolic name ending in ".*"> | *
*
*
* Examples:
*
*
* org.osgi.example.bundle
* org.osgi.example.*
* *
*
*
*
* x.y.*,"provide" -> x.y.z,"provide" is true
* *,"require" -> x.y, "require" is true
* *,"provide" -> x.y, "require" is true
* x.y,"provide" -> x.y.z, "provide" is false
*
*
* @param p The requested permission.
* @return {@code true} if the specified {@code BundlePermission}
* action is implied by this object; {@code false} otherwise.
*/
public boolean implies(Permission p) {
if (!(p instanceof BundlePermission)) {
return false;
}
BundlePermission requested = (BundlePermission) p;
final int effective = getActionsMask();
final int desired = requested.getActionsMask();
return ((effective & desired) == desired)
&& super.implies(requested);
}
/**
* Returns the canonical string representation of the
* {@code BundlePermission} actions.
*
*
* Import-Package: org.osgi.framework.startlevel; version="[1.0,2.0)"
*
*
* @version $Id: 270a001c55674ef419794fa4574472b09130af9e $
*/
package org.osgi.framework.startlevel;
osgi-core-4.3.0/src/org/osgi/framework/startlevel/packageinfo 0000644 0001750 0001750 00000000014 11527234116 024171 0 ustar drazzib drazzib version 1.0
osgi-core-4.3.0/src/org/osgi/framework/startlevel/FrameworkStartLevel.java 0000644 0001750 0001750 00000015367 11527234116 026626 0 ustar drazzib drazzib /*
* 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.
*
*
*
* 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.
*
*
*
* 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.
*
*
*
*
* @ThreadSafe
* @version $Id: bab1ac06b46613f6cff39b291295d8b3e51d58ce $
* @since 1.6
*/
public final class CapabilityPermission extends BasicPermission {
static final long serialVersionUID = -7662148639076511574L;
/**
* The action string {@code require}.
*/
public final static String REQUIRE = "require";
/**
* The action string {@code provide}.
*/
public final static String PROVIDE = "provide";
private final static int ACTION_REQUIRE = 0x00000001;
private final static int ACTION_PROVIDE = 0x00000002;
private final static int ACTION_ALL = ACTION_REQUIRE
| ACTION_PROVIDE;
final static int ACTION_NONE = 0;
/**
* The actions mask.
*/
transient int action_mask;
/**
* The actions in canonical form.
*
* @serial
*/
private volatile String actions = null;
/**
* The attributes of the requested capability. Must be null if not
* constructed with attributes.
*/
transient final Map
* name ::= <namespace> | <namespace ending in ".*"> | *
*
*
* Examples:
*
*
* com.acme.capability.*
* org.foo.capability
* *
*
*
* For the {@code require} action, the name can also be a filter expression.
* The filter gives access to the capability attributes as well as the
* following attributes:
*
*
* Since the above attribute names may conflict with attribute names of a
* capability, you can prefix an attribute name with '@' in the filter
* expression to match against the capability attributes and not one of the
* above attributes. Filter attribute names are processed in a case
* sensitive manner.
*
*