summaryrefslogtreecommitdiffstats
path: root/java/sca
diff options
context:
space:
mode:
authorrfeng <rfeng@13f79535-47bb-0310-9956-ffa450edef68>2009-09-15 23:24:13 +0000
committerrfeng <rfeng@13f79535-47bb-0310-9956-ffa450edef68>2009-09-15 23:24:13 +0000
commitef6050fe58ed58dd6b80c2253d24ceee6b25332d (patch)
tree8e0c8b74c8e62ca62c05c04d68fe58f09be5e1ab /java/sca
parent42476fd50abf44d0e2830cdbf65e5dcd81aaeeac (diff)
Update RemoteAdmin APIs
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@815562 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'java/sca')
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointDescription.java31
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointListener.java77
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointPermission.java1747
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ExportRegistration.java84
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ImportRegistration.java79
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminEvent.java180
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminListener.java8
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteConstants.java273
-rw-r--r--java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteServiceAdmin.java139
9 files changed, 1325 insertions, 1293 deletions
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointDescription.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointDescription.java
index 3dde0fb95d..f2cef84036 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointDescription.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointDescription.java
@@ -60,7 +60,8 @@ public class EndpointDescription implements Serializable {
* Description
*/
- public EndpointDescription(Map/* <String,Object> */properties) throws IllegalArgumentException {
+ public EndpointDescription(Map/* <String,Object> */properties)
+ throws IllegalArgumentException {
this.properties.putAll(properties);
interfaces = verifyInterfacesProperty();
@@ -74,11 +75,12 @@ public class EndpointDescription implements Serializable {
* @param ref A service reference that is exportable
* @throws IllegalArgumentException
*/
- public EndpointDescription(ServiceReference ref) throws IllegalArgumentException {
+ public EndpointDescription(ServiceReference ref)
+ throws IllegalArgumentException {
String[] keys = ref.getPropertyKeys();
for (int i = 0; i > keys.length; i++)
properties.put(keys[i], ref.getProperty(keys[i]));
-
+
interfaces = verifyInterfacesProperty();
remoteServiceId = verifyStringProperty(RemoteConstants.ENDPOINT_REMOTE_SERVICE_ID);
uri = verifyStringProperty(RemoteConstants.ENDPOINT_URI);
@@ -89,7 +91,7 @@ public class EndpointDescription implements Serializable {
* @return A list with the interface names.
* @throws IllegalArgumentException when
*/
- protected List /* <String> */verifyInterfacesProperty() {
+ protected List /* <String> */ verifyInterfacesProperty() {
List l = null;
Object objectClass = properties.get(Constants.OBJECTCLASS);
@@ -98,13 +100,16 @@ public class EndpointDescription implements Serializable {
else if (!(objectClass instanceof String[]))
throw new IllegalArgumentException("objectClass must be a String[]");
else {
- l = Collections.unmodifiableList(Arrays.asList((String[])objectClass));
+ l = Collections.unmodifiableList(Arrays
+ .asList((String[]) objectClass));
for (Iterator i = l.iterator(); i.hasNext();) {
- String interf = (String)i.next();
+ String interf = (String) i.next();
try {
getInterfaceVersion(interf);
} catch (Exception e) {
- throw new IllegalArgumentException("Improper version for interface " + interf + " caused by " + e);
+ throw new IllegalArgumentException(
+ "Improper version for interface " + interf
+ + " caused by " + e);
}
}
}
@@ -121,12 +126,14 @@ public class EndpointDescription implements Serializable {
protected String verifyStringProperty(String propName) {
Object r = properties.get(propName);
if (r == null) {
- throw new IllegalArgumentException("Required property not set: " + propName);
+ throw new IllegalArgumentException(
+ "Required property not set: " + propName);
}
if (!(r instanceof String)) {
- throw new IllegalArgumentException("Required property is not a string: " + propName);
+ throw new IllegalArgumentException(
+ "Required property is not a string: " + propName);
}
- return (String)r;
+ return (String) r;
}
/**
@@ -178,7 +185,7 @@ public class EndpointDescription implements Serializable {
* interface has no version in this Endpoint Description
*/
public Version getInterfaceVersion(String name) {
- String v = (String)properties.get("endpoint.version." + name);
+ String v = (String) properties.get("endpoint.version." + name);
if (v == null) {
return nullVersion;
} else {
@@ -289,7 +296,7 @@ public class EndpointDescription implements Serializable {
*/
public boolean equals(Object other) {
if (other instanceof EndpointDescription) {
- return getURI().equals(((EndpointDescription)other).getURI());
+ return getURI().equals(((EndpointDescription) other).getURI());
}
return false;
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointListener.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointListener.java
index 0802fea6e4..e8e8f37e4a 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointListener.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointListener.java
@@ -1,5 +1,6 @@
package org.apache.tuscany.sca.osgi.service.remoteadmin;
+
/**
* A whiteboard service that represents a listener for endpoints.
*
@@ -66,44 +67,44 @@ package org.apache.tuscany.sca.osgi.service.remoteadmin;
* @ThreadSafe
*/
public interface EndpointListener {
- /**
- * Specifies the interest of this listener with filters. This listener is
- * only interested in Endpoint Descriptions where its properties match the
- * given filter. The type of this property must be <code>String+</code>.
- */
- String ENDPOINT_LISTENER_SCOPE = "endpoint.listener.scope";
+ /**
+ * Specifies the interest of this listener with filters. This listener is
+ * only interested in Endpoint Descriptions where its properties match the
+ * given filter. The type of this property must be <code>String+</code>.
+ */
+ String ENDPOINT_LISTENER_SCOPE = "endpoint.listener.scope";
- /**
- * Register an endpoint with this listener.
- *
- * If the endpoint matches one of the filters registered with the
- * {@link #ENDPOINT_LISTENER_SCOPE} service property then this filter should
- * be given as the <code>matchedFilter</code> parameter.
- *
- * When this service is first registered or it is modified, it should
- * receive all known endpoints matching the filter.
- *
- * @param endpoint
- * The Endpoint Description to be published
- * @param matchedFilter
- * The filter from the {@link #ENDPOINT_LISTENER_SCOPE} that
- * matched the endpoint, must not be <code>null</code>.
- */
- void addEndpoint(EndpointDescription endpoint, String matchedFilter);
+ /**
+ * Register an endpoint with this listener.
+ *
+ * If the endpoint matches one of the filters registered with the
+ * {@link #ENDPOINT_LISTENER_SCOPE} service property then this filter should
+ * be given as the <code>matchedFilter</code> parameter.
+ *
+ * When this service is first registered or it is modified, it should
+ * receive all known endpoints matching the filter.
+ *
+ * @param endpoint
+ * The Endpoint Description to be published
+ * @param matchedFilter
+ * The filter from the {@link #ENDPOINT_LISTENER_SCOPE} that
+ * matched the endpoint, must not be <code>null</code>.
+ */
+ void addEndpoint(EndpointDescription endpoint, String matchedFilter);
- /**
- * Remove the registration of an endpoint.
- *
- * If an endpoint that was registered with the {@link #addEndpoint}
- * method is no longer available then this method should be called. This
- * will remove the endpoint from the listener.
- *
- * It is not necessary to remove endpoints when the service is unregistered
- * or modified in such a way that not all endpoints match the interest
- * filter anymore.
- *
- * @param endpoint
- * The Endpoint Description that is no longer valid.
- */
- void removeEndpoint(EndpointDescription endpoint);
+ /**
+ * Remove the registration of an endpoint.
+ *
+ * If an endpoint that was registered with the {@link #addEndpoint}
+ * method is no longer available then this method should be called. This
+ * will remove the endpoint from the listener.
+ *
+ * It is not necessary to remove endpoints when the service is unregistered
+ * or modified in such a way that not all endpoints match the interest
+ * filter anymore.
+ *
+ * @param endpoint
+ * The Endpoint Description that is no longer valid.
+ */
+ void removeEndpoint(EndpointDescription endpoint);
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointPermission.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointPermission.java
index 69b753fa03..f0c58d97c3 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointPermission.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/EndpointPermission.java
@@ -42,630 +42,641 @@ import org.osgi.framework.*;
*/
public final class EndpointPermission extends BasicPermission {
- static final long serialVersionUID = -7662148639076511574L;
- /**
- * The action string <code>get</code>.
- */
- public final static String EXPORT = "export";
- /**
- * The action string <code>register</code>.
- */
- public final static String IMPORT = "import";
-
- public final static String LISTENING = "listening";
-
- private final static int ACTION_EXPORT = 0x00000001;
- private final static int ACTION_IMPORT = 0x00000002;
- private final static int ACTION_ALL = ACTION_EXPORT | ACTION_IMPORT;
- 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 service used by this EndpointPermission. Must be null if not
- * constructed with a service.
- */
- transient final EndpointDescription endpoint;
-
- /**
- * The object classes for this EndpointPermission. Must be null if not
- * constructed with a service.
- */
- transient final String[] objectClass;
-
- /**
- * If this EndpointPermission was constructed with a filter, this holds a
- * Filter matching object used to evaluate the filter in implies.
- */
- transient Filter filter;
-
- /**
- * This dictionary holds the properties of the permission, used to match a
- * filter in implies. This is not initialized until necessary, and then
- * cached in this object.
- */
- private transient volatile Dictionary properties;
-
- /**
- * True if constructed with a name and the name is "*" or ends with ".*".
- */
- private transient boolean wildcard;
-
- /**
- * If constructed with a name and the name ends with ".*", this contains the
- * name without the final "*".
- */
- private transient String prefix;
-
- /**
- * Create a new EndpointPermission.
- *
- * <p>
- * The name of the service is specified as a fully qualified class name.
- * Wildcards may be used.
- *
- * <pre>
- * name ::= &lt;class name&gt; | &lt;class name ending in &quot;.*&quot;&gt; | *
- * </pre>
- *
- * Examples:
- *
- * <pre>
- * org.osgi.service.http.HttpService
- * org.osgi.service.http.*
- * *
- * </pre>
- *
- * For the <code>get</code> action, the name can also be a filter
- * expression. The filter gives access to the service properties as well as
- * the following attributes:
- * <ul>
- * <li>signer - A Distinguished Name chain used to sign the bundle
- * publishing the service. Wildcards in a DN are not matched according to
- * the filter string rules, but according to the rules defined for a DN
- * chain.</li>
- * <li>location - The location of the bundle publishing the service.</li>
- * <li>id - The bundle ID of the bundle publishing the service.</li>
- * <li>name - The symbolic name of the bundle publishing the service.</li>
- * </ul>
- * Since the above attribute names may conflict with service property names
- * used by a service, you can prefix an attribute name with '@' in the
- * filter expression to match against the service property and not one of
- * the above attributes. Filter attribute names are processed in a case
- * sensitive manner unless the attribute references a service property.
- * Service properties names are case insensitive.
- *
- * <p>
- * There are two possible actions: <code>get</code> and
- * <code>register</code>. The <code>get</code> permission allows the
- * owner of this permission to obtain a service with this name. The
- * <code>register</code> permission allows the bundle to register a
- * service under that name.
- *
- * @param name
- * The service class name
- * @param actions
- * <code>get</code>,<code>register</code> (canonical order)
- * @throws IllegalArgumentException
- * If the specified name is a filter expression and either the
- * specified action is not <code>get</code> or the filter has
- * an invalid syntax.
- */
- public EndpointPermission(String name, String actions) {
- this(name, parseActions(actions));
- if ((filter != null) && ((action_mask & ACTION_ALL) != ACTION_EXPORT)) {
- throw new IllegalArgumentException("invalid action string for filter expression");
- }
- }
-
- /**
- * Creates a new requested <code>EndpointPermission</code> object to be
- * used by code that must perform <code>checkPermission</code> for the
- * <code>get</code> action. <code>EndpointPermission</code> objects
- * created with this constructor cannot be added to a
- * <code>EndpointPermission</code> permission collection.
- *
- * @param endpoint
- * The requested service.
- * @param actions
- * The action <code>get</code>.
- * @throws IllegalArgumentException
- * If the specified action is not <code>get</code> or
- * reference is <code>null</code>.
- * @since 1.5
- */
- public EndpointPermission(EndpointDescription endpoint, String actions) {
- super(createName(endpoint));
- setTransients(null, parseActions(actions));
- this.endpoint = endpoint;
- this.objectClass = (String[])endpoint.getProperties().get(Constants.OBJECTCLASS);
- if ((action_mask & ACTION_ALL) != ACTION_EXPORT) {
- throw new IllegalArgumentException("invalid action string");
- }
- }
-
- /**
- * Create a permission name from a EndpointDescription TODO Needs work
- *
- * @param endpoint
- * EndpointDescription to use to create permission name.
- * @return permission name.
- */
- private static String createName(EndpointDescription endpoint) {
- if (endpoint == null) {
- throw new IllegalArgumentException("reference must not be null");
- }
- StringBuffer sb = new StringBuffer("(service.id=");
- // TODO sb.append(endpoint.getProperty(Constants.SERVICE_ID));
- sb.append(")");
- return sb.toString();
- }
-
- /**
- * Package private constructor used by EndpointPermissionCollection.
- *
- * @param name
- * class name
- * @param mask
- * action mask
- */
- EndpointPermission(String name, int mask) {
- super(name);
- setTransients(parseFilter(name), mask);
- this.endpoint = null;
- this.objectClass = null;
- }
-
- /**
- * Called by constructors and when deserialized.
- *
- * @param mask
- * action mask
- */
- private void setTransients(Filter f, int mask) {
- if ((mask == ACTION_NONE) || ((mask & ACTION_ALL) != mask)) {
- throw new IllegalArgumentException("invalid action string");
- }
- action_mask = mask;
- filter = f;
- if (f == null) {
- String name = getName();
- int l = name.length();
- /* if "*" or endsWith ".*" */
- wildcard = ((name.charAt(l - 1) == '*') && ((l == 1) || (name.charAt(l - 2) == '.')));
- if (wildcard && (l > 1)) {
- prefix = name.substring(0, l - 1);
- }
- }
- }
-
- /**
- * 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 >= 2 && (a[i - 2] == 'g' || a[i - 2] == 'G')
- && (a[i - 1] == 'e' || a[i - 1] == 'E')
- && (a[i] == 't' || a[i] == 'T')) {
- matchlen = 3;
- mask |= ACTION_EXPORT;
-
- } else if (i >= 7 && (a[i - 7] == 'r' || a[i - 7] == 'R')
- && (a[i - 6] == 'e' || a[i - 6] == 'E')
- && (a[i - 5] == 'g' || a[i - 5] == 'G')
- && (a[i - 4] == 'i' || a[i - 4] == 'I')
- && (a[i - 3] == 's' || a[i - 3] == 'S')
- && (a[i - 2] == 't' || a[i - 2] == 'T')
- && (a[i - 1] == 'e' || a[i - 1] == 'E')
- && (a[i] == 'r' || a[i] == 'R')) {
- matchlen = 8;
- mask |= ACTION_IMPORT;
-
- } else {
- // parse error
- throw new IllegalArgumentException("invalid permission: " + actions);
- }
-
- // make sure we didn't just match the tail of a word
- // like "ackbarfregister". 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;
- }
-
- /**
- * Parse filter string into a Filter object.
- *
- * @param filterString
- * The filter string to parse.
- * @return a Filter for this bundle. If the specified filterString is not a
- * filter expression, then <code>null</code> is returned.
- * @throws IllegalArgumentException
- * If the filter syntax is invalid.
- */
- private static Filter parseFilter(String filterString) {
- filterString = filterString.trim();
- if (filterString.charAt(0) != '(') {
- return null;
- }
-
- try {
- return FrameworkUtil.createFilter(filterString);
- } catch (InvalidSyntaxException e) {
- IllegalArgumentException iae = new IllegalArgumentException("invalid filter");
- iae.initCause(e);
- throw iae;
- }
- }
-
- /**
- * Determines if a <code>EndpointPermission</code> object "implies" the
- * specified permission.
- *
- * @param p
- * The target permission to check.
- * @return <code>true</code> if the specified permission is implied by
- * this object; <code>false</code> otherwise.
- */
- public boolean implies(Permission p) {
- if (!(p instanceof EndpointPermission)) {
- return false;
- }
- EndpointPermission requested = (EndpointPermission)p;
- if (endpoint != null) {
- return false;
- }
- // if requested permission has a filter, then it is an invalid argument
- if (requested.filter != null) {
- return false;
- }
- return implies0(requested, ACTION_NONE);
- }
-
- /**
- * Internal implies method. Used by the implies and the permission
- * collection implies methods.
- *
- * @param requested
- * The requested EndpointPermission which has already be
- * validated as a proper argument. The requested
- * EndpointPermission must not have a filter expression.
- * @param effective
- * The effective actions with which to start.
- * @return <code>true</code> if the specified permission is implied by
- * this object; <code>false</code> otherwise.
- */
- boolean implies0(EndpointPermission requested, int effective) {
- /* check actions first - much faster */
- effective |= action_mask;
- final int desired = requested.action_mask;
- if ((effective & desired) != desired) {
- return false;
- }
- /* we have name of "*" */
- if (wildcard && (prefix == null)) {
- return true;
- }
- /* if we have a filter */
- Filter f = filter;
- if (f != null) {
- return f.matchCase(requested.getProperties());
- }
- /* if requested permission not created with EndpointDescription */
- String[] requestedNames = requested.objectClass;
- if (requestedNames == null) {
- return super.implies(requested);
- }
- /* requested permission created with EndpointDescription */
- if (wildcard) {
- int pl = prefix.length();
- for (int i = 0, l = requestedNames.length; i < l; i++) {
- String requestedName = requestedNames[i];
- if ((requestedName.length() > pl) && requestedName.startsWith(prefix)) {
- return true;
- }
- }
- } else {
- String name = getName();
- for (int i = 0, l = requestedNames.length; i < l; i++) {
- if (requestedNames[i].equals(name)) {
- return true;
- }
- }
- }
- return false;
- }
-
- /**
- * Returns the canonical string representation of the actions. Always
- * returns present actions in the following order: <code>get</code>,
- * <code>register</code>.
- *
- * @return The canonical string representation of the actions.
- */
- public String getActions() {
- String result = actions;
- if (result == null) {
- StringBuffer sb = new StringBuffer();
- boolean comma = false;
-
- int mask = action_mask;
- if ((mask & ACTION_EXPORT) == ACTION_EXPORT) {
- sb.append(EXPORT);
- comma = true;
- }
-
- if ((mask & ACTION_IMPORT) == ACTION_IMPORT) {
- if (comma)
- sb.append(',');
- sb.append(IMPORT);
- }
-
- actions = result = sb.toString();
- }
-
- return result;
- }
-
- /**
- * Returns a new <code>PermissionCollection</code> object for storing
- * <code>EndpointPermission<code> objects.
- *
- * @return A new <code>PermissionCollection</code> object suitable for storing
- * <code>EndpointPermission</code> objects.
- */
- public PermissionCollection newPermissionCollection() {
- return new EndpointPermissionCollection();
- }
-
- /**
- * Determines the equality of two EndpointPermission objects.
- *
- * Checks that specified object has the same class name and action as this
- * <code>EndpointPermission</code>.
- *
- * @param obj
- * The object to test for equality.
- * @return true if obj is a <code>EndpointPermission</code>, and has the
- * same class name and actions as this
- * <code>EndpointPermission</code> object; <code>false</code>
- * otherwise.
- */
- public boolean equals(Object obj) {
- if (obj == this) {
- return true;
- }
-
- if (!(obj instanceof EndpointPermission)) {
- return false;
- }
-
- EndpointPermission sp = (EndpointPermission)obj;
-
- return (action_mask == sp.action_mask) && getName().equals(sp.getName())
- && ((endpoint == sp.endpoint) || ((endpoint != null) && (sp.endpoint != null) && endpoint
- .equals(sp.endpoint)));
- }
-
- /**
- * Returns the hash code value for this object.
- *
- * @return Hash code value for this object.
- */
- public int hashCode() {
- int h = 31 * 17 + getName().hashCode();
- h = 31 * h + getActions().hashCode();
- if (endpoint != null) {
- h = 31 * h + endpoint.hashCode();
- }
- return h;
- }
-
- /**
- * WriteObject is called to save the state of this permission 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 {
- if (endpoint != null) {
- throw new NotSerializableException("cannot serialize");
- }
- // 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 this permission 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(parseFilter(getName()), parseActions(actions));
- }
-
- /**
- * Called by <code><@link EndpointPermission#implies(Permission)></code>.
- *
- * @return a dictionary of properties for this permission.
- */
- private Dictionary/*<String,Object>*/getProperties() {
- Dictionary/*<String, Object>*/result = properties;
- if (result != null) {
- return result;
- }
- if (endpoint == null) {
- result = new Hashtable/*<String, Object>*/(1);
- if (filter == null) {
- result.put(Constants.OBJECTCLASS, new String[] {getName()});
- }
- return properties = result;
- }
- final Map props = new HashMap(4);
- // TODO needs work
- /*
- final Bundle bundle = endpoint.getBundle();
- if (bundle != null) {
- AccessController.doPrivileged(new PrivilegedAction() {
- public Object run() {
- props.put("id", new Long(bundle.getBundleId()));
- props.put("location", bundle.getLocation());
- String name = bundle.getSymbolicName();
- if (name != null) {
- props.put("name", name);
- }
- SignerProperty signer = new SignerProperty(bundle);
- if (signer.isBundleSigned()) {
- props.put("signer", signer);
- }
- return null;
- }
- });
- }
- */
- return properties = new Properties(props, endpoint);
- }
-
- private static class Properties extends Dictionary {
- private final Map properties;
- private final EndpointDescription service;
-
- Properties(Map properties, EndpointDescription service) {
- this.properties = properties;
- this.service = service;
- }
-
- public Object get(Object k) {
- if (!(k instanceof String)) {
- return null;
- }
- String key = (String)k;
- if (key.charAt(0) == '@') {
- return service.getProperties().get(key.substring(1));
- }
- Object value = properties.get(key);
- if (value != null) { // fall back to service properties
- return value;
- }
- return service.getProperties().get(key);
- }
-
- public int size() {
- return properties.size() + service.getProperties().size();
- }
-
- public boolean isEmpty() {
- // we can return false because this must never be empty
- return false;
- }
-
- public Enumeration keys() {
- Collection pk = properties.keySet();
- String spk[] =
- (String[])service.getProperties().keySet().toArray(new String[service.getProperties().size()]);
- List all = new ArrayList(pk.size() + spk.length);
- all.addAll(pk);
- add: for (int i = 0, length = spk.length; i < length; i++) {
- String key = spk[i];
- for (Iterator iter = pk.iterator(); iter.hasNext();) {
- if (key.equalsIgnoreCase((String)iter.next())) {
- continue add;
- }
- }
- all.add(key);
- }
- return Collections.enumeration(all);
- }
-
- public Enumeration elements() {
- Collection pk = properties.keySet();
- String spk[] =
- (String[])service.getProperties().keySet().toArray(new String[service.getProperties().size()]);
- List all = new ArrayList(pk.size() + spk.length);
- all.addAll(properties.values());
- add: for (int i = 0, length = spk.length; i < length; i++) {
- String key = spk[i];
- for (Iterator iter = pk.iterator(); iter.hasNext();) {
- if (key.equalsIgnoreCase((String)iter.next())) {
- continue add;
- }
- }
- all.add(service.getProperties().get(key));
- }
- return Collections.enumeration(all);
- }
-
- public Object put(Object key, Object value) {
- throw new UnsupportedOperationException();
- }
-
- public Object remove(Object key) {
- throw new UnsupportedOperationException();
- }
- }
+ static final long serialVersionUID = -7662148639076511574L;
+ /**
+ * The action string <code>get</code>.
+ */
+ public final static String EXPORT = "export";
+ /**
+ * The action string <code>register</code>.
+ */
+ public final static String IMPORT = "import";
+
+ public final static String LISTENING = "listening";
+
+ private final static int ACTION_EXPORT = 0x00000001;
+ private final static int ACTION_IMPORT = 0x00000002;
+ private final static int ACTION_ALL = ACTION_EXPORT | ACTION_IMPORT;
+ 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 service used by this EndpointPermission. Must be null if not
+ * constructed with a service.
+ */
+ transient final EndpointDescription endpoint;
+
+ /**
+ * The object classes for this EndpointPermission. Must be null if not
+ * constructed with a service.
+ */
+ transient final String[] objectClass;
+
+ /**
+ * If this EndpointPermission was constructed with a filter, this holds a
+ * Filter matching object used to evaluate the filter in implies.
+ */
+ transient Filter filter;
+
+ /**
+ * This dictionary holds the properties of the permission, used to match a
+ * filter in implies. This is not initialized until necessary, and then
+ * cached in this object.
+ */
+ private transient volatile Dictionary properties;
+
+ /**
+ * True if constructed with a name and the name is "*" or ends with ".*".
+ */
+ private transient boolean wildcard;
+
+ /**
+ * If constructed with a name and the name ends with ".*", this contains the
+ * name without the final "*".
+ */
+ private transient String prefix;
+
+ /**
+ * Create a new EndpointPermission.
+ *
+ * <p>
+ * The name of the service is specified as a fully qualified class name.
+ * Wildcards may be used.
+ *
+ * <pre>
+ * name ::= &lt;class name&gt; | &lt;class name ending in &quot;.*&quot;&gt; | *
+ * </pre>
+ *
+ * Examples:
+ *
+ * <pre>
+ * org.osgi.service.http.HttpService
+ * org.osgi.service.http.*
+ * *
+ * </pre>
+ *
+ * For the <code>get</code> action, the name can also be a filter
+ * expression. The filter gives access to the service properties as well as
+ * the following attributes:
+ * <ul>
+ * <li>signer - A Distinguished Name chain used to sign the bundle
+ * publishing the service. Wildcards in a DN are not matched according to
+ * the filter string rules, but according to the rules defined for a DN
+ * chain.</li>
+ * <li>location - The location of the bundle publishing the service.</li>
+ * <li>id - The bundle ID of the bundle publishing the service.</li>
+ * <li>name - The symbolic name of the bundle publishing the service.</li>
+ * </ul>
+ * Since the above attribute names may conflict with service property names
+ * used by a service, you can prefix an attribute name with '@' in the
+ * filter expression to match against the service property and not one of
+ * the above attributes. Filter attribute names are processed in a case
+ * sensitive manner unless the attribute references a service property.
+ * Service properties names are case insensitive.
+ *
+ * <p>
+ * There are two possible actions: <code>get</code> and
+ * <code>register</code>. The <code>get</code> permission allows the
+ * owner of this permission to obtain a service with this name. The
+ * <code>register</code> permission allows the bundle to register a
+ * service under that name.
+ *
+ * @param name
+ * The service class name
+ * @param actions
+ * <code>get</code>,<code>register</code> (canonical order)
+ * @throws IllegalArgumentException
+ * If the specified name is a filter expression and either the
+ * specified action is not <code>get</code> or the filter has
+ * an invalid syntax.
+ */
+ public EndpointPermission(String name, String actions) {
+ this(name, parseActions(actions));
+ if ((filter != null) && ((action_mask & ACTION_ALL) != ACTION_EXPORT)) {
+ throw new IllegalArgumentException(
+ "invalid action string for filter expression");
+ }
+ }
+
+ /**
+ * Creates a new requested <code>EndpointPermission</code> object to be
+ * used by code that must perform <code>checkPermission</code> for the
+ * <code>get</code> action. <code>EndpointPermission</code> objects
+ * created with this constructor cannot be added to a
+ * <code>EndpointPermission</code> permission collection.
+ *
+ * @param endpoint
+ * The requested service.
+ * @param actions
+ * The action <code>get</code>.
+ * @throws IllegalArgumentException
+ * If the specified action is not <code>get</code> or
+ * reference is <code>null</code>.
+ * @since 1.5
+ */
+ public EndpointPermission(EndpointDescription endpoint, String actions) {
+ super(createName(endpoint));
+ setTransients(null, parseActions(actions));
+ this.endpoint = endpoint;
+ this.objectClass = (String[]) endpoint.getProperties().get(
+ Constants.OBJECTCLASS);
+ if ((action_mask & ACTION_ALL) != ACTION_EXPORT) {
+ throw new IllegalArgumentException("invalid action string");
+ }
+ }
+
+ /**
+ * Create a permission name from a EndpointDescription TODO Needs work
+ *
+ * @param endpoint
+ * EndpointDescription to use to create permission name.
+ * @return permission name.
+ */
+ private static String createName(EndpointDescription endpoint) {
+ if (endpoint == null) {
+ throw new IllegalArgumentException("reference must not be null");
+ }
+ StringBuffer sb = new StringBuffer("(service.id=");
+ // TODO sb.append(endpoint.getProperty(Constants.SERVICE_ID));
+ sb.append(")");
+ return sb.toString();
+ }
+
+ /**
+ * Package private constructor used by EndpointPermissionCollection.
+ *
+ * @param name
+ * class name
+ * @param mask
+ * action mask
+ */
+ EndpointPermission(String name, int mask) {
+ super(name);
+ setTransients(parseFilter(name), mask);
+ this.endpoint = null;
+ this.objectClass = null;
+ }
+
+ /**
+ * Called by constructors and when deserialized.
+ *
+ * @param mask
+ * action mask
+ */
+ private void setTransients(Filter f, int mask) {
+ if ((mask == ACTION_NONE) || ((mask & ACTION_ALL) != mask)) {
+ throw new IllegalArgumentException("invalid action string");
+ }
+ action_mask = mask;
+ filter = f;
+ if (f == null) {
+ String name = getName();
+ int l = name.length();
+ /* if "*" or endsWith ".*" */
+ wildcard = ((name.charAt(l - 1) == '*') && ((l == 1) || (name
+ .charAt(l - 2) == '.')));
+ if (wildcard && (l > 1)) {
+ prefix = name.substring(0, l - 1);
+ }
+ }
+ }
+
+ /**
+ * 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 >= 2 && (a[i - 2] == 'g' || a[i - 2] == 'G')
+ && (a[i - 1] == 'e' || a[i - 1] == 'E')
+ && (a[i] == 't' || a[i] == 'T')) {
+ matchlen = 3;
+ mask |= ACTION_EXPORT;
+
+ } else if (i >= 7 && (a[i - 7] == 'r' || a[i - 7] == 'R')
+ && (a[i - 6] == 'e' || a[i - 6] == 'E')
+ && (a[i - 5] == 'g' || a[i - 5] == 'G')
+ && (a[i - 4] == 'i' || a[i - 4] == 'I')
+ && (a[i - 3] == 's' || a[i - 3] == 'S')
+ && (a[i - 2] == 't' || a[i - 2] == 'T')
+ && (a[i - 1] == 'e' || a[i - 1] == 'E')
+ && (a[i] == 'r' || a[i] == 'R')) {
+ matchlen = 8;
+ mask |= ACTION_IMPORT;
+
+ } else {
+ // parse error
+ throw new IllegalArgumentException("invalid permission: "
+ + actions);
+ }
+
+ // make sure we didn't just match the tail of a word
+ // like "ackbarfregister". 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;
+ }
+
+ /**
+ * Parse filter string into a Filter object.
+ *
+ * @param filterString
+ * The filter string to parse.
+ * @return a Filter for this bundle. If the specified filterString is not a
+ * filter expression, then <code>null</code> is returned.
+ * @throws IllegalArgumentException
+ * If the filter syntax is invalid.
+ */
+ private static Filter parseFilter(String filterString) {
+ filterString = filterString.trim();
+ if (filterString.charAt(0) != '(') {
+ return null;
+ }
+
+ try {
+ return FrameworkUtil.createFilter(filterString);
+ } catch (InvalidSyntaxException e) {
+ IllegalArgumentException iae = new IllegalArgumentException(
+ "invalid filter");
+ iae.initCause(e);
+ throw iae;
+ }
+ }
+
+ /**
+ * Determines if a <code>EndpointPermission</code> object "implies" the
+ * specified permission.
+ *
+ * @param p
+ * The target permission to check.
+ * @return <code>true</code> if the specified permission is implied by
+ * this object; <code>false</code> otherwise.
+ */
+ public boolean implies(Permission p) {
+ if (!(p instanceof EndpointPermission)) {
+ return false;
+ }
+ EndpointPermission requested = (EndpointPermission) p;
+ if (endpoint != null) {
+ return false;
+ }
+ // if requested permission has a filter, then it is an invalid argument
+ if (requested.filter != null) {
+ return false;
+ }
+ return implies0(requested, ACTION_NONE);
+ }
+
+ /**
+ * Internal implies method. Used by the implies and the permission
+ * collection implies methods.
+ *
+ * @param requested
+ * The requested EndpointPermission which has already be
+ * validated as a proper argument. The requested
+ * EndpointPermission must not have a filter expression.
+ * @param effective
+ * The effective actions with which to start.
+ * @return <code>true</code> if the specified permission is implied by
+ * this object; <code>false</code> otherwise.
+ */
+ boolean implies0(EndpointPermission requested, int effective) {
+ /* check actions first - much faster */
+ effective |= action_mask;
+ final int desired = requested.action_mask;
+ if ((effective & desired) != desired) {
+ return false;
+ }
+ /* we have name of "*" */
+ if (wildcard && (prefix == null)) {
+ return true;
+ }
+ /* if we have a filter */
+ Filter f = filter;
+ if (f != null) {
+ return f.matchCase(requested.getProperties());
+ }
+ /* if requested permission not created with EndpointDescription */
+ String[] requestedNames = requested.objectClass;
+ if (requestedNames == null) {
+ return super.implies(requested);
+ }
+ /* requested permission created with EndpointDescription */
+ if (wildcard) {
+ int pl = prefix.length();
+ for (int i = 0, l = requestedNames.length; i < l; i++) {
+ String requestedName = requestedNames[i];
+ if ((requestedName.length() > pl)
+ && requestedName.startsWith(prefix)) {
+ return true;
+ }
+ }
+ } else {
+ String name = getName();
+ for (int i = 0, l = requestedNames.length; i < l; i++) {
+ if (requestedNames[i].equals(name)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Returns the canonical string representation of the actions. Always
+ * returns present actions in the following order: <code>get</code>,
+ * <code>register</code>.
+ *
+ * @return The canonical string representation of the actions.
+ */
+ public String getActions() {
+ String result = actions;
+ if (result == null) {
+ StringBuffer sb = new StringBuffer();
+ boolean comma = false;
+
+ int mask = action_mask;
+ if ((mask & ACTION_EXPORT) == ACTION_EXPORT) {
+ sb.append(EXPORT);
+ comma = true;
+ }
+
+ if ((mask & ACTION_IMPORT) == ACTION_IMPORT) {
+ if (comma)
+ sb.append(',');
+ sb.append(IMPORT);
+ }
+
+ actions = result = sb.toString();
+ }
+
+ return result;
+ }
+
+ /**
+ * Returns a new <code>PermissionCollection</code> object for storing
+ * <code>EndpointPermission<code> objects.
+ *
+ * @return A new <code>PermissionCollection</code> object suitable for storing
+ * <code>EndpointPermission</code> objects.
+ */
+ public PermissionCollection newPermissionCollection() {
+ return new EndpointPermissionCollection();
+ }
+
+ /**
+ * Determines the equality of two EndpointPermission objects.
+ *
+ * Checks that specified object has the same class name and action as this
+ * <code>EndpointPermission</code>.
+ *
+ * @param obj
+ * The object to test for equality.
+ * @return true if obj is a <code>EndpointPermission</code>, and has the
+ * same class name and actions as this
+ * <code>EndpointPermission</code> object; <code>false</code>
+ * otherwise.
+ */
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (!(obj instanceof EndpointPermission)) {
+ return false;
+ }
+
+ EndpointPermission sp = (EndpointPermission) obj;
+
+ return (action_mask == sp.action_mask)
+ && getName().equals(sp.getName())
+ && ((endpoint == sp.endpoint) || ((endpoint != null)
+ && (sp.endpoint != null) && endpoint
+ .equals(sp.endpoint)));
+ }
+
+ /**
+ * Returns the hash code value for this object.
+ *
+ * @return Hash code value for this object.
+ */
+ public int hashCode() {
+ int h = 31 * 17 + getName().hashCode();
+ h = 31 * h + getActions().hashCode();
+ if (endpoint != null) {
+ h = 31 * h + endpoint.hashCode();
+ }
+ return h;
+ }
+
+ /**
+ * WriteObject is called to save the state of this permission 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 {
+ if (endpoint != null) {
+ throw new NotSerializableException("cannot serialize");
+ }
+ // 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 this permission 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(parseFilter(getName()), parseActions(actions));
+ }
+
+ /**
+ * Called by <code><@link EndpointPermission#implies(Permission)></code>.
+ *
+ * @return a dictionary of properties for this permission.
+ */
+ private Dictionary/*<String,Object>*/ getProperties() {
+ Dictionary/*<String, Object>*/ result = properties;
+ if (result != null) {
+ return result;
+ }
+ if (endpoint == null) {
+ result = new Hashtable/*<String, Object>*/(1);
+ if (filter == null) {
+ result.put(Constants.OBJECTCLASS, new String[] { getName() });
+ }
+ return properties = result;
+ }
+ final Map props = new HashMap(4);
+ // TODO needs work
+ /*
+ final Bundle bundle = endpoint.getBundle();
+ if (bundle != null) {
+ AccessController.doPrivileged(new PrivilegedAction() {
+ public Object run() {
+ props.put("id", new Long(bundle.getBundleId()));
+ props.put("location", bundle.getLocation());
+ String name = bundle.getSymbolicName();
+ if (name != null) {
+ props.put("name", name);
+ }
+ SignerProperty signer = new SignerProperty(bundle);
+ if (signer.isBundleSigned()) {
+ props.put("signer", signer);
+ }
+ return null;
+ }
+ });
+ }
+ */
+ return properties = new Properties(props, endpoint);
+ }
+
+ private static class Properties extends Dictionary {
+ private final Map properties;
+ private final EndpointDescription service;
+
+ Properties(Map properties, EndpointDescription service) {
+ this.properties = properties;
+ this.service = service;
+ }
+
+ public Object get(Object k) {
+ if (!(k instanceof String)) {
+ return null;
+ }
+ String key = (String) k;
+ if (key.charAt(0) == '@') {
+ return service.getProperties().get(key.substring(1));
+ }
+ Object value = properties.get(key);
+ if (value != null) { // fall back to service properties
+ return value;
+ }
+ return service.getProperties().get(key);
+ }
+
+ public int size() {
+ return properties.size() + service.getProperties().size();
+ }
+
+ public boolean isEmpty() {
+ // we can return false because this must never be empty
+ return false;
+ }
+
+ public Enumeration keys() {
+ Collection pk = properties.keySet();
+ String spk[] = (String[]) service.getProperties().keySet().toArray(new String[service.getProperties().size()]);
+ List all = new ArrayList(pk.size() + spk.length);
+ all.addAll(pk);
+ add: for (int i = 0, length = spk.length; i < length; i++) {
+ String key = spk[i];
+ for (Iterator iter = pk.iterator(); iter.hasNext();) {
+ if (key.equalsIgnoreCase((String) iter.next())) {
+ continue add;
+ }
+ }
+ all.add(key);
+ }
+ return Collections.enumeration(all);
+ }
+
+ public Enumeration elements() {
+ Collection pk = properties.keySet();
+ String spk[] = (String[])service.getProperties().keySet().toArray(new String[service.getProperties().size()]);
+ List all = new ArrayList(pk.size() + spk.length);
+ all.addAll(properties.values());
+ add: for (int i = 0, length = spk.length; i < length; i++) {
+ String key = spk[i];
+ for (Iterator iter = pk.iterator(); iter.hasNext();) {
+ if (key.equalsIgnoreCase((String) iter.next())) {
+ continue add;
+ }
+ }
+ all.add(service.getProperties().get(key));
+ }
+ return Collections.enumeration(all);
+ }
+
+ public Object put(Object key, Object value) {
+ throw new UnsupportedOperationException();
+ }
+
+ public Object remove(Object key) {
+ throw new UnsupportedOperationException();
+ }
+ }
}
/**
@@ -676,243 +687,253 @@ public final class EndpointPermission extends BasicPermission {
* @see java.security.PermissionCollection
*/
final class EndpointPermissionCollection extends PermissionCollection {
- static final long serialVersionUID = 662615640374640621L;
- /**
- * Table of permissions.
- *
- * @GuardedBy this
- */
- private transient Map permissions;
-
- /**
- * Boolean saying if "*" is in the collection.
- *
- * @serial
- * @GuardedBy this
- */
- private boolean all_allowed;
-
- /**
- * Table of permissions with filter expressions.
- *
- * @serial
- * @GuardedBy this
- */
- private Map filterPermissions;
-
- /**
- * Creates an empty EndpointPermissions object.
- */
- public EndpointPermissionCollection() {
- permissions = new HashMap();
- all_allowed = false;
- }
-
- /**
- * Adds a permission to this permission collection.
- *
- * @param permission
- * The Permission object to add.
- * @throws IllegalArgumentException
- * If the specified permission is not a EndpointPermission
- * object.
- * @throws SecurityException
- * If this <code>EndpointPermissionCollection</code> object
- * has been marked read-only.
- */
- public void add(final Permission permission) {
- if (!(permission instanceof EndpointPermission)) {
- throw new IllegalArgumentException("invalid permission: " + permission);
- }
- if (isReadOnly()) {
- throw new SecurityException("attempt to add a Permission to a " + "readonly PermissionCollection");
- }
-
- final EndpointPermission sp = (EndpointPermission)permission;
- if (sp.endpoint != null) {
- throw new IllegalArgumentException("cannot add to collection: " + sp);
- }
-
- final String name = sp.getName();
- final Filter f = sp.filter;
- synchronized (this) {
- /* select the bucket for the permission */
- Map pc;
- if (f != null) {
- pc = filterPermissions;
- if (pc == null) {
- filterPermissions = pc = new HashMap();
- }
- } else {
- pc = permissions;
- }
- final EndpointPermission existing = (EndpointPermission)pc.get(name);
-
- if (existing != null) {
- final int oldMask = existing.action_mask;
- final int newMask = sp.action_mask;
- if (oldMask != newMask) {
- pc.put(name, new EndpointPermission(name, oldMask | newMask));
- }
- } else {
- pc.put(name, sp);
- }
-
- if (!all_allowed) {
- if (name.equals("*")) {
- all_allowed = true;
- }
- }
- }
- }
-
- /**
- * Determines if a set of permissions implies the permissions expressed in
- * <code>permission</code>.
- *
- * @param permission
- * The Permission object to compare.
- * @return <code>true</code> if <code>permission</code> is a proper
- * subset of a permission in the set; <code>false</code>
- * otherwise.
- */
- public boolean implies(final Permission permission) {
- if (!(permission instanceof EndpointPermission)) {
- return false;
- }
- final EndpointPermission requested = (EndpointPermission)permission;
- /* if requested permission has a filter, then it is an invalid argument */
- if (requested.filter != null) {
- return false;
- }
-
- int effective = EndpointPermission.ACTION_NONE;
- Collection perms;
- synchronized (this) {
- final int desired = requested.action_mask;
- /* short circuit if the "*" Permission was added */
- if (all_allowed) {
- EndpointPermission sp = (EndpointPermission)permissions.get("*");
- if (sp != null) {
- effective |= sp.action_mask;
- if ((effective & desired) == desired) {
- return true;
- }
- }
- }
-
- String[] requestedNames = requested.objectClass;
- /* if requested permission not created with EndpointDescription */
- if (requestedNames == null) {
- effective |= effective(requested.getName(), desired, effective);
- if ((effective & desired) == desired) {
- return true;
- }
- }
- /* requested permission created with EndpointDescription */
- else {
- for (int i = 0, l = requestedNames.length; i < l; i++) {
- if ((effective(requestedNames[i], desired, effective) & desired) == desired) {
- return true;
- }
- }
- }
- Map pc = filterPermissions;
- if (pc == null) {
- return false;
- }
- perms = pc.values();
- }
-
- /* iterate one by one over filteredPermissions */
- for (Iterator iter = perms.iterator(); iter.hasNext();) {
- if (((EndpointPermission)iter.next()).implies0(requested, effective)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Consult permissions map to compute the effective permission for the
- * requested permission name.
- *
- * @param requestedName
- * The requested service name.
- * @param desired
- * The desired actions.
- * @param effective
- * The effective actions.
- * @return The new effective actions.
- */
- private int effective(String requestedName, final int desired, int effective) {
- final Map pc = permissions;
- EndpointPermission sp = (EndpointPermission)pc.get(requestedName);
- // strategy:
- // Check for full match first. Then work our way up the
- // name looking for matches on a.b.*
- if (sp != null) {
- // we have a direct hit!
- effective |= sp.action_mask;
- if ((effective & desired) == desired) {
- return effective;
- }
- }
- // work our way up the tree...
- int last;
- int offset = requestedName.length() - 1;
- while ((last = requestedName.lastIndexOf(".", offset)) != -1) {
- requestedName = requestedName.substring(0, last + 1) + "*";
- sp = (EndpointPermission)pc.get(requestedName);
- if (sp != null) {
- effective |= sp.action_mask;
- if ((effective & desired) == desired) {
- return effective;
- }
- }
- offset = last - 1;
- }
- /*
- * we don't have to check for "*" as it was already checked before we
- * were called.
- */
- return effective;
- }
-
- /**
- * Returns an enumeration of all the <code>EndpointPermission</code>
- * objects in the container.
- *
- * @return Enumeration of all the EndpointPermission objects.
- */
- public synchronized Enumeration elements() {
- List all = new ArrayList(permissions.values());
- Map pc = filterPermissions;
- if (pc != null) {
- all.addAll(pc.values());
- }
- return Collections.enumeration(all);
- }
-
- /* serialization logic */
- private static final ObjectStreamField[] serialPersistentFields =
- {new ObjectStreamField("permissions", Hashtable.class), new ObjectStreamField("all_allowed", Boolean.TYPE),
- new ObjectStreamField("filterPermissions", HashMap.class)};
-
- private synchronized void writeObject(ObjectOutputStream out) throws IOException {
- Hashtable hashtable = new Hashtable(permissions);
- ObjectOutputStream.PutField pfields = out.putFields();
- pfields.put("permissions", hashtable);
- pfields.put("all_allowed", all_allowed);
- pfields.put("filterPermissions", filterPermissions);
- out.writeFields();
- }
-
- private synchronized void readObject(java.io.ObjectInputStream in) throws IOException, ClassNotFoundException {
- ObjectInputStream.GetField gfields = in.readFields();
- Hashtable hashtable = (Hashtable)gfields.get("permissions", null);
- permissions = new HashMap(hashtable);
- all_allowed = gfields.get("all_allowed", false);
- filterPermissions = (HashMap)gfields.get("filterPermissions", null);
- }
+ static final long serialVersionUID = 662615640374640621L;
+ /**
+ * Table of permissions.
+ *
+ * @GuardedBy this
+ */
+ private transient Map permissions;
+
+ /**
+ * Boolean saying if "*" is in the collection.
+ *
+ * @serial
+ * @GuardedBy this
+ */
+ private boolean all_allowed;
+
+ /**
+ * Table of permissions with filter expressions.
+ *
+ * @serial
+ * @GuardedBy this
+ */
+ private Map filterPermissions;
+
+ /**
+ * Creates an empty EndpointPermissions object.
+ */
+ public EndpointPermissionCollection() {
+ permissions = new HashMap();
+ all_allowed = false;
+ }
+
+ /**
+ * Adds a permission to this permission collection.
+ *
+ * @param permission
+ * The Permission object to add.
+ * @throws IllegalArgumentException
+ * If the specified permission is not a EndpointPermission
+ * object.
+ * @throws SecurityException
+ * If this <code>EndpointPermissionCollection</code> object
+ * has been marked read-only.
+ */
+ public void add(final Permission permission) {
+ if (!(permission instanceof EndpointPermission)) {
+ throw new IllegalArgumentException("invalid permission: "
+ + permission);
+ }
+ if (isReadOnly()) {
+ throw new SecurityException("attempt to add a Permission to a "
+ + "readonly PermissionCollection");
+ }
+
+ final EndpointPermission sp = (EndpointPermission) permission;
+ if (sp.endpoint != null) {
+ throw new IllegalArgumentException("cannot add to collection: "
+ + sp);
+ }
+
+ final String name = sp.getName();
+ final Filter f = sp.filter;
+ synchronized (this) {
+ /* select the bucket for the permission */
+ Map pc;
+ if (f != null) {
+ pc = filterPermissions;
+ if (pc == null) {
+ filterPermissions = pc = new HashMap();
+ }
+ } else {
+ pc = permissions;
+ }
+ final EndpointPermission existing = (EndpointPermission) pc
+ .get(name);
+
+ if (existing != null) {
+ final int oldMask = existing.action_mask;
+ final int newMask = sp.action_mask;
+ if (oldMask != newMask) {
+ pc.put(name,
+ new EndpointPermission(name, oldMask | newMask));
+ }
+ } else {
+ pc.put(name, sp);
+ }
+
+ if (!all_allowed) {
+ if (name.equals("*")) {
+ all_allowed = true;
+ }
+ }
+ }
+ }
+
+ /**
+ * Determines if a set of permissions implies the permissions expressed in
+ * <code>permission</code>.
+ *
+ * @param permission
+ * The Permission object to compare.
+ * @return <code>true</code> if <code>permission</code> is a proper
+ * subset of a permission in the set; <code>false</code>
+ * otherwise.
+ */
+ public boolean implies(final Permission permission) {
+ if (!(permission instanceof EndpointPermission)) {
+ return false;
+ }
+ final EndpointPermission requested = (EndpointPermission) permission;
+ /* if requested permission has a filter, then it is an invalid argument */
+ if (requested.filter != null) {
+ return false;
+ }
+
+ int effective = EndpointPermission.ACTION_NONE;
+ Collection perms;
+ synchronized (this) {
+ final int desired = requested.action_mask;
+ /* short circuit if the "*" Permission was added */
+ if (all_allowed) {
+ EndpointPermission sp = (EndpointPermission) permissions
+ .get("*");
+ if (sp != null) {
+ effective |= sp.action_mask;
+ if ((effective & desired) == desired) {
+ return true;
+ }
+ }
+ }
+
+ String[] requestedNames = requested.objectClass;
+ /* if requested permission not created with EndpointDescription */
+ if (requestedNames == null) {
+ effective |= effective(requested.getName(), desired, effective);
+ if ((effective & desired) == desired) {
+ return true;
+ }
+ }
+ /* requested permission created with EndpointDescription */
+ else {
+ for (int i = 0, l = requestedNames.length; i < l; i++) {
+ if ((effective(requestedNames[i], desired, effective) & desired) == desired) {
+ return true;
+ }
+ }
+ }
+ Map pc = filterPermissions;
+ if (pc == null) {
+ return false;
+ }
+ perms = pc.values();
+ }
+
+ /* iterate one by one over filteredPermissions */
+ for (Iterator iter = perms.iterator(); iter.hasNext();) {
+ if (((EndpointPermission) iter.next()).implies0(requested,
+ effective)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Consult permissions map to compute the effective permission for the
+ * requested permission name.
+ *
+ * @param requestedName
+ * The requested service name.
+ * @param desired
+ * The desired actions.
+ * @param effective
+ * The effective actions.
+ * @return The new effective actions.
+ */
+ private int effective(String requestedName, final int desired, int effective) {
+ final Map pc = permissions;
+ EndpointPermission sp = (EndpointPermission) pc.get(requestedName);
+ // strategy:
+ // Check for full match first. Then work our way up the
+ // name looking for matches on a.b.*
+ if (sp != null) {
+ // we have a direct hit!
+ effective |= sp.action_mask;
+ if ((effective & desired) == desired) {
+ return effective;
+ }
+ }
+ // work our way up the tree...
+ int last;
+ int offset = requestedName.length() - 1;
+ while ((last = requestedName.lastIndexOf(".", offset)) != -1) {
+ requestedName = requestedName.substring(0, last + 1) + "*";
+ sp = (EndpointPermission) pc.get(requestedName);
+ if (sp != null) {
+ effective |= sp.action_mask;
+ if ((effective & desired) == desired) {
+ return effective;
+ }
+ }
+ offset = last - 1;
+ }
+ /*
+ * we don't have to check for "*" as it was already checked before we
+ * were called.
+ */
+ return effective;
+ }
+
+ /**
+ * Returns an enumeration of all the <code>EndpointPermission</code>
+ * objects in the container.
+ *
+ * @return Enumeration of all the EndpointPermission objects.
+ */
+ public synchronized Enumeration elements() {
+ List all = new ArrayList(permissions.values());
+ Map pc = filterPermissions;
+ if (pc != null) {
+ all.addAll(pc.values());
+ }
+ return Collections.enumeration(all);
+ }
+
+ /* serialization logic */
+ private static final ObjectStreamField[] serialPersistentFields = {
+ new ObjectStreamField("permissions", Hashtable.class),
+ new ObjectStreamField("all_allowed", Boolean.TYPE),
+ new ObjectStreamField("filterPermissions", HashMap.class) };
+
+ private synchronized void writeObject(ObjectOutputStream out)
+ throws IOException {
+ Hashtable hashtable = new Hashtable(permissions);
+ ObjectOutputStream.PutField pfields = out.putFields();
+ pfields.put("permissions", hashtable);
+ pfields.put("all_allowed", all_allowed);
+ pfields.put("filterPermissions", filterPermissions);
+ out.writeFields();
+ }
+
+ private synchronized void readObject(java.io.ObjectInputStream in)
+ throws IOException, ClassNotFoundException {
+ ObjectInputStream.GetField gfields = in.readFields();
+ Hashtable hashtable = (Hashtable) gfields.get("permissions", null);
+ permissions = new HashMap(hashtable);
+ all_allowed = gfields.get("all_allowed", false);
+ filterPermissions = (HashMap) gfields.get("filterPermissions", null);
+ }
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ExportRegistration.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ExportRegistration.java
index a8c825d4ef..4e98d633d8 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ExportRegistration.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ExportRegistration.java
@@ -15,49 +15,49 @@ import org.osgi.framework.*;
* @ThreadSafe
*/
public interface ExportRegistration {
- /**
- * Return the service being exported.
- *
- * @return The service being exported, must be <code>null</code> when this
- * registration is unregistered.
- * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
- */
- ServiceReference getExportedService() throws IllegalStateException;
+ /**
+ * Return the service being exported.
+ *
+ * @return The service being exported, must be <code>null</code> when this
+ * registration is unregistered.
+ * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
+ */
+ ServiceReference getExportedService() throws IllegalStateException;
- /**
- * Return the Endpoint Description that is created for this registration.
- *
- * @return the local Endpoint Description
- * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
- */
- EndpointDescription getEndpointDescription();
+ /**
+ * Return the Endpoint Description that is created for this registration.
+ *
+ * @return the local Endpoint Description
+ * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
+ */
+ EndpointDescription getEndpointDescription();
- /**
- * Delete the local endpoint and disconnect any remote distribution
- * providers. After this method returns, all the methods must return
- * <code>null</code>.
- *
- * This method has no effect when the endpoint is already destroyed or being
- * destroyed.
- */
- void close();
+ /**
+ * Delete the local endpoint and disconnect any remote distribution
+ * providers. After this method returns, all the methods must return
+ * <code>null</code>.
+ *
+ * This method has no effect when the endpoint is already destroyed or being
+ * destroyed.
+ */
+ void close();
- /**
- * Exception for any error during the import process.
- *
- * If the Remote Admin for some reasons is unable to create a registration,
- * then it must return a <code>Throwable</code> from this method. In this
- * case, all other methods must return on this interface must thrown an
- * Illegal State Exception. If no error occurred, this method must return
- * <code>null</code>.
- *
- * The error must be set before this Import Registration is returned.
- * Asynchronously occurring errors must be reported to the log.
- *
- * future ....
- *
- * @return The exception that occurred during the creation of the
- * registration or <code>null</code> if no exception occurred.
- */
- Throwable getException();
+ /**
+ * Exception for any error during the import process.
+ *
+ * If the Remote Admin for some reasons is unable to create a registration,
+ * then it must return a <code>Throwable</code> from this method. In this
+ * case, all other methods must return on this interface must thrown an
+ * Illegal State Exception. If no error occurred, this method must return
+ * <code>null</code>.
+ *
+ * The error must be set before this Import Registration is returned.
+ * Asynchronously occurring errors must be reported to the log.
+ *
+ * future ....
+ *
+ * @return The exception that occurred during the creation of the
+ * registration or <code>null</code> if no exception occurred.
+ */
+ Throwable getException();
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ImportRegistration.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ImportRegistration.java
index 2fcf973d3c..1d55dbfc75 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ImportRegistration.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/ImportRegistration.java
@@ -13,46 +13,47 @@ import org.osgi.framework.*;
* @ThreadSafe
*/
public interface ImportRegistration {
- /**
- * Answer the associated Service Reference for the proxy to the endpoint.
- *
- * @return A Service Reference to the proxy for the endpoint.
- * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
- */
- ServiceReference getImportedService();
+ /**
+ * Answer the associated Service Reference for the proxy to the endpoint.
+ *
+ * @return A Service Reference to the proxy for the endpoint.
+ * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
+ */
+ ServiceReference getImportedService();
- /**
- * Answer the associated remote Endpoint Description.
- *
- * @return A Endpoint Description for the remote endpoint.
- * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
- */
- EndpointDescription getImportedEndpointDescription();
+ /**
+ * Answer the associated remote Endpoint Description.
+ *
+ * @return A Endpoint Description for the remote endpoint.
+ * @throws IllegalStateException Thrown when this object was not properly initialized, see {@link #getException()}
+ */
+ EndpointDescription getImportedEndpointDescription();
- /**
- * Unregister this Import Registration. This must close the connection
- * to the end endpoint unregister the proxy. After this method returns,
- * all other methods must return null.
- *
- * This method has no effect when the service is already unregistered or in the process off.
- */
- void close();
-
- /**
- * Exception for any error during the import process.
- *
- * If the Remote Admin for some reasons is unable to create a registration,
- * then it must return a <code>Throwable</code> from this method. In this
- * case, all other methods must return on this interface must thrown an
- * Illegal State Exception. If no error occurred, this method must return
- * <code>null</code>.
- *
- * The error must be set before this Import Registration is returned.
- * Asynchronously occurring errors must be reported to the log.
- *
- * @return The exception that occurred during the creation of the
- * registration or <code>null</code> if no exception occurred.
- */
- Throwable getException();
+ /**
+ * Unregister this Import Registration. This must close the connection
+ * to the end endpoint unregister the proxy. After this method returns,
+ * all other methods must return null.
+ *
+ * This method has no effect when the service is already unregistered or in the process off.
+ */
+ void close();
+
+
+ /**
+ * Exception for any error during the import process.
+ *
+ * If the Remote Admin for some reasons is unable to create a registration,
+ * then it must return a <code>Throwable</code> from this method. In this
+ * case, all other methods must return on this interface must thrown an
+ * Illegal State Exception. If no error occurred, this method must return
+ * <code>null</code>.
+ *
+ * The error must be set before this Import Registration is returned.
+ * Asynchronously occurring errors must be reported to the log.
+ *
+ * @return The exception that occurred during the creation of the
+ * registration or <code>null</code> if no exception occurred.
+ */
+ Throwable getException();
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminEvent.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminEvent.java
index 5045abdea9..8bc0502b17 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminEvent.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminEvent.java
@@ -9,108 +9,106 @@ import org.osgi.framework.Bundle;
* @Immutable
*/
public class RemoteAdminEvent {
- /**
- * Add an import registration. The Remote Services Admin will call this
- * method when it imports a service. When this service is registered, the
- * Remote Service Admin must notify the listener of all existing Import
- * Registrations.
- *
- */
- public static final int IMPORT_REGISTRATION = 1;
+ /**
+ * Add an import registration. The Remote Services Admin will call this
+ * method when it imports a service. When this service is registered, the
+ * Remote Service Admin must notify the listener of all existing Import
+ * Registrations.
+ *
+ */
+ public static final int IMPORT_REGISTRATION = 1;
- /**
- * Add an export registration. The Remote Services Admin will call this
- * method when it exports a service. When this service is registered, the
- * Remote Service Admin must notify the listener of all existing Export
- * Registrations.
- */
- public static final int EXPORT_REGISTRATION = 2;
+ /**
+ * Add an export registration. The Remote Services Admin will call this
+ * method when it exports a service. When this service is registered, the
+ * Remote Service Admin must notify the listener of all existing Export
+ * Registrations.
+ */
+ public static final int EXPORT_REGISTRATION = 2;
- /**
- * Remove an export registration. The Remote Services Admin will call this
- * method when it removes the export of a service.
- *
- */
- public static final int EXPORT_UNREGISTRATION = 3;
+ /**
+ * Remove an export registration. The Remote Services Admin will call this
+ * method when it removes the export of a service.
+ *
+ */
+ public static final int EXPORT_UNREGISTRATION = 3;
- /**
- * Remove an import registration. The Remote Services Admin will call this
- * method when it removes the import of a service.
- *
- */
- public static final int IMPORT_UNREGISTRATION = 4;
+ /**
+ * Remove an import registration. The Remote Services Admin will call this
+ * method when it removes the import of a service.
+ *
+ */
+ public static final int IMPORT_UNREGISTRATION = 4;
- /**
- * A fatal importing error occurred. The Import Registration has been
- * closed.
- */
- public static final int IMPORT_ERROR = 5;
+ /**
+ * A fatal importing error occurred. The Import Registration has been
+ * closed.
+ */
+ public static final int IMPORT_ERROR = 5;
- /**
- * A fatal exporting error occurred. The Export Registration has been
- * closed.
- */
- public static final int EXPORT_ERROR = 6;
+ /**
+ * A fatal exporting error occurred. The Export Registration has been
+ * closed.
+ */
+ public static final int EXPORT_ERROR = 6;
- /**
- * A problematic situation occurred, the export is still active.
- */
- public static final int EXPORT_WARNING = 7;
- /**
- * A problematic situation occurred, the import is still active.
- */
- public static final int IMPORT_WARNING = 8;
+ /**
+ * A problematic situation occurred, the export is still active.
+ */
+ public static final int EXPORT_WARNING = 7;
+ /**
+ * A problematic situation occurred, the import is still active.
+ */
+ public static final int IMPORT_WARNING = 8;
- private ImportRegistration importRegistration;
- private ExportRegistration exportRegistration;
- private Throwable exception;
- private int type;
- private Bundle source;
+ private ImportRegistration importRegistration;
+ private ExportRegistration exportRegistration;
+ private Throwable exception;
+ private int type;
+ private Bundle source;
- RemoteAdminEvent(int type,
- Bundle source,
- ImportRegistration importRegistration,
- ExportRegistration exportRegistration,
- Throwable exception) {
- this.type = type;
- this.source = source;
- this.importRegistration = importRegistration;
- this.exportRegistration = exportRegistration;
- this.exception = exception;
- }
+ RemoteAdminEvent(int type, Bundle source,
+ ImportRegistration importRegistration,
+ ExportRegistration exportRegistration, Throwable exception) {
+ this.type = type;
+ this.source = source;
+ this.importRegistration = importRegistration;
+ this.exportRegistration = exportRegistration;
+ this.exception = exception;
+ }
- /**
- * @return the importRegistration
- */
- public ImportRegistration getImportRegistration() {
- return importRegistration;
- }
+ /**
+ * @return the importRegistration
+ */
+ public ImportRegistration getImportRegistration() {
+ return importRegistration;
+ }
- /**
- * @return the exportRegistration
- */
- public ExportRegistration getExportRegistration() {
- return exportRegistration;
- }
+ /**
+ * @return the exportRegistration
+ */
+ public ExportRegistration getExportRegistration() {
+ return exportRegistration;
+ }
- /**
- * @return the exception
- */
- public Throwable getException() {
- return exception;
- }
+ /**
+ * @return the exception
+ */
+ public Throwable getException() {
+ return exception;
+ }
- /**
- * @return the type
- */
- public int getType() {
- return type;
- }
+ /**
+ * @return the type
+ */
+ public int getType() {
+ return type;
+ }
- /**
- * @return the source
- */
- public Bundle getSource() {
- return source;
- }
+ /**
+ * @return the source
+ */
+ public Bundle getSource() {
+ return source;
+ }
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminListener.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminListener.java
index c81ec7ff13..7aa5ae0abe 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminListener.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteAdminListener.java
@@ -8,8 +8,8 @@ package org.apache.tuscany.sca.osgi.service.remoteadmin;
*/
public interface RemoteAdminListener {
- /**
- * @param event
- */
- void remoteAdminEvent(RemoteAdminEvent event);
+ /**
+ * @param event
+ */
+ void remoteAdminEvent( RemoteAdminEvent event);
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteConstants.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteConstants.java
index 379bb8c368..6207554c98 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteConstants.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteConstants.java
@@ -5,152 +5,153 @@ package org.apache.tuscany.sca.osgi.service.remoteadmin;
*
*/
public class RemoteConstants {
- private RemoteConstants() {
- }
+ private RemoteConstants() {
+ }
- /**
- * The configuration types supported by this Distribution Provider.
- *
- * Services that are suitable for distribution list the configuration types
- * that describe the configuration information for that service in the
- * {@link #SERVICE_EXPORTED_CONFIGS} or {@link #SERVICE_IMPORTED_CONFIGS}
- * property.
- *
- * A distribution provider must register a service that has this property
- * and enumerate all configuration types that it supports.
- *
- * The type of this property <code>String+</code>
- *
- * @see #SERVICE_EXPORTED_CONFIGS
- * @see #SERVICE_IMPORTED_CONFIGS
- */
- public final static String REMOTE_CONFIGS_SUPPORTED = "remote.configs.supported";
+ /**
+ * The configuration types supported by this Distribution Provider.
+ *
+ * Services that are suitable for distribution list the configuration types
+ * that describe the configuration information for that service in the
+ * {@link #SERVICE_EXPORTED_CONFIGS} or {@link #SERVICE_IMPORTED_CONFIGS}
+ * property.
+ *
+ * A distribution provider must register a service that has this property
+ * and enumerate all configuration types that it supports.
+ *
+ * The type of this property <code>String+</code>
+ *
+ * @see #SERVICE_EXPORTED_CONFIGS
+ * @see #SERVICE_IMPORTED_CONFIGS
+ */
+ public final static String REMOTE_CONFIGS_SUPPORTED = "remote.configs.supported";
- /**
- * Service property that lists the intents supported by the distribution
- * provider.
- *
- * Each distribution provider must register a service that has this property
- * and enumerate all the supported intents, having any qualified intents
- * expanded.
- *
- * The value of this property is of type <code>String+</code>.
- *
- * @see #SERVICE_INTENTS
- * @see #SERVICE_EXPORTED_INTENTS
- * @see #SERVICE_EXPORTED_INTENTS_EXTRA
- */
- public final static String REMOTE_INTENTS_SUPPORTED = "remote.intents.supported";
+ /**
+ * Service property that lists the intents supported by the distribution
+ * provider.
+ *
+ * Each distribution provider must register a service that has this property
+ * and enumerate all the supported intents, having any qualified intents
+ * expanded.
+ *
+ * The value of this property is of type <code>String+</code>.
+ *
+ * @see #SERVICE_INTENTS
+ * @see #SERVICE_EXPORTED_INTENTS
+ * @see #SERVICE_EXPORTED_INTENTS_EXTRA
+ */
+ public final static String REMOTE_INTENTS_SUPPORTED = "remote.intents.supported";
- /**
- * Defines the interfaces under which this service can be exported.
- *
- * This list must be a subset of the types listed in the objectClass service
- * property. The single value of an asterisk ('*' \u002A) indicates all
- * interfaces in the registration's objectClass property (not classes). It
- * is highly recommended to only export interfaces and not concrete classes
- * due to the complexity of creating proxies for some type of classes.
- *
- * The value of this property is of type String+.
- */
- public final static String SERVICE_EXPORTED_INTERFACES = "service.exported.interfaces";
+ /**
+ * Defines the interfaces under which this service can be exported.
+ *
+ * This list must be a subset of the types listed in the objectClass service
+ * property. The single value of an asterisk ('*' \u002A) indicates all
+ * interfaces in the registration's objectClass property (not classes). It
+ * is highly recommended to only export interfaces and not concrete classes
+ * due to the complexity of creating proxies for some type of classes.
+ *
+ * The value of this property is of type String+.
+ */
+ public final static String SERVICE_EXPORTED_INTERFACES = "service.exported.interfaces";
- /**
- * A list of intents that the distribution provider must implement to
- * distribute the service. Intents listed in this property are reserved for
- * intents that are critical for the code to function correctly, for
- * example, ordering of messages. These intents should not be configurable.
- *
- * The value of this property is of type <code>String+</code>.
- */
- public final static String SERVICE_EXPORTED_INTENTS = "service.exported.intents";
+ /**
+ * A list of intents that the distribution provider must implement to
+ * distribute the service. Intents listed in this property are reserved for
+ * intents that are critical for the code to function correctly, for
+ * example, ordering of messages. These intents should not be configurable.
+ *
+ * The value of this property is of type <code>String+</code>.
+ */
+ public final static String SERVICE_EXPORTED_INTENTS = "service.exported.intents";
- /**
- * Extra intents configured in addition to the the intents specified in
- * {@link #SERVICE_EXPORTED_INTENTS}.
- *
- * These intents are merged with the service.exported.intents and therefore
- * have the same semantics. They are extra, so that the
- * {@link #SERVICE_EXPORTED_INTENTS} can be set by the bundle developer and
- * this property is then set by the administrator/deployer. Bundles should
- * make this property configurable, for example through the Configuration
- * Admin service.
- *
- * The value of this property is of type <code>String+</code>.
- */
- public final static String SERVICE_EXPORTED_INTENTS_EXTRA = "service.exported.intents.extra";
+ /**
+ * Extra intents configured in addition to the the intents specified in
+ * {@link #SERVICE_EXPORTED_INTENTS}.
+ *
+ * These intents are merged with the service.exported.intents and therefore
+ * have the same semantics. They are extra, so that the
+ * {@link #SERVICE_EXPORTED_INTENTS} can be set by the bundle developer and
+ * this property is then set by the administrator/deployer. Bundles should
+ * make this property configurable, for example through the Configuration
+ * Admin service.
+ *
+ * The value of this property is of type <code>String+</code>.
+ */
+ public final static String SERVICE_EXPORTED_INTENTS_EXTRA = "service.exported.intents.extra";
- /**
- * A list of configuration types that should be used to export the service.
- *
- * Configuration types can be <em>synonymous</em> or <em>alternatives</em>.
- * In principle, a distribution provider should create an endpoint for each
- * recognized configuration type, the deployer is responsible that synonyms
- * do not clash.
- *
- * Each configuration type has an associated specification that describes
- * how the configuration data for the exported service is represented in an
- * OSGi framework.
- *
- * The value of this property is of type <code>String+</code>.
- */
- public final static String SERVICE_EXPORTED_CONFIGS = "service.exported.configs";
+ /**
+ * A list of configuration types that should be used to export the service.
+ *
+ * Configuration types can be <em>synonymous</em> or <em>alternatives</em>.
+ * In principle, a distribution provider should create an endpoint for each
+ * recognized configuration type, the deployer is responsible that synonyms
+ * do not clash.
+ *
+ * Each configuration type has an associated specification that describes
+ * how the configuration data for the exported service is represented in an
+ * OSGi framework.
+ *
+ * The value of this property is of type <code>String+</code>.
+ */
+ public final static String SERVICE_EXPORTED_CONFIGS = "service.exported.configs";
- /**
- * Must be set by a distribution provider to <code>true</code> when it
- * registers the end-point proxy as an imported service. Can be used by a
- * bundle to prevent it from getting an imported service.
- *
- * The value of this property is not defined, setting it is sufficient.
- */
- public final static String SERVICE_IMPORTED = "service.imported";
+ /**
+ * Must be set by a distribution provider to <code>true</code> when it
+ * registers the end-point proxy as an imported service. Can be used by a
+ * bundle to prevent it from getting an imported service.
+ *
+ * The value of this property is not defined, setting it is sufficient.
+ */
+ public final static String SERVICE_IMPORTED = "service.imported";
- /**
- * The configuration type used to import this services, as described in
- * {@link #SERVICE_EXPORTED_CONFIGS}. Any associated properties for this
- * configuration types must be properly mapped to the importing system. For
- * example, a URL in these properties must point to a valid resource when
- * used in the importing framework. Configuration types in this property
- * must be synonymous.
- *
- * The value of this property is of type <code>String+</code>.
- */
- public final String SERVICE_IMPORTED_CONFIGS = "service.imported.configs";
+ /**
+ * The configuration type used to import this services, as described in
+ * {@link #SERVICE_EXPORTED_CONFIGS}. Any associated properties for this
+ * configuration types must be properly mapped to the importing system. For
+ * example, a URL in these properties must point to a valid resource when
+ * used in the importing framework. Configuration types in this property
+ * must be synonymous.
+ *
+ * The value of this property is of type <code>String+</code>.
+ */
+ public final String SERVICE_IMPORTED_CONFIGS = "service.imported.configs";
- /**
- * A list of intents that this service implements. This property has dual
- * purpose. A bundle can use this service property to notify the
- * distribution provider that these intents are already implemented by the
- * exported service object. For an imported service, a distribution provider
- * must use this property to convey the combined intents of the exporting
- * service and the intents that the distribution providers add. To export a
- * service, a distribution provider must recognize all these intents and
- * expand any qualified intents.
- *
- * The value of this property is of type <code>String+</code>.
- */
- public final static String SERVICE_INTENTS = "service.intents";
+ /**
+ * A list of intents that this service implements. This property has dual
+ * purpose. A bundle can use this service property to notify the
+ * distribution provider that these intents are already implemented by the
+ * exported service object. For an imported service, a distribution provider
+ * must use this property to convey the combined intents of the exporting
+ * service and the intents that the distribution providers add. To export a
+ * service, a distribution provider must recognize all these intents and
+ * expand any qualified intents.
+ *
+ * The value of this property is of type <code>String+</code>.
+ */
+ public final static String SERVICE_INTENTS = "service.intents";
- /**
- * The property key for the endpoint URI. This is a unique id for an
- * endpoint following the URI syntax. As far as this specification is
- * concerned, this unique id is opaque.
- */
- final public static String ENDPOINT_URI = "endpoint.uri";
- /**
- * The property key for the endpoint service id. This is a unique id for a
- * service based on the framework id '.' service id or another model. As far as this specification is
- * concerned, this unique id is opaque.
- */
- final public static String ENDPOINT_REMOTE_SERVICE_ID = "endpoint.remote.service.id";
+ /**
+ * The property key for the endpoint URI. This is a unique id for an
+ * endpoint following the URI syntax. As far as this specification is
+ * concerned, this unique id is opaque.
+ */
+ final public static String ENDPOINT_URI = "endpoint.uri";
- /**
- * The key for a framework property that defines the UUID of the framework.
- *
- * The property must be set by the framework or through configuration before
- * the VM is started or some bundle. The value must be a Universally Unique
- * Id, it must not contain any dots ('.' \u002E).
- */
- public final static String FRAMEWORK_UUID = "org.osgi.framework.uuid";
+ /**
+ * The property key for the endpoint service id. This is a unique id for a
+ * service based on the framework id '.' service id or another model. As far as this specification is
+ * concerned, this unique id is opaque.
+ */
+ final public static String ENDPOINT_REMOTE_SERVICE_ID = "endpoint.remote.service.id";
+
+ /**
+ * The key for a framework property that defines the UUID of the framework.
+ *
+ * The property must be set by the framework or through configuration before
+ * the VM is started or some bundle. The value must be a Universally Unique
+ * Id, it must not contain any dots ('.' \u002E).
+ */
+ public final static String FRAMEWORK_UUID = "org.osgi.framework.uuid";
}
diff --git a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteServiceAdmin.java b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteServiceAdmin.java
index a341222a17..450f205d04 100644
--- a/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteServiceAdmin.java
+++ b/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/service/remoteadmin/RemoteServiceAdmin.java
@@ -1,8 +1,10 @@
package org.apache.tuscany.sca.osgi.service.remoteadmin;
-import java.util.*;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
-import org.osgi.framework.*;
+import org.osgi.framework.ServiceReference;
/**
* A Remote Service Admin manages the import and export of services.
@@ -17,75 +19,76 @@ import org.osgi.framework.*;
*/
public interface RemoteServiceAdmin {
- /**
- * Export a service to an endpoint. The Remote Service Admin must create an
- * endpoint that can be used by other Distrbution Providers to connect to
- * this Remote Service Admin and use the exported service. This method can
- * return null if the service could not be exported. ### do we need
- * exceptions?
- *
- * @param ref
- * The Service Reference to export
- * @return An Export Registration that combines the Endpoint Description and
- * the Service Reference or
- * <code>null</code> if the service could not be exported
- * @throws IllegalArgumentException
- * @throws UnsupportedOperationException
- */
- List/*<ExportRegistration>*/exportService(ServiceReference ref) throws IllegalArgumentException,
- UnsupportedOperationException;
+ /**
+ * Export a service to an endpoint. The Remote Service Admin must create an
+ * endpoint that can be used by other Distrbution Providers to connect to
+ * this Remote Service Admin and use the exported service. This method can
+ * return null if the service could not be exported. ### do we need
+ * exceptions?
+ *
+ * @param ref
+ * The Service Reference to export
+ * @return An Export Registration that combines the Endpoint Description and
+ * the Service Reference or
+ * <code>null</code> if the service could not be exported
+ * @throws IllegalArgumentException
+ * @throws UnsupportedOperationException
+ */
+ List/*<ExportRegistration>*/ exportService(ServiceReference ref) throws IllegalArgumentException, UnsupportedOperationException;
- /**
- * Export a service to a given endpoint. The Remote Service Admin must
- * create an endpoint from the given description that can be used by other
- * Distrbution Providers to connect to this Remote Service Admin and use the
- * exported service. This method can return null if the service could not be
- * exported because the endpoint could not be implemented by this Remote
- * Service Admin. ### do we need exceptions?
- *
- * @param ref
- * The Service Reference to export
- * @param properties
- * The properties to create a local endpoint that can be implemented by
- * this Remote Service Admin. If this is null, the endpoint will
- * be determined by the properties on the service, see
- * {@link #exportService(ServiceReference)}. The properties are
- * the same as given for an exported service. They are overlaid
- * over any properties the service defines.
- * @return An Export Registration that combines the Endpoint Description and
- * the Service Reference or
- * <code>null</code> if the service could not be exported
- * @throws IllegalArgumentException
- * @throws UnsupportedOperationException
- */
- List/*<ExportRegistration>*/exportService(ServiceReference ref, Map/*<String,Object>*/properties)
- throws IllegalArgumentException, UnsupportedOperationException;
+ /**
+ * Export a service to a given endpoint. The Remote Service Admin must
+ * create an endpoint from the given description that can be used by other
+ * Distrbution Providers to connect to this Remote Service Admin and use the
+ * exported service. This method can return null if the service could not be
+ * exported because the endpoint could not be implemented by this Remote
+ * Service Admin. ### do we need exceptions?
+ *
+ * @param ref
+ * The Service Reference to export
+ * @param properties
+ * The properties to create a local endpoint that can be implemented by
+ * this Remote Service Admin. If this is null, the endpoint will
+ * be determined by the properties on the service, see
+ * {@link #exportService(ServiceReference)}. The properties are
+ * the same as given for an exported service. They are overlaid
+ * over any properties the service defines.
+ * @return An Export Registration that combines the Endpoint Description and
+ * the Service Reference or
+ * <code>null</code> if the service could not be exported
+ * @throws IllegalArgumentException
+ * @throws UnsupportedOperationException
+ */
+ List/*<ExportRegistration>*/ exportService(ServiceReference ref,
+ Map/*<String,Object>*/ properties) throws IllegalArgumentException, UnsupportedOperationException;
- /**
- * Import a service from an endpoint. The Remote Service Admin must use the
- * given endpoint to create a proxy. This method can return null if the
- * service could not be imported. ### do we need exceptions?
- *
- * @param endpoint
- * The Endpoint Description to be used for import
- * @return An Import Registration that combines the Endpoint Description and
- * the Service Reference or
- * <code>null</code> if the endpoint could not be imported
- */
- ImportRegistration importService(EndpointDescription endpoint);
- /**
- * Answer the currently active Export Registrations.
- *
- * @return A collection of Export Registrations that are currently active.
- */
- Collection/*<? extends ExportRegistration>*/getExportedServices();
+ /**
+ * Import a service from an endpoint. The Remote Service Admin must use the
+ * given endpoint to create a proxy. This method can return null if the
+ * service could not be imported. ### do we need exceptions?
+ *
+ * @param endpoint
+ * The Endpoint Description to be used for import
+ * @return An Import Registration that combines the Endpoint Description and
+ * the Service Reference or
+ * <code>null</code> if the endpoint could not be imported
+ */
+ ImportRegistration importService(EndpointDescription endpoint);
- /**
- * Answer the currently active Import Registrations.
- *
- * @return A collection of Import Registrations that are currently active.
- */
- Collection/*<? extends ImportRegistration>*/getImportedEndpoints();
+
+ /**
+ * Answer the currently active Export Registrations.
+ *
+ * @return A collection of Export Registrations that are currently active.
+ */
+ Collection/*<? extends ExportRegistration>*/ getExportedServices();
+
+ /**
+ * Answer the currently active Import Registrations.
+ *
+ * @return A collection of Import Registrations that are currently active.
+ */
+ Collection/*<? extends ImportRegistration>*/ getImportedEndpoints();
}