com.ibm.debug.pdt.daas

Class DAASApplication

  • java.lang.Object
    • com.ibm.debug.pdt.daas.DAASApplication


  • public class DAASApplication
    extends java.lang.Object
    This class represents the IBM Compiled Languages Debug-as-a-Service application.
    Supported parameters for invocation:
    -localonly
    Restrict incoming connections on an unsecured port to only those that originate from the local host.
    
    -port=<port_number>
    The unsecured port number to be used by the debug daemon.
    
    -shutdown=<port_number>
    The port number to be used to shutdown the debug daemon.
    
    -keystore=<file_path>
    The fully qualified path to the keystore file to use with the secured daemon.
     
    -keystorepassword=<string>
    The keystore password to use with the specified keystore and the secured daemon.
     
    -secureport=<port_number>
    The secured port number to be used by the debug daemon. The -keystore and -keystorepassword parameters must be also be specified.  
    May be specified along with the -port parameter.
    
    -trace=<boolean>
    Turn on tracing if true.
    
    -logDir=<dir>
    Set up the root directory for logs.
    
    -requestTimeout=<Timeout in seconds>
    The amount of time to wait for requests to the debug engine. Once this time has expired, the debug session is automatically terminated.
    
    -sessionTimeout=<Timeout in seconds>
    The amount of time a debug session is allowed to be idle from either sending or receiving requests from the debug engine.
    Once this time has expired, the debug session will either be terminated or disconnected. See the sessionTimeoutAction for timeout behavior.
    
    -sessionTimeoutAction=<TERMINATE|TERMINATE_ABEND|DISCONNECT>
    Determines the action to take when the session timout period has expired.  
    TERMINATE will end the debug session and terminate the application.
    TERMINATE_ABEND will end the debug session and abend the application (not supported on all platforms).
    DISCONNECT will end the debug session and the application will run to completion.
     
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      static DAASApplication getInstance()
      Retrieves the instance of the DAAS application
      boolean start(java.lang.String[] parameters)
      Starts the IBM Compiled Languages Debug-as-a-Service application.
      void stop()
      Stops the IBM Compiled Languages Debug-as-a-Service application.
      Does nothing if the application is not started.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getInstance

        public static DAASApplication getInstance()
        Retrieves the instance of the DAAS application
        Returns:
        the application
      • start

        public boolean start(java.lang.String[] parameters)
                      throws java.lang.Exception
        Starts the IBM Compiled Languages Debug-as-a-Service application. with the specified parameters.
        For example:
         DAASApplication.getInstance().start(new String[] { //
                        "-port=8015", //
                        "-trace=true" });
         
        Parameters:
        parameters - A list of command line parameters with values as appropriate
        Returns:
        true if the application has started
        Throws:
        java.lang.Exception - when the application is already started
      • stop

        public void stop()
        Stops the IBM Compiled Languages Debug-as-a-Service application.
        Does nothing if the application is not started.
IBM Debug-as-a-Service
1.0.6.202001312138

Copyright © 2020 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.