Package com.sun.enterprise.admin.launcher

Class GFLauncher

java.lang.Object
com.sun.enterprise.admin.launcher.GFLauncher
public abstract class GFLauncher extends Object
This is the main Launcher class designed for external and internal usage.

Each of the 3 kinds of server, domain, node-agent and instance, need to subclass this class.

Author:
bnevins

  • Method Details

    • launch

      public final void launch() throws GFLauncherException
      Launches the server.
      Throws:
      GFLauncherException - if launch failed.

    • relaunch

      public final void relaunch() throws GFLauncherException
      Launches the server - but forces the setup() to go through again.
      Throws:
      GFLauncherException

    • setup

      public void setup() throws GFLauncherException, com.sun.enterprise.universal.xml.MiniXmlParserException
      Throws:
      GFLauncherException
      com.sun.enterprise.universal.xml.MiniXmlParserException

    • getInfo

      public final GFLauncherInfo getInfo()
      Returns:
      The callerParameters object that contains startup callerParameters

    • getAdminRealmKeyFile

      public String getAdminRealmKeyFile()
      Returns the admin realm key file for the server, if the admin realm is a FileRealm. Otherwise return null. This value can be used to create a FileRealm for the server.

    • isSecureAdminEnabled

      public boolean isSecureAdminEnabled()
      Returns true if secure admin is enabled

    • getExitValue

      public final int getExitValue()
      Returns the exit value of the glassFishProcess. This only makes sense when we ran in verbose mode and waited for the glassFishProcess to exit in the wait() method. Caveat Emptor!
      Returns:
      the glassFishProcess' exit value if it completed and we waited. Otherwise it returns -1

    • getProcess

      public final Process getProcess() throws GFLauncherException
      You don't want to call this before calling launch because it would not make sense.
      Returns:
      The Process object of the launched Server glassFishProcess. you will either get a valid Process object or an Exceptio will be thrown. You are guaranteed not to get a null.
      Throws:
      GFLauncherException - if the Process has not been created yet - call launch() before calling this method.

    • getProcessStreamDrainer

      public final com.sun.enterprise.universal.process.ProcessStreamDrainer getProcessStreamDrainer() throws GFLauncherException
      A ProcessStreamDrainer is always attached to every Process created here. It is handy for getting the stdin and stdout as a nice String.
      Returns:
      A valid ProcessStreamDrainer. You are guaranteed to never get a null.
      Throws:
      GFLauncherException - if the glassFishProcess has not launched yet
      See Also:
      • ProcessStreamDrainer

    • getLogFilename

      public String getLogFilename() throws GFLauncherException
      Get the location of the server logfile
      Returns:
      The full path of the logfile
      Throws:
      GFLauncherException - if you call this method too early

    • getDebugPort

      public final int getDebugPort()
      Return the port number of the debug port, or -1 if debugging is not enabled.
      Returns:
      the debug port, or -1 if not debugging

    • isDebugSuspend

      public final boolean isDebugSuspend()
      Return true if suspend=y AND debugging is on. otherwise return false.
      Returns:
      true if suspending, or false if either not suspending or not debugging

    • needsAutoUpgrade

      public final boolean needsAutoUpgrade()
      Does this domain need to be automatically upgraded before it can be started?
      Returns:
      true if the domain needs to be upgraded first

    • needsManualUpgrade

      public final boolean needsManualUpgrade()
      Does this domain need to be manually upgraded before it can be started?
      Returns:
      true if the domain needs to be upgraded first

    • getCommandLine

      public final CommandLine getCommandLine()

    • setCommandLine

      protected final void setCommandLine(CommandLine commandLine)

    • getJvmOptions

      public final List<String> getJvmOptions()