11:12 a.m.
Author: thomas.diesler(a)jboss.com
Date: 2009-06-01 12:12:34 -0400 (Mon, 01 Jun 2009)
New Revision: 89609
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractBridge.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractConnector.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractPackageListener.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicRequest.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicResponse.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/JMXInvocation.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/LocalInvocation.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/OSGiInvoker.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/SocketInvocation.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitFailure.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitResponse.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyActivator.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyExtender.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnector.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnectorMBean.java
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/SocketConnector.java
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/BlueprintCapability.java
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/Capability.java
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/ConfigAdminCapability.java
projects/jboss-osgi/trunk/testsuite/trailblazer/src/test/java/org/jboss/test/osgi/trailblazer/AuditService.java
Log:
Add javadoc
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractBridge.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractBridge.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractBridge.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -37,7 +37,7 @@
import org.jboss.osgi.husky.Response;
/**
- * [TODO]
+ * An abstract {@link Bridge} implementation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractConnector.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractConnector.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractConnector.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -37,7 +37,7 @@
import org.jboss.osgi.husky.runtime.PackageListener;
/**
- * [TODO]
+ * An abstract {@link Connector} implementation
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
@@ -68,7 +68,7 @@
}
throw new IllegalStateException("Cannot find listener to handle: " +
testClass + ", we have " + listeners);
}
-
+
public InputStream process(InputStream reqStream)
{
try
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractPackageListener.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractPackageListener.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/AbstractPackageListener.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -32,7 +32,7 @@
import org.jboss.osgi.husky.runtime.Runner;
/**
- * [TODO]
+ * An abstract {@link PackageListener} implementation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicRequest.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicRequest.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicRequest.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -26,7 +26,7 @@
import org.jboss.osgi.husky.Request;
/**
- * [TODO]
+ * A basic {@link Request} implementation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicResponse.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicResponse.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/BasicResponse.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -31,7 +31,7 @@
import org.jboss.osgi.husky.Response;
/**
- * [TODO]
+ * A basic {@link Response} implementation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/JMXInvocation.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/JMXInvocation.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/JMXInvocation.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -38,8 +38,10 @@
import org.jboss.osgi.husky.runtime.osgi.JMXConnector;
/**
- * [TODO]
+ * A JMX based invocation.
*
+ * This is mainly used for local framework testing.
+ *
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
*/
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/LocalInvocation.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/LocalInvocation.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/LocalInvocation.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -31,7 +31,7 @@
import org.jboss.osgi.husky.runtime.junit.JUnitRunner;
/**
- * [TODO]
+ * An 'in-memory' invocation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/OSGiInvoker.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/OSGiInvoker.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/OSGiInvoker.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -35,8 +35,14 @@
import org.jboss.osgi.husky.runtime.osgi.JMXConnector;
/**
- * [TODO]
+ * An {@link Invoker} suitable for OSGi bundle testing.
*
+ * It delegates the invocation to
+ *
+ * #1 {@link SocketInvocation}
+ * #2 {@link JMXInvocation}
+ * #3 {@link LocalInvocation}
+ *
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
*/
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/SocketInvocation.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/SocketInvocation.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/internal/SocketInvocation.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -33,11 +33,13 @@
import org.jboss.osgi.husky.Request;
import org.jboss.osgi.husky.Response;
-import org.jboss.osgi.husky.runtime.Connector;
+import org.jboss.osgi.husky.runtime.osgi.SocketConnector;
/**
- * [TODO]
+ * A Socket invocation.
*
+ * This is mainly used for remote framework testing.
+ *
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
*/
@@ -50,31 +52,29 @@
private static String getPort()
{
- String propNamePort = Connector.class.getName().toLowerCase() + ".port";
- String port = System.getProperty(propNamePort);
+ String port = System.getProperty(SocketConnector.PROP_SOCKET_CONNECTOR_PORT);
return port;
}
private static String getHost()
{
- String propNameHost = Connector.class.getName().toLowerCase() + ".host";
- String host = System.getProperty(propNameHost);
+ String host = System.getProperty(SocketConnector.PROP_SOCKET_CONNECTOR_HOST);
return host;
}
-
+
public Response invoke(Request req) throws Exception
{
Socket socket = new Socket(InetAddress.getByName(getHost()), new
Integer(getPort()));
-
+
// Marshall the Request
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ObjectOutputStream oos = new ObjectOutputStream(baos);
oos.writeObject(req);
oos.close();
-
+
InputStream reqBytes = new ByteArrayInputStream(baos.toByteArray());
Util.copyStream(reqBytes, socket.getOutputStream());
-
+
// Unmarshall the Response
ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());
Response response = (Response)ois.readObject();
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitFailure.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitFailure.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitFailure.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -27,7 +27,8 @@
import org.junit.runner.Description;
/**
- * [TODO]
+ * A {@link Failure} implementation that can be constructed
+ * from a JUnit4 Failure.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitResponse.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitResponse.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/junit/JUnitResponse.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -23,11 +23,13 @@
// $Id$
+import org.jboss.osgi.husky.Response;
import org.jboss.osgi.husky.internal.BasicResponse;
import org.junit.runner.Result;
/**
- * [TODO]
+ * A {@link Response} implementation that can be constructed
+ * from a JUnit4 Result.
*
* @author Thomas.Diesler(a)jboss.com
* @since 16-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyActivator.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyActivator.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyActivator.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -25,10 +25,21 @@
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;
+import org.osgi.framework.BundleListener;
/**
- * [TODO]
+ * This is the Husky {@link BundleActivator}.
*
+ * It unconditionally starts the {@link JMXConnector}.
+ *
+ * If the {@link SocketConnector#PROP_SOCKET_CONNECTOR_HOST} and
+ * {@link SocketConnector#PROP_SOCKET_CONNECTOR_PORT} properites are set it also
+ * starts the {@link SocketConnector}.
+ *
+ * Finally it starts the {@link HuskyExtender}, which is a {@link BundleListener}
+ * that looks for manifest headers called {@link HuskyExtender#HEADER_TEST_PACKAGE}.
+ *
+ *
* @author Thomas.Diesler(a)jboss.com
* @since 17-May-2009
*/
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyExtender.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyExtender.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/HuskyExtender.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -35,13 +35,17 @@
import org.osgi.service.log.LogService;
/**
- * [TODO]
+ * The Husky extender is a {@link BundleListener} that checkes
+ * the {@link #HEADER_TEST_PACKAGE}
*
* @author Thomas.Diesler(a)jboss.com
* @since 17-May-2009
*/
public class HuskyExtender implements BundleListener
{
+ /** The manifest header that identifies a bundle as Husky test bundle:
'Test-Package' */
+ public static final String HEADER_TEST_PACKAGE = "Test-Package";
+
private BundleContext context;
private LogService log;
@@ -56,11 +60,12 @@
if (event.getType() == BundleEvent.STARTED)
{
Bundle bundle = event.getBundle();
- String testPackage = (String)bundle.getHeaders().get("Test-Package");
+ String testPackage = (String)bundle.getHeaders().get(HEADER_TEST_PACKAGE);
if (testPackage != null)
{
log.log(LogService.LOG_INFO, "Test-Package [" + testPackage +
"] in bundle: " + bundle);
- registerPackageListener(bundle, testPackage.split("[, ]"));
+ String[] packages = testPackage.split("[,\\s]");
+ registerPackageListener(bundle, packages);
}
}
}
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnector.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnector.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnector.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -38,7 +38,8 @@
import org.osgi.service.log.LogService;
/**
- * [TODO]
+ * The JMX connector is a {@link Connector} that process Husky
+ * requests via an JMX invocation.
*
* @author Thomas.Diesler(a)jboss.com
* @since 17-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnectorMBean.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnectorMBean.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/JMXConnectorMBean.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -30,7 +30,7 @@
import org.jboss.osgi.husky.runtime.PackageListener;
/**
- * [TODO]
+ * The management interface of the {@link JMXConnector}.
*
* @author Thomas.Diesler(a)jboss.com
* @since 17-May-2009
Modified:
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/SocketConnector.java
===================================================================
---
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/SocketConnector.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/husky/harness/src/main/java/org/jboss/osgi/husky/runtime/osgi/SocketConnector.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -39,13 +39,23 @@
import org.osgi.service.log.LogService;
/**
- * [TODO]
+ * The socket connector is a {@link Connector} that process Husky
+ * requests via an socket invocations.
*
+ * Both, the test runner process as well as the remote target process must
+ * configure the properties {@link #PROP_SOCKET_CONNECTOR_HOST} and
+ * {@link #PROP_SOCKET_CONNECTOR_PORT}.
+ *
* @author Thomas.Diesler(a)jboss.com
* @since 17-May-2009
*/
public class SocketConnector extends AbstractConnector
{
+ /** The Husky socket connector host poperty:
'org.jboss.osgi.husky.runtime.connector.host' */
+ public static final String PROP_SOCKET_CONNECTOR_HOST =
Connector.class.getName().toLowerCase() + ".host";
+ /** The Husky socket connector port poperty:
'org.jboss.osgi.husky.runtime.connector.port' */
+ public static final String PROP_SOCKET_CONNECTOR_PORT =
Connector.class.getName().toLowerCase() + ".port";
+
private LogService log;
private BundleContext context;
private ServiceRegistration sreg;
@@ -64,15 +74,13 @@
private static String getPort(BundleContext context)
{
- String propNamePort = Connector.class.getName().toLowerCase() + ".port";
- String port = context.getProperty(propNamePort);
+ String port = context.getProperty(PROP_SOCKET_CONNECTOR_PORT);
return port;
}
private static String getHost(BundleContext context)
{
- String propNameHost = Connector.class.getName().toLowerCase() + ".host";
- String host = context.getProperty(propNameHost);
+ String host = context.getProperty(PROP_SOCKET_CONNECTOR_HOST);
return host;
}
@@ -102,7 +110,7 @@
listenerThread.stopListener();
}
- private class ListenerThread extends Thread
+ class ListenerThread extends Thread
{
private ServerSocket serverSocket;
Modified:
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/BlueprintCapability.java
===================================================================
---
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/BlueprintCapability.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/BlueprintCapability.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -26,8 +26,13 @@
//$Id$
/**
- * [TODO]
+ * Adds the Blueprint capability to the {@link OSGiRuntime}
+ * under test.
*
+ * It is ignored if the {@link BlueprintService} is already registered.
+ *
+ * Installed bundles: jboss-osgi-blueprint.jar
+ *
* @author thomas.diesler(a)jboss.com
* @since 05-May-2009
*/
Modified:
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/Capability.java
===================================================================
---
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/Capability.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/Capability.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -30,8 +30,15 @@
import java.util.Set;
/**
- * [TODO]
+ * An abstract OSGi capability that can be installed in an
+ * {@link OSGiRuntime}.
*
+ * The capability is only installed if the service name given in the constructor
+ * is not already registered with the OSGi framework.
+ *
+ * It maintains an ordered set of dependent capabilities and bundles that
+ * must be installed to provide the functionality advertised by this capability.
+ *
* @author thomas.diesler(a)jboss.com
* @since 05-May-2009
*/
Modified:
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/ConfigAdminCapability.java
===================================================================
---
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/ConfigAdminCapability.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/spi/src/main/java/org/jboss/osgi/spi/testing/ConfigAdminCapability.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -21,14 +21,18 @@
*/
package org.jboss.osgi.spi.testing;
+//$Id$
+
import org.osgi.service.cm.ConfigurationAdmin;
-
-//$Id$
-
/**
- * [TODO]
+ * Adds the OSGi compedium ConfigAdmin capability to the {@link OSGiRuntime}
+ * under test.
*
+ * It is ignored if the {@link ConfigurationAdmin} is already registered.
+ *
+ * Installed bundles: org.apache.felix.metatype.jar, org.apache.felix.configadmin.jar
+ *
* @author thomas.diesler(a)jboss.com
* @since 05-May-2009
*/
Modified:
projects/jboss-osgi/trunk/testsuite/trailblazer/src/test/java/org/jboss/test/osgi/trailblazer/AuditService.java
===================================================================
---
projects/jboss-osgi/trunk/testsuite/trailblazer/src/test/java/org/jboss/test/osgi/trailblazer/AuditService.java 2009-06-01
15:56:08 UTC (rev 89608)
+++
projects/jboss-osgi/trunk/testsuite/trailblazer/src/test/java/org/jboss/test/osgi/trailblazer/AuditService.java 2009-06-01
16:12:34 UTC (rev 89609)
@@ -1,7 +1,5 @@
package org.jboss.test.osgi.trailblazer;
-
-
/**
* [TODO]
*