| Methods Summary |
|---|
| void | abortServer()AS PE will wait before exiting, until client executes this method.
try {
getRMIClient().triggerServerExit();
}
catch (Throwable t) {
//Even if there is an error, that should not affect client performance.
//Ignore the error.
}
|
| public void | createInstance()
throw new UnsupportedOperationException(
_strMgr.getString("notSupported"));
|
| public void | deleteInstance()
throw new UnsupportedOperationException(
_strMgr.getString("notSupported"));
|
| void | execute(java.io.File script)
try
{
ProcessExecutor exec = new ProcessExecutor(
new String[] {script.getAbsolutePath()});
exec.execute();
}
catch (Exception e)
{
throw new InstanceException(_strMgr.getString("procExecError"), e);
}
|
| com.sun.enterprise.util.ProcessExecutor | execute(java.lang.String[] command)
return execute(command, null);
|
| com.sun.enterprise.util.ProcessExecutor | execute(java.lang.String[] command, java.lang.String[] interativeOptions)
try
{
ProcessExecutor exec = new ProcessExecutor(command, interativeOptions);
if (nativeLauncher) {
// native processes don't return, so don't wait
// this follows the methodology for se, but should be revisted to make
// sure timeouts for state transitions are reasonable
exec.execute(false, false);
} else {
// expect the process to return
exec.execute();
}
// this signature for execute will terminiate the process
// if it goes on too long, reason for return signature is for SE ProcessManager watchdog
return exec;
}
catch (Exception e)
{
throw new InstanceException(_strMgr.getString("procExecError"), e);
}
|
| protected int | executeKillServ(java.util.List pidList)
if (debug) System.out.println("PID fed to killserv is = " + pidList);
try {
String killServScript = fetchKillServ();
List<String> cmds = new ArrayList<String>();
cmds.add(killServScript);
cmds.addAll(pidList);
ProcessBuilder pb = new ProcessBuilder(cmds);
Process killer = pb.start();
return killer.waitFor();
} catch (Exception ex) {
throw new InstanceException(ex);
}
|
| private java.lang.String | fetchKillServ()
String killServScript =
getConfig().getRepositoryRoot() + File.separator +
getConfig().getRepositoryName() + File.separator;
if (getConfig().getInstanceName() != null)
killServScript += getConfig().getInstanceName() + File.separator;
killServScript += "bin" + File.separator + PEFileLayout.KILL_SERV_OS;
File killServ = new File(killServScript);
if (killServ.exists()) return killServScript;
String installLibKillServ =
getFileLayout().getInstallRootDir().getAbsolutePath() +
File.separator + PEFileLayout.LIB_DIR + File.separator +
PEFileLayout.KILL_SERV_OS;
return installLibKillServ;
|
| protected com.sun.enterprise.admin.servermgmt.RepositoryConfig | getConfig()
return _config;
|
| int | getConflictedPort()Get the port on which conflict occured.
int port = 0;
try {
port = getRMIClient().getConflictedPort();
}
catch (Exception ex) {
// Not interested!!
}
return port;
|
| protected PEFileLayout | getFileLayout()
return super.getFileLayout(getConfig());
|
| public int | getInstanceStatus()
int status = Integer.MIN_VALUE;
try {
status = getRMIClient().getInstanceStatusCode();
}
catch (Exception ex) {
/**
* There is a timimg issue here while reading the admsn file.
* If the client attempts to rmi the server before the admsn
* is created an exception will be thrown. Supressing the exception
* so that the client will be able to rmi the server in the next
* attempt once the admsn was created.
*/
//throw new InstanceException(ex);
//log this??
}
return status;
|
| public java.lang.String | getNativeName()
return "appservDAS";
|
| protected java.util.List | getPIDsToBeKilled()
List<String> pids = new ArrayList<String>();
int pid = NO_PROCESS;
File pidFileDir = getFileLayout().getConfigRoot();
File pidFile = new File(pidFileDir, SystemPropertyConstants.PID_FILE);
if (! isPIDFileValid(pidFileDir, pidFile))
return pids;
pid = JvmInfoUtil.getPIDfromFileAndDelete(pidFile);
// 2. check if file has latest pid - TODO
if (pid != NO_PROCESS) pids.add(""+pid);
return pids;
|
| private com.sun.enterprise.admin.server.core.channel.RMIClient | getRMIClient()
if (rmiClient == null)
{
String stubPath = getFileLayout().getStubFile().getAbsolutePath();
String seedPath = getFileLayout().getSeedFile().getAbsolutePath();
rmiClient = new RMIClient(false, stubPath, seedPath);
}
return rmiClient;
|
| public boolean | isInstanceFailed()Returns whether the server is in the startup failed state or
not.
return (Status.kInstanceFailedCode ==
getInstanceStatus());
|
| public boolean | isInstanceNotRunning()
return (Status.kInstanceNotRunningCode ==
getInstanceStatus());
|
| public boolean | isInstanceRunning()
return (Status.kInstanceRunningCode ==
getInstanceStatus());
|
| public boolean | isInstanceStarting()
return (getInstanceStatus() ==
Status.kInstanceStartingCode);
|
| protected boolean | isPIDFileValid(java.io.File pidFileDir, java.io.File pidFile)
// Before reading it and executing scripts using the pids in that
// file, compare the timestamp on this file and the admsn file in
// the same folder. Why compare with admsn? Because I need to make
// sure that this pid file was indeed updated when the VM came up
// If it was not then we should not kill some random processes with
// pids corresponding to the stale pids in the file. And to effect
// that I have to use some relative timestamp - in this case it is
// that of admsn. Also admsn does not get deleted during VM stop
// It was important to choose a file (for reference timestamp) that
// will not be deleted during VM stop. Otherwise the --kill option
// will be useless if the VM hung after deleting the reference file
// during the stop. We need the --kill option exactly in this
// scenario. Hence the choice of admsn
File refTSFile = new File(pidFileDir, SystemPropertyConstants.REF_TS_FILE);
if (pidFile.lastModified() < refTSFile.lastModified())
return false;
return true;
|
| public boolean | isRestartNeeded()
boolean isRestartNeeded = false;
try
{
isRestartNeeded = getRMIClient().isRestartNeeded();
}
catch (Exception e)
{
throw new InstanceException(e.getMessage(), e);
}
return isRestartNeeded;
|
| private boolean | isStoppable()To stop an instance the instance must be in (running | stopping |
starting) state.
final int state = getInstanceStatus();
return
state == Status.kInstanceRunningCode ||
state == Status.kInstanceStartingCode;
|
| private boolean | isTrue(java.lang.Boolean b)
return Boolean.TRUE.equals(b);
|
| public void | killRelatedProcesses()
List<String> pids = getPIDsToBeKilled();
// kill the hanging process
if (!pids.isEmpty()) {
int exitValue = executeKillServ(pids);
if (debug) System.out.println("Exit value is = " + exitValue);
if (exitValue != 0)
throw new InstanceException(
getMessages().getCannotStopInstanceMessage(
getConfig().getDisplayName()));
} else {
throw new InstanceException(_strMgr.getString("noPidsToKill"));
}
|
| public java.lang.String[] | listInstances()
throw new UnsupportedOperationException(
_strMgr.getString("notSupported"));
|
| private boolean | ok(java.lang.String s)
return s != null && s.length() > 0;
|
| void | postStart()
if (isInstanceFailed()) {
int port = getConflictedPort();
abortServer();
throw new InstanceException(
getMessages().getStartupFailedMessage(
getConfig().getDisplayName(), port ));
}
if (!isInstanceRunning() &&
!isInstanceNotRunning())
{
/*
Instance could not be started in TIME_OUT_SECONDS.
Trying to stop.
*/
try {
stopInstance();
} catch (Exception e) {
throw new InstanceException(
getMessages().getStartInstanceTimeOutMessage(
getConfig().getDisplayName()), e);
}
throw new InstanceException(
getMessages().getStartInstanceTimeOutMessage(
getConfig().getDisplayName()));
}
if (isInstanceNotRunning()) {
throw new InstanceException(
getMessages().getStartupFailedMessage(
getConfig().getDisplayName()));
}
setRMIClient(null);
|
| void | postStop()
if (!isInstanceNotRunning())
{
throw new InstanceException(
getMessages().getCannotStopInstanceMessage(
getConfig().getDisplayName()));
}
setRMIClient(null);
|
| protected void | preStart()To start an instance the instance must be in not running state.
final int state = getInstanceStatus();
if (Status.kInstanceNotRunningCode != state)
{
throw new InstanceException(
getMessages().getCannotStartInstanceInvalidStateMessage(
getConfig().getDisplayName(),
Status.getStatusString(state)));
}
|
| private void | restoreSystemProps()
System.setProperties(systemPropsCopy);
|
| private void | saveSystemProps()
systemPropsCopy = new Properties();
systemPropsCopy.putAll(System.getProperties());
|
| private void | setRMIClient(com.sun.enterprise.admin.server.core.channel.RMIClient client)
this.rmiClient = client;
|
| private void | setSecurity()
// Ref: Issue 1558
// if the username, admin password and master password are all empty or
// null strings, don't mess with writing to the stdin of
// the AS process eventually.
// Note that this case never happens currently. The master password will always
// be set to something.
boolean gotAtLeastOne =
securityInfo != null &&
securityInfo.length >=3 &&
(ok(securityInfo[0]) || ok(securityInfo[1]) || ok(securityInfo[2]));
if(gotAtLeastOne)
{
System.setProperty("com.sun.aas.promptForIdentity", "true");
}
else
{
// don't set com.sun.aas.promptForIdentity to false -- it may be seen as true anyways!!
securityInfo = null;
}
|
| public java.lang.Process | startInstance(java.lang.String[] SecurityInfo, java.lang.String[] commandLineArgs, java.util.Properties EnvProps)startInstance method to use if there are security strings (user]pw/master-pw),
args, and the env props to set.
Process process = null;
securityInfo = SecurityInfo;
envProps = EnvProps;
if(envProps == null)
envProps = new Properties(); // I don't want to check for null a zillion times!
nativeLauncher = Boolean.getBoolean(SystemPropertyConstants.NATIVE_LAUNCHER);
// WBN TURN OFF OLD CODE BY DEFAULT
String s = System.getenv("OLD_LAUNCHER");
if(s != null && s.equals("true"))
return startInstanceUsingScript(commandLineArgs);
// synchronize across ALL instances of this class
synchronized(getClass())
{
// EVERYTHING between saving & restoring system properties must be
// protected from other threads.
try
{
saveSystemProps();
/*
if(nativeLauncher)
return startInstanceUsingScript(commandLineArgs);
else
*/
process = startInstanceAllJava(commandLineArgs);
}
finally
{
restoreSystemProps();
}
}
if(!verbose || nativeLauncher)
{
waitUntilStarting(null);
waitUntilStarted();
postStart();
}
return process;
|
| public java.lang.Process | startInstance(java.lang.String[] interativeOptions, java.lang.String[] commandLineArgs)
return startInstance(interativeOptions, commandLineArgs, null);
|
| public java.lang.Process | startInstance()startInstance method to use if there aren't any interactiveOptions or
args to append to the executing process
return startInstance(null, null);
|
| public java.lang.Process | startInstance(java.lang.String[] interativeOptions)startInstance method to use if there are interactiveOption, but no
args to append to the executing process
String[] commandLineArgs=null;
return startInstance(interativeOptions, commandLineArgs);
|
| private java.lang.Process | startInstanceAllJava(java.lang.String[] commandLineArgs)startInstance method to use if there are interactiveOption and
args to append to the executing process
Process process = null;
try
{
// Invoke launcher directly without running startserv script.
// This saves a JVM
verbose = false;
debug = false;
preStart();
if(isTrue((Boolean)getConfig().get(DomainConfig.K_VERBOSE)))
verbose = true;;
if(isTrue((Boolean)getConfig().get(DomainConfig.K_DEBUG)))
debug = true;
setSecurity();
ArrayList<String> args = new ArrayList<String>();
args.add("start");
if(nativeLauncher)
args.add("display");
if ( debug )
args.add("debug");
if ( verbose )
args.add("verbose");
if (commandLineArgs != null)
{
for (String arg : commandLineArgs)
if(!args.contains(arg)) // no duplicates
args.add(arg);
}
String[] launcherArgs = args.toArray(new String[args.size()]);
System.setProperty(SystemPropertyConstants.INSTANCE_ROOT_PROPERTY,
getConfig().getRepositoryRoot() + File.separator +
getConfig().getRepositoryName());
if(nativeLauncher)
{
ASNativeLauncher launcher = new ASNativeLauncher(this);
launcher.preProcess(launcherArgs, envProps);
try
{
process = launcher.launch(launcherArgs, securityInfo);
}
catch(ASLauncherException e)
{
throw new InstanceException(e);
}
}
else
{
ASLauncher launcher = new ASLauncher();
launcher.setRefreshConfigContext(_config.getRefreshConfigContext());
launcher.preProcess(launcherArgs, envProps);
process = launcher.process(launcherArgs, securityInfo);
}
}
catch ( Exception ex )
{
throw new InstanceException(
getMessages().getInstanceStartupExceptionMessage(
getConfig().getDisplayName()), ex);
}
return process;
|
| protected com.sun.enterprise.util.ProcessExecutor | startInstanceExecute(java.lang.String[] command, java.lang.String[] SecurityInfo)This method is called internally from the startInstance method
and was needed so SE could execute a process that doesn't return
return execute(command, SecurityInfo);
|
| private java.lang.Process | startInstanceUsingScript(java.lang.String[] commandLineArgs)Ancient code that uses startserv script
preStart();
// check if --debug or --verbose options were given to asadmin
Boolean v = (Boolean)getConfig().get(DomainConfig.K_VERBOSE);
verbose = false;
if ( v != null ) {
verbose = v.booleanValue();
}
Boolean d = (Boolean)getConfig().get(DomainConfig.K_DEBUG);
debug = false;
if ( d != null ) {
debug = d.booleanValue();
}
String[] command=null;
File script = getFileLayout(getConfig()).getStartServ();
Process process=null;
ArrayList alCmd=new ArrayList();
// append required arguments to start command
alCmd.add(script.getAbsolutePath());
// WBN - we need to distinguish CLI calls from commandline calls
alCmd.add("cli");
//
// add temporary switch for new ProcessLauncher. Will optimize this section
// better once the commons-launcher is removed ???
// This will be removed once PE using the new invocation classes
if ( System.getProperty("com.sun.aas.processLauncher") == null && verbose ) {
try {
// Invoke launcher directly without running startserv script.
// This saves a JVM, and will allow CTRL-C and CTRL-\ on asadmin
// to reach the server JVM.
// Set system props needed by launcher
System.setProperty(SystemPropertyConstants.INSTANCE_ROOT_PROPERTY,
getConfig().getRepositoryRoot() + File.separator +
getConfig().getRepositoryName());
ArrayList args = new ArrayList();
args.add("s1as-server");
//FIXTHIS: The com.sun.aas.instanceName probably needs to be dynamically set, but for
//now this is not important as it is not being used.
args.add("-Dcom.sun.aas.instanceName=server");
args.add("start");
if ( debug ) {
args.add("debug");
}
if ( verbose ) {
args.add("verbose");
}
// addin command line args
if (commandLineArgs != null) {
for(int ii=0; ii < commandLineArgs.length; ii++) {
args.add(commandLineArgs[ii]);
}
}
// extract full command
String[] argStrings = (String[])args.toArray(
new String[args.size()]);
/* This doesnt work with the JDK1.4.2 javac
LauncherBootstrap.main(argStrings);
*/
Class launcherClass = Class.forName("LauncherBootstrap");
Class[] paramClasses = new Class[] { String[].class };
Object[] argsArray = new Object[] { argStrings };
Method mainMethod = launcherClass.getMethod("main", paramClasses);
// If verbose, LauncherBootstrap.main() returns only after
// the appserver JVM exits.
mainMethod.invoke(null, argsArray);
} catch ( Exception ex ) {
throw new InstanceException(
getMessages().getInstanceStartupExceptionMessage(
getConfig().getDisplayName()), ex);
}
} else if (System.getProperty("com.sun.aas.processLauncher") != null && verbose) {
// add arguments to main command, native must come first
if (nativeLauncher) {
// use native launcher, add in argument
alCmd.add("native");
}
if (debug) alCmd.add("debug");
if (verbose) alCmd.add("verbose");
// addin command line args
if (commandLineArgs != null) {
for(int ii=0; ii < commandLineArgs.length; ii++) {
alCmd.add(commandLineArgs[ii]);
}
}
// extract full command
command=new String[alCmd.size()];
command=(String[])alCmd.toArray(command);
try {
// exec process directly to exercise needed control
ProcessExecutor exec = new ProcessExecutor(command, securityInfo);
// set verbose flag so process error stream get redirected to stderr
exec.setVerbose(verbose);
// call execute so it will not be timed out
exec.execute(false, false);
process=exec.getSubProcess();
// this will force process to wait for executing process
int exitValue=process.waitFor();
System.exit(exitValue);
} catch (Exception e) {
throw new InstanceException(_strMgr.getString("procExecError"), e);
}
} else {
// add arguments to main command, native must come first
if (nativeLauncher) {
// use native launcher, add in argument
alCmd.add("native");
}
// check to see if debug is enabled
if (debug) {
alCmd.add("debug");
}
// addin command line args
if (commandLineArgs != null) {
for(int ii=0; ii < commandLineArgs.length; ii++) {
alCmd.add(commandLineArgs[ii]);
}
}
// extract full command
command=new String[alCmd.size()];
command=(String[])alCmd.toArray(command);
// call method for executing so can be overriden in descendants
// also, keep executor for any error information
ProcessExecutor processExec=startInstanceExecute(command, securityInfo);
process=processExec.getSubProcess();
waitUntilStarting(processExec);
waitUntilStarted();
postStart();
}
return process;
|
| public void | stopInstance()
if(!isStoppable())
return;
RMIClient rmiClient = getRMIClient();
String instanceName = getConfig().getInstanceName();
// domains set the instance name to "server" -- but not in the RepositoryConfig
if(!ok(instanceName))
instanceName = "server";
ShutdownEvent shutdownEvent = new ShutdownEvent(instanceName);
AdminEventResult result = rmiClient.sendNotification(shutdownEvent);
waitUntilStopped(60);
postStop();
|
| public void | stopInstanceScript()
if(!isStoppable())
return;
execute(getFileLayout(getConfig()).getStopServ());
waitUntilStopped(60);
postStop();
|
| public boolean | stopInstanceWithinTime(int timeout)
if(!isStoppable())
return true;
RMIClient rmiClient = getRMIClient();
String instanceName = getConfig().getInstanceName();
// domains set the instance name to "server" -- but not in the RepositoryConfig
if(!ok(instanceName))
instanceName = "server";
ShutdownEvent shutdownEvent = new ShutdownEvent(instanceName);
AdminEventResult result = rmiClient.sendNotification(shutdownEvent);
waitUntilStopped(timeout);
if (isInstanceNotRunning()) {
postStop();
return true;
} else return false;
|
| protected void | waitUntilStarted()
// PE set to 20 minutes
waitUntilStarted(1200);
|
| protected void | waitUntilStarted(int timeoutSeconds)
InstanceTimer timer = new InstanceTimer(timeoutSeconds, 0,
new TimerCallback()
{
public boolean check() throws Exception
{
return (isInstanceRunning() ||
isInstanceFailed() ||
isInstanceNotRunning());
}
}
);
timer.run(); //synchronous
|
| protected void | waitUntilStarting(com.sun.enterprise.util.ProcessExecutor processExec)
waitUntilStarting(processExec, 180);
|
| protected void | waitUntilStarting(com.sun.enterprise.util.ProcessExecutor processExec, int timeoutSeconds)
InstanceTimer timer = new InstanceTimer(timeoutSeconds, 0,
new TimerCallback()
{
public boolean check() throws Exception
{
return isInstanceStarting() ||
isInstanceRunning() ||
isInstanceFailed();
}
}
);
timer.run(); //synchronous
if (getInstanceStatus() == Status.kInstanceNotRunningCode)
{
throw new InstanceException(
getMessages().getTimeoutStartingMessage(
getConfig().getDisplayName()));
}
|
| void | waitUntilStopped(int timeout)
InstanceTimer timer = new InstanceTimer(timeout, 0,
new TimerCallback()
{
public boolean check() throws Exception
{
return isInstanceNotRunning();
}
}
);
timer.run(); //synchronous
|
