Hi JB, some suggestions:

On 09/22/2011 04:22 PM, [email protected] wrote:
==============================================================================
--- 
karaf/trunk/management/mbeans/dev/src/main/java/org/apache/karaf/management/mbeans/dev/DevMBean.java
 (added)
+++ 
karaf/trunk/management/mbeans/dev/src/main/java/org/apache/karaf/management/mbeans/dev/DevMBean.java
 Thu Sep 22 20:22:49 2011
@@ -0,0 +1,48 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.karaf.management.mbeans.dev;
+
+import java.util.List;
+
+/**
+ * MBean providing dev actions.
+ */
+public interface DevMBean {
+
+    /**
+     * Get the current OSGi framework in use.
+     *
+     * @return the name of the OSGi framework in use.

+     * @throws Exception
+     */
+    String framework() throws Exception;
+
+    /**
+     * OSGi framework options.
+     *
+     * @param debug enable debug of the OSGi framework to use.

@param debug enable debugging of the OSGi framework
or
@param debug place OSGi framework in debug mode

I'm unsure if this command is passive (then former is better)--or active (latter is better.)

+     * @param framework name of the OSGI framework to use.
+     * @throws Exception
+     */
+    void frameworkOptions(boolean debug, String framework) throws Exception;
+

If you're going to include the ability to set the framework in frameworkOptions, seems more natural to list it first, no?

+    /**
+     * Restart Karaf, with eventually a cleanup.

s/eventually/optionally

+     *
+     * @param clean if true, Karaf is cleanup, false else.
+     * @throws Exception
+     */
+    void restart(boolean clean) throws Exception;
+
+}


@param clean if true, Karaf restarts in default state with all user-added bundles and features gone (i.e., /data directory deleted); if false present Karaf state will be retained upon restart

(You *might* prefer using "erase" instead of "clean" here, but they're both good.)

Glen

--
Glen Mazza
Talend - http://www.talend.com/ai
Blog - http://www.jroller.com/gmazza
Twitter - glenmazza

Reply via email to