/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.launcher;
import java.io.File;
import java.util.*;
import com.sun.enterprise.universal.io.SmartFile;
import com.sun.enterprise.universal.xml.MiniXmlParser;
import com.sun.enterprise.universal.xml.MiniXmlParserException;
import com.sun.enterprise.util.HostAndPort;
/**
*
* @author bnevins
*/
class GFEmbeddedLauncher extends GFLauncher {
public GFEmbeddedLauncher(GFLauncherInfo info) {
super(info);
}
@Override
void internalLaunch() throws GFLauncherException {
try {
launchInstance();
}
catch (Exception ex) {
throw new GFLauncherException(ex);
}
}
@Override
List<File> getMainClasspath() throws GFLauncherException {
throw new GFLauncherException("not needed?!?");
}
@Override
String getMainClass() throws GFLauncherException {
String className = System.getenv(GFE_RUNSERVER_CLASS);
if (className == null)
return "org.glassfish.tests.embedded.EmbeddedMain";
return className;
}
@Override
public synchronized void setup() throws GFLauncherException, MiniXmlParserException {
// remember -- this is designed exclusively for SQE usage
// don't do it mmore than once -- that would be silly!
if (setup)
return;
else
setup = true;
try {
setupFromEnv();
}
catch (GFLauncherException gfle) {
String msg = "";
throw new GFLauncherException(GENERAL_MESSAGE + gfle.getMessage());
}
setCommandLine();
/* it is NOT an error for there to be no domain.xml (yet).
* so eat exceptions. Also just set the default to 4848 if we don't find
* the port...
*/
GFLauncherInfo info = getInfo();
try {
File parent = info.getDomainParentDir();
String domainName = info.getDomainName();
String instanceName = info.getInstanceName();
if (instanceName == null)
instanceName = "server";
File dom = new File(parent, domainName);
File theConfigDir = new File(dom, "config");
File dx = new File(theConfigDir, "domain.xml");
info.setConfigDir(theConfigDir);
info.setDomainRootDir(new File(System.getenv(INSTALL_HOME)));
MiniXmlParser parser = new MiniXmlParser(dx, instanceName);
info.setAdminAddresses(parser.getAdminAddresses());
File logFile = new File(dom, "logs");
logFile = new File(logFile, "server.log");
logFilename = logFile.getAbsolutePath();
}
catch (Exception e) {
// temp todo
e.printStackTrace();
}
List<HostAndPort> adminAddresses = info.getAdminAddresses();
if (adminAddresses == null || adminAddresses.isEmpty()) {
adminAddresses = new ArrayList<HostAndPort>();
adminAddresses.add(new HostAndPort("localhost", 4848, false));
info.setAdminAddresses(adminAddresses);
}
GFLauncherLogger.addLogFileHandler(getLogFilename(), info);
//super.fixLogFilename();
/*
String domainName = parser.getDomainName();
if(GFLauncherUtils.ok(domainName)) {
info.setDomainName(domainName);
}
*/
}
public String getLogFilename() throws GFLauncherException {
return logFilename;
}
@Override
void setClasspath() {
String classPath = gfeJar.getPath() + File.pathSeparator + javaDbClassPath;
if (runServerJar != null)
classPath = classPath + File.pathSeparator + runServerJar.getPath();
setClasspath(classPath);
}
@Override
void setCommandLine() throws GFLauncherException {
List<String> cmdLine = getCommandLine();
cmdLine.clear();
cmdLine.add(javaExe.getPath());
addThreadDump(cmdLine);
cmdLine.add("-cp");
cmdLine.add(getClasspath());
addDebug(cmdLine);
cmdLine.add(getMainClass());
cmdLine.add("--installdir");
cmdLine.add(installDir.getPath());
cmdLine.add("--instancedir");
cmdLine.add(domainDir.getPath());
cmdLine.add("--autodelete");
cmdLine.add("false");
cmdLine.add("--autodeploy");
}
private void addDebug(List<String> cmdLine) {
String suspend;
String debugPort = System.getenv("GFE_DEBUG_PORT");
if (ok(debugPort)) {
suspend = "y";
}
else {
debugPort = "12345";
suspend = "n";
}
cmdLine.add("-Xdebug");
cmdLine.add("-Xrunjdwp:transport=dt_socket,server=y,suspend=" + suspend + ",address=" + debugPort);
}
private void addThreadDump(List<String> cmdLine) {
File logDir = new File(domainDir, "logs");
File jvmLogFile = new File(logDir, "jvm.log");
// bnevins :
// warning these are the only order-dependent JVM options that I know about
// Unlock... *must* come before the other two.
cmdLine.add("-XX:+UnlockDiagnosticVMOptions");
cmdLine.add("-XX:+LogVMOutput");
cmdLine.add("-XX:LogFile=" + jvmLogFile.getPath());
}
private void setupFromEnv() throws GFLauncherException {
// we require several env. variables to be set for embedded-cli usage
setupEmbeddedJars();
setupInstallationDir();
setupJDK();
setupDomainDir();
setupJavaDB();
setClasspath();
}
private void setupDomainDir() throws GFLauncherException {
String domainDirName = getInfo().getDomainName();
domainDir = getInfo().getDomainParentDir();
domainDir = new File(domainDir, domainDirName);
if (!domainDir.isDirectory())
domainDir.mkdirs();
if (!domainDir.isDirectory())
throw new GFLauncherException("Can not create directory: " + domainDir);
domainDir = SmartFile.sanitize(domainDir);
domainXml = SmartFile.sanitize(new File(domainDir, "config/domain.xml"));
}
private void setupJDK() throws GFLauncherException {
String err = "You must set the environmental variable JAVA_HOME to point " +
"at a valid JDK. <jdk>/bin/javac[.exe] must exist.";
String jdkDirName = System.getenv(JAVA_HOME);
if (!ok(jdkDirName))
throw new GFLauncherException(err);
File jdkDir = new File(jdkDirName);
if (!jdkDir.isDirectory())
throw new GFLauncherException(err);
if (File.separatorChar == '\\')
javaExe = new File(jdkDir, "bin/java.exe");
else
javaExe = new File(jdkDir, "bin/java");
if (!javaExe.isFile())
throw new GFLauncherException(err);
javaExe = SmartFile.sanitize(javaExe);
}
private void setupInstallationDir() throws GFLauncherException {
String err = "You must set the environmental variable S1AS_HOME to point " +
"at a GlassFish installation or at an empty directory or at a " +
"location where an empty directory can be created.";
String installDirName = System.getenv(INSTALL_HOME);
if (!ok(installDirName))
throw new GFLauncherException(err);
installDir = new File(installDirName);
if (!installDir.isDirectory())
installDir.mkdirs();
if (!installDir.isDirectory())
throw new GFLauncherException(err);
installDir = SmartFile.sanitize(installDir);
}
private void setupEmbeddedJars() throws GFLauncherException {
String err = "You must set the environmental variable GFE_JAR to point " +
"at the Embedded jarfile.";
String gfeJarName = System.getenv(GFE_JAR);
if (!ok(gfeJarName))
throw new GFLauncherException(err);
gfeJar = new File(gfeJarName);
if (!gfeJar.isFile() || gfeJar.length() < 1000000L)
throw new GFLauncherException(err);
gfeJar = SmartFile.sanitize(gfeJar);
err = "You must set the environmental variable GFE_RUNSERVER_JAR to point " +
"at the server startup jar.";
String runServerJarName = System.getenv(GFE_RUNSERVER_JAR);
if (runServerJarName != null) {
if (!ok(runServerJarName)) {
throw new GFLauncherException(err);
}
runServerJar = new File(runServerJarName);
if (!runServerJar.isFile())
throw new GFLauncherException(err);
runServerJar = SmartFile.sanitize(runServerJar);
}
}
private void setupJavaDB() throws GFLauncherException {
// It normally will be in either:
// * install-dir/javadb/lib
// * install-dir/../javadb/lib
if(javaDbClassPath != null)
return;
String relPath = "javadb/lib";
File derbyLib = new File(installDir, relPath);
if(!derbyLib.isDirectory())
derbyLib = new File(installDir.getParentFile(), relPath);
if(!derbyLib.isDirectory())
throw new GFLauncherException("Could not find the JavaDB lib directory.");
// we have a valid directory. Let's verify the right jars are there!
javaDbClassPath = "";
boolean firstItem = true;
for(String fname : DERBY_FILES) {
File f = new File(derbyLib, fname);
if(javaDbClassPath == null) {
javaDbClassPath = f.getPath();
}
else {
javaDbClassPath += File.pathSeparator;
javaDbClassPath += f.getPath();
}
if(!f.exists())
throw new GFLauncherException("Could not find the JavaDB jar: " + f);
}
}
private boolean ok(String s) {
return s != null && s.length() > 0;
}
private boolean setup = false;
private File gfeJar, runServerJar;
private File installDir;
private File javaExe;
private File domainDir;
private File domainXml;
private String javaDbClassPath, logFilename;
private static final String GFE_RUNSERVER_JAR = "GFE_RUNSERVER_JAR";
private static final String GFE_RUNSERVER_CLASS = "GFE_RUNSERVER_CLASS";
private static final String GFE_JAR = "GFE_JAR";
private static final String INSTALL_HOME = "S1AS_HOME";
private static final String JAVA_HOME = "JAVA_HOME";
//private static final String DOMAIN_DIR = "GFE_DOMAIN";
private static final String GENERAL_MESSAGE =
" ********* GENERAL MESSAGE ********\n" +
"You must setup four different environmental variables to run embedded" +
" with asadmin. They are\n" +
"GFE_JAR - path to the embedded jar\n" +
"S1AS_HOME - path to installation directory. This can be empty or not exist yet.\n" +
"JAVA_HOME - path to a JDK installation. JRE installation is generally not good enough\n" +
"GFE_DEBUG_PORT - optional debugging port. It will start suspended.\n" +
"\n********* SPECIFIC MESSAGE ********\n";
private String[] DERBY_FILES =
{
"derby.jar",
"derbyclient.jar",
};
}