org.jboss.as.arquillian.container.ManagementClient Maven / Gradle / Ivy
/*
* 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.as.arquillian.container;
import static org.jboss.as.controller.client.helpers.ClientConstants.CONTROLLER_PROCESS_STATE_STARTING;
import static org.jboss.as.controller.client.helpers.ClientConstants.CONTROLLER_PROCESS_STATE_STOPPING;
import static org.jboss.as.controller.client.helpers.ClientConstants.DEPLOYMENT;
import static org.jboss.as.controller.client.helpers.ClientConstants.FAILURE_DESCRIPTION;
import static org.jboss.as.controller.client.helpers.ClientConstants.OP;
import static org.jboss.as.controller.client.helpers.ClientConstants.OP_ADDR;
import static org.jboss.as.controller.client.helpers.ClientConstants.OUTCOME;
import static org.jboss.as.controller.client.helpers.ClientConstants.READ_ATTRIBUTE_OPERATION;
import static org.jboss.as.controller.client.helpers.ClientConstants.READ_RESOURCE_OPERATION;
import static org.jboss.as.controller.client.helpers.ClientConstants.RECURSIVE;
import static org.jboss.as.controller.client.helpers.ClientConstants.RESULT;
import static org.jboss.as.controller.client.helpers.ClientConstants.SUBSYSTEM;
import static org.jboss.as.controller.client.helpers.ClientConstants.SUCCESS;
import java.io.Closeable;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.HashMap;
import java.util.List;
import java.util.Set;
import javax.management.Attribute;
import javax.management.AttributeList;
import javax.management.AttributeNotFoundException;
import javax.management.InstanceAlreadyExistsException;
import javax.management.InstanceNotFoundException;
import javax.management.IntrospectionException;
import javax.management.InvalidAttributeValueException;
import javax.management.ListenerNotFoundException;
import javax.management.MBeanException;
import javax.management.MBeanInfo;
import javax.management.MBeanRegistrationException;
import javax.management.MBeanServerConnection;
import javax.management.NotCompliantMBeanException;
import javax.management.NotificationFilter;
import javax.management.NotificationListener;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
import javax.management.QueryExp;
import javax.management.ReflectionException;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
import javax.security.auth.callback.CallbackHandler;
import org.jboss.arquillian.container.spi.client.protocol.metadata.HTTPContext;
import org.jboss.arquillian.container.spi.client.protocol.metadata.JMXContext;
import org.jboss.arquillian.container.spi.client.protocol.metadata.ProtocolMetaData;
import org.jboss.arquillian.container.spi.client.protocol.metadata.Servlet;
import org.jboss.as.controller.client.ModelControllerClient;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.Property;
import org.jboss.logging.Logger;
/**
* A helper class to join management related operations, like extract sub system ip/port (web/jmx)
* and deployment introspection.
*
* @author Aslak Knutsen
*/
public class ManagementClient implements AutoCloseable, Closeable {
private static final Logger logger = Logger.getLogger(ManagementClient.class);
private static final String SUBDEPLOYMENT = "subdeployment";
private static final String UNDERTOW = "undertow";
private static final String NAME = "name";
private static final String SERVLET = "servlet";
private static final String POSTFIX_WEB = ".war";
private static final String POSTFIX_EAR = ".ear";
private final String mgmtAddress;
private final int mgmtPort;
private final String mgmtProtocol;
private final ModelControllerClient client;
private URI webUri;
private URI ejbUri;
// cache static RootNode
private ModelNode rootNode = null;
private MBeanServerConnection connection;
private JMXConnector connector;
public ManagementClient(ModelControllerClient client, final String mgmtAddress, final int managementPort, final String protocol) {
if (client == null) {
throw new IllegalArgumentException("Client must be specified");
}
this.client = client;
this.mgmtAddress = mgmtAddress;
this.mgmtPort = managementPort;
this.mgmtProtocol = protocol;
}
//-------------------------------------------------------------------------------------||
// Public API -------------------------------------------------------------------------||
//-------------------------------------------------------------------------------------||
public ModelControllerClient getControllerClient() {
return client;
}
/**
* @return The base URI or the web susbsystem. Usually http://localhost:8080
*/
public URI getWebUri() {
if (webUri == null) {
try {
webUri = new URI("http://localhost:8080");
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
try {
if (rootNode == null) {
readRootNode();
}
} catch (Exception e) {
throw new RuntimeException(e);
}
ModelNode undertowNode = rootNode.get("subsystem", UNDERTOW);
if (undertowNode.isDefined()) {
List vhosts = undertowNode.get("server").asPropertyList();
ModelNode socketBinding = new ModelNode();
if (!vhosts.isEmpty()) {//if empty no virtual hosts defined
socketBinding = vhosts.get(0).getValue().get("http-listener", "default").get("socket-binding");
}
if (socketBinding.isDefined()) {
webUri = getBinding("http", socketBinding.asString());
}
}
}
return webUri;
}
public ProtocolMetaData getProtocolMetaData(String deploymentName) {
URI webURI = getWebUri();
ProtocolMetaData metaData = new ProtocolMetaData();
metaData.addContext(new JMXContext(getConnection()));
HTTPContext context = new HTTPContext(webURI.getHost(), webURI.getPort());
metaData.addContext(context);
try {
ModelNode deploymentNode = readResource(createDeploymentAddress(deploymentName));
if (isWebArchive(deploymentName)) {
extractWebArchiveContexts(context, deploymentNode);
} else if (isEnterpriseArchive(deploymentName)) {
extractEnterpriseArchiveContexts(context, deploymentNode);
}
} catch (Exception e) {
throw new RuntimeException(e);
}
return metaData;
}
public boolean isServerInRunningState() {
try {
ModelNode op = new ModelNode();
op.get(OP).set(READ_ATTRIBUTE_OPERATION);
op.get(OP_ADDR).setEmptyList();
op.get(NAME).set("server-state");
ModelNode rsp = client.execute(op);
return SUCCESS.equals(rsp.get(OUTCOME).asString())
&& !CONTROLLER_PROCESS_STATE_STARTING.equals(rsp.get(RESULT).asString())
&& !CONTROLLER_PROCESS_STATE_STOPPING.equals(rsp.get(RESULT).asString());
} catch (RuntimeException rte) {
throw rte;
} catch (IOException ex) {
return false;
}
}
@Override
public void close() {
try {
getControllerClient().close();
} catch (IOException e) {
throw new RuntimeException("Could not close connection", e);
} finally {
if (connector != null) {
try {
connector.close();
} catch (IOException e) {
throw new RuntimeException("Could not close JMX connection", e);
}
}
}
}
private void readRootNode() throws Exception {
rootNode = readResource(new ModelNode());
}
private static ModelNode defined(final ModelNode node, final String message) {
if (!node.isDefined()) { throw new IllegalStateException(message); }
return node;
}
private URI getBinding(final String protocol, final String socketBinding) {
try {
final String socketBindingGroupName = rootNode.get("socket-binding-group").keys().iterator().next();
final ModelNode operation = new ModelNode();
operation.get(OP_ADDR).get("socket-binding-group").set(socketBindingGroupName);
operation.get(OP_ADDR).get("socket-binding").set(socketBinding);
operation.get(OP).set(READ_RESOURCE_OPERATION);
operation.get("include-runtime").set(true);
ModelNode binding = executeForResult(operation);
String ip = binding.get("bound-address").asString();
//it appears some system can return a binding with the zone specifier on the end
if (ip.contains(":") && ip.contains("%")) {
ip = ip.split("%")[0];
}
final int port = defined(binding.get("bound-port"), socketBindingGroupName + " -> " + socketBinding + " -> bound-port is undefined").asInt();
return URI.create(protocol + "://" + NetworkUtils.formatPossibleIpv6Address(ip) + ":" + port);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
//-------------------------------------------------------------------------------------||
// Metadata Extraction Operations -----------------------------------------------------||
//-------------------------------------------------------------------------------------||
private boolean isEnterpriseArchive(String deploymentName) {
return deploymentName.endsWith(POSTFIX_EAR);
}
private boolean isWebArchive(String deploymentName) {
return deploymentName.endsWith(POSTFIX_WEB);
}
private ModelNode createDeploymentAddress(String deploymentName) {
ModelNode address = new ModelNode();
address.add(DEPLOYMENT, deploymentName);
return address;
}
private void extractEnterpriseArchiveContexts(HTTPContext context, ModelNode deploymentNode) {
if (deploymentNode.hasDefined(SUBDEPLOYMENT)) {
for (ModelNode subdeployment : deploymentNode.get(SUBDEPLOYMENT).asList()) {
String deploymentName = subdeployment.keys().iterator().next();
if (isWebArchive(deploymentName)) {
extractWebArchiveContexts(context, deploymentName, subdeployment.get(deploymentName));
}
}
}
}
private void extractWebArchiveContexts(HTTPContext context, ModelNode deploymentNode) {
extractWebArchiveContexts(context, deploymentNode.get(NAME).asString(), deploymentNode);
}
private void extractWebArchiveContexts(HTTPContext context, String deploymentName, ModelNode deploymentNode) {
if (deploymentNode.hasDefined(SUBSYSTEM)) {
ModelNode subsystem = deploymentNode.get(SUBSYSTEM);
if (subsystem.hasDefined(UNDERTOW)) {
ModelNode webSubSystem = subsystem.get(UNDERTOW);
if (webSubSystem.isDefined() && webSubSystem.hasDefined("context-root")) {
final String contextName = webSubSystem.get("context-root").asString();
if (webSubSystem.hasDefined(SERVLET)) {
for (final ModelNode servletNode : webSubSystem.get(SERVLET).asList()) {
for (final String servletName : servletNode.keys()) {
context.add(new Servlet(servletName, toContextName(contextName)));
}
}
}
/*
* This is a WebApp, it has some form of webcontext whether it has a
* Servlet or not. AS7 does not expose jsp / default servlet in mgm api
*/
context.add(new Servlet("default", toContextName(contextName)));
}
}
}
}
private String toContextName(String deploymentName) {
String correctedName = deploymentName;
if (correctedName.startsWith("/")) {
correctedName = correctedName.substring(1);
}
return correctedName;
}
//-------------------------------------------------------------------------------------||
// Common Management API Operations ---------------------------------------------------||
//-------------------------------------------------------------------------------------||
private ModelNode readResource(ModelNode address) throws Exception {
final ModelNode operation = new ModelNode();
operation.get(OP).set(READ_RESOURCE_OPERATION);
operation.get(RECURSIVE).set("true");
operation.get(OP_ADDR).set(address);
return executeForResult(operation);
}
private ModelNode executeForResult(final ModelNode operation) throws Exception {
final ModelNode result = client.execute(operation);
checkSuccessful(result, operation);
return result.get(RESULT);
}
private void checkSuccessful(final ModelNode result,
final ModelNode operation) throws UnSuccessfulOperationException {
if (!SUCCESS.equals(result.get(OUTCOME).asString())) {
logger.error("Operation " + operation + " did not succeed. Result was " + result);
throw new UnSuccessfulOperationException(result.get(
FAILURE_DESCRIPTION).toString());
}
}
private MBeanServerConnection getConnection() {
if (connection == null) {
try {
final HashMap env = new HashMap();
if (Authentication.username != null && Authentication.username.length() > 0) {
// Only set this is there is a username as it disabled local authentication.
env.put(CallbackHandler.class.getName(), Authentication.getCallbackHandler());
}
connector = JMXConnectorFactory.connect(getRemoteJMXURL(), env);
connection = new MBeanConnectionProxy(connector.getMBeanServerConnection());
} catch (IOException e) {
throw new RuntimeException(e);
}
}
return connection;
}
public JMXServiceURL getRemoteJMXURL() {
try {
if (mgmtProtocol.equals("http-remoting")) {
return new JMXServiceURL("service:jmx:http-remoting-jmx://" + NetworkUtils.formatPossibleIpv6Address(mgmtAddress) + ":" + mgmtPort);
} else if (mgmtProtocol.equals("https-remoting")) {
return new JMXServiceURL("service:jmx:https-remoting-jmx://" + NetworkUtils.formatPossibleIpv6Address(mgmtAddress) + ":" + mgmtPort);
} else {
return new JMXServiceURL("service:jmx:remoting-jmx://" + NetworkUtils.formatPossibleIpv6Address(mgmtAddress) + ":" + mgmtPort);
}
} catch (Exception e) {
throw new RuntimeException("Could not create JMXServiceURL:" + this, e);
}
}
public int getMgmtPort() {
return mgmtPort;
}
public String getMgmtAddress() {
return NetworkUtils.formatPossibleIpv6Address(mgmtAddress);
}
public String getMgmtProtocol() {
return mgmtProtocol;
}
public URI getRemoteEjbURL() {
if (ejbUri == null) {
URI webUri = getWebUri();
try {
ejbUri = new URI("http-remoting", webUri.getUserInfo(), webUri.getHost(), webUri.getPort(),null,null,null);
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
}
return ejbUri;
}
//-------------------------------------------------------------------------------------||
// Helper classes ---------------------------------------------------------------------||
//-------------------------------------------------------------------------------------||
private static class UnSuccessfulOperationException extends Exception {
private static final long serialVersionUID = 1L;
public UnSuccessfulOperationException(String message) {
super(message);
}
}
private class MBeanConnectionProxy implements MBeanServerConnection {
private MBeanServerConnection connection;
/**
* @param connection connection to delegate to
*/
private MBeanConnectionProxy(MBeanServerConnection connection) {
super();
this.connection = connection;
}
@Override
public ObjectInstance createMBean(String className, ObjectName name) throws ReflectionException,
InstanceAlreadyExistsException, MBeanException, NotCompliantMBeanException,
IOException {
checkConnection();
return connection.createMBean(className, name);
}
@Override
public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName) throws ReflectionException,
InstanceAlreadyExistsException, MBeanException, NotCompliantMBeanException,
InstanceNotFoundException, IOException {
checkConnection();
return connection.createMBean(className, name, loaderName);
}
@Override
public ObjectInstance createMBean(String className, ObjectName name, Object[] params, String[] signature)
throws ReflectionException, InstanceAlreadyExistsException, MBeanException,
NotCompliantMBeanException, IOException {
checkConnection();
return connection.createMBean(className, name, params, signature);
}
@Override
public ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params,
String[] signature) throws ReflectionException, InstanceAlreadyExistsException,
MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException {
checkConnection();
return connection.createMBean(className, name, loaderName, params, signature);
}
@Override
public void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException, IOException {
checkConnection();
connection.unregisterMBean(name);
}
@Override
public ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException, IOException {
try {
return connection.getObjectInstance(name);
} catch (IOException e) {
checkConnection();
return connection.getObjectInstance(name);
}
}
@Override
public Set queryMBeans(ObjectName name, QueryExp query) throws IOException {
try {
return connection.queryMBeans(name, query);
} catch (IOException e) {
checkConnection();
return connection.queryMBeans(name, query);
}
}
@Override
public Set queryNames(ObjectName name, QueryExp query) throws IOException {
try {
return connection.queryNames(name, query);
} catch (IOException e) {
checkConnection();
return connection.queryNames(name, query);
}
}
@Override
public boolean isRegistered(ObjectName name) throws IOException {
try {
return connection.isRegistered(name);
} catch (IOException e) {
checkConnection();
return connection.isRegistered(name);
}
}
@Override
public Integer getMBeanCount() throws IOException {
try {
return connection.getMBeanCount();
} catch (IOException e) {
checkConnection();
return connection.getMBeanCount();
}
}
@Override
public Object getAttribute(ObjectName name, String attribute) throws MBeanException, AttributeNotFoundException,
InstanceNotFoundException, ReflectionException, IOException {
try {
return connection.getAttribute(name, attribute);
} catch (IOException e) {
checkConnection();
return connection.getAttribute(name, attribute);
}
}
@Override
public AttributeList getAttributes(ObjectName name, String[] attributes) throws InstanceNotFoundException,
ReflectionException, IOException {
try {
return connection.getAttributes(name, attributes);
} catch (IOException e) {
checkConnection();
return connection.getAttributes(name, attributes);
}
}
@Override
public void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException,
AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException, IOException {
checkConnection();
connection.setAttribute(name, attribute);
}
@Override
public AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException,
ReflectionException, IOException {
checkConnection();
return connection.setAttributes(name, attributes);
}
@Override
public Object invoke(ObjectName name, String operationName, Object[] params, String[] signature)
throws InstanceNotFoundException, MBeanException, ReflectionException, IOException {
checkConnection();
return connection.invoke(name, operationName, params, signature);
}
@Override
public String getDefaultDomain() throws IOException {
try {
return connection.getDefaultDomain();
} catch (IOException e) {
checkConnection();
return connection.getDefaultDomain();
}
}
@Override
public String[] getDomains() throws IOException {
try {
return connection.getDomains();
} catch (IOException e) {
checkConnection();
return connection.getDomains();
}
}
@Override
public void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter,
Object handback) throws InstanceNotFoundException, IOException {
try {
connection.addNotificationListener(name, listener, filter, handback);
} catch (IOException e) {
if (!checkConnection()) {
connection.addNotificationListener(name, listener, filter, handback);
} else {
throw e;
}
}
}
@Override
public void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)
throws InstanceNotFoundException, IOException {
try {
connection.addNotificationListener(name, listener, filter, handback);
} catch (IOException e) {
if (!checkConnection()) {
connection.addNotificationListener(name, listener, filter, handback);
} else {
throw e;
}
}
}
@Override
public void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException,
ListenerNotFoundException, IOException {
try {
connection.removeNotificationListener(name, listener);
} catch (IOException e) {
if (!checkConnection()) {
connection.removeNotificationListener(name, listener);
} else {
throw e;
}
}
}
@Override
public void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)
throws InstanceNotFoundException, ListenerNotFoundException, IOException {
try {
connection.removeNotificationListener(name, listener, filter, handback);
} catch (IOException e) {
if (!checkConnection()) {
connection.removeNotificationListener(name, listener, filter, handback);
} else {
throw e;
}
}
}
@Override
public void removeNotificationListener(ObjectName name, NotificationListener listener)
throws InstanceNotFoundException, ListenerNotFoundException, IOException {
try {
connection.removeNotificationListener(name, listener);
} catch (IOException e) {
if (!checkConnection()) {
connection.removeNotificationListener(name, listener);
} else {
throw e;
}
}
}
@Override
public void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter,
Object handback) throws InstanceNotFoundException, ListenerNotFoundException, IOException {
try {
connection.removeNotificationListener(name, listener, filter, handback);
} catch (IOException e) {
if (!checkConnection()) {
connection.removeNotificationListener(name, listener, filter, handback);
} else {
throw e;
}
}
}
@Override
public MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException,
ReflectionException, IOException {
try {
return connection.getMBeanInfo(name);
} catch (IOException e) {
checkConnection();
return connection.getMBeanInfo(name);
}
}
@Override
public boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException, IOException {
try {
return connection.isInstanceOf(name, className);
} catch (IOException e) {
checkConnection();
return connection.isInstanceOf(name, className);
}
}
private boolean checkConnection() {
try {
this.connection.getDefaultDomain();
return true;
} catch (IOException ioe) {
}
this.connection = this.getConnection();
return false;
}
private MBeanServerConnection getConnection() {
try {
final HashMap env = new HashMap();
env.put(CallbackHandler.class.getName(), Authentication.getCallbackHandler());
connector = JMXConnectorFactory.connect(getRemoteJMXURL(), env);
connection = connector.getMBeanServerConnection();
} catch (IOException e) {
throw new RuntimeException(e);
}
return connection;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy