felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From don...@apache.org
Subject svn commit: r672676 - in /felix/sandbox/donsez/mosgi.util: ./ src/ src/main/ src/main/java/ src/main/java/org/ src/main/java/org/apache/ src/main/java/org/apache/felix/ src/main/java/org/apache/felix/sandbox/ src/main/java/org/apache/felix/sandbox/mosg...
Date Sun, 29 Jun 2008 21:25:15 GMT
Author: donsez
Date: Sun Jun 29 14:25:14 2008
New Revision: 672676

URL: http://svn.apache.org/viewvc?rev=672676&view=rev
Log:
creation of the mosgi.util bundle : provides utility classes to register MBeans within MOSGi
server or within the platform' default MBeanServer.

Added:
    felix/sandbox/donsez/mosgi.util/
    felix/sandbox/donsez/mosgi.util/LICENSE
    felix/sandbox/donsez/mosgi.util/NOTICE
    felix/sandbox/donsez/mosgi.util/pom.xml   (with props)
    felix/sandbox/donsez/mosgi.util/src/
    felix/sandbox/donsez/mosgi.util/src/main/
    felix/sandbox/donsez/mosgi.util/src/main/java/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java
  (with props)
    felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java
  (with props)
    felix/sandbox/donsez/mosgi.util/src/site/

Added: felix/sandbox/donsez/mosgi.util/LICENSE
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/mosgi.util/LICENSE?rev=672676&view=auto
==============================================================================
--- felix/sandbox/donsez/mosgi.util/LICENSE (added)
+++ felix/sandbox/donsez/mosgi.util/LICENSE Sun Jun 29 14:25:14 2008
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Added: felix/sandbox/donsez/mosgi.util/NOTICE
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/mosgi.util/NOTICE?rev=672676&view=auto
==============================================================================
--- felix/sandbox/donsez/mosgi.util/NOTICE (added)
+++ felix/sandbox/donsez/mosgi.util/NOTICE Sun Jun 29 14:25:14 2008
@@ -0,0 +1,13 @@
+Apache Felix (sandbox) MOSGi Utility
+Copyright 2008 The Apache Software Foundation
+
+I. Included Software
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+Licensed under the Apache License 2.0.
+
+II. Used Software
+
+III. License Summary
+- Apache License 2.0

Added: felix/sandbox/donsez/mosgi.util/pom.xml
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/mosgi.util/pom.xml?rev=672676&view=auto
==============================================================================
--- felix/sandbox/donsez/mosgi.util/pom.xml (added)
+++ felix/sandbox/donsez/mosgi.util/pom.xml Sun Jun 29 14:25:14 2008
@@ -0,0 +1,86 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<project>
+
+	<properties>
+		<description>provides utility classes to register MBeans.</description>
+	</properties>  
+
+  <modelVersion>4.0.0</modelVersion>
+  <packaging>bundle</packaging>
+  <name>MOSGi Utilities</name>
+  <artifactId>org.apache.felix.sandbox.mosgi.util</artifactId>
+  <groupId>org.apache.felix.sandbox</groupId>
+  <version>0.3.0</version>
+  <description>${description}</description>
+
+  <dependencies>
+
+	<dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>osgi_R4_core</artifactId>
+      <version>1.0</version>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
+    
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>osgi_R4_compendium</artifactId>
+      <version>1.0</version>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
+    
+  </dependencies>
+
+  <build>
+    <plugins>
+		<plugin>
+			<groupId>org.apache.maven.plugins</groupId>
+			<artifactId>maven-compiler-plugin</artifactId>
+			<!-- best lock down version of the plugin too -->
+			<configuration>
+				<source>1.5</source>
+				<target>1.5</target>
+			</configuration>
+	  </plugin>
+        
+      <plugin>
+	        <groupId>org.apache.felix</groupId>
+	        <artifactId>maven-bundle-plugin</artifactId>
+			<!-- best lock down version of the plugin too -->
+	        <extensions>true</extensions>
+	        <configuration>
+	          <instructions>	          
+		            <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName>		
         	
+		          	
+		            <Import-Package>*</Import-Package>
+		
+		            <Export-Package>${pom.artifactId}</Export-Package>
+		
+		            <Private-Package>
+		            		${pom.artifactId}.*
+		            </Private-Package>
+		        </instructions>
+	  		</configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

Propchange: felix/sandbox/donsez/mosgi.util/pom.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java?rev=672676&view=auto
==============================================================================
--- felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java
(added)
+++ felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java
Sun Jun 29 14:25:14 2008
@@ -0,0 +1,76 @@
+/* 
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.felix.sandbox.mosgi.util;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.BundleEvent;
+import org.osgi.framework.BundleListener;
+import org.osgi.framework.ServiceRegistration;
+
+
+/**
+ * This class registers the mbean on the platform agent if the MOSGi is not installed. Else
the mbean is registered as an OSGi service.
+ * <p>It listens also the installation or the uninstallation of the MOSGi agent.
+ * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
+ */
+public class MBeanRegistration implements BundleListener {
+   	
+	private ServiceRegistration serviceRegistration=null;
+	
+	private BundleContext bundleContext;
+	private Object mbean;
+	private String objectNameStr;
+	private String[] objectClasses;
+	
+	public MBeanRegistration(BundleContext bundleContext, Object mbean, String objectNameStr,
String[] objectClasses) {
+		this.bundleContext=bundleContext;
+		this.mbean=mbean;
+		this.objectClasses=objectClasses;
+		this.objectNameStr=objectNameStr;
+	}
+	
+	public void open() throws Exception {
+		serviceRegistration=MBeanRegistrationHelper.registerMBean(bundleContext, mbean, objectNameStr,
objectClasses);
+		bundleContext.addBundleListener(this);	
+	}
+	
+	public void close() throws Exception {
+		bundleContext.removeBundleListener(this);
+		MBeanRegistrationHelper.unregisterMBean(objectNameStr, serviceRegistration);
+	}
+	
+	public void bundleChanged(BundleEvent bundleEvent) {
+		/* TODO switch the MBean registration/unregistration between MOSGi and the platform when
the MOSGi bundle lifecycle changes (INSTALLED/UNINSTALLED) */
+		Bundle bundle=bundleEvent.getBundle();
+		String symbolicName=bundle.getSymbolicName();
+		if(MBeanRegistrationHelper.MOSGIAGENT_SYMBOLICNAME.equals(symbolicName)){
+			if(bundleEvent.getType()==BundleEvent.UNINSTALLED || bundleEvent.getType()==BundleEvent.UNINSTALLED
) {
+				try {
+					MBeanRegistrationHelper.unregisterMBean(objectNameStr, serviceRegistration);
+					serviceRegistration=MBeanRegistrationHelper.registerMBean(bundleContext, mbean, objectNameStr,
objectClasses);
+				} catch (Exception e) {
+					// TODO deal with exceptions while registration and unregistration
+					e.printStackTrace();
+				}
+			}
+		}
+	}
+}
+

Propchange: felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistration.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java?rev=672676&view=auto
==============================================================================
--- felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java
(added)
+++ felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java
Sun Jun 29 14:25:14 2008
@@ -0,0 +1,75 @@
+/* 
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.felix.sandbox.mosgi.util;
+
+import java.lang.management.ManagementFactory;
+import java.util.Dictionary;
+import java.util.Properties;
+
+import javax.management.MBeanServer;
+import javax.management.ObjectName;
+
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceRegistration;
+
+/**
+ * This helper registers the mbean on the platform agent if the MOSGi is not installed. Else
the mbean is registered as an OSGi service.
+ * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
+ */
+public class MBeanRegistrationHelper {
+   	
+	static final String MOSGIAGENT_SYMBOLICNAME="org.apache.felix.mosgi.jmx.agent";
+	
+    public static ServiceRegistration registerMBean(BundleContext bundleContext, Object mbean,
String objectNameStr, String[] objectClasses) throws Exception {
+    	ServiceRegistration serviceRegistration=null;
+    	
+    	boolean isMosgiInstalled=false;
+    	Bundle[] bundles=bundleContext.getBundles();
+    	for (int i = 0; i < bundles.length; i++) {
+			Bundle bundle = bundles[i];
+			String symbolicName=bundle.getSymbolicName();
+			if("org.apache.felix.mosgi.jmx.agent".equals(symbolicName)){
+		    	isMosgiInstalled=true;
+				break;
+			}
+		}    	    	
+    	if(isMosgiInstalled){
+	    	Dictionary registrationProperties=new Properties();
+	    	registrationProperties.put(MOSGIAGENT_SYMBOLICNAME,objectNameStr);
+	       	serviceRegistration=bundleContext.registerService(objectClasses,mbean,registrationProperties);
+    	} else {
+    		MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer();
+    		mbeanServer.registerMBean(mbean, new ObjectName(objectNameStr));
+    	}
+    	
+    	return serviceRegistration;
+    }
+    
+    public static void unregisterMBean(String objectNameStr, ServiceRegistration serviceRegistration)
throws Exception {
+        	if(serviceRegistration!=null) {
+       		serviceRegistration.unregister();
+       	} else {
+    		  MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer();
+    		  mbeanServer.unregisterMBean(new ObjectName(objectNameStr));       		
+       	}
+    }
+
+}
+

Propchange: felix/sandbox/donsez/mosgi.util/src/main/java/org/apache/felix/sandbox/mosgi/util/MBeanRegistrationHelper.java
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message