/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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.jboss.arquillian.container.osgi.remote;
import static org.jboss.osgi.jmx.JMXConstantsExt.DEFAULT_REMOTE_JMX_HOST;
import static org.jboss.osgi.jmx.JMXConstantsExt.DEFAULT_REMOTE_JMX_RMI_PORT;
import static org.jboss.osgi.jmx.JMXConstantsExt.DEFAULT_REMOTE_JMX_RMI_REGISTRY_PORT;
import static org.jboss.osgi.jmx.JMXConstantsExt.REMOTE_JMX_HOST;
import static org.jboss.osgi.jmx.JMXConstantsExt.REMOTE_JMX_RMI_PORT;
import static org.jboss.osgi.jmx.JMXConstantsExt.REMOTE_JMX_RMI_REGISTRY_PORT;
import java.io.IOException;
import java.net.URL;
import java.util.Iterator;
import java.util.Properties;
import javax.management.InstanceNotFoundException;
import javax.management.MBeanServerConnection;
import javax.management.openmbean.CompositeData;
import javax.management.openmbean.TabularData;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
import org.jboss.arquillian.osgi.internal.AbstractDeployableContainer;
import org.jboss.arquillian.osgi.internal.JMXServiceURLFactory;
import org.jboss.arquillian.protocol.jmx.JMXConnectorServerExt;
import org.jboss.arquillian.protocol.jmx.JMXMethodExecutor;
import org.jboss.arquillian.protocol.jmx.JMXMethodExecutor.ExecutionType;
import org.jboss.arquillian.protocol.jmx.JMXServerFactory;
import org.jboss.arquillian.spi.ContainerMethodExecutor;
import org.jboss.arquillian.spi.Context;
import org.jboss.arquillian.spi.LifecycleException;
import org.jboss.logging.Logger;
import org.jboss.osgi.spi.util.BundleInfo;
import org.jboss.osgi.testing.OSGiTestHelper;
import org.jboss.osgi.testing.internal.ManagementSupport;
import org.jboss.osgi.vfs.AbstractVFS;
import org.jboss.osgi.vfs.VirtualFile;
import org.jboss.shrinkwrap.api.Archive;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleException;
import org.osgi.jmx.framework.BundleStateMBean;
import org.osgi.jmx.framework.FrameworkMBean;
/**
* The remote OSGi container.
*
* @author thomas.diesler@jboss.com
* @version $Revision: $
*/
public class RemoteDeployableContainer extends AbstractDeployableContainer
{
// Provide logging
private static final Logger log = Logger.getLogger(RemoteDeployableContainer.class);
// Workaround for [ARQ-282] DeployableContainer.stop(Context) never called
private static JMXConnectorServerExt jmxConnectorServer;
private JMXConnector jmxConnector;
private ManagementSupport jmxSupport;
@Override
public void start(Context context) throws LifecycleException
{
// Create and start the JMXConnectorServer that the test case uses to connect back to the client
if (jmxConnectorServer == null)
jmxConnectorServer = createJMXConnectorServer();
// Adding a shutdown hook to close JMXConnectors. This hack is a workaround for
// [ARQ-282] DeployableContainer.stop(Context) never called
Runtime.getRuntime().addShutdownHook(new Thread()
{
@Override
public void run()
{
shutdownJMXConnectors();
}
});
// Create the JMXConnector that the test client uses to connect to the remote MBeanServer
MBeanServerConnection connection = getMBeanServerConnection();
jmxSupport = new ManagementSupport(connection);
super.start(context);
installSupportBundles();
}
@Override
public void stop(Context context) throws LifecycleException
{
super.stop(context);
// [ARQ-282] DeployableContainer.stop(Context) never called
// shutdownJMXConnectors();
}
private void shutdownJMXConnectors()
{
// Stop the JMXConnectorServer
if (jmxConnectorServer != null)
{
jmxConnectorServer.stop();
jmxConnectorServer = null;
}
// Close the JMXConnector
if (jmxConnector != null)
{
try
{
jmxConnector.close();
}
catch (IOException ex)
{
log.warn("Cannot close JMXConnector", ex);
}
}
}
@Override
public ContainerMethodExecutor getMethodExecutor(Properties props)
{
MBeanServerConnection mbeanServer = getMBeanServerConnection();
props.put(ExecutionType.class, ExecutionType.REMOTE);
return new JMXMethodExecutor(mbeanServer, props);
}
@Override
public BundleHandle installBundle(Archive<?> archive) throws BundleException, IOException
{
VirtualFile virtualFile = OSGiTestHelper.toVirtualFile(archive);
return installBundle(virtualFile);
}
@Override
public BundleHandle installBundle(URL bundleURL) throws BundleException, IOException
{
VirtualFile virtualFile = AbstractVFS.getRoot(bundleURL);
return installBundle(virtualFile);
}
private BundleHandle installBundle(VirtualFile virtualFile) throws BundleException, IOException
{
BundleInfo info = BundleInfo.createBundleInfo(virtualFile);
String streamURL = info.getRoot().getStreamURL().toExternalForm();
FrameworkMBean frameworkMBean = jmxSupport.getFrameworkMBean();
long bundleId = frameworkMBean.installBundleFromURL(info.getLocation(), streamURL);
return new BundleHandle(bundleId, info.getSymbolicName());
}
@Override
public void uninstallBundle(BundleHandle handle) throws BundleException, IOException
{
FrameworkMBean frameworkMBean = jmxSupport.getFrameworkMBean();
frameworkMBean.uninstallBundle(handle.getBundleId());
}
@Override
public int getBundleState(BundleHandle handle)
{
try
{
BundleStateMBean bundleState = jmxSupport.getBundleStateMBean();
String state = bundleState.getState(handle.getBundleId());
if ("INSTALLED".equals(state))
return Bundle.INSTALLED;
if ("RESOLVED".equals(state))
return Bundle.RESOLVED;
if ("STARTING".equals(state))
return Bundle.STARTING;
if ("ACTIVE".equals(state))
return Bundle.ACTIVE;
if ("STOPPING".equals(state))
return Bundle.STOPPING;
if ("UNINSTALLED".equals(state))
return Bundle.UNINSTALLED;
else
throw new IllegalStateException("Unsupported state: " + state);
}
catch (Exception ex)
{
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof InstanceNotFoundException == false)
log.warn("Cannot get state for bundle: " + this, cause);
return Bundle.UNINSTALLED;
}
}
@Override
public void startBundle(BundleHandle handle) throws BundleException
{
try
{
FrameworkMBean frameworkMBean = jmxSupport.getFrameworkMBean();
frameworkMBean.startBundle(handle.getBundleId());
}
catch (IOException ex)
{
throw new BundleException("Cannot start bundle: " + handle, ex);
}
}
@Override
public void stopBundle(BundleHandle handle) throws BundleException
{
try
{
FrameworkMBean frameworkMBean = jmxSupport.getFrameworkMBean();
frameworkMBean.stopBundle(handle.getBundleId());
}
catch (IOException ex)
{
throw new BundleException("Cannot start bundle: " + handle, ex);
}
}
@Override
public boolean isBundleInstalled(String symbolicName)
{
try
{
BundleStateMBean bundleStateMBean = jmxSupport.getBundleStateMBean();
TabularData listBundles = bundleStateMBean.listBundles();
Iterator<?> iterator = listBundles.values().iterator();
while (iterator.hasNext())
{
CompositeData bundleType = (CompositeData)iterator.next();
String bsn = (String)bundleType.get(BundleStateMBean.SYMBOLIC_NAME);
if (bsn.equals(symbolicName))
return true;
}
return false;
}
catch (RuntimeException rte)
{
throw rte;
}
catch (Exception ex)
{
throw new IllegalStateException("Cannot obtain remote bundles", ex);
}
}
// Get the MBeanServerConnection through the JMXConnector
private MBeanServerConnection getMBeanServerConnection()
{
String jmxHost = System.getProperty(REMOTE_JMX_HOST, System.getProperty("jboss.bind.address", DEFAULT_REMOTE_JMX_HOST));
int jmxPort = Integer.parseInt(System.getProperty(REMOTE_JMX_RMI_PORT, DEFAULT_REMOTE_JMX_RMI_PORT));
int rmiPort = Integer.parseInt(System.getProperty(REMOTE_JMX_RMI_REGISTRY_PORT, DEFAULT_REMOTE_JMX_RMI_REGISTRY_PORT));
JMXServiceURL serviceURL = JMXServiceURLFactory.getServiceURL(jmxHost, jmxPort, rmiPort, "osgi-jmx-connector");
try
{
if (jmxConnector == null)
{
log.debug("Connecting JMXConnector to: " + serviceURL);
jmxConnector = JMXConnectorFactory.connect(serviceURL, null);
}
return jmxConnector.getMBeanServerConnection();
}
catch (IOException ex)
{
throw new IllegalStateException("Cannot obtain MBeanServerConnection to: " + serviceURL, ex);
}
}
private JMXConnectorServerExt createJMXConnectorServer()
{
// Start the JSR160 connector
String jmxHost = System.getProperty(REMOTE_JMX_HOST, System.getProperty("jboss.bind.address", DEFAULT_REMOTE_JMX_HOST));
int jmxPort = Integer.parseInt(System.getProperty(REMOTE_JMX_RMI_PORT, DEFAULT_REMOTE_JMX_RMI_PORT));
int rmiPort = Integer.parseInt(System.getProperty(REMOTE_JMX_RMI_REGISTRY_PORT, DEFAULT_REMOTE_JMX_RMI_REGISTRY_PORT));
JMXServiceURL serviceURL = JMXServiceURLFactory.getServiceURL(jmxHost, jmxPort + 1, rmiPort, "arquillian-osgi-callback");
try
{
log.debug("Starting JMXConnectorServer on: " + serviceURL);
JMXConnectorServerExt connectorServer = new JMXConnectorServerExt(serviceURL, rmiPort);
connectorServer.start(JMXServerFactory.findOrCreateMBeanServer());
return connectorServer;
}
catch (IOException ex)
{
log.error("Cannot start JMXConnectorServer on: " + serviceURL, ex);
return null;
}
}
}