com.sun.enterprise.admin.cli.optional.StartDatabaseCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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.
*/
// Portions Copyright [2018] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.admin.cli.optional;
import com.sun.enterprise.admin.cli.CLIProcessExecutor;
import com.sun.enterprise.universal.glassfish.GFLauncherUtils;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.glassfish.api.Param;
import org.glassfish.api.admin.CommandException;
import org.glassfish.api.admin.CommandValidationException;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.annotations.Service;
/**
* start-database command This command class will invoke DBControl to first ping
* if the database is running. If not then it will start the database. If the
* database is already started, then a message will be displayed to the user.
*
* @author Jane Young
* @author Bill Shannon
*/
@Service(name = "start-database")
@PerLookup
public final class StartDatabaseCommand extends DatabaseCommand {
private final static String DATABASE_DIR_NAME = "databases";
@Param(name = "dbhome", optional = true)
private String dbHome;
@Param(name = "jvmoptions", optional = true, separator = ' ')
private String[] jvmoptions;
private static final LocalStringsImpl strings
= new LocalStringsImpl(StartDatabaseCommand.class);
/**
* Defines the command to start the database
*
* @return
*/
public String[] startDatabaseCmd() {
ArrayList cmd = new ArrayList<>();
cmd.add(sJavaHome + File.separator + "bin" + File.separator + "java");
cmd.add("-Djava.library.path=" + sInstallRoot + File.separator + "lib");
cmd.addAll(dbManager.getSystemProperty());
cmd.add("-cp");
cmd.add(sClasspath + File.pathSeparator + sDatabaseClasspath);
if (jvmoptions != null) {
cmd.addAll(Arrays.asList(jvmoptions));
}
cmd.add(dbManager.getDBControl().getName());
cmd.add("start");
cmd.add(dbHost);
cmd.add(dbPort);
cmd.add("true");
cmd.add(dbHome);
return cmd.toArray(new String[cmd.size()]);
}
/**
* Defines the command to print out the database sysinfo
*
* @return
*/
public String[] sysinfoCmd() throws Exception {
List cmd = new ArrayList<>();
cmd.add(sJavaHome + File.separator + "bin" + File.separator + "java");
cmd.add("-Djava.library.path=" + sInstallRoot + File.separator + "lib");
cmd.addAll(dbManager.getSystemProperty());
cmd.add("-cp");
cmd.add(sClasspath + File.pathSeparator + sDatabaseClasspath);
cmd.add(dbManager.getDBControl().getName());
cmd.add("sysinfo");
cmd.add(dbHost);
cmd.add(dbPort);
cmd.add("false");
return cmd.toArray(new String[cmd.size()]);
}
/**
* This method returns dbhome. If dbhome option is specified, then the
* option value is returned. If not, then go through series of conditions to
* determine the default dbhome directory. The conditions are as follow: 1.
* if ${dbType}.log exists in the current directory, then that is the
* default dbhome directory. 2. if ${dbType}.log does not exist in the
* current directory, then create a "databases" in
* . This is usually in filebased
* installation. In package based installation this directory is
* /var/SUNWappserver.
*/
private String getDatabaseHomeDir() {
// dbhome is specified then return the dbhome option value
if (dbHome != null) {
return dbHome;
}
// Check if current directory contains ${dbType}.log
// for now we are going to rely on ${dbType}.log file to ascertain
// whether the current directory is where databases were created.
// However, this may not always be right.
// The reason for this behavior is so that it is
// compatible with 8.2PE and 9.0 release.
// In 8.2PE and 9.0, the current directory is the
// default dbhome.
final String currentDir = System.getProperty("user.dir");
if ((new File(currentDir, dbManager.getLogFileName())).exists()) {
return currentDir;
}
// The default dbhome is /databases
final File installPath = GFLauncherUtils.getInstallDir();
if (installPath != null) {
final File dbDir = new File(installPath, DATABASE_DIR_NAME);
if (!dbDir.isDirectory() && !dbDir.mkdir()) {
logger.warning(strings.get("CantCreateDatabaseDir", dbDir));
}
try {
return dbDir.getCanonicalPath();
} catch (IOException ioe) {
// if unable to get canonical path, then return absolute path
return dbDir.getAbsolutePath();
}
}
// hopefully it'll never get here. if installPath is null then
// asenv.conf is incorrect.
return null;
}
/**
* Execute the command
*
* @throws CommandException
*/
@Override
protected int executeCommand() throws CommandException, CommandValidationException {
final CLIProcessExecutor cpe = new CLIProcessExecutor();
String dbLog = "";
int exitCode = 0;
try {
prepareProcessExecutor();
dbHome = getDatabaseHomeDir();
if (dbHome != null) {
dbLog = dbHome + File.separator + dbManager.getLogFileName();
}
logger.finer("Ping Database");
cpe.execute("pingDatabaseCmd", pingDatabaseCmd(true), true);
// if ping is unsuccesfull then database is not up and running
if (cpe.exitValue() > 0) {
logger.finer("Start Database");
cpe.execute("startDatabaseCmd", startDatabaseCmd(), false);
if (cpe.exitValue() != 0) {
throw new CommandException(strings.get("UnableToStartDatabase", dbLog));
}
} else if (cpe.exitValue() < 0) {
// Something terribly wrong!
throw new CommandException(strings.get("CommandUnSuccessful", name));
} else {
// Database already started
logger.info(strings.get("StartDatabaseStatus", dbHost, dbPort));
}
} catch (IllegalThreadStateException ite) {
// IllegalThreadStateException is thrown if the
// process has not yet teminated and is still running.
// see http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Process.html#exitValue()
// This is good since that means the database is up and running.
CLIProcessExecutor cpePing = new CLIProcessExecutor();
CLIProcessExecutor cpeSysInfo = new CLIProcessExecutor();
try {
if (!programOpts.isTerse()) {
// try getting sysinfo
logger.fine(strings.get("database.info.msg", dbHost, dbPort));
}
cpePing.execute("pingDatabaseCmd", pingDatabaseCmd(true), true);
int counter = 0;
// Give time for the database to be started
while (cpePing.exitValue() != 0 && counter < 10) {
cpePing.execute("pingDatabaseCmd", pingDatabaseCmd(true), true);
Thread.sleep(500);
counter++;
//break out if start-database failed
try {
cpe.exitValue();
break;
} catch (IllegalThreadStateException itse) {
continue;
}
}
if (!programOpts.isTerse()) {
logger.finer("Database SysInfo");
if (cpePing.exitValue() == 0) {
cpeSysInfo.execute("sysinfoCmd", sysinfoCmd(), true);
if (cpeSysInfo.exitValue() != 0) {
logger.info(strings.get("CouldNotGetSysInfo"));
}
}
}
} catch (Exception e) {
throw new CommandException(strings.get("CommandUnSuccessful", name), e);
}
if (cpePing.exitValue() == 0) {
logger.info(strings.get("DatabaseStartMsg"));
if ((new File(dbLog)).canWrite()) {
logger.info(strings.get("LogRedirectedTo", dbLog));
}
} else {
throw new CommandException(strings.get("UnableToStartDatabase", dbLog));
}
} catch (CommandException ce) {
throw ce;
} catch (Exception e) {
throw new CommandException(strings.get("CommandUnSuccessful", name), e);
}
return exitCode;
}
}