* Action Methods * class Bundle.loadClass * execute Bundle.start * Bundle.stop * StartLevel.setBundleStartLevel * extensionLifecycle BundleContext.installBundle for extension bundles * Bundle.update for extension bundles * Bundle.uninstall for extension bundles * lifecycle BundleContext.installBundle * Bundle.update * Bundle.uninstall * listener BundleContext.addBundleListener for SynchronousBundleListener * BundleContext.removeBundleListener for SynchronousBundleListener * metadata Bundle.getHeaders * Bundle.getLocation * resolve PackageAdmin.refreshPackages * PackageAdmin.resolveBundles * resource Bundle.getResource * Bundle.getResources * Bundle.getEntry * Bundle.getEntryPaths * Bundle.findEntries * Bundle resource/entry URL creation * startlevel StartLevel.setStartLevel * StartLevel.setInitialBundleStartLevel * context Bundle.getBundleContext * ** *
* The special action "*" will represent all actions. *
* The name of this permission is a filter expression. The filter gives access * to the following parameters: *
class (Value is "class").
* @since 1.3
*/
public final static String CLASS = "class";
/**
* The action string execute (Value is "execute").
* @since 1.3
*/
public final static String EXECUTE = "execute";
/**
* The action string extensionLifecycle (Value is
* "extensionLifecycle").
* @since 1.3
*/
public final static String EXTENSIONLIFECYCLE = "extensionLifecycle";
/**
* The action string lifecycle (Value is "lifecycle").
* @since 1.3
*/
public final static String LIFECYCLE = "lifecycle";
/**
* The action string listener (Value is "listener").
* @since 1.3
*/
public final static String LISTENER = "listener";
/**
* The action string metadata (Value is "metadata").
* @since 1.3
*/
public final static String METADATA = "metadata";
/**
* The action string resolve (Value is "resolve").
* @since 1.3
*/
public final static String RESOLVE = "resolve";
/**
* The action string resource (Value is "resource").
* @since 1.3
*/
public final static String RESOURCE = "resource";
/**
* The action string startlevel (Value is "startlevel").
* @since 1.3
*/
public final static String STARTLEVEL = "startlevel";
/**
* The action string context (Value is "context").
* @since 1.4
*/
public final static String CONTEXT = "context";
/*
* NOTE: A framework implementor may also choose to replace this class in
* their distribution with a class that directly interfaces with the
* framework implementation. This replacement class MUST NOT
* alter the public/protected signature of this class.
*/
/*
* This class will load the AdminPermission class in the package named by
* the org.osgi.vendor.framework package. For each instance of this class,
* an instance of the vendor AdminPermission class will be created and this
* class will delegate method calls to the vendor AdminPermission instance.
*/
private static class ImplHolder {
private static final String packageProperty = "org.osgi.vendor.framework";
static final Constructor initStringString;
static final Constructor initBundleString;
static {
Constructor[] constructors = run();
initStringString = constructors[0];
initBundleString = constructors[1];
}
private ImplHolder() {
}
public static Constructor[] run() {
String packageName = System
.getProperty(packageProperty);
if (packageName == null) {
throw new NoClassDefFoundError(packageProperty
+ " property not set");
}
Class delegateClass;
try {
delegateClass = Class.forName(packageName
+ ".AdminPermission");
}
catch (ClassNotFoundException e) {
throw new NoClassDefFoundError(e.toString());
}
Constructor[] result = new Constructor[2];
try {
result[0] = delegateClass
.getConstructor(new Class[] {String.class,
String.class });
result[1] = delegateClass
.getConstructor(new Class[] {Bundle.class,
String.class });
}
catch (NoSuchMethodException e) {
throw new NoSuchMethodError(e.toString());
}
return result;
}
}
/*
* This is the delegate permission created by the constructor.
*/
private final Permission delegate;
/**
* Creates a new AdminPermission object that matches all
* bundles and has all actions. Equivalent to AdminPermission("*","*");
*/
public AdminPermission() {
this("*", "*"); //$NON-NLS-1$
}
/**
* Create a new AdminPermission.
*
* This constructor must only be used to create a permission that is going
* to be checked.
* * Examples: * *
* (signer=\*,o=ACME,c=US) * (&(signer=\*,o=ACME,c=US)(name=com.acme.*)(location=http://www.acme.com/bundles/*)) * (id>=1) ** *
* When a signer key is used within the filter expression the signer value * must escape the special filter chars ('*', '(', ')'). *
* Null arguments are equivalent to "*".
*
* @param filter A filter expression that can use signer, location, id, and
* name keys. A value of "*" or null matches
* all bundle.
* @param actions class, execute,
* extensionLifecycle, lifecycle,
* listener, metadata,
* resolve, resource,
* startlevel or context. A value of "*" or null
* indicates all actions
*/
public AdminPermission(String filter, String actions) {
// arguments will be null if called from a PermissionInfo defined with
// no args
super(filter == null ? "*" : filter);
try {
try {
delegate = (Permission) ImplHolder.initStringString
.newInstance(new Object[] {filter, actions});
}
catch (InvocationTargetException e) {
throw e.getTargetException();
}
}
catch (Error e) {
throw e;
}
catch (RuntimeException e) {
throw e;
}
catch (Throwable e) {
throw new RuntimeException(e.toString());
}
}
/**
* Creates a new AdminPermission object to be used by the
* code that must check a Permission object.
*
* @param bundle A bundle
* @param actions class, execute,
* extensionLifecycle, lifecycle,
* listener, metadata,
* resolve, resource,
* startlevel, context.
* @since 1.3
*/
public AdminPermission(Bundle bundle, String actions) {
super(createName(bundle));
try {
try {
delegate = (Permission) ImplHolder.initBundleString
.newInstance(new Object[] {bundle, actions});
}
catch (InvocationTargetException e) {
throw e.getTargetException();
}
}
catch (Error e) {
throw e;
}
catch (RuntimeException e) {
throw e;
}
catch (Throwable e) {
throw new RuntimeException(e.toString());
}
}
/**
* Create a permission name from a Bundle
*
* @param bundle Bundle to use to create permission name.
* @return permission name.
*/
private static String createName(Bundle bundle) {
StringBuffer sb = new StringBuffer();
sb.append("(id=");
sb.append(bundle.getBundleId());
sb.append(")");
return sb.toString();
}
/**
* Determines the equality of two AdminPermission objects.
*
* @param obj The object being compared for equality with this object.
* @return true if obj is equivalent to this
* AdminPermission; false otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof AdminPermission)) {
return false;
}
AdminPermission p = (AdminPermission) obj;
return delegate.equals(p.delegate);
}
/**
* Returns the hash code value for this object.
*
* @return Hash code value for this object.
*/
public int hashCode() {
return delegate.hashCode();
}
/**
* Returns the canonical string representation of the
* AdminPermission actions.
*
*
* Always returns present AdminPermission actions in the
* following order: class, execute,
* extensionLifecycle, lifecycle,
* listener, metadata, resolve,
* resource, startlevel, context.
*
* @return Canonical string representation of the
* AdminPermission actions.
*/
public String getActions() {
return delegate.getActions();
}
/**
* Determines if the specified permission is implied by this object. This
* method throws an exception if the specified permission was not
* constructed with a bundle.
*
*
* This method returns true if the specified permission is an
* AdminPermission AND
*
* Special case: if the specified permission was constructed with "*"
* filter, then this method returns true if this object's
* filter is "*" and this object's actions include all of the specified
* permission's actions
*
* @param p The permission to interrogate.
*
* @return true if the specified permission is implied by
* this object; false otherwise.
* @throws RuntimeException if specified permission was not constructed with
* a bundle or "*"
*/
public boolean implies(Permission p) {
if (!(p instanceof AdminPermission)) {
return false;
}
AdminPermission pp = (AdminPermission) p;
return delegate.implies(pp.delegate);
}
/**
* Returns a new PermissionCollection object suitable for
* storing AdminPermissions.
*
* @return A new PermissionCollection object.
*/
public PermissionCollection newPermissionCollection() {
return delegate.newPermissionCollection();
}
}