com.sun.enterprise.admin.cli
Class LocalServerCommand

java.lang.Object
  com.sun.enterprise.admin.cli.CLICommand
      com.sun.enterprise.admin.cli.LocalServerCommand

All Implemented Interfaces:

org.jvnet.hk2.component.PostConstruct

Direct Known Subclasses:

LocalDomainCommand

public abstract class LocalServerCommand
extends CLICommand

A class that's supposed to capture all the behavior common to operation on a "local" server. It's getting fairly complicated thus the "section headers" comments. This class plays two roles,

• a place for putting common code - which are final methods. A parent class that is communicating with its own unknown sub-classes. These are non-final methods

  Author:

  Byron Nevins

  Field Summary

  private ServerDirs	serverDirs
  private static LocalStringsImpl	strings

  Fields inherited from class com.sun.enterprise.admin.cli.CLICommand

  argv, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, WARNING

  Constructor Summary

  LocalServerCommand()
  

  Method Summary

  protected boolean	checkForSpecialFiles() Override this method and return false to turn-off the file validation.
  protected HostAndPort	getAdminAddress() Returns the admin address of the local domain.
  protected HostAndPort	getAdminAddress(java.lang.String serverName) Returns the admin address of a particular server.
  protected java.io.File	getDomainXml()
  private java.io.File	getJKS()
  protected java.lang.String	getMasterPassword() Get the master password, either from a password file or by asking the user.
  protected java.io.File	getMasterPasswordFile()
  protected int	getPrevPid()
  protected ServerDirs	getServerDirs()
  private java.io.File	getUniquePath(java.io.File f)
  protected long	getUptime() Get uptime from the server.
  protected boolean	isRestartable() See if the server is restartable As of March 2011 -- this only returns false if a passwordfile argument was given when the server started -- but it is no longer available - i.e.
  protected boolean	isRunning() Is the server still running? This is only called when we're hanging around waiting for the server to die.
  protected boolean	isRunning(int port) convenience method for the local machine
  protected boolean	isRunning(java.lang.String host, int port) There is sometimes a need for subclasses to know if a local domain is running.
  private boolean	isRunningByCheckingForPidFile() Is the server still running? This is only called when we're hanging around waiting for the server to die.
  private boolean	isRunningUsingJps() Is the server still running? This is only called when we're hanging around waiting for the server to die.
  protected boolean	isThisServer(java.io.File ourDir, java.lang.String directoryKey) See if the server is alive and is the one at the specified directory.
  protected boolean	loadAndVerifyKeystore(java.io.File jks, java.lang.String mpv)
  private long	parseUptime(java.lang.String up) The remote uptime command returns a string like: Uptime: 10 minutes, 53 seconds, Total milliseconds: 653859\n We find that last number and extract it.
  protected java.lang.String	readFromMasterPasswordFile() Checks if the create-domain was created using --savemasterpassword flag which obtains security by obfuscation! Returns null in case of failure of any kind.
  protected void	resetServerDirs()
  private java.lang.String	retry(int times)
  protected void	setLocalPassword()
  protected void	setServerDirs(ServerDirs sd)
  protected void	unsetLocalPassword()
  private boolean	usingLocalPassword()
  protected boolean	verifyMasterPassword(java.lang.String mpv)
  protected void	waitForRestart(java.io.File pwFile, long oldTimeStamp, long uptimeOldServer)
  private void	waitForRestartLocal(java.io.File pwFile, long oldTimeStamp, long uptimeOldServer) Wait for the local server to restart.
  private void	waitForRestartRemote(long uptimeOldServer) Wait for the remote server to restart.

  Methods inherited from class com.sun.enterprise.admin.cli.CLICommand

  checkHelp, execute, executeCommand, getBooleanOption, getCommand, getManPage, getName, getOperandModel, getOption, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, ok, parse, postConstruct, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, toString, usageOptions, validate

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Field Detail

  serverDirs

  private ServerDirs serverDirs

  strings

  private static final LocalStringsImpl strings

  Constructor Detail

  LocalServerCommand

  public LocalServerCommand()

  Method Detail

  checkForSpecialFiles

  protected boolean checkForSpecialFiles()

  Override this method and return false to turn-off the file validation. E.g. it demands that config/domain.xml be present. In special cases like Synchronization -- this is how you turn off the testing.

  Returns:

  true - do the checks, false - don't do the checks

  getAdminAddress

  protected final HostAndPort getAdminAddress()
                                       throws CommandException

  Returns the admin address of the local domain. Note that this method should be called only when you own the domain that is available on an accessible file system.

  Returns:

  HostAndPort object with admin server address

  Throws:

  CommandException - in case of parsing errors

  getAdminAddress

  protected final HostAndPort getAdminAddress(java.lang.String serverName)
                                       throws CommandException

  Returns the admin address of a particular server. Note that this method should be called only when you own the server that is available on an accessible file system.

  Returns:

  HostAndPort object with admin server address

  Throws:

  CommandException - in case of parsing errors

  setServerDirs

  protected final void setServerDirs(ServerDirs sd)

  setLocalPassword

  protected final void setLocalPassword()

  unsetLocalPassword

  protected final void unsetLocalPassword()

  resetServerDirs

  protected final void resetServerDirs()
                                throws java.io.IOException

  Throws:

  java.io.IOException

  getServerDirs

  protected final ServerDirs getServerDirs()

  getDomainXml

  protected final java.io.File getDomainXml()

  readFromMasterPasswordFile

  protected final java.lang.String readFromMasterPasswordFile()

  Checks if the create-domain was created using --savemasterpassword flag which obtains security by obfuscation! Returns null in case of failure of any kind.

  Returns:

  String representing the password from the JCEKS store named master-password in domain folder

  verifyMasterPassword

  protected final boolean verifyMasterPassword(java.lang.String mpv)

  loadAndVerifyKeystore

  protected boolean loadAndVerifyKeystore(java.io.File jks,
                                          java.lang.String mpv)

  getMasterPassword

  protected final java.lang.String getMasterPassword()
                                              throws CommandException

  Get the master password, either from a password file or by asking the user.

  Throws:

  CommandException

  isThisServer

  protected final boolean isThisServer(java.io.File ourDir,
                                       java.lang.String directoryKey)

  See if the server is alive and is the one at the specified directory.

  Returns:

  true if it's the DAS at this domain directory

  isRunning

  protected final boolean isRunning(java.lang.String host,
                                    int port)

  There is sometimes a need for subclasses to know if a local domain is running. An example of such a command is change-master-password command. The stop-domain command also needs to know if a domain is running without having to provide user name and password on command line (this is the case when I own a domain that has non-default admin user and password) and want to stop it without providing it.

  In such cases, we need to know if the domain is running and this method provides a way to do that.

  Returns:

  boolean indicating whether the server is running

  isRunning

  protected final boolean isRunning(int port)

  convenience method for the local machine

  isRunning

  protected boolean isRunning()

  Is the server still running? This is only called when we're hanging around waiting for the server to die. Byron Nevins, Nov 7, 2010 - Check to see if the process itself is still running We use OS tools to figure this out. See ProcessUtils for details. Failover to the JPS check if necessary

  waitForRestart

  protected final void waitForRestart(java.io.File pwFile,
                                      long oldTimeStamp,
                                      long uptimeOldServer)
                               throws CommandException

  Throws:

  CommandException

  getPrevPid

  protected final int getPrevPid()

  isRunningUsingJps

  private final boolean isRunningUsingJps()

  Is the server still running? This is only called when we're hanging around waiting for the server to die. Byron Nevins, Nov 7, 2010 - Check to see if the process itself is still running We use jps to check If there are any problems fall back to the previous implementation of isRunning() which looks for the pidfile to get deleted

  isRunningByCheckingForPidFile

  private boolean isRunningByCheckingForPidFile()

  Is the server still running? This is only called when we're hanging around waiting for the server to die.

  waitForRestartLocal

  private void waitForRestartLocal(java.io.File pwFile,
                                   long oldTimeStamp,
                                   long uptimeOldServer)
                            throws CommandException

  Wait for the local server to restart.

  Throws:

  CommandException

  waitForRestartRemote

  private void waitForRestartRemote(long uptimeOldServer)
                             throws CommandException

  Wait for the remote server to restart.

  Throws:

  CommandException

  getUptime

  protected final long getUptime()
                          throws CommandException

  Get uptime from the server.

  Throws:

  CommandException

  isRestartable

  protected final boolean isRestartable()
                                 throws CommandException

  See if the server is restartable As of March 2011 -- this only returns false if a passwordfile argument was given when the server started -- but it is no longer available - i.e. the user deleted it or made it unreadable.

  Throws:

  CommandException

  parseUptime

  private long parseUptime(java.lang.String up)

  The remote uptime command returns a string like: Uptime: 10 minutes, 53 seconds, Total milliseconds: 653859\n We find that last number and extract it. XXX - this is pretty gross, and fragile

  usingLocalPassword

  private boolean usingLocalPassword()

  getJKS

  private final java.io.File getJKS()

  getMasterPasswordFile

  protected java.io.File getMasterPasswordFile()

  retry

  private java.lang.String retry(int times)
                          throws CommandException

  Throws:

  CommandException

  getUniquePath

  private java.io.File getUniquePath(java.io.File f)