/*
* Jopr Management Platform
* Copyright (C) 2005-2009 Red Hat, Inc.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2, as
* published by the Free Software Foundation, and/or the GNU Lesser
* General Public License, version 2.1, also as published by the Free
* Software Foundation.
*
* This program 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 General Public License and the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program;
* if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.rhq.plugins.jbossas5.helper;
import java.io.File;
import java.io.FilenameFilter;
import java.io.IOException;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import org.apache.maven.artifact.versioning.ComparableVersion;
/**
* A class that aggregates various static information about a JBoss AS/EAP/SOA-P installation.
*
* @author Ian Springer
* @author Jessica Sant
*/
public class JBossInstallationInfo {
private static final String ANY_ADDRESS = "0.0.0.0";
private static final String LOCALHOST_ADDRESS = "127.0.0.1";
private static final String SOA_IMPL_VERSION_PREFIX = "SOA-";
private static final String EAP_IMPL_VERSION_PREFIX = "EAP-";
private static final String EPP_IMPL_VERSION_PREFIX = "JBoss-EPP";
private static final ComparableVersion VERSION_4_2 = new ComparableVersion("4.2");
private JBossProductType productType;
private String version;
private String defaultBindAddress;
private boolean isEap;
private String majorVersion;
public JBossInstallationInfo(File installationDir) throws IOException {
File binDir = new File(installationDir, "bin");
File runJar = new File(binDir, "run.jar");
if (!runJar.exists()) {
throw new RuntimeException(runJar + " does not exist - " + installationDir
+ " does not appear to be a JBoss installation/home directory.");
}
Attributes jarManifestAttributes = loadManifestAttributesFromJar(runJar);
this.productType = JBossProductType.determineJBossProductType(jarManifestAttributes);
this.version = getVersion(jarManifestAttributes);
int majorVersionIndex = version.indexOf('.');
if (-1 == majorVersionIndex) {
throw new RuntimeException("Unexpected run.jar implementation version, can't parse: " + this.version);
}
fixProductTypeAndVersion(jarManifestAttributes, installationDir);
this.defaultBindAddress = getDefaultServerName(this.version);
this.isEap = determineEap(jarManifestAttributes);
this.majorVersion = version.substring(0, version.indexOf('.'));
}
/**
* Tries to make sense of the mess of JBoss product versioning.
*
* @param jarManifestAttributes
* @param installationDir
*/
private void fixProductTypeAndVersion(Attributes jarManifestAttributes, File installationDir) {
//the main mess is with BRMS < 5.3.0 being advertised as EWP
if (productType == JBossProductType.EWP && version.startsWith("5.1")) {
//this still can be a BRMS server... We can check that by looking for drools jars
//in the client. Brittle you say? Yes, of course ;)
File client = new File(installationDir, "client");
if (client.exists() && client.isDirectory()) {
boolean containsBrmsJars = false;
for(String file : client.list()) {
if (file.endsWith("BRMS.jar")) {
containsBrmsJars = true;
break;
}
}
if (containsBrmsJars) {
productType = JBossProductType.BRMS;
if ("5.1.1".equals(version)) {
//BRMS 5.2.0 is based on EWP 5.1.1
version = "5.2.0";
}
}
}
}
}
public JBossProductType getProductType() {
return this.productType;
}
/**
* Returns the version of this JBoss installation. AS versions 4.0.4 or later will be OSGi-style (e.g. 4.0.4.GA);
* earlier versions will not (e.g. 4.0.1sp1, 4.0.2).
*
* @return the version of this JBoss installation
*/
public String getVersion() {
return this.version;
}
public String getDefaultBindAddress() {
return this.defaultBindAddress;
}
/**
* Returns if this is an EAP version of the server
*
* @return
*/
public boolean isEap() {
return isEap;
}
public String getMajorVersion() {
return majorVersion;
}
/**
* Loads the top-level attributes from the manifest file of the given jar file.
*
* @param jarFile the jar file
* @return the top-level attributes from the manifest file
* @throws IOException on failure to read the jar file
*/
private static Attributes loadManifestAttributesFromJar(File jarFile) throws IOException {
JarFile jar = new JarFile(jarFile);
Attributes mainAttributes = jar.getManifest().getMainAttributes();
jar.close();
return mainAttributes;
}
private static String getVersion(Attributes jarManifestAttributes) {
String implementationVersion = jarManifestAttributes.getValue(Attributes.Name.IMPLEMENTATION_VERSION);
// e.g. AS 5.1: "Implementation-Version: 5.1.0.GA (build: SVNTag=JBoss_5_1_0_GA date=200905221634)"
// e.g. EAP 5.0: "Implementation-Version: 5.0.0.Beta (build: SVNTag=JBPAPP_5_0_0_Beta date=200906191731)"
if (implementationVersion.startsWith(EPP_IMPL_VERSION_PREFIX)) {
implementationVersion = implementationVersion.substring(EPP_IMPL_VERSION_PREFIX.length()).trim();
}
int spaceIndex = validateImplementationVersion(implementationVersion);
String version = implementationVersion.substring(0, spaceIndex);
if (version.startsWith(SOA_IMPL_VERSION_PREFIX)) {
version = version.substring(SOA_IMPL_VERSION_PREFIX.length());
}
if (version.startsWith(EAP_IMPL_VERSION_PREFIX)) {
version = version.substring(EAP_IMPL_VERSION_PREFIX.length());
}
return version;
}
private static boolean determineEap(Attributes jarManifestAttributes) {
String implementationTitle = jarManifestAttributes.getValue(Attributes.Name.IMPLEMENTATION_TITLE);
// e.g. AS 5.1: "Implementation-Title: JBoss [The Oracle]"
// e.g. EAP 5.0: "Implementation-Title: JBoss [EAP]"
return implementationTitle.contains("[EAP]");
}
private static int validateImplementationVersion(String implementationVersion) {
if (implementationVersion == null) {
throw new IllegalStateException("'" + Attributes.Name.IMPLEMENTATION_VERSION
+ "' MANIFEST.MF attribute not found.");
}
int spaceIndex = implementationVersion.indexOf(' ');
if (spaceIndex == -1) {
throw new IllegalStateException("'" + Attributes.Name.IMPLEMENTATION_VERSION
+ "' MANIFEST.MF attribute has an invalid value: " + implementationVersion);
}
return spaceIndex;
}
private static String getDefaultServerName(String serverVersion) {
ComparableVersion comparableVersion = new ComparableVersion(serverVersion);
return (comparableVersion.compareTo(VERSION_4_2) >= 0) ? LOCALHOST_ADDRESS : ANY_ADDRESS;
}
@Override
public String toString() {
return this.getClass().getSimpleName() + "[productType=" + this.productType + ", version=" + this.version
+ ", defaultBindAddress=" + this.defaultBindAddress + "]";
}
}