org.jboss.remotingjmx.Util Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2012, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.remotingjmx;
import static org.jboss.remotingjmx.Constants.HTTPS_SCHEME;
import static org.jboss.remotingjmx.Constants.HTTP_SCHEME;
import static org.jboss.remotingjmx.Constants.PROTOCOL_HTTPS_REMOTING_JMX;
import static org.jboss.remotingjmx.Constants.PROTOCOL_HTTP_REMOTING_JMX;
import static org.jboss.remotingjmx.Constants.PROTOCOL_REMOTE;
import static org.jboss.remotingjmx.Constants.PROTOCOL_REMOTE_HTTP;
import static org.jboss.remotingjmx.Constants.PROTOCOL_REMOTE_HTTPS;
import static org.jboss.remotingjmx.Constants.PROTOCOL_REMOTING_JMX;
import static org.jboss.remotingjmx.Constants.REMOTE_SCHEME;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Map;
import javax.management.remote.JMXServiceURL;
import org.jboss.logging.Logger;
/**
* A holder for utility methods.
*
* @author Darran Lofthouse
* @author Brad Maxwell
*/
public class Util {
private static final Logger log = Logger.getLogger(Util.class);
private static Integer DEFAULT_TIMEOUT_SECONDS = 30;
public static enum Timeout {
GENERIC("org.jboss.remoting-jmx.timeout"),
CHANNEL("org.jboss.remoting-jmx.timeout.channel"),
CONNECTION("org.jboss.remoting-jmx.timeout.connection"),
VERSIONED_CONNECTION("org.jboss.remoting-jmx.timeout.versioned.connection");
private String propertyName;
Timeout(String propertyName) {
this.propertyName = propertyName;
}
public String toString() {
return propertyName;
}
}
// Prevent instantiation.
private Util() {
}
private static void warnDeprecated(String usedProtocol, String recommendedProtocol) {
log.warnf("The protocol '%s' is deprecated, instead you should use '%s'.", usedProtocol, recommendedProtocol);
}
@SuppressWarnings("deprecation")
public static URI convert(final JMXServiceURL serviceUrl) throws IOException {
String urlProtocol = serviceUrl.getProtocol();
final String scheme;
// This deliberately allows the fall through from the deprecated case.
switch (urlProtocol) {
case PROTOCOL_REMOTING_JMX:
warnDeprecated(PROTOCOL_REMOTING_JMX, PROTOCOL_REMOTE);
case PROTOCOL_REMOTE:
scheme = REMOTE_SCHEME;
break;
case PROTOCOL_HTTP_REMOTING_JMX:
warnDeprecated(PROTOCOL_HTTP_REMOTING_JMX, PROTOCOL_REMOTE_HTTP);
case PROTOCOL_REMOTE_HTTP:
scheme = HTTP_SCHEME;
break;
case PROTOCOL_HTTPS_REMOTING_JMX:
warnDeprecated(PROTOCOL_HTTPS_REMOTING_JMX, PROTOCOL_REMOTE_HTTPS);
case PROTOCOL_REMOTE_HTTPS:
scheme = HTTPS_SCHEME;
break;
default:
throw new IllegalArgumentException(String.format("Unrecognised protocol '%s'", urlProtocol));
}
String host = serviceUrl.getHost();
int port = serviceUrl.getPort();
try {
return new URI(scheme, null, host, port, null, null, null);
} catch (URISyntaxException e) {
throw new IOException("Unable to create connection URI", e);
}
}
public static Integer getTimeoutValue(Timeout property, Map environment) {
// Check for most specific system property first
Integer timeoutSeconds = Integer.getInteger(property.toString());
if(timeoutSeconds != null)
return timeoutSeconds;
// Check for generic system property
timeoutSeconds = Integer.getInteger(Timeout.GENERIC.toString());
if(timeoutSeconds != null)
return timeoutSeconds;
if(environment != null) {
// Check most specific property in the environment
timeoutSeconds = getInteger(environment.get(property.toString()));
if(timeoutSeconds != null)
return timeoutSeconds;
// Check property in the environment
timeoutSeconds = getInteger(environment.get(Timeout.GENERIC.toString()));
if(timeoutSeconds != null)
return timeoutSeconds;
}
return DEFAULT_TIMEOUT_SECONDS;
}
// Return an integer if it is an Integer or can get Integer from String, else null
public static Integer getInteger(Object object) {
try {
if(object instanceof Integer)
return (Integer) object;
if(object instanceof String)
return Integer.valueOf((String) object);
} catch(NumberFormatException nfe) {
}
return null;
}
}